3 api v1 deduction get_de

mpeltriaux edited this page 2022-02-16 11:23:25 +01:00

Table of Contents

• Spezifikation
• GET Response allgemein
• Ökokonto Abbuchung
• GET alle
• Beispiel Response
• GET einzeln
• Beispiel Response

Spezifikation

GET Response allgemein

Jeder erfolgreiche GET Request wird mit folgender Response Struktur beantwortet:

{
    "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

Ökokonto Abbuchung

GET alle

/api/v1/deduction

Beispiel Response

{
    "f784e131-afb7-4e15-ad57-0b2469f5e967": {
        "id": "f784e131-afb7-4e15-ad57-0b2469f5e967",
        "eco_account": {
            "id": "3e7acd84-bb67-408d-886e-91004c319f38",
            "identifier": "OEK-12022-TW4ECJ",
            "title": "Tolles Ökokonto"
        },
        "surface": 1000.0,
        "intervention": {
            "id": "97d7cce8-83e9-4043-bc76-317caf983a41",
            "identifier": "EIV-12022-B6XGM9",
            "title": "Tolles Baugebiet GEÄNDERT1"
        }
    },
    "a4f12eec-a29a-46c5-8fb8-58a8d3661eb6": {
        "id": "a4f12eec-a29a-46c5-8fb8-58a8d3661eb6",
        "eco_account": {
            "id": "3e7acd84-bb67-408d-886e-91004c319f38",
            "identifier": "OEK-12022-TW4ECJ",
            "title": "Tolles Ökokonto"
        },
        "surface": 500.0,
        "intervention": {
            "id": "75c656e3-fdb9-46d5-bbd2-8dd26b6d295f",
            "identifier": "EIV-012022-30X31E",
            "title": "Tolles Baugebiet GEÄNDERT"
        }
    },
    ...
}
    

GET einzeln

/api/v1/deduction/<uuid>

Beispiel Response

{
    "5ed582e0-b895-44c9-a6c9-211f0f546726": {
        "id": "5ed582e0-b895-44c9-a6c9-211f0f546726",
        "eco_account": {
            "id": "3e7acd84-bb67-408d-886e-91004c319f38",
            "identifier": "OEK-12022-TW4ECJ",
            "title": "Tolles Ökokonto"
        },
        "surface": 152200.0,
        "intervention": {
            "id": "75c656e3-fdb9-46d5-bbd2-8dd26b6d295f",
            "identifier": "EIV-012022-30X31E",
            "title": "Tolles Baugebiet GEÄNDERT"
        }
    }
}