Fehlerbehandlung

Allgemeines Fehlerformat

Für die meisten API-Aufrufe wird ein Fehler-JSON-Dokument zurückgegeben. Die HTTP-Anfrage wird mit Status 200 OK quittiert — die Fehlererkennung erfolgt durch Auswertung des JSON.

{
  "statuscode": 500,
  "statusmsg": "Internal server error",
  "additionalstatusmsg": ""
}

Feld	Beschreibung
statuscode	Fehlercode (in Anlehnung an HTTP-Statuscodes)
statusmsg	Fehlermeldung
additionalstatusmsg	Zusätzliche Debug-Informationen (nicht für Endbenutzer)

HTTP-Statuscodes

Code	Bedeutung
200	Erfolg (oder Fehler im JSON)
400	Fehlender oder fehlerhafter Parameter
401	Fehlender oder fehlerhafter Token, keine Berechtigung
404	Ressource nicht gefunden
500	Serverfehler / Ausnahme

Ausnahme: Artikelbilder

Der Endpunkt /articlesimage.jpg gibt kein Fehler-JSON zurück, sondern verwendet ausschließlich HTTP-Statuscodes für die Fehlerbehandlung.

Empfohlene Vorgehensweise

1. Immer den HTTP-Statuscode prüfen
2. Bei 200: Prüfen ob statuscode im JSON vorhanden ist
3. Bei 500: Generell abfangen (Ausnahmebehandlung)
4. additionalstatusmsg nur für Debugging verwenden, nicht für Endbenutzer anzeigen