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 | Gilt für alle Aktionen (Anlegen, Aktualisieren, Lesen), wenn nicht genauer angegeben. |
updrule | m = mandatory | Übersteuert die defarule in der angegebenen Aktion “Aktualisieren”. |
readrule | m = mandatory | Übersteuert die defarule in der angegebenen Aktion “Lesen”. |
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. |
Aktualisieren | Aktualisiert bestehende Datensätze. |
Lesen | Gibt den zu lesenden Datensatz zurück. |