From 4136c065a7cf857bbf07b3b41571fddeb195df9a Mon Sep 17 00:00:00 2001 From: Michel Peltriaux Date: Fri, 28 Jan 2022 15:01:27 +0100 Subject: [PATCH] =?UTF-8?q?=E2=80=9Eapi-v1-intervention-check=5Fde?= =?UTF-8?q?=E2=80=9C=20hinzuf=C3=BCgen?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- api-v1-intervention-check_de.md | 93 +++++++++++++++++++++++++++++++++ 1 file changed, 93 insertions(+) create mode 100644 api-v1-intervention-check_de.md diff --git a/api-v1-intervention-check_de.md b/api-v1-intervention-check_de.md new file mode 100644 index 0000000..40d41f9 --- /dev/null +++ b/api-v1-intervention-check_de.md @@ -0,0 +1,93 @@ +## Spezifikation +### Eingriff + +**Achtung:** Für die Prüfung sind die Rechte der Zulassungsbehörde nötig. + +#### GET +Mit `GET` kann ein bestehender Eingriff auf logische Fehler geprüft werden. Als Response erhält der Sender immer eine Asukunft über den Erfolg der Prüfung (`success`) sowie eine Detailübersicht, aus welcher die gefundenen Fehler hervorgehen. + +`/api/v1/intervention//check` + + +#### Beispiel Response Erfolg +```json +{ + "success": true, + "details": { + "intervention": { + "id": "97d7cce8-83e9-4043-bc76-317caf983a41", + "errors": [] + }, + "compensations": [ + { + "id": "d68e9874-70c0-41c5-bd05-9dda97d70ac0", + "errors": [] + }, + { + "id": "128d387d-9ef5-499c-a33f-9aa0ff4ea731", + "errors": [] + }, + { + "id": "a57ed186-7a64-4b25-bbae-185fb96a132d", + "errors": [] + }, + { + "id": "d0ef1ef2-0bfd-4162-b8ac-15a560a2346f", + "errors": [] + }, + { + "id": "7303afbb-693c-4623-adb0-8ab115d6bacc", + "errors": [] + }, + { + "id": "71a0d04e-8d6a-4d95-845a-6889d920b5f6", + "errors": [] + } + ] + } +} + +``` + +#### Beispiel Response Fehler +```json +{ + "success": false, + "details": { + "intervention": { + "id": "97d7cce8-83e9-4043-bc76-317caf983a41", + "errors": [ + "Aktenzeichen Zulassungsbehörde fehlt" + ] + }, + "compensations": [ + { + "id": "d68e9874-70c0-41c5-bd05-9dda97d70ac0", + "errors": [] + }, + { + "id": "128d387d-9ef5-499c-a33f-9aa0ff4ea731", + "errors": [ + "Ungleiche Zustandsflächenmengen" + ] + }, + { + "id": "a57ed186-7a64-4b25-bbae-185fb96a132d", + "errors": [] + }, + { + "id": "d0ef1ef2-0bfd-4162-b8ac-15a560a2346f", + "errors": [] + }, + { + "id": "7303afbb-693c-4623-adb0-8ab115d6bacc", + "errors": [] + }, + { + "id": "71a0d04e-8d6a-4d95-845a-6889d920b5f6", + "errors": [] + } + ] + } +} +``` \ No newline at end of file