Response codes

De API gebruikt HTTP response codes om aan te geven wat de status van een request is.
Over het algemeen geldt: de response van een succesvolle request valt in de 2xx range, een mislukte request in de 4xx range en een eventuele serverfout in de 5xx range.

In sommige gevallen kan het bij 4xx response codes zo zijn dat er aanvullende informatie in de body staat met oorzaak van de error.

HTTP Status codeOmschrijving
200 - OKDe request is succesvol, response bevat headers en
body.
204 - No contentDe request is succesvol, response bevat alleen
headers.
400 - Bad requestDe request is mislukt, header of body bevat ongeldige
data.
401 - UnauthorizedDe request is mislukt, header bevat geen (geldige) API
key.

Deze error wordt getoond wanneer er geen (geldige) API key wordt gebruikt voor een call waar autorisatie wel vereist is. Bent u er zeker van dat de API key juist en geldig is? Neem in dat geval contact op met SBCL via [email protected].
403 - ForbiddenDe request is mislukt, actie niet toegestaan met API
key.
404 - Not foundDe request is mislukt, object bestaat niet.
409 - Conflict / Duplicate Installation foundDe request is mislukt, object bestaat al.
Deze error wordt getoond wanneer er meerdere installaties zijn gevonden op basis van de meegestuurde data.

In het geval dat deze error wordt getoond bij het aanmaken van een installatie bevat de error de Installation ID van de installatie die al bestaat op basis van opgegeven Installation ID en Manufacturer ID.

In het geval dat deze error wordt getoond bij het zoeken naar een installatie wordt er een e-mail verstuurd naar de beheerder (SBCL) zodat deze eventueel actie kan ondernemen.
422 – Unprocessable
entity
De request is mislukt, header of body bevat niet alle
verplichte data.
429 - Too many
requests
De request is mislukt, limiet van API key overschreden.

Deze error wordt getoond wanneer het ingestelde requestslimiet van de API key is overschreden.

In dat geval wordt er een e-mail verstuurd naar het e-mailadres, dat gekoppeld is aan de account. Daarin staat meer informatie over de door SBCL ingestelde limiet.
5xx - Server error(s)De request is mislukt, er is een probleem op de API
server.