Allgemeine Information

Die GoliathAPI bietet die Möglichkeit von außen Daten abzurufen, anzulegen und zu aktualisieren.
Unsere API wird kontinuierlich weiterentwickelt und verbessert.

Jedes Update der API führt zu einer Änderung der Versionsnummer.
Über die Angabe der Versionsnummer in der Austauschdatei bleibt jede Version in sich stabil und ist von den Änderungen der neuen Version nicht betroffen.

Manchmal lassen sich allerdings Breaking Changes nicht vermeiden, bspw. wenn eine neue Funktion eine inkompatible Änderung des zugrunde liegenden Datenmodells erfordert. Darüber informieren wir allerdings im Änderungsprotokoll der API.

Datentypen der JSON-Properties

Datentyp	Beispiel	Bemerkung
string	Abcdefg123	Alphanummerisch
number	155.13	Nummerisch
utcdate	2023-02-14T00:00:00Z	Datumzeit als UTC (ISO 8601)
bool	true / false	Wahr oder Falsch
object	{…}	Beinhaltet weitere Properties
array	[{…}, {…}]	Beinhaltet mehrere Objekte

Regeln der JSON-Properties

Regel	Ausprägungen	Bemerkung
defarule	m = mandatory o = optional i = ignored	Gilt für alle Aktionen (Anlegen, Aktualisieren, Lesen), wenn nicht genauer angegeben.
updrule	m = mandatory o = optional i = ignored	Übersteuert die defarule in der angegebenen Aktion “Aktualisieren”.
readrule	m = mandatory o = optional i = ignored	Übersteuert die defarule in der angegebenen Aktion “Lesen”.

Groß-/Kleinschreibung

Die Properties in der JSON können Upper, Lower oder Mixed-Case sein. Die API legt keinen Wert auf Groß-/Kleinschreibung.

API-Typen

Typ	Bemerkung
GoliathAPIStandard	Entspricht dem heutigen GoliathAPI-Standard.

API-Operationen

Aktion

Aktion	Bemerkung
Anlegen	Legt die Datensätze an. Bestehende Datensätze werden nicht aktualisiert. [POST]
Aktualisieren	Aktualisiert bestehende Datensätze. [PATCH]
Lesen	Gibt den zu lesenden Datensatz zurück. (In Progress) [GET]

Aufgabe	Ausgeschlossene Aktionen	Bemerkung
Vorabcheck	Lesen	Die API simuliert die Verarbeitung und gibt eine qualifizierte Rückmeldung.
Verarbeiten		Die API führt die angegebenen Aktion aus.

GoliathAPI