API

Konzept

Die API basiert auf dem CRUD-Prinzip, führt jedoch Konzepte und Methoden zum Verknüpfen anderer Entitäten ein.

Entitäten müssen eine eindeutige ID vom Typ string haben. Diese ID wird nicht immer als „ID“ bezeichnet.

Die vollständige Entität wird bei CREATE und UPDATE zurückgegeben.

Entitätseigenschaften sind entweder einfache oder komplexe Eigenschaften. Komplexe Eigenschaften können nicht per Update geändert werden, sondern müssen über die angegebenen Methoden verändert werden. Sie sind in der Rückgabe des vollständigen Objekts enthalten.

Entitäten werden normalerweise ohne ID erstellt. Diese wird vom Server generiert (und in der vollständigen Entität zurückgegeben).

Bei UPDATE -Aufrufen wird das Ziel durch das ID-Feld im Objekt identifiziert.

Grundlegende Methoden: (Ersetzen Sie Entity durch den Namen der jeweiligen Entität mit führendem Großbuchstaben.)

CREATE : newEntity (entity: Object)

READ : getEntity (id: string)

READ ALL : getAll ()

UPDATE : updateEntity (entity: Object)

DELETE : deleteEntity (id: string)

Komplexe Eigenschaften sind immer ungeordnet. Wird eine Ordnung benötigt, wird ein „Priorität“-Attribut o.Ä. verwendet. Für jede komplexe Eigenschaft existieren die folgenden Methoden, die jeweils den neuen Eigenschaftswert zurückgeben: (Ersetzen Sie „Property“ durch den Pascal-Namen der jeweiligen Eigenschaft).

ADD: assignProperty(id: string)

REMOVE: unassignProperty(id: string)

Zugriff auf die API

Methodenaufrufe werden mit HTTPS und JSON-RPC 2.0 durchgeführt. Die Authentifizierung erfolgt über die HTTP-Authentifizierung entweder mit dem Basisschema gemäß RFC 7617 oder mit dem Inhaberschema gemäß RFC 6750. Der Token für das Inhaberschema muss mithilfe eines API-Aufrufs unter Verwendung der Basisauthentifizierung abgerufen werden.

Beispiele

Die folgenden Beispiele sind grafisch aufgearbeitete Netzwerkmitschnitte.

Löschen einer Nebenstelle

Anlegen einer Nebenstelle

Liste alle Nebenstellen

Update einer Nebenstelle