„api-v1-json-properties“ hinzufügen

api-v1-json-properties.md

@@ -0,0 +1,100 @@
+# Json Attribute
+## Eingriff
+* `type`: Muss immer `MultiPolygon` sein
+* `coordinates`: Enthält die Koordinaten der Geometrie(n) (EPSG:4326)
+* `properties`: Enthält die Attribute des Eingriffsobjektes
+* `title` (str): Bezeichnung/Titel des Eingriffs
+* `responsible`: Enthält Informationen zu zuständigen Akteuren (Zulassungsbehörde, Naturschutzbehörde, Eingriffsverursacher)
+* `responsible.registration_office` (str): Identifiziert eindeutig eine Zulassungsbehörde (bspw. "untere Baubehörde - Kreisverwaltung XY")
+* `responsible.registration_file_number` (str): Aktenzeichen der Zulassungsbehörde
+* `responsible.conservation_office` (str): Identifiziert eindeutig eine Eintragungsstelle/Naturschutzbehörde (bspw. "Kreisverwaltung XY")
+* `responsible.conservation_file_number` (str): Aktenzeichen der Eintragungsstelle
+* `responsible.handler`: Enthält Informationen zum Eingriffsverursacher
+* `responsible.handler.type` (str): Identifiziert eindeutig die Art des Verursachers (bspw. "Stadt", "Sonstige und private Träger", ...)
+* `responsible.handler.details` (str): Details zum Eingriffsverursacher
+* `legal`: Enthält Informationen zum rechtlichen Status des Eingriffs
+* `legal.registration_date` (str): Zulassungsdatum (ISO Format)
+* `legal.binding_date` (str): Bestandskraftdatum/Ende der Widerspruchsfrist (ISO Format)
+* `legal.process_type` (str): Identifiziert eindeutig einen Verfahrenstyp für den Eingriff (bspw. "Genehmigung", "Kenntnisgabe", ...)
+* `legal.laws` (list): Identifiziert eine Menge von Gesetzen auf deren Grundlage der Eingriff genehmigt wurde
+* `payments` (list): Enthält Informationen zu einer Menge von Ersatzzahlungen 
+* `payment.amount` (float): Zahlungsbetrag in €
+* `payment.due_on` (str): Zahlungstermin (ISO Format)
+* `payment.comment` (str): Kommentar zur Zahlung (Falls kein Termin angegeben werden kann, soll erklärt werden weshalb)
+
+### Pflichtattribute
+
+
+### Beispiel 
+<details>
+  <summary>Beispiel body (POST|PUT)</summary>
+    
+```json
+    {
+    "type": "MultiPolygon",
+    "coordinates": [
+        [
+            [
+                [
+                    7.593955993652341,
+                    50.36244809879689
+                ],
+                [
+                    7.592582702636717,
+                    50.36023051515941
+                ],
+                [
+                    7.601766586303708,
+                    50.35823186336356
+                ],
+                [
+                    7.603225708007811,
+                    50.3628587510637
+                ],
+                [
+                    7.599148750305174,
+                    50.362557606415464
+                ],
+                [
+                    7.596273422241207,
+                    50.362612360130036
+                ],
+                [
+                    7.593955993652341,
+                    50.36244809879689
+                ]
+            ]
+        ]
+    ],
+    "properties": {
+        "title": "Baugebiet an der Markgrafenstraße",
+        "responsible": {
+            "registration_office": 1764986,
+            "registration_file_number": "123",
+            "conservation_office": "710138",
+            "conservation_file_number": "5664",
+            "handler": {
+                "type": "710185",
+                "detail": "Firma Mustermann"
+            }
+        },
+        "legal": {
+            "registration_date": "1990-01-01",
+            "binding_date": "1990-01-01",
+            "process_type": null,
+            "laws": [
+                "710067"
+            ]
+        },
+        "payments": [
+            {
+                "amount": 5.00,
+                "due_on": "1990-01-01",
+                "comment": "Test"
+            }
+        ]
+    }
+}
+```
+    
+</details>