From 50e3911e1e50dd7528e4d7a90640442a5dae50ea Mon Sep 17 00:00:00 2001
From: mpeltriaux <michel.peltriaux@sgdnord.rlp.de>
Date: Mon, 25 Apr 2022 13:41:02 +0200
Subject: [PATCH] =?UTF-8?q?=E2=80=9Ekonova-code=E2=80=9C=20hinzuf=C3=BCgen?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 konova-code.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 konova-code.md

diff --git a/konova-code.md b/konova-code.md
new file mode 100644
index 0000000..6d0b0f1
--- /dev/null
+++ b/konova-code.md
@@ -0,0 +1,25 @@
+# Codes
+Mittels Codes werden eindeutig Biotoptypen, Maßnahmen oder Behörden identifiziert. Das identifizierende Attribute lautet `atom_id`. 
+
+## GET
+In `GET` Antworten werden hinterlegte Codes samt der zugehörigen, menschenlesbaren, Daten ausgegeben, zum Beispiel:
+```json
+                ...
+                "registration_office": {
+                    "atom_id": 1764986,
+                    "long_name": "Stadt Koblenz",
+                    "short_name": null
+                },
+                ...
+```
+
+Die hier zurückgegebenen Attribute identifizieren den Code (`atom_id`) und geben weitere semantische Informationen preis (`long_name` bzw. `short_name` (Abkürzung, falls vorhanden)).
+
+## POST|PUT
+Zur Verwendung von Codes in schreibenden Requests (z.B. `POST` und `PUT`) genügt es die Codes einfach als Wert zu setzen:
+```json
+                ...
+                "registration_office": 1764986,
+                ...
+```
+Die Codes können sowohl als Integer als auch als String angegeben werden.
\ No newline at end of file