6 api v1 ema get_de

mpeltriaux edited this page 2023-02-23 11:00:11 +01:00

Table of Contents

• Spezifikation
• GET Response allgemein
• EMA
• 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

EMA

GET alle

/api/v1/ema

Beispiel Response

{
    "f1410071-239e-4615-b7a5-f0780030d42c": {
        "type": "MultiPolygon",
        "coordinates": [
            [
                [
                    [
                        7.845568656921382,
                        50.79829702304368
                    ],
                    [
                        7.837371826171871,
                        50.80155187891526
                    ],
                    [
                        7.835698127746578,
                        50.805267562209806
                    ],
                    [
                        7.841062545776364,
                        50.806623577403386
                    ],
                    [
                        7.848916053771969,
                        50.808359219420474
                    ],
                    [
                        7.855696678161618,
                        50.807057493952975
                    ],
                    [
                        7.854666709899899,
                        50.80423696434001
                    ],
                    [
                        7.850461006164548,
                        50.80217570040005
                    ],
                    [
                        7.845568656921382,
                        50.79829702304368
                    ]
                ]
            ]
        ],
        "properties": {
            "id": "f1410071-239e-4615-b7a5-f0780030d42c",
            "identifier": "EMA-12022-5T92V0",
            "title": "Tolles EMA",
            "created_on": "2022-01-13T08:22:36.792Z",
            "modified_on": "2022-01-21T08:06:08.874Z",
            "responsible": {
                "conservation_office": {
                    "id": 54352,
                    "long_name": "LK Ahrweiler",
                    "short_name": "10"
                },
                "conservation_file_number": "unbekannt",
                "handler": {
                    "type": {
                        "id": 5352562,
                        "long_name": "Sonstige und private Träger",
                        "short_name": "Sonstige und private Träger"
                    },
                    "detail": "Firma Mustermann234"
                }
            },
            "before_states": [
                {
                    "biotope": {
                        "id": 5256554,
                        "long_name": "Buchenmischwald mit einheimischen Laubbaumarten",
                        "short_name": "AA2"
                    },
                    "biotope_details": [],
                    "surface": 1.0
                }
            ],
            "after_states": [
                {
                    "biotope": {
                        "id": 6467322,
                        "long_name": "Buchen-Eichenmischwald",
                        "short_name": "AB1"
                    },
                    "biotope_details": [],
                    "surface": 1.0
                }
            ],
            "actions": [
                {
                    "action_types": [
                        {
                            "id": 646362,
                            "long_name": "Sonstiges (s. Erläuterungen)",
                            "short_name": null
                        }
                    ],
                    "action_details": [],
                    "amount": 1.0,
                    "unit": "cm",
                    "comment": ""
                }
            ],
            "deadlines": []
        }
    },
    "08ce8b90-231f-42d5-82dd-a3f555d82de0": {
        "type": "MultiPolygon",
        "coordinates": [
            [
                [
                    [
                        7.845568656921382,
                        50.79829702304368
                    ],
                    [
                        7.837371826171871,
                        50.80155187891526
                    ],
                    [
                        7.835698127746578,
                        50.805267562209806
                    ],
                    [
                        7.841062545776364,
                        50.806623577403386
                    ],
                    [
                        7.848916053771969,
                        50.808359219420474
                    ],
                    [
                        7.855696678161618,
                        50.807057493952975
                    ],
                    [
                        7.854666709899899,
                        50.80423696434001
                    ],
                    [
                        7.850461006164548,
                        50.80217570040005
                    ],
                    [
                        7.845568656921382,
                        50.79829702304368
                    ]
                ]
            ]
        ],
        "properties": {
            "id": "08ce8b90-231f-42d5-82dd-a3f555d82de0",
            "identifier": "EMA-012022-M8XI99",
            "title": "Tolles EMA123",
            "created_on": "2022-01-24T15:38:51.395Z",
            "modified_on": "2022-01-24T15:42:01.431Z",
            "responsible": {
                "conservation_office": {
                    "id": 6432622,
                    "long_name": "LK Ahrweiler",
                    "short_name": "10"
                },
                "conservation_file_number": "",
                "handler": {
                    "type": {
                        "id": 6234646,
                        "long_name": "Sonstige und private Träger",
                        "short_name": "Sonstige und private Träger"
                    },
                    "detail": "Firma Mustermann234"
                }
            },
            "before_states": [
                {
                    "biotope": {
                        "id": 64747543,
                        "long_name": "Buchenmischwald mit einheimischen Laubbaumarten",
                        "short_name": "AA2"
                    },
                    "biotope_details": [],
                    "surface": 1.0
                }
            ],
            "after_states": [
                {
                    "biotope": {
                        "id": 6363645,
                        "long_name": "Buchen-Eichenmischwald",
                        "short_name": "AB1"
                    },
                    "biotope_details": [],
                    "surface": 10.0
                }
            ],
            "actions": [
                {
                    "action_types": [
                        {
                            "id": 646364,
                            "long_name": "Sonstiges (s. Erläuterungen)",
                            "short_name": null
                        }
                    ],
                    "action_details": [],
                    "amount": 1.0,
                    "unit": "cm",
                    "comment": ""
                }
            ],
            "deadlines": []
        }
    },
    ...
}
    

GET einzeln

/api/v1/ema/<uuid>

Beispiel Response

{
    "f1410071-239e-4615-b7a5-f0780030d42c": {
        "type": "MultiPolygon",
        "coordinates": [
            [
                [
                    [
                        7.845568656921382,
                        50.79829702304368
                    ],
                    [
                        7.837371826171871,
                        50.80155187891526
                    ],
                    [
                        7.835698127746578,
                        50.805267562209806
                    ],
                    [
                        7.841062545776364,
                        50.806623577403386
                    ],
                    [
                        7.848916053771969,
                        50.808359219420474
                    ],
                    [
                        7.855696678161618,
                        50.807057493952975
                    ],
                    [
                        7.854666709899899,
                        50.80423696434001
                    ],
                    [
                        7.850461006164548,
                        50.80217570040005
                    ],
                    [
                        7.845568656921382,
                        50.79829702304368
                    ]
                ]
            ]
        ],
        "properties": {
            "id": "f1410071-239e-4615-b7a5-f0780030d42c",
            "identifier": "EMA-12022-5T92V0",
            "title": "Tolles EMA",
            "created_on": "2022-01-13T08:22:36.792Z",
            "modified_on": "2022-01-21T08:06:08.874Z",
            "responsible": {
                "conservation_office": {
                    "id": 536363,
                    "long_name": "LK Ahrweiler",
                    "short_name": "10"
                },
                "conservation_file_number": "unbekannt",
                "handler": {
                    "type": {
                        "id": 6478324,
                        "long_name": "Sonstige und private Träger",
                        "short_name": "Sonstige und private Träger"
                    },
                    "detail": "Firma Mustermann234"
                }
            },
            "before_states": [
                {
                    "biotope": {
                        "id": 4736342,
                        "long_name": "Buchenmischwald mit einheimischen Laubbaumarten",
                        "short_name": "AA2"
                    },
                    "biotope_details": [],
                    "surface": 1.0
                }
            ],
            "after_states": [
                {
                    "biotope": {
                        "id": 636357643,
                        "long_name": "Buchen-Eichenmischwald",
                        "short_name": "AB1"
                    },
                    "biotope_details": [],
                    "surface": 1.0
                }
            ],
            "actions": [
                {
                    "action_types": [
                        {
                            "id": 7573643,
                            "long_name": "Sonstiges (s. Erläuterungen)",
                            "short_name": null
                        }
                    ],
                    "action_details": [],
                    "amount": 1.0,
                    "unit": "cm",
                    "comment": ""
                }
            ],
            "deadlines": []
        }
    }
}