10

api v1 compensation post_de

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

Table of Contents

• Spezifikation
• Kompensation
• Codes
• POST
• Beispiel Body
• Beispiel Response

Spezifikation

Kompensation

Codes

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

1. biotope
2. action

POST

Mit POST kann eine neue Kompensation angelegt werden. Die Kompensationsdaten werden im Request body als application/json gesendet. War der Request erfolgreich, erhält der Sender die id des neu angelegten Eintrags. Beim Erstellen eines neuen Eintrags kann ein optionaler external_identifier mitgegeben werden, der sich auf die ID im Ursprungssystem bezieht. Neben dem neu generierten Identifier in der Response kann dieser Eintrag künftig auch über diesen externen Identifier via API gefunden und bearbeitet werden.

Achtung: Eine Kompensation kann nur angelegt werden, wenn der zugehörige Eingriff bereits existiert und referenziert wird. Sofern der Eingriff mit einem external_identifier angelegt wurde, kann der entsprechende Wert für die intervention alternativ genutzt werden.

/api/v1/compensation

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 Kompensation",
        "external_identifier": "EXT-ID-12345",
        "is_cef": false,
        "is_pik": false,
        "is_coherence_keeping": false,
        "intervention": "97d7cce8-83e9-4043-bc76-317caf983a41",
        "before_states": [
            {
                "biotope": "136156",
                "biotope_details": [
                    "138046"
                ],
                "surface": 1000.0
            }
        ],
        "after_states": [
            {
                "biotope": "136204",
                "biotope_details": [],
                "surface": 1000.0
            }
        ],
        "actions": [
            {
                "action_types": [
                    "709297",
                    "709289",
                    "709299"
                ],
                "action_details": [ 
                    "709649", 
                    "709709"
                ],
                "amount": 1000.0,
                "unit": "m²",
                "comment": ""
            }
        ],
        "deadlines": [
            {
                "type": "finished",
                "date": "2022-01-31",
                "comment": ""
            }
        ]
    }
}
    

Beispiel Response

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