Paginering, sorteren en rate limiting

Titel	Paginering, sorteren en rate limiting
Status	IN ONTWIKKELING ROSA-ARCHITECTUURSCAN BESLUITVORMING IN BEHEER
Versie	1.1.0
Datum	27 September 2024
Auteur	Architectenraad Edu-V
Acties	Geen openstaande acties

COULD In het Afsprakenstelsel Edu-V wordt paginering, sorteren en rate limiting niet voorgeschreven. Leveranciers kunnen deze technieken toepassen om de performance van hun koppelvlakken te verhogen, indien het toegepast wordt dan wel op de volgende manier.

Paginering Specificatie

Query Parameters

start

Type: integer
Locatie: query parameter
Beschrijving: Startpunt voor paginering van resultaten
Default waarde: 0
Voorbeeld:
- start=0 - Het startpunt voor paginering (default)

limit

Type: integer
Locatie: query parameter
Beschrijving: Limiet van het aantal resultaten per pagina
Default waarde: 20
Maximum waarde: 100
Voorbeelden:
- limit=20 - De standaard waarde indien niet opgegeven
- limit=100 - De grootst aanbevolen paginagrootte

Gebruik

GET /api/resource?start=0&limit=20

Release notes

1.0.0: Paginering, sorteren en rate limiting als separate pagina opgenomen. Alle endpoints met betrekking tot paginering zijn verwijderd uit de technische API specificaties.
1.1.0 Naar aanleiding van RFC0046 dat als paginering wordt ingesteld we wel een standaard paginering afspreken binnen het Edu-V afsprakenstelsel.