From 37cc76a13e048d716495b1d08f2395d501a308e1 Mon Sep 17 00:00:00 2001 From: Michel Peltriaux Date: Fri, 28 Jan 2022 14:25:42 +0100 Subject: [PATCH] =?UTF-8?q?=E2=80=9Eapi-v1-compensation-post=5Fde=E2=80=9C?= =?UTF-8?q?=20hinzuf=C3=BCgen?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- api-v1-compensation-post_de.md | 104 +++++++++++++++++++++++++++++++++ 1 file changed, 104 insertions(+) create mode 100644 api-v1-compensation-post_de.md diff --git a/api-v1-compensation-post_de.md b/api-v1-compensation-post_de.md new file mode 100644 index 0000000..acb5d65 --- /dev/null +++ b/api-v1-compensation-post_de.md @@ -0,0 +1,104 @@ +## Spezifikation +### Kompensation +#### Codes +Folgende Attribute referenzieren die `atomId` eines oKey Eintrags für Eingriffe: +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. + +**Achtung**: Eine Kompensation kann nur angelegt werden, wenn der zugehörige Eingriff bereits existiert und referenziert wird. + +`/api/v1/compensation` + +#### Beispiel Body + +```json +{ + "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", + "is_cef": false, + "is_coherence_keeping": false, + "intervention": "97d7cce8-83e9-4043-bc76-317caf983a41", + "before_states": [ + { + "biotope": "136156", + "surface": 1000.0 + } + ], + "after_states": [ + { + "biotope": "136204", + "surface": 1000.0 + } + ], + "actions": [ + { + "action": "709452", + "amount": 1000.0, + "unit": "qm", + "comment": "" + } + ], + "deadlines": [ + { + "type": "finished", + "date": "2022-01-31", + "comment": "" + } + ] + } +} + +``` + + + + +#### Beispiel Response +```json +{ + "id": "75c656e3-fdb9-46d5-bbd2-8dd26b6d295f" +} + +``` \ No newline at end of file