„api v1 compensation get_de“ ändern
parent
5e2cd4ee42
commit
7d5570e0fc
@ -1,4 +1,27 @@
|
|||||||
## Spezifikation
|
## Spezifikation
|
||||||
|
### GET Response allgemein
|
||||||
|
Jeder erfolgreiche `GET` Request wird mit folgender Response Struktur beantwortet:
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"rpp": 5,
|
||||||
|
"p": 1,
|
||||||
|
"next": "http://example.org/api/v1/xyz/?rpp=5&p=2",
|
||||||
|
"results": {
|
||||||
|
...
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
Erklärung:
|
||||||
|
* `rpp`: Results per page. Bestimmt wie viele Ergebnisse pro Seite zurückgeliefert werden
|
||||||
|
* `p`: Page. Gibt die zurückgelieferte Seitennummer an
|
||||||
|
* `next`: URL zur nächsten Seite. Sollte keine weitere Seite existieren wird hier `null` stehen
|
||||||
|
* `results`: Die angefragten Daten.
|
||||||
|
* Alle folgenden Response Beispiele beziehen sich auf den Inhalt von `results`
|
||||||
|
|
||||||
|
Request Parameter:
|
||||||
|
* `rpp`: Kann direkt als `GET` Parameter im Request mitgegeben werden (s. `next` URL). Muss eine Zahl > 0 sein. Falls nicht angegeben, wird ein Standardwert verwendet
|
||||||
|
* `p`: Kann direkt als `GET` Parameter im Request mitgegeben werden (s. `next` URL). Muss eine Zahl > 0 sein. Falls nicht angegeben, wird ein Standardwert verwendet
|
||||||
|
|
||||||
### Kompensation
|
### Kompensation
|
||||||
#### GET alle
|
#### GET alle
|
||||||
`/api/v1/compensation`
|
`/api/v1/compensation`
|
||||||
|
Loading…
Reference in New Issue
Block a user