1 konova codes
mpeltriaux edited this page 2022-04-25 13:43:04 +02:00

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:

                ...
                "registration_office": {
                    "atom_id": 1764986,
                    "long_name": "Stadt Koblenz",
                    "short_name": null
                },
                ...

Somit ist die Darstellung in eigenen Diensten einfacher über long_name bzw. short_name (falls vorhanden) umzusetzen. 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:

                ...
                "registration_office": 1764986,
                ...

Die Codes können sowohl als Integer als auch als String angegeben werden.