Versions Compared

Key

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

...

Note

De beheer API is beschikbaar via MAGDA. Gebruik onderstaande linken voor de MAGDA documentatie en voor het interesseformulier om aan te sluiten op het Verenigingsloket (met als bouwsteen het Verenigingsregister):

Mogelijkheden:

  • Registreren van een nieuwe vereniging

  • Wijzigen van de gegevens van een vereniging

  • Zoeken naar een vereniging op basis van naam, postcode, gemeente

  • Alle gegevens van een vereniging opvragen

  • Historiek opvragen van een vereniging

...

De publieke API bevat een ZOEK functionaliteit. Deze zoek functionaliteit is een elastic search implementatie. De zoekcriteria kan je dus samenstellen zoals je bij elastic search zou doen. (zie algemene syntax) Hierbij enkele voorbeelden:

Query

Wat is het resultaat?

q=*

Alle verenigingen in het verenigingsregister

q=vereniging

Alle verenigingen die ergens de tekst vereniging in een zoekveld hebben staan. Dat kan in de naam zijn, maar evengoed in een ander veld dat beschikbaar is in de zoek resultaten

q=naam:vereniging

Alle verenigingen die het woord vereniging in hun naam hebben. Het moet wel degelijk het volledige woord zijn dat er in zit: “Vereniging van zoekers” zal teruggevonden worden, maar “Zoekvereniging” niet.

q=naam:*bal*

Alle verenigingen die ergens in hun naam het woord bal hebben. In dit geval kan het ook in het midden van het woord zitten. Zo zal ook de vereniging met naam “voetbalclub de sjotters” in de resultaten aanwezig zijn

q=doelgroep.minimumleeftijd:<=16

alle verenigingen die een waarde hebben in het veld doelgroep.leeftijd die kleiner of gelijk is aan 16.

q=naam:vereniging AND locaties.postcode:9000

Je kan 2 criteria combineren met AND, OR en ook met haakjes ()

q=locaties.postcode:(1234 OR 5678)

Je kan filteren op verschillende mogelijke waarden door deze tussen haakjes te plaatsen en te scheiden door OR

Codelijsten

Om deze functionaliteit te gebruiken, heb je geen API Key nodig.

...