...
| Note |
|---|
Digitaal Vlaanderen vertaalt alleen de velden in de OpenAPI-specificaties. |
Certificates listing
This is the most important endpoint you need to provide. It needs to return a list of certificates which are relevant for the user. The user can be identified via his/her social security number (ssn) (= INSZ/NISS). The list is essentially a list of Certificate Detail items. Refer to the OpenAPI documentation of the API for more information.
Links have to be provided for the client to be able to navigate through the different pages of the certificates. For more information, refer to the HATEOAS section and the examples.
The response needs to be paginated at all times. Page metadata should be delivered in the payload, so the client knows how many certificates there are, which page it is on, etc. Please refer to the examples.
The URL has a
pageparameter, which should be 0-based. If 0 is passed, the first page should be returned.In the page metadata, nothing is 0-based, but everything is 1-based. So, for example, the
numberparameter should have the value 1 on the first page.
Model specifics
certificates (required): list of certificates. Essentially, a list of Certificate Detail items (see below).
If no certificates can be found for the provided SSN, this should be an empty list.
...
Lijst met attesten
Dit is het belangrijkste endpoint dat u moet voorzien. Het moet zorgen voor een lijst met attesten en vergunningen die bij de aangemelde gebruiker horen, en de details over die attesten en vergunningen. De gebruiker wordt geïdentificeerd op basis van zijn/haar INSZ-nummer. Zie ook de OpenAPI-specificaties voor meer informatie.
Er moeten links worden voorzien zodat de klant door de verschillende pagina’s met attesten en vergunningen kan navigeren. Zie ook HATEOAS voor meer informatie en voorbeelden.
De respons moet altijd een paginering hebben. De metadata bij de pagina’s moet deel uitmaken van de payload zodat de klant weet hoeveel attesten en vergunningen er zijn, op welke pagina’s die staan, enz. Zie ook de voorbeelden hieronder.
The URL heeft een
page-parameter, die 0-based moet zijn. Zodra 0 is gepasseerd, moet de eerste pagina worden meegegeven.In de metadata van de pagina is er echter niets 0-based, alleen 1-based. Bijv. de
number-parameter moet op de eerste pagina de waarde 1 hebben.
Model-specifieke informatie
certificates (verplicht): lijst met attesten, eigenlijk een lijst met detailinformatie over de attesten en vergunningen (zie hieronder).
Worden er geen attesten of vergunningen gevonden voor het INSZ-nummer, dan moet de lijst leeg zijn.
Request (voorbeeld)
Headers: Authorization: Bearer XyZAbCd1234
...
URL https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302?limit=10&page=0
Response (
...