...
Er moeten links worden voorzien zodat de client door de verschillende pagina’s met attesten en vergunningen kan navigeren. Zie ook HATEOAS voor meer informatie en voorbeelden.
De response respons moet altijd een paginering hebben. De metadata bij de pagina’s moet deel uitmaken van de payload zodat de client weet hoeveel attesten en vergunningen er zijn, op welke pagina’s die staan, enz. Zie ook de codevoorbeelden hieronder.
...
Header:
Authorization: Bearer XyZAbCd1234Method: GET
URL:
https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302?limit=10&page=0
...
respons (voorbeeld)
| Code Block |
|---|
{
"certificates": [
{
"id": "85144567-7043-4469-9e79-279f4eb31e27",
"language" : "nl",
"name": "Dienstencheques 2019",
"year": 2019,
"links": [
{
"rel": "self",
"href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/85144567-7043-4469-9e79-279f4eb31e27/nl"
},
{
"rel": "download",
"href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/85144567-7043-4469-9e79-279f4eb31e27/nl/download"
}
]
}
],
"pageMetadata": {
"number": 1,
"size": 10,
"totalElements": 40,
"totalPages": 4
},
"links": [
{
"rel": "self",
"href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302?limit=10&page=0"
},
{
"rel": "next",
"href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302?limit=10&page=1"
},
{
"rel": "start",
"href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302?limit=10&page=0"
},
{
"rel": "last",
"href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302?limit=10&page=3"
}
]
} |
Paginering en maximumwaarden
Paginering verplicht
De response respons moet gepagineerd zijn voor elke collection die wordt meegegeven. De volgende 2 parameters in de URL’s moeten hiervoor aanwezig zijn:
...
Metadata voor paginering zijn verplicht in het pageMetadata-object van de responserespons:
| Code Block |
|---|
"pageMetadata": {
"number": 1,
"size": 10,
"totalElements": 40,
"totalPages": 4
} |
...
| Note |
|---|
Er kunnen extra velden worden toegevoegd in de responserespons, maar ze zullen niet meegenomen worden. |
...
Header:
Authorization: Bearer XyZAbCd1234Method: GET
URL:
https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/85144567-7043-4469-9e79-279f4eb31e27/nl
...
respons (voorbeeld)
| Code Block |
|---|
{
"id": "85144567-7043-4469-9e79-279f4eb31e27",
"language" : "nl",
"name": "certificate-1234",
"links": [
{
"rel": "self",
"href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/85144567-7043-4469-9e79-279f4eb31e27/nl"
},
{
"rel": "download",
"href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/85144567-7043-4469-9e79-279f4eb31e27/nl/download"
}
]
} |
...