| Table of Contents | ||||
|---|---|---|---|---|
|
...
Wanneer er voor een bepaald INSZ-nummer geen attesten of vergunningen worden gevonden, verwachten we een lege collectie als antwoord, geen error 404.
Zie ook de Foutberichten.
...
Detail attest/vergunning
Dit is de link waarachter meer details over een attest/vergunning beschikbaar zijn. Deze link zorgt ervoor dat de klant bepaalde functionaliteiten kan vinden, zoals bijv. het attest/de vergunning downloaden.
Zie ook HATEOS
...
Behind this link, more information about a certain certificate can be found.
Links have to be provided for the client to be able to discover specific functionalities, for example: downloading the certificate. For more information, refer to the HATEOAS section and the examples.
...
.
Er kunnen extra velden worden toegevoegd in de response, maar ze zullen niet meegenomen worden.
Primary key
Important to note here are the parameters that define a certificate. The primary key of a certificate is its ID + its language. That means that both have to be in the URL. It depends on your own design whether these are path parameters or query parameters.
Our examples define them as path parameters. The choice is yours, however. Since we expect a HATEOAS design, we will simply discover the URL via your API.
Model specifics
...
id (required): the ID of the certificate.
...
Dit zijn de parameters die het attest/de vergunning definiëren. Voor een attest is de primary key: ID + taal. Beide moeten dus in de URL staan. Afhankelijk van de opzet zijn dit path parameters of query parameters.
In de voorbeelden zijn het path parameters. Omdat we een HATEOAS design verwachten, vinden we de URL via uw API.
Model-specifieke informatie
id (verplicht): het ID van het attest/de vergunning
taal (verplicht): de taal van het attest/de vergunning, verplicht in ISO639-1 formaat:
nl,fr,de,en. Zie ook: https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes . Expected 1 of these 4:nl,fr,de,en.name naam (requiredverplicht): name of the certificateyear (optional): year when the certificate was handed out (if applicablede naam van het attest/de vergunning
jaar (optioneel): het jaar dat het attest/de vergunning werd uitgegeven (indien van toepassing)
community (optional): community where the certificate handed out (if applicable). Should be a NIS code. More information optioneel): de gemeente waar het attest/de vergunning werd uitgegeven (indien van toepassing). Dit moet een NIS-code zijn. Zie ook: https://statbel.fgov.be/nl/over-statbel/methodologie/classificaties/geografie
Request (example)
Headers:
Authorization: Bearer XyZAbCd1234Method: GET
URL
https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/85144567-7043-4469-9e79-279f4eb31e27/nl
Response (example)
HATEOAS
...