API-Dokumentation

Allgemeine Informationen

Sowohl die Übergabe von Parametern als auch die zurückgelieferten Daten werden als JSON übergeben.

Die Rückgaben können anhand ihrer HTTP-Status-Codes ausgewertet werden. Die Codes orientieren sich inhaltlich an denen des HTTP-Standards, können aber in Details anders ausgelegt sein.

Welche Codes eine Rückgabe erzeugen kann, ist in der Dokumentation der jeweiligen Endpoints vermerkt. Details zur Rückgabe können der JSON-Antwort entnommen werden.

Statuscodes im 400er-Bereich beinhalten Fehler, die auf Client-Seite durch Änderungen behoben werden können.

Statuscodes im 500er-Bereich beziehen sich immer auf ein Problem, auf das der Client keinen Einfluss hat.

Allgemein

Endpoints

Funktionen