Hoe werkt de foutafhandeling?
De webservice is gebouwd op het verwerken van gegevens. Hierbij kunnen fouten optreden. Communicatie over deze fouten gebeurt op een gestructureerde manier, via zogenaamde response codes.
Voor de foutafhandeling worden met name algemeen gebruikte response codes gebruikt. In deze paragraaf worden enkele generieke weergegeven. In de detail documentatie worden specifieke response codes vermeld.
Een response code kan zowel positief als negatief zijn, hier is technisch geen verschil.
| Response code | Response text | Uitleg |
|---|---|---|
| 200 OK | OK | |
| 401 Unauthorized | Unauthorized: You need to be logged in to use this method. Unauthorized: Expired token |
Authenticatie is mislukt om welke reden dan ook. Specifiek: indien JWT verlopen is. |
| 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 |
Authorisatie is mislukt. Meestal is de reden dat een recht ontbreekt. Het eerste recht welke ontbreekt wordt in de foutmelding meegegeven. De "address" melding geeft aan dat een firewall in werking is getreden. |
| 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. |
In het geval van een foutcode: meestal zal een meer informatieve beschrijving worden toegevoegd. Wanneer bijvoorbeeld een invoerparameter ontbreekt, zal het systeem reageren met de naam van de parameter. Let erop dat alleen de eerste ontbrekende parameter de foutcode zal triggeren. Het is mogelijk dat meerdere verplichte parameters ontbreken. In dat geval zal alleen de eerste worden getoond.
