„konova-code“ hinzufügen
parent
2fb95d8754
commit
50e3911e1e
25
konova-code.md
Normal file
25
konova-code.md
Normal file
@ -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.
|
Loading…
Reference in New Issue
Block a user