Wie funktioniert die Fehlerbehandlung?
Der Webservice ist auf die Verarbeitung von Daten ausgelegt. Dabei können Fehler auftreten. Die Kommunikation über diese Fehler erfolgt auf strukturierte Weise, über sogenannte Response-Codes.
Für die Fehlerbehandlung werden insbesondere allgemein gebräuchliche Response-Codes verwendet. In diesem Abschnitt werden einige generische dargestellt. In der Detaildokumentation werden spezifische Response-Codes aufgeführt.
Ein Response-Code kann sowohl positiv als auch negativ sein, hier gibt es technisch keinen Unterschied.
| Response code | Response text | Erläuterung |
|---|---|---|
| 200 OK | OK | |
| 401 Unauthorized | Unauthorized: You need to be logged in to use this method. Unauthorized: Expired token |
Die Authentifizierung ist aus welchem Grund auch immer fehlgeschlagen. Speziell: wenn das JWT abgelaufen ist. |
| 403 Forbidden | Forbidden: User does not have rights to perform action. Forbidden: Insufficient rights [<<RIGHT>>]. Forbidden: You are not allowed to use this method from your address |
Die Autorisierung ist fehlgeschlagen. Meistens ist der Grund, dass ein Recht fehlt. Das erste fehlende Recht wird in der Fehlermeldung übergeben. Die „address“-Meldung gibt an, dass eine Firewall in Kraft getreten ist. |
| 404 Not found | Not Found: The requested resource cannot be found. | |
| 412 Precondition failed | Precondition Failed: One of the required input parameters is missing. | |
| 500 Internal server error | Internal Server Error: Something really went bad. |
Im Falle eines Fehlercodes: Meistens wird eine informativere Beschreibung hinzugefügt. Wenn beispielsweise ein Eingabeparameter fehlt, reagiert das System mit dem Namen des Parameters. Beachten Sie, dass nur der erste fehlende Parameter den Fehlercode auslöst. Es ist möglich, dass mehrere Pflichtparameter fehlen. In diesem Fall wird nur der erste angezeigt.
