‹ Overzicht
Freave Services API

Aan de slag met de Freave API

› Foutafhandeling

Authenticatie



Foutafhandeling

Gepubliceerd op 13-10-2018

Als er zich een fout voordoet zal de API met de passende HTTP-code antwoorden. Daarnaast zal de API bij 4xx fouten een foutobject meesturen om meer informatie te geven over wat er precies is misgegaan. Onderstaand een voorbeeld:

{
	"error": [
		{
			"http_code": 422,
			"error_description": "This is an example error.",
			"error_description_translated": "Dit is een voorbeeldfout."
		}
	]
}

Een foutobject bevat de volgende parameters:

  • error_code - De HTTP-code die bij de fout hoort.
  • error_description - Een beschrijving - in het Engels - over de fout.
  • error_description_translated - Een beschrijving over de fout in de taal van de client 1.

HTTP foutcodes

Naast de foutobjecten die u ontvangt bij 4xx fouten ontvangt u ook de volgende HTTP-codes.

  • 200 OK - Het verzoek was succesvol
  • 400 Bad request - Meestal een parameter die mist of ongeldig is.
  • 401 Unauthorized - Bijvoorbeeld als de access token mist.
  • 403 Forbidden - Client heeft geen toestemming tot de resource.
  • 404 Not found - De opgevraagde resource bestaat niet.
  • 405 Method not allowed - De gebruikte methode is niet toegestaan. (Bijvoorbeeld POST i.p.v GET)
  • 422 Unprocessable Entity - Een ongeldige aanvraag. Bijvoorbeeld als parameters missen of onjuist zijn.
  • 429 Too many requests - Er zijn te veel HTTP verzoeken gedaan. Zie ratelimiting.
  • 500 Internal server error - Er ging iets mis in de applicatie. 
  • 503 Service unavailable - Onderhoud of een storing.

  1. Momenteel is dit altijd Nederlands. ↩︎