Fehler

Die ONE API nutzt konventionelle HTTP-Response-Statuscodes um anzuzeigen, ob die Verarbeitung einer Anfrage erfolgreich war oder nicht: Bei Erfolg wird der Statuscode 200 zurückgeliefert, Codes im Bereich 4xx deuten auf ungültige Anfragedaten hin, im Bereich 5xx auf API- bzw. serverseitige Probleme hin.

Fehler bzw. deren Ursachen werden im Regelfall mit den Elementen code und message im Payload (Response-Body) genauer spezifiziert. Das optionale Element data kann zudem weitere Angaben enthalten, die für die Problemlösung hilfreich sind.

Beispiel

1
2
3
4
5
6
7
8
9
10

{
    "code": "rest_invalid_param",
    "message": "Ungültige(r) Parameter: site_slug",
    "data": {
        "status": 400,
        "params": {
            "site_slug": "Ungültiger Parameter."
        }
    }
}