ftracker/docs/API.md

API Endpoint Documentation

Arrival

[Request]
POST /arrival

{
	"room": "roomname",
	"name": "Firstname Lastname",
	"agreetoguidelines": true
}

[Response]
200 OK

409 CONFLICT
{
	"request": "departure",
	"arrival": {
		"time": "UTC-ISO-TIMESTAMP",
		"room": "roomname"
	},
	"message": "Error: Undeparted arrival exists"
}

Departure

[Request]
POST /departure

{
	"name": "Firstname Lastname",
	"cleanedworkspace": true
}

[Response]
200 OK

409 CONFLICT
{
	"request": "arrival",
	"message": "Error: No arrival exists"
}

Retrieve data

[Request]
GET /data
Authorization: Basic < base64 USER:PASSWORD >

[Response]
200 OK

[
	{
		"room": "roomname",
		"name": "firstname-middlename-lastname",
		"arrival": "UTC-ISO-TIMESTAMP",
		"departure": "UTC-ISO-TIMESTAMP" || null
	},
	...
]