9

api v1 compensation put_de

mpeltriaux edited this page 2026-05-10 09:57:37 +00:00

Table of Contents

• Spezifikation
• Kompensation
• Codes
• PUT
• Beispiel Body
• Beispiel Response

Spezifikation

Kompensation

Codes

Folgende Attribute referenzieren die Id eines oKey Eintrags für Kompensationen:

1. biotope
2. action

PUT

Mit PUT kann eine Kompensation überarbeitet werden. Die Kompensationsdaten werden im Request body als application/json gesendet. War der Request erfolgreich, erhält der Sender die id des überarbeiteten Eintrags. Beim Aktualisieren eines Eintrags kann ein optionaler external_identifier mitgegeben werden, der sich auf die ID im Ursprungssystem bezieht. Wenn der mitgegebene external_identifier dem bereits gesetzten entspricht, gibt es keine Änderung. Handelt es sich um einen neuen Wert, wird dieser zusätzlich zum bereits existierenden externen Identifikator gesetzt, sodass historisch nachvollzogen werden kann wann zu welchen externen IDs der Eintrag referenziert werden konnte.

/api/v1/compensation/<uuid>

Achtung: Sofern der Eingriff mit einem external_identifier angelegt wurde, kann der entsprechende Wert für die intervention alternativ genutzt werden.

Beispiel Body

{
    "type": "MultiPolygon",
    "coordinates": [
        [
            [
                [
                    7.477097511291501,
                    50.14218444767971
                ],
                [
                    7.479243278503415,
                    50.140479182654374
                ],
                [
                    7.483620643615721,
                    50.14300955409459
                ],
                [
                    7.482976913452146,
                    50.14405466845533
                ],
                [
                    7.481346130371092,
                    50.14416467916495
                ],
                [
                    7.479929924011228,
                    50.143174573669675
                ],
                [
                    7.47808456420898,
                    50.14232196640389
                ],
                [
                    7.477097511291501,
                    50.14218444767971
                ]
            ]
        ]
    ],
    "properties": {
        "title": "Tolle Kompensation1234",
        "external_identifier": "EXT-ID-12345",
        "is_cef": false,
        "is_coherence_keeping": false,
        "intervention": "97d7cce8-83e9-4043-bc76-317caf983a41",
        "before_states": [
            {
                "biotope": "136156",
                "biotope_details": [],
                "surface": 1000.0
            }
        ],
        "after_states": [
            {
                "biotope": "136204",
                "biotope_details": [],
                "surface": 1000.0
            }
        ],
        "actions": [
            {
                "action_types": [
                    "709297",
                    "709289",
                    "709299"
                ],
                "action_details": [],
                "amount": 1000.0,
                "unit": "qm",
                "comment": ""
            }
        ],
        "deadlines": [
            {
                "type": "finished",
                "date": "2022-01-31",
                "comment": ""
            }
        ]
    }
}
    

Beispiel Response

{
    "id": "75c656e3-fdb9-46d5-bbd2-8dd26b6d295f"
}