Error Handling

Fehlerstruktur

Das standardisierte Schema der LIVOI-API wurde für eine klare, konsistente und effiziente Fehlerbehandlung in Integrationen entwickelt. Es ermöglicht eine präzise Fehlererkennung, eine gezielte Weiterverarbeitung und eine stabile Automatisierung von Fehlerfällen. Das Ergebnis sind geringere Wartungskosten, eine schnellere Fehlersuche und eine höhere Zuverlässigkeit in der Systemkommunikation.

Die Fehlerrückgabe umfasst:

status_code - numerischer HTTP-Statuscode der Antwort
status_message - textuelle Beschreibung des Statuscodes
errors - Liste mit detaillierten Informationen zu Ursache und Typ des Fehlers

json

{
  "status_code": 403,
  "status_message": "Forbidden",
  "errors": [
    {
      "info": "Access denied. You do not have permission to perform this action.",
      "type": "Exception",
      "cause": {
        "details": "Access denied. You do not have permission to perform this action."
      }
    }
  ]
}

Alle API-Fehler folgen einem standardisierten JSON-Format für konsistente Fehlerbehandlung:

HTTP-Statuscodes

Code	Status	Beschreibung
200	OK	Standardantwort für erfolgreiche HTTP-Anfragen. Die Ressource wurde erfolgreich abgerufen oder verarbeitet.
201	Created	Die Anfrage war erfolgreich und eine neue Ressource wurde erstellt. Wird typischerweise bei POST-Anfragen verwendet.
204	No Content	Die Anfrage war erfolgreich, aber es gibt keinen Inhalt zurückzugeben. Häufig bei DELETE-Operationen.

Code	Status	Beschreibung
400	Bad Request	Die Anfrage war fehlerhaft oder unvollständig. Überprüfen Sie die übermittelten Parameter oder das JSON-Format.
401	Unauthorized	Authentifizierung ist erforderlich und fehlgeschlagen oder wurde nicht bereitgestellt. Überprüfen Sie Ihre Zugangsdaten.
403	Forbidden	Der Zugriff auf die angeforderte Ressource wurde verweigert. Fehlende Berechtigungen oder verbotene Aktion.
404	Not Found	Die angeforderte Ressource konnte nicht gefunden werden. Überprüfen Sie die URL oder ID.
409	Conflict	Die Anfrage steht im Konflikt mit dem aktuellen Zustand der Ressource. Beispielsweise existiert ein Eintrag bereits.
422	Unprocessable Entity	Die Anfrage konnte syntaktisch verarbeitet werden, enthält jedoch semantische Fehler. Validierung fehlgeschlagen.
429	Too Many Requests	Der Client hat zu viele Anfragen in kurzer Zeit gesendet. Rate Limit wurde erreicht.

Code	Status	Beschreibung
500	Internal Server Error	Ein unerwarteter Fehler ist auf dem Server aufgetreten. Der Vorgang konnte nicht abgeschlossen werden.
503	Service Unavailable	Der Server ist vorübergehend nicht verfügbar, z. B. aufgrund von Wartung oder Überlastung. Versuchen Sie es später erneut.

Error Handling

Fehlerstruktur

HTTP-Statuscodes

Auf dieser Seite