Versions Compared

Key

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

Detail

Info

Let op!

Bij het gebruik van speciale characters (vb. é, ç, #, %, $, /, …) of spaties voor één van de de query parameters dien je wel URL-encoding toe te passen. Zie ook https://www.w3schools.com/tags/ref_urlencode.ASP

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.

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

sort

query

De velden om op te sorteren

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.

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.

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

Op deze pagina

Table of Contents
maxLevel2

Info

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