Lijst van begrippen uit DSO ophalen, tips voor beginner

Organisaties Digitaal Stelsel Omgevingswet
#1

Met api’s heb ik nauwelijks ervaring en de documentatie is nog net iets te complex voor me. Vandaar de vraag hier.

Ik wil een deel van de catalogus opvragen van Catalogus opvragen - Ontwikkelaarsportaal

  • mijn doel is een lijst in excel (evt via een csv)
  • met in die lijst:
    • alle begrippen
    • waarbij “valt binnen:” is “wetgeving”
    • de velden die ik wil zijn
      • voorkeursterm
      • naam
      • definitie
      • valt binnen (ter controle dat dit altijd “wetgeving” is)
      • toelichtingen
      • uri
      • bronnen

Ik heb een api key, maar weet ook niet hoe ik deze moet integreren in mijn request.

Alvast dank voor alle hulp,
Michael

#2

Een vraag als dit (in de adresbalk van je browser) levert je een antwoord, mits je de API key meestuurt:

https://service.pre.omgevingswet.overheid.nl/publiek/catalogus/api/opvragen/v3/concepten?zoekTerm=Afval

De API key meesturen kan bijvoorbeeld met behulp van de Firefox extensie addHeader. Je vult dan als header in X-Api-Key en als waarde daarbij je API key. En dat voor URL pattern *.omgevingswet.overheid.nl.

Als je dit eenmaal aan de gang hebt kun je via deze link onderzoeken wat er nog meer kan: https://aandeslagmetdeomgevingswet.nl/publish/pages/155981/catalogus-opvragen-v3.json

Marco

1 like
#3

Beste Michael,

De begrippen zijn ondergebracht in de verzameling ‘concepten’.
Om alle begrippen die vallen binnen “wetgeving” op te halen moet je gebruik maken van het conceptschema “wetgeving”, met als URI:
http://wetgeving.omgevingswet.overheid.nl/id/conceptscheme/Wetgeving

De volledige request wordt dan:
https://service.pre.omgevingswet.overheid.nl/publiek/catalogus/api/opvragen/v3/concepten?conceptschema=http://wetgeving.omgevingswet.overheid.nl/id/conceptscheme/Wetgeving

Het resultaat is een JSON bestand met de Concepten die voldoen aan in dit geval Wetgeving. Hierbij wil ik wel opmerken dat het resultaat is gepagineerd en dat maximale resultaat niet meer dan 100 concepten per pagina (page) zal zijn (maximum pageSize=100).

De X-API-KEY moet in de header geplaatst worden van het request of bv. via de extensie ModHeader als de aanroep via Google Chrome wordt gedaan.

vriendelijke groet (namens)

Patrick

#4

Bedankt voor de antwoorden. Ik ben een heel stuk wijzer :slight_smile:

Jammer dat er een max van 100 zit aan de begrippen, daardoor moet ik nog wat gaan knutselen om toch alles in 1 excelbestand te krijgen.

Is het mogelijk om in het resultaat slechts bepaalde velden meegestuurd te krijgen? Bijvoorbeeld definitie en naam?

Michael