Ga naar hoofdinhoud

Open Source Register

Catalogus opvragen - API specificatie

Dienst voor het kadaster en de openbare registers

Originele specificatie (JSON)

API documentatie

Catalogus API (3.2.2)

Download OpenAPI specification:Download

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

Omschrijving

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

Om te kunnen tijdreizen wordt metadata meegegeven:

  • de datum waarop het concepte (juridisch) geldig is geworden
  • de datum waarop de (juridische) geldigheid vervalt.

Concepten zijn geordend per domein. Dit domein wordt beschreven als een conceptschema. Binnen een conceptschema kunnen concepten worden geordend in collecties. De conceptschema worden federatief beheerd door de verschillende bronhouders. Bij ieder conceptschema wordt aangegeven wie de bronhouder is en daarmee verantwoordelijk is voor de inhoud.

Documentatie

Beschrijving van de informatie over concepten, geldigheid/provenance, collecties en datasets (op basis van Best Practices for meaningful connected computing).

API-key

Om API's te gebruiken dient bij elke request een API key meegegeven te worden (via een x-api-key header). Bij verkeerd gebruik of misbruik van de API kunnen we in contact treden en in het uiterste geval de API key intrekken.

Begrippenkaders opvragen

Endpoint voor het opvragen van alle begrippenkaders

Authorizations:
Apikey
query Parameters
uri
string
Example: uri=http://stelselcatalogus.omgevingswet.overheid.nl/id/conceptscheme/Stelselcatalogus

uri van het op te vragen conceptschema

gepubliceerdDoor
string
Example: gepubliceerdDoor=https://standaarden.overheid.nl/owms/terms/Geonovum

owms uri van de eigenaar de op te vragen resources

geldigOp
string <YYYY-MM-dd>
Example: geldigOp=2020-08-23

Filter op het moment waarop de resource geldig is binnen de Stelselcatalogus op basis van de prov:Entity

inclusiefBeeindigdeVersies
boolean
Default: false
Example: inclusiefBeeindigdeVersies=true

Parameter om ook resources die beeindigd zijn te kunnen ophalen. Default worden beeindigde resources niet terug gegeven.

zoekTerm
string
Example: zoekTerm=Afval

zoekterm voor het zoeken op naam van een concept, waardelijst etc.

page
integer
Default: 1

Paginanummer voor paginering. Deze is gelimiteerd zodat het totaal aantal op te vragen resultaten niet hoger is dan 10000. Gebruik het _links.next.href object om te navigeren.

pageSize
integer
Default: 10
Enum: 10 20 40 100

Aantal resultaten per pagina

Responses

Response samples

Content type
application/hal+json
{}

Conceptschema's opvragen

Endpoint voor het opvragen van alle conceptschema's

Authorizations:
Apikey
query Parameters
uri
string
Example: uri=http://stelselcatalogus.omgevingswet.overheid.nl/id/conceptscheme/Stelselcatalogus

uri van het op te vragen conceptschema

gepubliceerdDoor
string
Example: gepubliceerdDoor=https://standaarden.overheid.nl/owms/terms/Geonovum

owms uri van de eigenaar de op te vragen resources

geldigOp
string <YYYY-MM-dd>
Example: geldigOp=2020-08-23

Filter op het moment waarop de resource geldig is binnen de Stelselcatalogus op basis van de prov:Entity

inclusiefBeeindigdeVersies
boolean
Default: false
Example: inclusiefBeeindigdeVersies=true

Parameter om ook resources die beeindigd zijn te kunnen ophalen. Default worden beeindigde resources niet terug gegeven.

zoekTerm
string
Example: zoekTerm=Afval

zoekterm voor het zoeken op naam van een concept, waardelijst etc.

page
integer
Default: 1

Paginanummer voor paginering. Deze is gelimiteerd zodat het totaal aantal op te vragen resultaten niet hoger is dan 10000. Gebruik het _links.next.href object om te navigeren.

pageSize
integer
Default: 10
Enum: 10 20 40 100

Aantal resultaten per pagina

_expandScope
Array of strings
Items Enum: "concepten" "collecties"

Query parameter voor het aangeven welke gegevens voor het conceptschema dienen te worden embed

Responses

Response samples

Content type
application/hal+json
{}

Collecties opvragen

Endpoint voor het opvragen van collecties

Authorizations:
Apikey
query Parameters
uri
string
Example: uri=http://stelselcatalogus.omgevingswet.overheid.nl/stelselcatalogus/id/collection/Collectie

uri van de op te vragen collectie

gepubliceerdDoor
string
Example: gepubliceerdDoor=https://standaarden.overheid.nl/owms/terms/Geonovum

owms uri van de eigenaar de op te vragen resources

geldigOp
string <YYYY-MM-dd>
Example: geldigOp=2020-08-23

Filter op het moment waarop de resource geldig is binnen de Stelselcatalogus op basis van de prov:Entity

inclusiefBeeindigdeVersies
boolean
Default: false
Example: inclusiefBeeindigdeVersies=true

Parameter om ook resources die beeindigd zijn te kunnen ophalen. Default worden beeindigde resources niet terug gegeven.

zoekTerm
string
Example: zoekTerm=Afval

zoekterm voor het zoeken op naam van een concept, waardelijst etc.

conceptschema
string
Example: conceptschema=http://stelselcatalogus.omgevingswet.overheid.nl/id/conceptscheme/Stelselcatalogus

uri van het conceptschema waar de te filteren collecties onderdeel van uit maken

page
integer
Default: 1

Paginanummer voor paginering. Deze is gelimiteerd zodat het totaal aantal op te vragen resultaten niet hoger is dan 10000. Gebruik het _links.next.href object om te navigeren.

pageSize
integer
Default: 10
Enum: 10 20 40 100

Aantal resultaten per pagina

_expandScope
Array of strings
Items Value: "concepten"

Query parameter voor het aangeven welke gegevens voor de collectie dienen te worden embed

Responses

Response samples

Content type
application/hal+json
{}

Concepten opvragen

Endpoint voor het opvragen van concepten

Authorizations:
Apikey
query Parameters
uri
string
Example: uri=http://stelselcatalogus.omgevingswet.overheid.nl/stelselcatalogus/id/concept/API

uri van het op te vragen concept

gepubliceerdDoor
string
Example: gepubliceerdDoor=https://standaarden.overheid.nl/owms/terms/Geonovum

owms uri van de eigenaar de op te vragen resources

geldigOp
string <YYYY-MM-dd>
Example: geldigOp=2020-08-23

Filter op het moment waarop de resource geldig is binnen de Stelselcatalogus op basis van de prov:Entity

inclusiefBeeindigdeVersies
boolean
Default: false
Example: inclusiefBeeindigdeVersies=true

Parameter om ook resources die beeindigd zijn te kunnen ophalen. Default worden beeindigde resources niet terug gegeven.

zoekTerm
string
Example: zoekTerm=Afval

zoekterm voor het zoeken op naam van een concept, waardelijst etc.

conceptschema
string
Example: conceptschema=http://stelselcatalogus.omgevingswet.overheid.nl/id/conceptscheme/Stelselcatalogus

uri van het conceptschema waar de te filteren concepten onderdeel van uit maken

collectie
string
Example: collectie=http://stelselcatalogus.omgevingswet.overheid.nl/stelselcatalogus/id/collection/Collectie

uri van de collectie waar de te filteren concepten onderdeel van uit maken

page
integer
Default: 1

Paginanummer voor paginering. Deze is gelimiteerd zodat het totaal aantal op te vragen resultaten niet hoger is dan 10000. Gebruik het _links.next.href object om te navigeren.

pageSize
integer
Default: 10
Enum: 10 20 40 100

Aantal resultaten per pagina

Responses

Response samples

Content type
application/hal+json
{}

Begrippen opvragen

Endpoint voor het opvragen van begrippen

Authorizations:
Apikey
query Parameters
uri
string
Example: uri=http://stelselcatalogus.omgevingswet.overheid.nl/stelselcatalogus/id/concept/API

uri van het op te vragen concept

gepubliceerdDoor
string
Example: gepubliceerdDoor=https://standaarden.overheid.nl/owms/terms/Geonovum

owms uri van de eigenaar de op te vragen resources

zoekTerm
string
Example: zoekTerm=Afval

zoekterm voor het zoeken op naam van een concept, waardelijst etc.

geldigOp
string <YYYY-MM-dd>
Example: geldigOp=2020-08-23

Filter op het moment waarop de resource geldig is binnen de Stelselcatalogus op basis van de prov:Entity

inclusiefBeeindigdeVersies
boolean
Default: false
Example: inclusiefBeeindigdeVersies=true

Parameter om ook resources die beeindigd zijn te kunnen ophalen. Default worden beeindigde resources niet terug gegeven.

begrippenkader
string
Example: begrippenkader=http://stelselcatalogus.omgevingswet.overheid.nl/id/conceptscheme/Stelselcatalogus

URI van het begrippenkader waar de te filteren begrippen onderdeel van uit maken

page
integer
Default: 1

Paginanummer voor paginering. Deze is gelimiteerd zodat het totaal aantal op te vragen resultaten niet hoger is dan 10000. Gebruik het _links.next.href object om te navigeren.

pageSize
integer
Default: 10
Enum: 10 20 40 100

Aantal resultaten per pagina

Responses

Response samples

Content type
application/hal+json
{}

Activiteiten opvragen

Endpoint voor het opvragen van activiteiten

Authorizations:
Apikey
query Parameters
uri
string
Example: uri=http://stelselcatalogus.omgevingswet.overheid.nl/stelselcatalogus/id/concept/API

uri van het op te vragen concept

zoekTerm
string
Example: zoekTerm=Afval

zoekterm voor het zoeken op naam van een concept, waardelijst etc.

geldigOp
string <YYYY-MM-dd>
Example: geldigOp=2020-08-23

Filter op het moment waarop de resource geldig is binnen de Stelselcatalogus op basis van de prov:Entity

inclusiefBeeindigdeVersies
boolean
Default: false
Example: inclusiefBeeindigdeVersies=true

Parameter om ook resources die beeindigd zijn te kunnen ophalen. Default worden beeindigde resources niet terug gegeven.

page
integer
Default: 1

Paginanummer voor paginering. Deze is gelimiteerd zodat het totaal aantal op te vragen resultaten niet hoger is dan 10000. Gebruik het _links.next.href object om te navigeren.

pageSize
integer
Default: 10
Enum: 10 20 40 100

Aantal resultaten per pagina

Responses

Response samples

Werkzaamheden opvragen

Endpoint voor het opvragen van werkzaamheden

Authorizations:
Apikey
query Parameters
uri
string
Example: uri=http://stelselcatalogus.omgevingswet.overheid.nl/stelselcatalogus/id/concept/API

uri van het op te vragen concept

zoekTerm
string
Example: zoekTerm=Afval

zoekterm voor het zoeken op naam van een concept, waardelijst etc.

geldigOp
string <YYYY-MM-dd>
Example: geldigOp=2020-08-23

Filter op het moment waarop de resource geldig is binnen de Stelselcatalogus op basis van de prov:Entity

inclusiefBeeindigdeVersies
boolean
Default: false
Example: inclusiefBeeindigdeVersies=true

Parameter om ook resources die beeindigd zijn te kunnen ophalen. Default worden beeindigde resources niet terug gegeven.

page
integer
Default: 1

Paginanummer voor paginering. Deze is gelimiteerd zodat het totaal aantal op te vragen resultaten niet hoger is dan 10000. Gebruik het _links.next.href object om te navigeren.

pageSize
integer
Default: 10
Enum: 10 20 40 100

Aantal resultaten per pagina

Responses

Response samples

Content type
application/hal+json

Bronnen opvragen

Endpoint voor het opvragen van bronnen

Authorizations:
Apikey
query Parameters
uri
string
Example: uri=http://stelselcatalogus.omgevingswet.overheid.nl/id/bibliograficresouce/Omgevingswet

uri van de op te vragen bron

gepubliceerdDoor
string
Example: gepubliceerdDoor=https://standaarden.overheid.nl/owms/terms/Geonovum

owms uri van de eigenaar de op te vragen resources

geldigOp
string <YYYY-MM-dd>
Example: geldigOp=2020-08-23

Filter op het moment waarop de resource geldig is binnen de Stelselcatalogus op basis van de prov:Entity

inclusiefBeeindigdeVersies
boolean
Default: false
Example: inclusiefBeeindigdeVersies=true

Parameter om ook resources die beeindigd zijn te kunnen ophalen. Default worden beeindigde resources niet terug gegeven.

zoekTerm
string
Example: zoekTerm=Afval

zoekterm voor het zoeken op naam van een concept, waardelijst etc.

page
integer
Default: 1

Paginanummer voor paginering. Deze is gelimiteerd zodat het totaal aantal op te vragen resultaten niet hoger is dan 10000. Gebruik het _links.next.href object om te navigeren.

pageSize
integer
Default: 10
Enum: 10 20 40 100

Aantal resultaten per pagina

Responses

Response samples

Waardelijsten opvragen

Endpoint voor het opvragen van waardelijsten

Authorizations:
Apikey
query Parameters
uri
string
Example: uri=http://stelselcatalogus.omgevingswet.overheid.nl/id/waardelijst/ActiviteitenGroep_1.0.0

uri van de op te vragen waardelijst

set
string
Example: set=IMOW

Set waartoe de op te vragen waardelijst behoort

versieVan
string
Example: versieVan=http://stelselcatalogus.omgevingswet.overheid.nl/id/waardelijst/ActiviteitenGroep

VersieVan bevat de waardelijst uri waartoe de waardelijstversie behoort

gepubliceerdDoor
string
Example: gepubliceerdDoor=https://standaarden.overheid.nl/owms/terms/Geonovum

owms uri van de eigenaar de op te vragen resources

geldigOp
string <YYYY-MM-dd>
Example: geldigOp=2020-08-23

Filter op het moment waarop de resource geldig is binnen de Stelselcatalogus op basis van de prov:Entity

inclusiefBeeindigdeVersies
boolean
Default: false
Example: inclusiefBeeindigdeVersies=true

Parameter om ook resources die beeindigd zijn te kunnen ophalen. Default worden beeindigde resources niet terug gegeven.

_expandScope
Array of strings
Items Value: "waarden"

Query parameter voor het aangeven welke gegevens voor de waardelijst dienen te worden embed

zoekTerm
string
Example: zoekTerm=Afval

zoekterm voor het zoeken op naam van een concept, waardelijst etc.

page
integer
Default: 1

Paginanummer voor paginering. Deze is gelimiteerd zodat het totaal aantal op te vragen resultaten niet hoger is dan 10000. Gebruik het _links.next.href object om te navigeren.

pageSize
integer
Default: 10
Enum: 10 20 40 100

Aantal resultaten per pagina

Responses

Response samples

Content type
application/hal+json
{}

Informatieproducten opvragen

Endpoint voor het opvragen van informatieproducten. Let op, dit endpoint is nog in BETA-stadium. Er kunnen nog breaking changes worden doorgevoerd.

Authorizations:
Apikey
query Parameters
geldigOp
string <YYYY-MM-dd>
Example: geldigOp=2020-08-23

Filter op het moment waarop de resource geldig is binnen de Stelselcatalogus op basis van de prov:Entity

inclusiefBeeindigdeVersies
boolean
Default: false
Example: inclusiefBeeindigdeVersies=true

Parameter om ook resources die beeindigd zijn te kunnen ophalen. Default worden beeindigde resources niet terug gegeven.

zoekTerm
string
Example: zoekTerm=Afval

zoekterm voor het zoeken op naam van een concept, waardelijst etc.

omgevingsaspect
string
Example: omgevingsaspect=http://standaarden.omgevingswet.overheid.nl/omgevingsnorm/id/concept/ExterneVeiligheid

filter voor het zoeken op een omgevingsaspect op basis van URI.

page
integer
Default: 1

Paginanummer voor paginering. Deze is gelimiteerd zodat het totaal aantal op te vragen resultaten niet hoger is dan 10000. Gebruik het _links.next.href object om te navigeren.

pageSize
integer
Default: 10
Enum: 10 20 40 100

Aantal resultaten per pagina

Responses

Response samples

Content type
application/hal+json
{}

Applicatie-eigenschappen van de Stelselcatalogus opvragen

Endpoint voor het opvragen van de applicatie-eigenschappen

Authorizations:
Apikey

Responses

Response samples

Content type
application/json
{
  • "app-info": {
    }
}

Health status van de Stelselcatalogus opvragen

Endpoint voor het opvragen van de health status

Authorizations:
Apikey

Responses

Response samples

Content type
application/json
{
  • "status": "UP"
}