Uitleg

REST (Representational State Transfer) is een stijl van software architecture voor het ontwerp van netwerk applicaties. Het fundamentele concept van een RESTful API is de 'resource'. Alle informatie die benoemd kan worden is een resource: een (gegenereerd) diagram, document, afbeelding, verzameling (collection) van resources, etc. In het geval van de BRO is dit bijvoorbeeld een Registratie Object. REST gebruikt een resource identifier om een resource te identificeren.

De status van een resource op een willekeurig moment heet een 'resource representation' en bevat data, metadata die de data omschrijft en hypermedia links die de gebruikers helpen het object te interpreteren.

Het data formaat van een 'resource representation' staat bekend als een 'media type' en stelt vast hoe de resource representation verwerkt moet worden.

Daarnaast zijn registratie-objecten gegroepeerd in registratiedomeinen. Dit is terug te vinden in de URL (/gm voor grondwatermonitoring, /sr  voor bodem- en grondonderzoek). In de toekomst is de verwachting dat op domein niveau nieuwe functionaliteit wordt gerealiseerd.

De uitgifte REST services zijn bedoeld voor "incidenteel" gebruik. Ze zijn niet geschikt voor uitgifte in bulk. Hiervoor zijn atom feeds beschikbaar.  De operaties op kenmerken / karakteristieken zijn dan ook niet bedoeld om middels steeds verfijndere, op basis van geografisch kenmerken, uitgifte te bewerkstelligen (zogenaamde "tiling"). In de toekomst zullen deze operaties hoogstwaarschijnlijk worden beschermd op overvragen ("throttling").

Aanpassing URL's: in december 2021 hebben wij onze URL's aangepast zodat zij compliant zijn aan de REST Designrules van de NL overheid . De voormalige URL's (voorbeeldlink: https://publiek.broservices.nl/gm/gld-v1.0/) zijn in april 2022 uit productie genomen.


URL's

Hier onder staan de URL's van de beschikbare REST services. Met de weergegeven URL kom je in de productieomgeving terecht.

Voor de demo-omgeving of de acceptatie-omgeving kun je de bijbehorende REST services benaderen door toevoeging van 'int-' respectievelijk 'acc-' voor 'publiek'. Voorbeeld: https://int-publiek.broservices.nl/gm/gmw/v1/

Domein grondwatermonitoring

Uitgifte

Visualisatie

Domein bodem- en grondonderzoek

Uitgifte

Visualisatie

Domein grondwatergebruik

Uitgifte


Domein Mijnbouwwet

Uitgifte

BRO algemene services

Waardelijsten

Het is mogelijk om een lijst met alle waarden (uit de catalogi) op te vragen bij de LV BRO via een REST-service.

Waardelijst Service
url: https://publiek.broservices.nl/bro/refcodes/v1

In de openAPI specificatie van de service zelf is een uitleg opgenomen, de zogeheten Swagger-uitleg.

Aanpassing URL refcodes: in december 2021 hebben wij onze URL's aangepast zodat zij compliant zijn aan de REST Designrules van de NL overheid . De voormalige URL (https://publiek.broservices.nl/refcodes/api/) is sinds april 2022 niet meer beschikbaar..