DIGITAAL VLAANDEREN

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 10 Next »

Detail

Element

Type

Opmerkingen

Verplicht

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.

Ja

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 Veel gestelde vragen verenigingsregister

Nee

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.

Nee

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.

Nee

Validaties op vraag

Er zijn geen functionele validaties op de vraag

Voorbeeld

Onderstaand voorbeeld zoeken we verenigingen op waarbij het maximumleeftijd van de doelgroep op 100 staat. In het resultaat willen we maximum 5 verenigingen.

GET organisaties/verenigingen/verenigingen/zoeken?q=doelgroep.maximumleeftijd:100&limit=5
header X-Correlation-Id : "761c1f36-bd5f-4f7c-b32f-16045cccc9ee"

Op deze pagina


Met vragen kunt u steeds terecht bij de MAGDA Service Desk.

  • No labels