ftracker/docs/API.md

70 lines
863 B
Markdown
Raw Normal View History

2020-11-30 18:00:16 +01:00
API Endpoint Documentation
==========================
Arrival
```javascript
[Request]
POST /arrival
{
2020-12-01 01:27:09 +01:00
"room": "roomname",
2020-11-30 18:00:16 +01:00
"name": "Firstname Lastname",
"agreetoguidelines": true
}
[Response]
200 OK
2020-12-01 15:48:10 +01:00
409 CONFLICT
{
"request": "departure",
"arrival": {
"time": "UTC-ISO-TIMESTAMP",
"room": "roomname"
},
"message": "Error: Undeparted arrival exists"
}
2020-11-30 18:00:16 +01:00
```
Departure
```javascript
[Request]
POST /departure
{
"name": "Firstname Lastname",
"cleanedworkspace": true
}
[Response]
2020-12-01 13:08:40 +01:00
200 OK
2020-12-01 15:48:10 +01:00
409 CONFLICT
{
"request": "arrival",
"message": "Error: No arrival exists"
}
2020-11-30 18:00:16 +01:00
```
Retrieve data
```javascript
[Request]
GET /data
Authorization: Basic < base64 USER:PASSWORD >
[Response]
200 OK
[
{
2020-12-01 01:27:09 +01:00
"room": "roomname",
"name": "firstname-middlename-lastname",
"arrival": "UTC-ISO-TIMESTAMP",
"departure": "UTC-ISO-TIMESTAMP" || null
2020-11-30 18:00:16 +01:00
},
...
]
```