GMW Berichtencatalogus uitgiftewebservice

Let op: dit document is een conceptversie en dus in progress!. Deze berichtencatalogus wordt onderdeel van de baseline behorende bij de gegevenscatalogus versie 1.1 van de Grondwatermonitoringput (GMW). Het document gaat bij release van (standaarden-)versie 1.1 de bestaande documentatie Uitgiftehandboek en Koppelvlakbeschrijving vervangen. De releasedatum volgens de standaard-versie 1.1 zal zijn op 1 januari 2026. Wij verwachten dat de documentatie enkele maanden eerder beschikbaar is, medio Q4 2025.

1. Inleiding

1.1. Voorwoord

Betrouwbare en toegankelijke informatie over de samenstelling en opbouw van de ondergrond is van groot belang voor een dichtbevolkt land als het onze. Het helpt overheden, bedrijven en burgers om op feiten gebaseerde beslissingen te nemen over het gebruik van de ondergrond, bijvoorbeeld in verband met bereikbaarheid, waterveiligheid, warmte- en koudeopslag, aardgasproductie en de winning van aardwarmte. Ook voorkomen we zo dat informatie dubbel moet worden ingewonnen omdat het niet centraal is geregistreerd.

Het verzamelen, beschikbaar stellen, en gebruiken van al deze informatie is sinds september 2015 wettelijk vastgelegd in de Basisregistratie Ondergrond (BRO). Op 1 januari 2018 is het eerste deel van de Wet BRO in werking getreden, op 1 januari 2020 het tweede deel, op 1 januari c.q. 1 juli 2021 het derde deel en op 1 januari c.q. 1 juli 2022 het vierde deel.

Omdat de BRO een onderdeel is van het Stelsel van Basisregistraties, zijn verplichtingen met betrekking tot aanlevering, gebruik, terugmelding en onderzoek in de werkprocessen van overheidsorganisaties opgenomen in de Wet BRO. De BRO-gegevens worden centraal geregistreerd in de Landelijke Voorziening BRO (LV-BRO).

1.2. Doelstelling

Het document Handreiking Afname BRO Gegevens beschrijft via welke uitgiftekanalen BRO-gegevens geraadpleegd of gedownload kunnen worden en welke functionele en technische mogelijkheden deze kanalen bieden. Onder de noemer 'BRO uitgifte API' vallen dan in het bijzonder de 'REST uitgifteservice' en de 'SOAP webservice'. Functioneel gezien lijken deze twee uitgifteservices veel op elkaar.

• De REST service is met name handig om als software ontwikkelaar 'incidenteel even snel en alleen publieke gegevens' op te halen uit de LV-BRO, zonder dat je je eerst moet aanmelden en zonder dat een PKIoverheid certificaat nodig is.

• De SOAP webservice is met name geschikt om frequent en volledig geautomatiseerd in een machine-to-machine omgeving toegang te hebben tot alle beschikbare gegevens. Hiervoor moet je je aanmelden en heb je een PKIoverheid certificaat nodig.

Blijft over de vraag: hoe zien de uitgifteverzoeken en hun antwoorden er uit om gegevens over een grondwatermonitoringput (GMW) op te vragen en wat is de structuur van de diverse uitgiftedocumenten?

1.3. Doelgroepen

Doelgroepen voor dit document zijn organisaties en personen die aan de afnamekant van de BRO opereren, waaronder bestuursorganen (bestuurders, beleidsmakers, BRO-coördinatoren) en bedrijven (ingenieurs, software-leveranciers).

1.4. Samenhang met andere documentatie

De informatievoorziening over de afname van BRO-gegevens vindt plaats op 3 niveaus.

1. Het startpunt met algemene informatie over de diverse uitgiftekanalen is het document Handreiking Afname BRO Gegevens. Dit document verwijst door naar het volgende niveau.

2. Het tweede niveau bevat algemene informatie per uitgiftekanaal (zie https://basisregistratieondergrond.nl/inhoud-bro/aanleveren-opvragen/gegevens-opvragen/ ):

   1. De handleiding van de REST uitgifteservice is te vinden op https://www.bro-productomgeving.nl/bpo/latest/informatie-voor-softwareleveranciers/url-s-publieke-rest-services

   2. Algemene informatie over de SOAP webservice is te vinden op https://basisregistratieondergrond.nl/inhoud-bro/aanleveren-opvragen/instructies/gegevens-opvragen-via-soap-webservices/ . De handleiding voor het inrichten van SoapUI in het bijzonder is te vinden op https://basisregistratieondergrond.nl/inhoud-bro/aanleveren-opvragen/instructies/gegevens-opvragen-via-soap-webservices/aansluiten-demo-omgeving-soapui/

3. Het derde niveau is de BRO Productomgeving. Hier vindt u specifieke informatie per domein/registratieobjecttype zoals scopedocument, gegevenscatalogus en werkafspraken, storymap, berichtencatalogi voor inname en uitgifte, voorbeeldberichten voor inname en uitgifte.

Het verdient aanbeveling dat u zich eerst bekend maakt met de aangeven informatie uit de eerste 2 niveau's.
Daarna kunt u zich verdiepen in de GMW-specifieke informatie in de BRO productomgeving, waaronder de GMW gegevenscatalogus en eventuele werkafspraken en in het bijzonder dit document, de GMW berichtencatalogus uitgiftewebservice.

1.5. Leeswijzer

Hoofdstuk 2 beschrijft de algemene werking van de GMW uitgiftewebservice.
Hoofdstuk 3 beschrijft de structuur van de diverse uitgiftedocumenten.
Hoofdstuk 4 bevat een toelichting op enkele voorbeeldberichten.
Hoofdstuk 5 bevat de toegestane waarden van de enumeraties (niet-beheerde lijsten met toegestane waarden).
Hoofdstuk 6 bevat verwijzingen (URN's en URL's) naar de codelijsten (beheerde lijsten met toegestane waarden).
Hoofdstuk 7 bevat een vertaaltabel, aan de hand waarvan, gegeven de Engelstalige naam van een entiteit of een attribuut, de Nederlandse naam in de catalogus kan worden opgezocht.

1.6. Versiehistorie

2. Algemene werking van de GMW uitgiftewebservice

Dit hoofdstuk beschrijft de algemene werking van de GMW uitgiftewebservice.
Paragraaf 2.1 beschrijft de operaties die de GMW uitgiftewebservice ondersteunt.
Paragraaf 2.2 beschrijft de BRO-berichten (request en response) die een rol spelen bij die operaties.

2.1. Operaties

De GMW uitgiftewebservice wordt gerealiseerd als een SOAP-webservice. De onderstaande figuur beschrijft de operaties van de webservice, hun requests en hun responses.

De wsdl kan worden gedowload van https://schema.broservices.nl/dsgmw-v1.1.wsdl
De GMW uitgiftewebservice ondersteunt twee soap operaties:

• dispatchCharacteristics (uitgifte van kengegevens).

• dispatchData (uitgifte van objectgegevens).

Een soap operatie heeft een request en een response:

• Het DispatchCharacteristicsRequest (Verzoek tot uitgifte van kengegevens) en de DispatchCharacteristicsResponse (Bericht van verzending van kengegevens).

• Het DispatchDataRequest (Verzoek tot uitgifte van objectgegevens) en de DispatchDataResponse (Bericht van verzending van objectgegevens).

Naast een functioneel antwoord (een bericht van verzending) kan een verzoek ook leiden tot een foutmelding:

• SOAP:Fault (Systeemfout): als er tijdens de verwerking van het uitgifteverzoek een onverwachte fout optreedt in het BRO-systeem, dan leidt dit tot een SOAP:Fault.

• ParseFault (Validatiefout): als de uitgiftewebservice constateert dat een uitgifteverzoek niet een welgevormd XML-bericht is of dat het niet voldoet aan de XSD-schemavalidatie, dan leidt dit tot een ParseFault.

2.2. BRO-berichten

Deze paragraaf beschrijft de verschillende BRO-berichten (request, response en foutmeldingen) die een rol spelen in de GMW uitgiftewebservice.

2.2.1. DispatchCharacteristicsRequest

Het BRO-bericht DispatchCharacteristicsRequest bevat het uitgifteverzoek tot het leveren van de in het BRO-register opgenomen kengegevens van de GMW registratieobjecten die voldoen aan bepaalde kenmerken. Het DispatchCharacteristicsRequest (Verzoek tot uitgifte van kengegevens) van de GMW uitgiftewebservice is een specialisatie van AbstractDispatchCharacteristicsRequest in de package brocommon, waaraan het het attribuut criteria (kenmerken) toevoegt met de GMW specifieke kenmerken.

De definities van de attributen van de CriteriaSet uit brocommon staan in onderstaande tabel:

 De definities van de attributen, die GMW_CriteriaSet uit dsgmw-messages.xsd hieraan toevoegt, staan in onderstaande tabel:

2.2.2. DispatchDataRequest

Het BRO-bericht DispatchDataRequest bevat het uitgifteverzoek tot het leveren van de in het BRO-register opgenomen gegevens van een bepaald registratieobject. Daarbij wordt het registratieobject geïdentificeerd door zijn BRO-ID. Het DispatchDataRequest (Verzoek tot uitgifte van objectgegevens) van de GMW uitgiftewebservice is een specialisatie van DispatchDataRequest in de package brocommon, waaraan het het attribuut dataToBeDelivered (te leveren gegevens) toevoegt.

De definities van de drie transactiegegevens (uit brocommon) staan in onderstaande tabel:

2.2.3. SOAP:Fault

Tijdens de uitvoering van een operatie kan er een onverwachte fout optreden in het BRO-systeem. Hiervoor kunnen verschillende oorzaken zijn, zoals het falen van bepaalde software of hardware. Deze onverwachte fouten worden beschouwd als een technische fout veroorzaakt door het BRO-systeem. De BRO stuurt dan een bericht in de vorm van een generieke SOAP:Fault (Systeemfout).

Een SOAP:Fault (Systeemfout) bestaat uit twee verplichte gegevens en één optioneel gegeven. De definities van deze gegevens staan in onderstaande tabel:

2.2.4. ParseFault

Als er fouten in het uitgifteverzoek worden gevonden tijdens de technische controle van een uitgifteverzoek, bijvoorbeeld het uitgifteverzoek is niet een welgevormd XML-bericht of het uitgifteverzoek voldoet niet aan de schemavalidatie, dan worden deze beschouwd als een softwarefout in het systeem van de data-afnemer. Het BRO-systeem stuurt dan een bericht in de vorm van een ParseFault (Validatiefout).

Het BRO-bericht ParseFault (Validatiefout) is in feite een gemodelleerde vorm van de algemene SOAP:Fault (Systeemfout), waarbij op de plek van het detail de gegevens van de ParseFault (Validatiefout) worden opgenomen. In de ParseFault (Validatiefout) zit een lijst met abortReasons (Redenen afbreken).

Dit BRO-bericht begint met een SOAP:Fault (Systeemfout), bestaande uit drie gegevens, waarin het attribuut detail het specifieke type ParseFault (Validatiefout) heeft. De definities van deze gegevens staan in onderstaande tabel:

De ParseFault (Validatiefout) bestaat uit drie gegevens en een lijst met abortReasons. De definities van de gegevens van ParseFault (Validatiefout) staan in onderstaande tabel:

Iedere AbortReason (Reden afbreken) bestaat uit twee gegevens. De definities staan in onderstaande tabel:

2.2.5. DispatchCharacteristicsResponse

Onder normale omstandigheden bestaat het antwoord op een DispatchCharacteristicsRequest (Verzoek tot uitgifte van kengegevens) uit een DispatchCharacteriscticsResponse (Bericht van verzending van kengegevens). Het antwoord dispatchCharacteristicsResponse is gedefinieerd in het XSD-bestand dsgmw-messages.xsd. Het is een specialisatie van DispatchResponse zoals gedefinieerd in brocommon.xsd. Het voegt daaraan toe het attribuut numberOfDocuments (aantal documenten) en een optionele lijst met dispatchDocuments (uitgiftedocumenten).

Het BRO-bericht dispatchCharacteristicsResponse kan twee betekenissen hebben:

• Een bericht van afwijzing.

• Een bericht van verzending van kengegevens.

Onderstaande tabel geeft weer welke gegevens onder welke omstandigheden in het BRO-bericht opgenomen zullen worden. De lijst met criterionErrors (kenmerkfouten) speelt alleen een rol bij de uitgifte van kenmerken.

Onderstaande tabel bevat de definities van de gegevens van de DispatchResponse uit brocommon.xsd:

Onderstaande tabel bevat de definities van de gegevens die DispatchCharacteristicsResponse uit dsgmw-messages.xsd toevoegt aan DispatchResponse uit brocommon:

Als er geen registratieobjecten zijn gevonden die voldoen aan de kenmerken, dan heeft het attribuut numberOfDocuments de waarde 0 en is de lijst met dispatchDocuments leeg.

Als er meer dan 2000 registratieobjecten zijn gevonden die voldoen aan de kenmerken, dan heeft het attribuut numberOfDocuments de waarde 2000 en is de lijst met dispatchDocuments beperkt tot dat aantal.

Ieder dispatchDocument (uitgiftedocument) is:

• óf van het type dsgmw:GMW_C, met daarin de kengegevens van een grondwatermonitoringput die niet uit registratie is genomen,

• óf van het type brocom:BRO_DO, met daarin de kengegevens van een registratieobject dat uit registratie is genomen.

(Figuur AbstractCharacteristics - GMW_C)

Het type uitgiftedocument BRO_DO is een specialisatie van AbstractRegistrationObject in de package brocommon. Dit type uitgiftedocument bestaat uit de gegevens:

• broId (BRO-ID).

• deregistered (uit registratie genomen).

• deregistrationTime (tijdstip uit registratie genomen)

Het type uitgiftedocument GMW_C is een specialisatie van AbstractCharacteristics in de package brocommon, wat op zijn beurt een specialisatie is van AbstractRegistrationObject. Dit type uitgiftedocument bestaat uit de onderstaande gegevens. De gegevens zijn gedefinieerd in de GMW gegevenscatalogus.

• broId (BRO-ID).

• deregistered (uit registratie genomen).

• deliveryAccountableParty (bronhouder)

• qualityRegime (kwaliteitsregime)

• objectRegistrationTime (tijdstip registratie object)

• latestCorrectionTime (tijdstip laatste correctie object)

• underReview (in onderzoek)

• standardizedLocation (gestandaardiseerde locatie)

• deliveredLocation (aangeleverde locatie)

• withPrehistory (met voorgeschiedenis)

• constructionStandard (kwaliteitsnorm inrichting)

• initialFunction (initiële functie)

• removed (opgeruimd)

• numberOfMonitoringTubes (aantal monitoringbuizen)

• NITGCode (NITG-code)

• wellCode (putcode)

• owner (eigenaar)

• wellHeadProtector (beschermconstructie)

• wellConstructionDate (inrichtingsdatum put)

• wellRemovalDate (opruimingsdatum put)

• localVerticalReferencePoint (lokaal verticaal referentiepunt)

• offset (verschuiving)

• verticalDatum (verticaal referentievlak)

• groundLevelPosition (maaiveldpositie)

• StatusOverview (Statusoverzicht) met minimaal 1 en maximaal 4 tubeStatus (buisstatus)

• DiameterRange (Diameterbereik) met smallestTubeTopDiameter (kleinste diameter bovenkant buis) en largestTubeTopDiameter (grootste diameter bovenkant buis)

• ScreenPositionRange (Filterbereik) met shallowestScreenTopPosition (positie bovenkant ondiepste filter) en deepestScreenTopPosition (positie onderkant diepste filter).

2.2.5.1. DispatchDataResponse

Onder normale omstandigheden bestaat het antwoord op een dispatchDataRequest (verzoek tot uitgifte van objectgegevens) uit een dispatchDataResponse (bericht van verzending van objectgegevens). Het antwoord DispatchDataResponse is gedefinieerd in het XSD-bestand dsgmw-messages.xsd. Het is een specialisatie van DispatchResponse zoals gedefinieerd in brocommon.xsd. Het voegt daaraan toe één optioneel dispatchDocument.

Het BRO-bericht dispatchDataResponse kan twee betekenissen hebben:

• Een bericht van afwijzing.

• Een bericht van verzending van objectgegevens.

Onderstaande tabel geeft weer welke gegevens onder welke omstandigheden in het BRO-bericht opgenomen zullen worden. De lijst met criterionErrors (kenmerkfouten) speelt alleen een rol bij de uitgifte van kenmerken en dus niet bij de uitgifte van objectgegevens.

Zie de voorgaande paragraaf voor de definities van de gegevens van de DispatchResponse uit brocommon.

Onderstaande tabel bevat de definities van de gegevens die DispatchDataResponse uit dsgmw-messages.xsd toevoegt aan DispatchResponse uit brocommon:

3. Uitgiftedocumenten

Een uitgiftedocument bevat de gegevens van het opgevraagde registratieobject, die in het BRO-systeem geregistreerd zijn. De beschikbare gegevens zijn gedefinieerd in de catalogus.

De GMW uitgiftewebservice kent vijf types uitgiftedocumenten; zie onderstaande tabel. Welke type wordt uitgeleverd hangt af van de opgevraagde gegevens (zie het gegeven  dataToBeDelivered  (te leveren gegevens) in het  DispatchDataRequest (Verzoek tot uitgifte van objectgegevens), de identiteit van de afnemer en de registratiestatus van het registratieobject.

Onderstaande figuur geeft de uitgiftedocumenten weer inclusief de mogelijke inhoud:

De featuretype (objecttype) GroundwaterMonitoringWell (Grondwatermonitoringput) en de gerelateerde featuretypes zijn volledig gedefinieerd in de GMW gegevenscatalogus.

De attributen/gegevensgroepen met een schuine streep voor hun naam worden afgeleid door de GMW innamewebservice; deze gegevens worden niet aangeleverd via een brondocument.

De attributen met een min-teken voor hun naam worden alleen uitgeleverd in de GMW_PO_DP en GMW_PPO_DP varianten van de uitgiftedocumenten.

3.1. Inhoud GMW_PO_DP

Uitgiftedocument GMW_PO_DP bevat:

• De actuele gegevens van een GroundwaterMonitoringWell (Grondwatermonitoringput) conform de GMW gegevenscatalogus,

  • aangevuld met de WellHistory (Putgeschiedenis), die is afgeleid van de aangeleverde brondocumenten,

  • met daarin de lijst met IntermediateEvents (Tussentijdse gebeurtenissen), 

    • waarvan de eventDate (datum gebeurtenis) is afgeleid van een aangeleverde datum in het brondocument (wellConstructionDate (inrichtingsdatum put), eventDate (datum gebeurtenis) of wellRemovalDate (opruimingsdatum put), afhankelijk van het betreffende brondocument)

    • en de eventName (naam gebeurtenis) is afgeleid van de naam van het brondocument,

    • maar niet de EventData (Resultaat gebeurtenis) bij een IntermediateEvent (Tussentijdse gebeurtenis) .

3.2. Inhoud GMW-PO

Uitgiftedocument GMW-PO bevat dezelfde gegevens als uitgiftedocument GMW-PO-DP met uitzondering van de volgende gegevens:

• objectIdAccountableParty (object-ID bronhouder).

• deliveryResponsibleParty (dataleverancier)

3.3. Inhoud GMW-PPO-DP

Uitgiftedocument GMW_PPO_DP bevat:

• De gegevens van een GroundwaterMonitoringWell (Grondwatermonitoringput) conform de GMW gegevenscatalogus, zoals aangeleverd in een GMW_Construction of GMW_ConstructionWithHistory brondocument en aangepast conform eventuele verwerkte correctieverzoeken voor dit brondocument,

  • aangevuld met de WellHistory (Putgeschiedenis), die is afgeleid van de aangeleverde brondocumenten,

  • met daarin de lijst met IntermediateEvents (Tussentijdse gebeurtenissen), 

    • waarvan de eventDate (datum gebeurtenis) is afgeleid van een aangeleverde datum in het brondocument (wellConstructionDate (inrichtingsdatum put), eventDate (datum gebeurtenis) of wellRemovalDate (opruimingsdatum put), afhankelijk van het betreffende brondocument)

    • en de eventName (naam gebeurtenis) is afgeleid van de naam van het brondocument,

    • maar niet de EventData (Resultaat gebeurtenis) bij een IntermediateEvent (Tussentijdse gebeurtenis) .

3.4. Inhoud GMW-PPO

Uitgiftedocument GMW-PPO bevat dezelfde gegevens als uitgiftedocument GMW_PPO_DP, met uitzondering van de volgende gegevens:

• objectIdAccountableParty (object-ID bronhouder).

• deliveryResponsibleParty (dataleverancier)

3.5. Inhoud BRO-DO

Uitgiftedocument BRO-DO is  gedefinieerd in de package brocommon. Het bevat de volgende gegevens van een grondwatermonitoringput die uit registratie is genomen:

• broId (BRO-ID).

• deregistered (uit registratie genomen).

• deregistrationTime (tijdstip uit registratie genomen).

4. Voorbeeldberichten

4.1. Integrale XML-voorbeeldberichten

Integrale voorbeeldberichten zijn te vinden via de link "GMW Voorbeeldberichten uitgiftewebservice" op de GMW landingspagina.

4.2. XML-code snippets

Voorbeelden van een aantal algemene stukken XML-code (code snippets) zijn te vinden in de Handreiking Afname BRO Gegevens.

5. Enumeraties

In de BRO wordt een onderscheid gemaakt tussen beheerde waardenlijsten en niet-beheerde waardenlijsten.

In de gegevenscatalogus en de XSD-bestanden noemen we een niet-beheerde waardenlijst een enumeratie. Bij een enumeratie staat de lijst met toegestane waarden vast en kan de lijst met toegestane waarden niet veranderd worden zonder aanpassingen in de gegevenscatalogus, de berichtdefinities (XSD-bestanden) en de software (voor het maken of verwerken van een bericht).

De onderstaande tabel geeft een overzicht van de GMW-specifieke enumeraties.

• De eerste kolom bevat de Engelstalige naam van de enumeratie, zoals deze voorkomt in de XSD-bestanden.

• De tweede kolom bevat de Nederlandstalige naam, zoals die voorkomt in de gegevenscatalogus.

• De derde kolom bevat de toegestane waarden, die gebruikt mogen worden in een BRO-verzoek.

• De vierde kolom bevat een omschrijving van de toegestane waarde.

6. Codelijsten

In de BRO wordt een onderscheid gemaakt tussen beheerde waardenlijsten en niet-beheerde waardenlijsten.

In de gegevenscatalogus en de XSD-bestanden noemen we een beheerde waardenlijst een codelijst. Het domein van een codelijst is een uitbreidbare opsomming van toegestane waarden.

De onderstaande tabel geeft een overzicht van de GMW-specifieke codelijsten.

• De eerste kolom bevat de Engelstalige naam van de codelijst, zoals deze voorkomt in de XSD-bestanden.

• De tweede kolom bevat de Nederlandstalige naam, zoals die voorkomt in de gegevenscatalogus.

• De derde kolom bevat de URN, die in een BRO-verzoek gebruikt moet worden bij het XML-attribuut codeSpace. Zie Codelist (Codelijst) en de voorbeeldberichten voor nadere informatie.

• De vierde kolom bevat een link naar de REST-service, waarmee u de inhoud van een bepaalde codelijst kunt opvragen. Als resultaat ontvangt u dan een JSON-bericht met daarin alle waarden van de codelijst met de beschrijvingen.

7. Vertaaltabel

Dit hoofdstuk bevat een vertaaltabel, aan de hand waarvan, gegeven de Engelstalige naam van een complexType of element of een attribuut in de XSD-bestanden, de Nederlandse naam in de gegevenscatalogus kan worden opgezocht.

De onderstaande tabel is gesorteerd op alfabetische volgorde van de Engelstalige naam van het complexType/element. Tussen haakjes staat het type modelelement van de entiteit. Binnen een entiteit zijn de attributen gesorteerd op Engelstalige naam.