ftracker/docs/API.md

54 lines
619 B
Markdown

API Endpoint Documentation
==========================
Arrival
```javascript
[Request]
POST /arrival
{
"room": "roomname",
"name": "Firstname Lastname",
"agreetoguidelines": true
}
[Response]
200 OK
```
Departure
```javascript
[Request]
POST /departure
{
"name": "Firstname Lastname",
"cleanedworkspace": true
}
[Response]
OK
```
Retrieve data
```javascript
[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
},
...
]
```