Page:
konova codes
Pages
EGON
Home
Home_en
api v1 compensation delete_de
api v1 compensation get_de
api v1 compensation json properties de
api v1 compensation post_de
api v1 compensation put_de
api v1 deduction delete_de
api v1 deduction get_de
api v1 deduction json properties de
api v1 deduction post_de
api v1 deduction put_de
api v1 ecoaccount delete_de
api v1 ecoaccount get_de
api v1 ecoaccount json properties de
api v1 ecoaccount post_de
api v1 ecoaccount put_de
api v1 ema delete_de
api v1 ema get_de
api v1 ema json properties de
api v1 ema post_de
api v1 ema put_de
api v1 intervention check_de
api v1 intervention delete_de
api v1 intervention get_de
api v1 intervention json properties de
api v1 intervention post_de
api v1 intervention put_de
api v1 share get_de
api v1 share put_de
api_de
custom commands
features
features_de
features_en
generate_report_de
konova codes
recalculate_parcels_de
technical documentation
technical documentation_de
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.