ftracker/docs/API.md

52 lines
568 B
Markdown
Raw Normal View History

2020-11-30 18:00:16 +01:00
API Endpoint Documentation
==========================
Arrival
```javascript
[Request]
POST /arrival
{
"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
[
{
'name': 'firstname-middlename-lastname',
'arrival': 'UTC-ISO-TIMESTAMP',
'departure': 'UTC-ISO-TIMESTAMP'
},
...
]
```