IT-Naturschutz/konova
7
1
Fork 0
Code Issues 6 Pull Requests 1 Actions Projects Releases 28 Wiki Activity

„api-v1-intervention-check_de“ hinzufügen

Michel Peltriaux 2022-01-28 15:01:27 +01:00
parent 5de313e464
commit 4136c065a7
1 changed files with 93 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

93
api-v1-intervention-check_de.md Normal file

@ -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/<uuid>/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": []
}
]
}
}
```