Page Comparison

...

"pageMetadata": {
    "number": 1,
    "size": 10,
    "totalElements": 40,
    "totalPages": 4
}

We expect the object to contain De volgende 4 parameters :

...

zijn verplicht (allemaal 1-based

...

)

• number  het paginanummer

• size  (required) the number of the page in the total number of pages. This is a 1-based parameter.

• totalElements (required) the total number of elements in the collection. This is a 1-based parameter.

• totalPages (required) the total number of pages in the collection. This is a 1-based parameter.

No certificates found

When no certificates can be found for a certain SSN, we expect an empty collection as a return, not an error 404 (for more details, refer to Error Messages).

...

• het paginanummer in het totaal aantal pagina’s

• totalElements het totale aantal items in de collectie

• totalPages  het totale aantal pagina’s in de collectie

Er werden geen attesten of vergunningen gevonden

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. <voeg link toe naar foutberichten in de API specs>

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.

...

• id (required): the ID of the certificate.

• language (required): the language of the certificate. Should be in ISO639-1 format. More information: https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes . Expected 1 of these 4: nl, fr, de, en.

• name (required): name of the certificate

• year (optional): year when the certificate was handed out (if applicable)

• community (optional): community where the certificate handed out (if applicable). Should be a NIS code. More information https://statbel.fgov.be/nl/over-statbel/methodologie/classificaties/geografie

Request (example)

Headers: Authorization: Bearer XyZAbCd1234

Method: GET

URL URL https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/85144567-7043-4469-9e79-279f4eb31e27/nl

Response (example)

HATEOAS