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