X-Correlation-Id

header

Maakt deel uit van de header. Zie ook: Werking en overzicht uitzonderingen MAGDA RESTful services.
Dit is het transactie ID, gebruikt voor logging en foutafhandeling.

X

q

query

De zoekterm q wordt gebruikt door volledige termen of wildcards.

Bijvoorbeeld

• q=locaties.postcode:1000 opzoeking op een genest veld, beschrijf je het pad naar het veld.

• q=gemeente:Brussel opzoeking op het veld gemeente

• q=korteNaam:DV* opzoeking met wildcard (hier in het veld ‘korteNaam’)

• q=Brussel opzoeking in alle velden naar de term ‘Brussel’

Voor meer voorbeelden, zie https://vlaamseoverheid.atlassian.net/wiki/spaces/MG/pages/6564610476

sort

query

De velden om op te sorteren (binnenkort beschikbaar)

offset

query

Een parameter die wordt gebruikt bij het pagineren van resultaten. Het aantal items dat overgeslagen zal worden.

Bijvoorbeeld

• offset=10 geeft aan dat je de eerste 10 resultaten wilt overslaan.

limit

query

Het aantal items dat (maximaal) zal worden opgehaald

Bijvoorbeeld

• limit=20 geeft aan dat je maximaal 20 resultaten op de huidige pagina wilt weergeven.