Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • certificates (verplicht): lijst met attesten, eigenlijk een lijst met detailinformatie over de attesten en vergunningen (zie hieronder).

Note

Worden er geen attesten of vergunningen gevonden voor het INSZ-nummer, dan moet de lijst leeg zijn.

Request (voorbeeld)

HeadersAuthorization: Bearer XyZAbCd1234

...

Paginering en maximumwaarden

Paginering verplicht

As stated above, we require that the response is paginated when you return a collection. In the URL's, this is shown by the presence of two parameters:

...

De response moet gepagineerd zijn voor elke collection die wordt meegegeven. De volgende 2 parameters in de URL’s moeten hiervoor aanwezig zijn: I

  • page: het paginanummers (0-based)

  • limit: defines the number of items on a single page (evidently, het aantal items op 1 pagina (1-based)

Paged returns are, evidently, only required when you return a collection. A detail of a single certificate does not require a paged returnGepagineerde resultaten zijn natuurlijk alleen nodig wanneer er een collectie als resultaat is. Voor 1 attest/vergunning + details is er een paginering nodig.

Info

Worden er geen attesten of vergunningen gevonden voor het INSZ-nummer, dan moet de lijst leeg zijn.

De API-client kan de maximumwaarde kiezen

The page and limit parameters are present in the URL: De parameters voor de paginering en de maximumwaarden maken deel uit van de URL: https://<hostname>/v1/certificates/<ssn>?limit=10&page=0. The limit parameter can be directed by the client of the API. If the client asks for 10 items, 10 should be returned. If the client wants 50 results, 50 should be returned.This can have a sensible upper limit, however. Our suggestion would be to use 100 results as the upper limit. That means that if a client asks for more than the upper limit, you default back to the upper limit you definedT

De API-client kan de parameter met de grenswaarde controleren. Als de client 10 items vraagt, dan moeten er 10 worden gegeven. Vraagt de client er 50, dan moeten er 50 worden gegeven.

Er kan natuurlijk een maximumwaarde worden bepaald. Werk met een maximumwaarde van 100 items. Vraagt de client om meer resultaten dan die in de maximumwaarde, dan wordt de default maximumwaarde getoond.

Er werden geen default-waarden gedefinieerd

...