Übersicht über Formate bei Fehlern

Freigegeben: JSON-Repräsentation

In diesem Kapitel erfahren Sie mehr zu den Grundlagen der Fehlerbehandlung und zum Format, in dem Fehler zurückgegeben werden.

Abhängig vom Verarbeitungsergebnis einer HTTP-Anforderung wird die Anforderung mit verschiedenen HTTP-Statuscodes beantwortet. Optional werden beschreibende Informationen als JSON zurückgeliefert.

Beispiel für eine Antwort für eine fehlgeschlagene Anforderung (Request):

Response

HTTP/1.1 400 BadRequest
  
{
    "reason": "10019: Missing value for a mandatory property.",
    "severity": 1,
}

Beschreibung der Parameter zu der Antwort auf die fehlerhafte Anforderung:

Eigenschaft

Beschreibung

reason

Ein optionaler kurzer Beschreibungstext, weshalb der Fehler aufgetreten ist. Dieser Text wird als Titel der Fehlermeldung verwendet.

hint

Ein optionaler Hinweistext für den Anwender mit Tipps für die Fehlerbehebung.

details

Optionale Detailinformationen zum Fehler.

severity

Optionaler Schweregrad des Fehlers. Folgende Werte sind möglich:

Success = 0,
Information = 1,
Warning = 2,
Error = 3