Page:
api_de
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
24
api_de
mpeltriaux edited this page 2022-09-28 09:25:56 +02:00
API
Vorbereitung
- Nutzer muss mindestens der Nutzergruppe
Standardangehören- Eigene/Freigegebene Daten können eingesehen werden (
GET) - Neue Daten können angelegt (
POST) und bestehende bearbeitet werden (PUT) - Eigene/Freigegebene Daten können gelöscht werden (
DELETE) - Für eigene/freigegebene Daten kann die Liste der freigegebenen Nutzer eingesehen werden (
GET) - Daten können anderen Nutzern freigegeben werden
- Achtung: Wenn keine weitere Berechtigung außer der
StandardGruppe vorliegt, können Nutzer zur Liste der freigegebenen Nutzer lediglich hinzugefügt aber nicht entfernt werden. Zum Entfernen von Nutzern wird die BerechtigungZulassungsbehördeoderEintragungsstellebenötigt.
- Achtung: Wenn keine weitere Berechtigung außer der
- Eigene/Freigegebene Daten können eingesehen werden (
- Nutzer muss sich einen API Token im KSP-Profil generieren
- Generierte Token müssen erst von Administratoren bestätigt werden. Vorher sind sie nicht gültig und können nicht verwendet werden. Administratoren werden automatisch nach Generierung eines neuen Token per Mail informiert.
- Token können von Administratoren zeitlich begrenzt werden. Ist das Datum der Gültigkeit abgelaufen, können die Token nicht länger verwendet werden
- Jeder Request muss mit den Headern
KsptokenundKspuserfür den Token sowie den Nutzernamen abgeschickt werden
Hinweise
- Daten werden im geojson Format ausgeliefert und entgegen genommen
- Nur Geometrien vom Typ
MultiPolygonsind erlaubt - Für das Anlegen neuer Einträge für alle Datentypen gilt: Es muss mindestens ein
titleangegeben werden, alle anderen Felder (auch die Geometrie) dürfen leer/null sein - Details zum Umgang mit vordefinierten Codes können hier eingesehen werden
- URL-Requests per
POSToderPUTmüssen auf ein/enden
Workflow
Sobald ein neuer Eintrag zu einem Objekttyp erstellt wurde (s. Details unten), erhält der Sender eine Response mit der id des neu erzeugten Eintrags. Diese wird für alle zukünftigen Änderungen (PUT) oder lesenden Anfragen (GET) verwendet.
Objekte werden einzeln angelegt. D.h. jeder Request enthält genau ein Objekt. Das bedeutet z.B. beim Anlegen von Eingriffen und zugehörigen Kompensationen, dass zunächst der Eingriff angelegt werden muss. Die somit erhaltene id des Eingriffs wird zum Anlegen von zugehörigen Kompensationen in Folgeschritten verwendet (s. Detail unten).