From 3985820a968b3cef42633757a5330577d134ba83 Mon Sep 17 00:00:00 2001 From: mpeltriaux Date: Wed, 16 Feb 2022 11:23:12 +0100 Subject: [PATCH] =?UTF-8?q?=E2=80=9Eapi=20v1=20ecoaccount=20get=5Fde?= =?UTF-8?q?=E2=80=9C=20=C3=A4ndern?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- api-v1-ecoaccount-get_de.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/api-v1-ecoaccount-get_de.md b/api-v1-ecoaccount-get_de.md index 4255062..d9dbb7f 100644 --- a/api-v1-ecoaccount-get_de.md +++ b/api-v1-ecoaccount-get_de.md @@ -1,4 +1,27 @@ ## 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 + ### Ökokonten #### GET alle `/api/v1/ecoaccount`