Versions Compared

Key

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

...

  • Indexnaam, met momenteel keuze uit 3 endpoints waarbinnen je kan zoeken:

    1. organisations (organisaties)

    2. people (personen, bv. hun functies of hoedanigheden)

    3. bodies (organen)

  • Zoekterm: Elasticsearch QueryString zoekterm 

  • [Optioneel] Filter: veldnamen die in respons zullen zitten 

  • [Optioneel] Offset: startpunt van zoekresultaten (voor paging bijvoorbeeld) 

  • [Optioneel] Limit: aantal resultaten, default 100 (ook voor paging) 

...

  • Maak een request zoals je normaal doet, maar maak geen gebruik van ‘offset’ of ‘limit’. Gebruik in plaats daarvan ‘scroll=true’

  • Dit geeft 500 100 resultaten die je gewoon kan verwerken. In aanvulling krijg je hierdoor ook een http-header x-search-metadata die een Scroll-Id bevat, samen met nog wat andere info. (deze header is een json-string). 

  • Na deze request heb je 30 seconden de tijd om een call te doen naar https://api.wegwijs.vlaanderen.be/v1/search/people/scroll?id=SCROLLID

  • Deze zal je de volgende pagina geven (opnieuw 500 100 items), samen met de x-search-metadata header en een nieuwe scrollId. 

  • Herhaal dit proces tot je geen nieuwe items meer krijgt. 

...

Als je om één of andere reden niet in de mogelijkheid bent 500 100 items te verwerken in 30 seconden, is het best zelf logica te voorzien om de data op te slaan en nadien te verwerken. 

...