Fehler

Alle Fehler geben den spezifischsten, passenden HTTP-Antwortcode aus der folgenden Tabelle zurück:

Rückgabecodes

Code	Fehler	Beschreibung
400	Fehlerhafte Anfrage	Vom Client wurde eine fehlerhaft formatierte Anfrage empfangen. Dies ist die allgemeinste Antwort, die von der API zurückgegeben wird
401	Nicht autorisiert	Sie sind nicht autorisiert und können nicht auf die angeforderte Ressource zugreifen
403	Zugriff verweigert	Sie haben keine Berechtigung, auf die angeforderte Ressource zuzugreifen
404	Nicht gefunden	Die angeforderte Ressource kann nicht gefunden werden. Sie könnte später verfügbar sein
405	Methode nicht erlaubt	Für die angeforderte Ressource wurde eine nicht unterstützte HTTP-Methode 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, da ein Konflikt mit der vorhandenen Ressource besteht
410	Nicht mehr verfügbar	Die angeforderte Ressource ist nicht mehr verfügbar und wird es auch in Zukunft nie wieder sein
411	Länge erforderlich	Die angeforderte Ressource erwartet, dass der Client eine Content-Length angibt
413	Anfragekörper zu groß	Der vom Client bereitgestellte Anfragekörper war zu groß, die Ressource verweigert die Verarbeitung
415	Nicht unterstützter Medientyp	Vom Client wurde ein falscher (oder kein) Content-Type angegeben
422	Nicht verarbeitbare Entität	Die Anfrage ist nicht fehlerhaft 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 zur Ratenbegrenzung
500	Interner Serverfehler	Der Server konnte Ihre Anfrage aufgrund eines unerwarteten internen Serverfehlers nicht verarbeiten
501	Nicht implementiert	Die angeforderte Ressource wurde nicht implementiert
503	Dienst nicht verfügbar	Der angeforderte Dienst ist vorübergehend nicht verfügbar

Standard-Antwortformat

Alle Fehler verfügen über einen standardisierten Antwortkörper mit zwei Feldern, code und Nachricht. Weitere Felder können verwendet werden, sind jedoch optional.

Beispiele

Dies ist die einfachste Form des Rückgabekörpers eines Fehlers; Clients können sich darauf verlassen, dass diese Felder in jedem Fehler vorhanden sind.

Fehlerantworten - Beispiel 1 (Basis)

{
  "code": 429,
  "message": "Sie haben die zulässige Anzahl von Anfragen überschritten. Bitte versuchen Sie es später erneut"
}

Das folgende Beispiel enthält zusätzlich zu den Standardfeldern Fehler im Zusammenhang mit dieser spezifischen Anfrage.

Fehlerantworten - Beispiel 2 (Komplexer)

{
  "code": 422,
  "message": "Nicht verarbeitbare Entität",
  "cause": "Validierung fehlgeschlagen",
  "errors": [
    {
      "resource": "Issue",
      "field": "title",
      "code": "missing_field"
    },
    ...
  ]
}