Catalogus opvragen

De Stelselcatalogus voor de Omgevingswet verbindt definities, toelichtingen en uitleg van begrippen, regels, informatiemodellen, producten en services met elkaar.

Label: Catalogus

Endpoint V3

https://service.pre.omgevingswet.overheid.nl/publiek/catalogus/api/opvragen/v3

Endpoint V2 (vervalt 1-1-2022)

https://service.pre.omgevingswet.overheid.nl/publiek/catalogus/api/
opvragen/v2

Omschrijving

Met deze API kunnen begrippen worden opgevraagd. Van ieder begrip geeft de API (voor zover relevant) de formele definitie, uitleg in klare taal, bron en gerelateerde begrippen (semantische relatie, generalisatie, specialisatie, onderdeel van, bestaat uit).

Om te kunnen tijdreizen wordt metadata meegegeven:

  • de datum waarop het begrip is gepubliceerd
  • de datum waarop het begrip uit de lijst met actuele begrippen is gehaald
  • de datum waarop het begrip (juridisch) geldig is geworden
  • de datum waarop de (juridische) geldigheid vervalt.

Begrippen zijn geordend per domein. Dit domein wordt beschreven als een dataset. Binnen een domein kunnen begrippen worden geordend in collecties.

De datasets worden federatief beheerd door de verschillende bronhouders. Bij iedere dataset wordt aangegeven wie de bronhouder is en daarmee verantwoordelijk is voor de inhoud.

Nieuw in V3

Vooral de Developer Experience van deze API is met V3 verbeterd, dat wil zeggen dat de endpoints duidelijker zijn geworden en ook de manier waarop resultaten gefilterd kunnen worden, is verbeterd.

De API beschikt nu over de volgende endpoints:

  • ConceptSchema’s opvragen (/conceptschemas)
  • Collecties opvragen (/collecties)
  • Concepten opvragen (/concepten)
  • Bronnen opvragen (/bronnen)
  • Waardelijsten opvragen (/waardelijsten)
  • Informatieproducten opvragen (/informatieproducten)
  • Applicatie-eigenschappen opvragen (/info)
  • Health status opvragen (/health)

Elke endpoint heeft een aantal generieke en specifieke parameters, waardoor het gebruik eenduidiger is geworden.

Documentatie


Status

Versie 3 is beschikbaar in de pre-productieomgeving.

Versie 2 is beschikbaar in de pre-productieomgeving (vervalt per 1-1-2022).

Meer informatie

Deze service in van belang in het proces catalogus opvragen.

API-key

Om API's te gebruiken dient bij elke request een API-key meegegeven te worden. Alle API's werken met dezelfde key.

Feedback

Geef feedback op deze service. Ga naar het forum om je bevindingen met ons te delen.