IT-Naturschutz/konova
7
1
Fork 0
Code Issues 6 Pull Requests 1 Actions Projects Releases 28 Wiki Activity

„api v1 intervention get_de“ ändern

mpeltriaux 2022-02-16 11:22:44 +01:00
parent 9b32f91401
commit 5e2cd4ee42
1 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
api-v1-intervention-get_de.md

@ -1,4 +1,29 @@
## 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
### Eingriff
#### GET alle
`/api/v1/intervention`