Basisprincipes: http response codes

De AuditCase REST API volgt zoveel mogelijk de standaard principes voor wat betreft het gebruik van http response codes in een REST API. Voor meer informatie zie:http://www.restapitutorial.com/lessons/httpmethods.html

 

OK meldingen

In de meeste methods zal er http code 200 (OK) terug worden gezonden als de actie is gelukt. Voor POST method zal http code 201 (CREATED) worden geretourneerd als het is gelukt.

 

Foutmeldingen

Als de request niet correct verwerkt kan worden dan geeft de server een http code 500 (INTERNAL SERVER ERROR) terug. In de toekomst zal de API worden uitgebreid zodat status 400 (BAD REQUEST) terugkomt in deze gevallen. In de response of in http response header “Error” kan worden uitgelezen wat de foutmelding precies is.

 

Server foutmeldingen

Er komt een http status 500 terug met daarin in json formaat wat er mis is gegaan. In de ‘message’ property kan worden uitgelezen wat de foutmelding is. Overigens kan dit ook in de response header “Error” worden uitgelezen.

 

Voorbeeld response:

{

  • "status"500,
  • "message""Unknown action: action for this method.",
  • "name"null,
  • "responseText""nl.c2c.exceptions.CustomException...."

}

Hebt u meer vragen? Een aanvraag indienen
Mogelijk gemaakt door Zendesk