Fehler

Bei allen Fehlern wird der spezifischste, passende HTTP-Antwortcode aus der folgenden Tabelle zurückgegeben:

Rückgabe-Codes

Code	Fehler	Beschreibung
400	Schlechte Anfrage	Eine fehlerhafte Anfrage wurde vom Client empfangen. Dies ist die allgemeinste Antwort, die von der API gegeben wird
401	Unbefugte	Sie sind nicht berechtigt und können nicht auf die angeforderte Ressource zugreifen
403	Verbotene	Sie haben keine Berechtigung für den Zugriff auf die angeforderte Ressource
404	Nicht gefunden	Die angeforderte Ressource kann nicht gefunden werden. Sie kann später verfügbar werden
405	Nicht erlaubte Methode	Eine nicht unterstützte HTTP-Methode wurde für die angeforderte Ressource verwendet
406	Nicht akzeptabel	Der vom Client angeforderte Typ Accept oder Accept-Encoding ist nicht verfügbar
409	Konflikt	Die Anfrage kann nicht abgeschlossen werden, weil es einen Konflikt mit der vorhandenen Ressource gibt
410	Fortgegangen	Die angeforderte Ressource ist nicht mehr verfügbar und wird es auch in Zukunft nicht sein
411	Erforderliche Länge	Die angeforderte Ressource erwartet die Angabe einer Content-Length durch den Client
413	Anfrage Entität zu groß	Der vom Client gelieferte Request Body war zu groß, die Ressource weigert sich, ihn zu verarbeiten
415	Nicht unterstützter Medientyp	Der Client hat einen falschen (oder keinen) Content-Type angegeben
422	Unverarbeitbare Entität	Die Anfrage ist nicht missgebildet und der Medientyp ist akzeptabel, aber die Ressource kann die Anfrage nicht verarbeiten
429	Zu viele Anfragen	Das Ratenlimit wurde erreicht. Weitere Informationen finden Sie im Abschnitt Ratenbegrenzung
500	Interner Serverfehler	Der Server konnte Ihre Anfrage aufgrund eines unerwarteten internen Serverfehlers nicht bearbeiten
501	Nicht implementiert	Die angeforderte Ressource wurde noch nicht implementiert
503	Dienst nicht verfügbar	Der angeforderte Dienst ist vorübergehend nicht verfügbar

Standard-Antwortformat

Alle Fehler haben einen Standardantwortkörper mit zwei Feldern, Code und Nachricht. Es können weitere Felder verwendet werden, die jedoch optional sind.

Beispiele

Dies ist die einfachste Form des Rückgabeteils eines Fehlers. Die Kunden können sich darauf verlassen, dass diese Felder in jedem Fehler vorhanden sind.

Fehlerreaktionen - Beispiel 1 (Baseline)

{
        "code": 429,
        "message": "You have exceeded your number of requests. Please try again later"
}

Das folgende Beispiel enthält neben den Standardfeldern auch Felder für Fehler im Zusammenhang mit dieser speziellen Anfrage.

Fehlerreaktionen - Beispiel 2 (komplexer)

{
        "code": 422,
        "message": "Unprocessable entity",
        "cause": "Validation failed",
        "errors": [
            {
                "resource": "Issue",
                "field": "title",
                "code": "missing_field"
            },
            ...
        ]
}