added env switch for empty day rendering + switched from 255 to 254 for auto logout
This commit is contained in:
96
Readme.md
96
Readme.md
@@ -26,73 +26,93 @@ Nutzeransicht (/user):
|
||||
|
||||

|
||||
|
||||
## Buchungstypen
|
||||
|
||||
1 - Kommen
|
||||
2 - Gehen
|
||||
3 - Kommen Manuell
|
||||
4 - Gehen Manuell
|
||||
254 - Automatisch abgemeldet
|
||||
|
||||
## API
|
||||
|
||||
Nutzung der API
|
||||
wenn die `dev-docker-compose.yml` Datei gestartet wird, ist direkt ein SwaggerUI Server mit entsprechender Datei inbegriffen.
|
||||
|
||||
### Buchungen [/time]
|
||||
|
||||
#### [GET] Anfrage
|
||||
|
||||
Parameter: cardID (string)
|
||||
Antwort: `200`
|
||||
|
||||
```json
|
||||
[
|
||||
{
|
||||
"cradID": "test_card",
|
||||
"readerID": "test_reader",
|
||||
"bookingTyp": 2,
|
||||
"loggedTime": "2024-09-05T08:37:53.117641Z",
|
||||
"id": 5
|
||||
},
|
||||
{
|
||||
"cradID": "test_card",
|
||||
"readerID": "mytest",
|
||||
"bookingTyp": 1,
|
||||
"loggedTime": "2024-09-05T08:51:12.670827Z",
|
||||
"id": 6
|
||||
},
|
||||
]
|
||||
```
|
||||
Antwort `500`
|
||||
Serverfehler
|
||||
|
||||
#### [PUT] Anfrage
|
||||
Parameter: id (int)
|
||||
Body: (veränderte Parameter)
|
||||
```json
|
||||
{
|
||||
{
|
||||
"cradID": "test_card",
|
||||
"readerID": "mytest",
|
||||
"bookingTyp": 1,
|
||||
"loggedTime": "2024-09-05T08:51:12.670827Z",
|
||||
}
|
||||
```
|
||||
Antwort `200`
|
||||
```json
|
||||
{
|
||||
"readerID": "test_reader",
|
||||
"bookingTyp": 2,
|
||||
"loggedTime": "2024-09-05T08:37:53.117641Z",
|
||||
"id": 5
|
||||
},
|
||||
{
|
||||
"cradID": "test_card",
|
||||
"readerID": "mytest",
|
||||
"bookingTyp": 1,
|
||||
"loggedTime": "2024-09-05T08:51:12.670827Z",
|
||||
"id": 6
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
Antwort `500`
|
||||
Serverfehler
|
||||
|
||||
#### [PUT] Anfrage
|
||||
|
||||
Parameter: id (int)
|
||||
Body: (veränderte Parameter)
|
||||
|
||||
```json
|
||||
{
|
||||
"cradID": "test_card",
|
||||
"readerID": "mytest",
|
||||
"bookingTyp": 1,
|
||||
"loggedTime": "2024-09-05T08:51:12.670827Z"
|
||||
}
|
||||
```
|
||||
```
|
||||
|
||||
Antwort `200`
|
||||
|
||||
```json
|
||||
{
|
||||
"cradID": "test_card",
|
||||
"readerID": "mytest",
|
||||
"bookingTyp": 1,
|
||||
"loggedTime": "2024-09-05T08:51:12.670827Z",
|
||||
"id": 6
|
||||
}
|
||||
```
|
||||
|
||||
### Neue Buchung [/time/new]
|
||||
|
||||
#### [PUT] Anfrage
|
||||
|
||||
Parameter:
|
||||
|
||||
- cardID (string)
|
||||
- readerID (string)
|
||||
- bookingType (string)
|
||||
|
||||
Antwort `202` Akzeptiert und eingefügt
|
||||
|
||||
```json
|
||||
{
|
||||
"cradID": "test_card",
|
||||
"readerID": "mytest",
|
||||
"bookingTyp": 1,
|
||||
"loggedTime": "2024-09-05T08:51:12.670827Z",
|
||||
"id": 6
|
||||
"cradID": "test_card",
|
||||
"readerID": "mytest",
|
||||
"bookingTyp": 1,
|
||||
"loggedTime": "2024-09-05T08:51:12.670827Z",
|
||||
"id": 6
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user