GMN BCI Voorbeeldberichten

Voorbeeldberichten

Dit hoofdstuk bevat enkele voorbeeldberichten en van diverse onderdelen van de berichten een uitgebreide toelichting.

Integrale voorbeeldberichten

De integrale voorbeeldberichten zijn te vinden op GMN Inname voorbeeldberichten in xml. De volgende paragrafen beschrijven de beschikbare voorbeeldberichten, hun intentie en een summiere beschrijving van de inhoud.

01registrationRequestStartRegistration

Het voorbeeldbericht 01registrationRequestStartRegistration.xml bevat een registratieverzoek, waarmee de registratie van een nieuw registratieobject in de BRO wordt gestart.

Onderstaande figuur toont op hoofdlijnen de structuur van het registratieverzoek en het brondocument. 

Dan volgt hier regel voor regel een beschrijving van het voorbeeldbericht. Zie de onderstaande tabellen met regelnummers en XML-code van de regel.

De eerste regel van het voorbeeldbericht bevat de XML-proloog. Merk op dat de tekens volgens UTF-8 gecodeerd moeten worden. Dit is met name van belang voor speciale tekens, zoals à, á, ï.

Regel 2 t/m 7 bevatten de opening tag van het registrationRequest (registratieverzoek) als root XML-element en de namespaces van de gebruikte XML-schemadefinities (XSD's).

Regel 12 t/m 21 bevatten de transactiegegevens.

Regel 12 bevat de requestReference (verzoekkenmerk), een voor de dataleverancier unieke aanduiding van het BRO-verzoek.

Regel 14 bevat het optionele element deliveryAccountableParty (bronhouder). De waarde is het KvK-nummer van de bronhouder. Dit element is opgenomen in het voorbeeldbericht, omdat in dit voorbeeld de dataleverancier niet de bronhouder is.

Regel 18 bevat het qualityRegime (kwaliteitsregime) als aanduiding van de kwaliteitseis waaraan de gegevens in het brondocument voldoen . De waarde IMBRO/A is nodig, omdat de waarde van startDateMonitoring (begindatum monitoring) niet een volledige datum is.

<registrationRequest 
      xmlns="http://www.broservices.nl/xsd/isgmn/1.0"
      xmlns:brocom="http://www.broservices.nl/xsd/brocommon/3.0"
      xmlns:gml="http://www.opengis.net/gml/3.2"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://www.broservices.nl/xsd/isgmn/1.0 ../../XSD/isgmn-messages.xsd"
      >
  <!-- Disclaimer: dit voorbeeldbericht valideert tegen de XSD van de innameservice.
       Het is niet gevalideert door de innamewebservice en is vaktechnisch/inhoudelijk niet voorbeeldig.
  -->
  <brocom:requestReference>Groningen_01</brocom:requestReference>
  <!--Optional: dataleverancier is niet de bronhouder, dus is het gegeven aanwezig. -->
  <brocom:deliveryAccountableParty>27376655</brocom:deliveryAccountableParty>
  <!--Optional: brondocument is GMN_StartRegistration, dus mag het gegeven niet aanwezig zijn.
  <brocom:broId>GMN123456789012</brocom:broId>
  -->
  <brocom:qualityRegime>IMBRO</brocom:qualityRegime>
  <!--Optional: niet toegestaan bij GMN.
  <brocom:underPrivilege>ja</brocom:underPrivilege>
  -->

Regel 22 bevat de opening tag van het sourceDocument (brondocument).

Regel 23 geeft aan dat GMN_StartRegistration het type is van het brondocument. Het attribuut gml:id bevat een door de dataleverancier aangeleverde waarde die uniek moet zijn binnen dit bericht.

Regel 24 is het eerste gegeven binnen dit brondocument, de objectIdAccountableParty (object-ID bronhouder).

Regel 25 bevat de binnen het werkveld herkenbare naam voor het grondwatermonitoringnet.

Regel 26 bevat de deliveryContext (kader aanlevering). Het XML-attribuut codeSpace bevat de unieke aanduiding van de gebruikte codelijst (urn:bro:gmn:DeliveryContext) . De waarde 'kaderrichtlijnWater' van het XML-element is één van de toegestane waarden uit die codelijst (zie de catalogus).

Regel 27 en 28 bevatten ook elementen met een waarde uit een codelijst.

Regel 29 t/m 38 bevat de startDateMonitoring (begindatum monitoring). In het voorbeeldbericht heeft dit de waarde 2021 (het jaar 2021). Volgens de catalogus kan er naast een jaartal ook sprake zijn van 3 andere varianten. Regel 32 t/m 35 bevatten als commentaar alle 4 varianten voor 1 maart 2021 met een afnemende nauwkeurigheid.

  <sourceDocument>
    <GMN_StartRegistration gml:id="id_0001">
        <objectIdAccountableParty>meetnet_07</objectIdAccountableParty>
        <name>Provinciaal meetnet grondwater Groningen; Delfzijl</name>
        <deliveryContext codeSpace="urn:bro:gmn:DeliveryContext">kaderrichtlijnWater</deliveryContext>
        <monitoringPurpose codeSpace="urn:bro:gmn:MonitoringPurpose">strategischBeheerKwaliteitRegionaal</monitoringPurpose>
        <groundwaterAspect codeSpace="urn:bro:gmn:GroundwaterAspect">kwantiteit</groundwaterAspect>
        <startDateMonitoring>
          <!--You have a CHOICE of the next 4 items at this level-->
          <!-- 
          <brocom:date>2021-03-01</brocom:date>
          <brocom:yearMonth>2021-03</brocom:yearMonth>
          <brocom:year>2021</brocom:year>
          <brocom:voidReason>onbekend</brocom:voidReason>
           -->
          <brocom:date>2021-03-01</brocom:date>
        </startDateMonitoring>

Vanaf regel 39 volgen één of meer voorkomens van een measuringPoint (meetpunt) waaruit het grondwatermonitoringnet bestaat. Het voorbeeldbericht bevat er 2, maar dat hadden er ook meer of minder kunnen zijn.

Regel 41 geeft aan dat MeasuringPoint (Meetpunt) het type is van het element measuringPoint (meetpunt). Het attribuut gml:id bevat een door de dataleverancier aangeleverde waarde die uniek moet zijn binnen dit bericht.

Regel 42 bevat de measuringPointCode (meetpuntcode) van het meetpunt.

Regel 43 bevat de opening tag van de monitoringTube (monitoringbuis).

Regel 44 geeft aan dat GroundwaterMonitoringTube (GMW-monitoringbuis) het type is van het element monitoringTube (monitoringbuis). Het attribuut gml:id bevat een door de dataleverancier aangeleverde waarde die uniek moet zijn binnen dit bericht.

Elke monitoringbuis wordt geïdentificeerd door de combinatie van broId (BRO-id) en tubeNumber (buisnummer).

Regel 45 bevat de broID (BRO-id) van het monitoringbuis.

Regel 46 bevat de tubeNumber (buisnummer) van het monitoringbuis.

Regel 47 bevat de closing tag van de GroundwaterMonitoringTube (GMW-monitoringbuis) als type van de monitoringTube (monitoringbuis).

Regel 48 bevat de closing tag van de monitoringTube (monitoringbuis).

Regel 49 bevat de closing tag van de MeasuringPoint (Meetpunt) als type van het measuringPoint (meetpunt).

Regel 50 bevat de closing tag van de measuringPoint (meetpunt).

Regel 51 t/m 61 bevatten een tweede measuringPoint (meetpunt). 

        <!-- 1 or more repetitions: -->
        <measuringPoint>
          <MeasuringPoint gml:id="id_0002">
            <measuringPointCode>GMW07F000001</measuringPointCode>
            <monitoringTube>
              <GroundwaterMonitoringTube gml:id="id_0003">
                <broId>GMW123456789001</broId>
                <tubeNumber>2</tubeNumber>
              </GroundwaterMonitoringTube>
            </monitoringTube>
          </MeasuringPoint>
        </measuringPoint>
        <measuringPoint>
          <MeasuringPoint gml:id="id_0004">
            <measuringPointCode>GMW07F000002</measuringPointCode>
            <monitoringTube>
              <GroundwaterMonitoringTube gml:id="id_0005">
                <broId>GMW123456789002</broId>
                <tubeNumber>3</tubeNumber>
              </GroundwaterMonitoringTube>
            </monitoringTube>
          </MeasuringPoint>
        </measuringPoint>

Regel 62 bevat de closing tag GMN_StartRegistration als type van het sourceDocument (brondocument).

Regel 63 bevat de closing tag van het sourceDocument (brondocument).

Regel 64 bevat de closing tag van het registrationRequest (registratieverzoek).

    </GMN_StartRegistration>
  </sourceDocument>
</registrationRequest>

02registrationRequestMeasuringPoint

Het voorbeeldbericht 02registrationRequestMeasuringPoint.xml bevat een registratieverzoek, waarmee een meetpunt wordt toegevoegd aan een registratieobject dat al is opgenomen in de BRO. Het meetpunt speelt vanaf de eventDate (datum gebeurtenis) in het brondocument een rol binnen het meetnet. Het voorbeeldbericht borduurt voort op het voorbeeldbericht 01registrationRequestStartRegistration.xml.

NB 1: De combinatie van EventName (NaamGebeurtenis), eventDate (datum gebeurtenis) en measuringPointCode (meetpuntcode) moet uniek zijn binnen een registratieobject. Dit heeft tot gevolg er per meetpunt een GMN_MeasuringPoint (GMN-Meetpunt) brondocument in een registrationRequest (registratieverzoek) aangeboden moeten worden.

Onderstaande figuur toont op hoofdlijnen de structuur van het registratieverzoek en het brondocument. 

Dan volgt hier regel voor regel een beschrijving van het voorbeeldbericht. Zie de onderstaande tabellen met regelnummers en XML-code van de regel.

De eerste regel van het voorbeeldbericht bevat de XML-proloog. Merk op dat de tekens volgens UTF-8 gecodeerd moeten worden. Dit is met name van belang voor speciale tekens, zoals à, á, ï.

Regel 2 t/m 8 bevatten de opening tag van het registrationRequest (registratieverzoek) als root XML-element en de namespaces van de gebruikte XML-schemadefinities (XSD's).

Regel 13 t/m 21 bevatten de transactiegegevens.

Regel 13 bevat de requestReference (verzoekkenmerk), een voor de dataleverancier unieke aanduiding van het BRO-verzoek.

Regel 15 bevat het optionele element deliveryAccountableParty (bronhouder). De waarde is het KvK-nummer van de bronhouder. Dit element is opgenomen in het voorbeeldbericht, omdat in dit voorbeeld de dataleverancier niet de bronhouder is.

Regel 17 bevat de broId (BRO-id) als unieke identificatie van het registratieobject dat aangevuld moet worden met de gegevens in het brondocument van dit registratieverzoek .

Regel 18 bevat het qualityRegime (kwaliteitsregime) als aanduiding van de kwaliteitseis waaraan de gegevens in het brondocument voldoen .

<registrationRequest 
      xmlns="http://www.broservices.nl/xsd/isgmn/1.0"
      xmlns:brocom="http://www.broservices.nl/xsd/brocommon/3.0"
      xmlns:gml="http://www.opengis.net/gml/3.2"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://www.broservices.nl/xsd/isgmn/1.0 ../../XSD/isgmn-messages.xsd"
      >

  <!-- Disclaimer: dit voorbeeldbericht valideert tegen de XSD van de innamewebservice.
       Het is niet gevalideert door de innamewebservice en is vaktechnisch/inhoudelijk niet voorbeeldig.
  -->
  <brocom:requestReference>Groningen_02</brocom:requestReference>
  <!--Optional: dataleverancier is niet de bronhouder, dus is het gegeven aanwezig. -->
  <brocom:deliveryAccountableParty>27376655</brocom:deliveryAccountableParty>
  <!--Optional: brondocument is GMN_AddMeasuringPoint, dus moet het gegeven aanwezig zijn. -->
  <brocom:broId>GMN123456789012</brocom:broId>
  <brocom:qualityRegime>IMBRO</brocom:qualityRegime>
  <!--Optional: niet toegestaan bij GMN.
  <brocom:underPrivilege>ja</brocom:underPrivilege>
  -->

Regel 22 bevat de opening tag van het sourceDocument (brondocument).

Regel 23 geeft aan dat GMN_MeasuringPoint het type is van het brondocument. Het attribuut gml:id bevat een door de dataleverancier aangeleverde waarde die uniek moet zijn binnen dit bericht.

Regel 24 t/m 33 bevat de eventDate (datum gebeurtenis) waarop de gegevens in de werkelijkheid hun geldigheid hebben gekregen. In het voorbeeldbericht heeft dit de waarde 2021-08-15 (15 augustus 2021). Volgens de catalogus kan er naast een volledige datum (jaar, maand, dag) ook sprake zijn van 3 minder nauwkeurige varianten. Regel 27 t/m 30 bevatten als commentaar alle 4 varianten voor 15 augustus 2021 met een afnemende nauwkeurigheid.

  <sourceDocument>
    <GMN_MeasuringPoint gml:id="id_0001">
        <eventDate>
          <!--You have a CHOICE of the next 4 items at this level-->
          <!-- 
          <brocom:date>2021-08-15</brocom:date>
          <brocom:yearMonth>2021-08</brocom:yearMonth>
          <brocom:year>2021</brocom:year>
          <brocom:voidReason>onbekend</brocom:voidReason>
           -->
          <brocom:date>2021-08-15</brocom:date>
        </eventDate>

Regel 34 t/m 44 bevat het measuringPoint (meetpunt), waaruit het grondwatermonitoringnet bestaat.

Regel 35 geeft aan dat MeasuringPoint (Meetpunt) het type is van het element measuringPoint (meetpunt). Het attribuut gml:id bevat een door de dataleverancier aangeleverde waarde die uniek moet zijn binnen dit bericht.

Regel 36 bevat de measuringPointCode (meetpuntcode) van het meetpunt.

Regel 37 bevat de opening tag van de monitoringTube (monitoringbuis).

Regel 38 geeft aan dat GroundwaterMonitoringTube (GMW-monitoringbuis) het type is van het element monitoringTube (monitoringbuis). Het attribuut gml:id bevat een door de dataleverancier aangeleverde waarde die uniek moet zijn binnen dit bericht.

Elke monitoringbuis wordt geïdentificeerd door de combinatie van broId (BRO-id) en tubeNumber (buisnummer).

Regel 39 bevat de broID (BRO-id) van het monitoringbuis.

Regel 40 bevat de tubeNumber (buisnummer) van het monitoringbuis.

Regel 41 bevat de closing tag van de GroundwaterMonitoringTube (GMW-monitoringbuis) als type van de monitoringTube (monitoringbuis).

Regel 42 bevat de closing tag van de monitoringTube (monitoringbuis).

Regel 43 bevat de closing tag van de MeasuringPoint (Meetpunt) als type van het measuringPoint (meetpunt).

Regel 44 bevat de closing tag van de measuringPoint (meetpunt).

        <measuringPoint>
          <MeasuringPoint gml:id="id_0002">
            <measuringPointCode>GMW07E000001</measuringPointCode>
            <monitoringTube>
              <GroundwaterMonitoringTube gml:id="id_0003">
                <broId>GMW123456789003</broId>
                <tubeNumber>1</tubeNumber>
              </GroundwaterMonitoringTube>
            </monitoringTube>
          </MeasuringPoint>
        </measuringPoint>

Regel 45 bevat de closing tag GMN_StartRegistration als type van het sourceDocument (brondocument).

Regel 46 bevat de closing tag van het sourceDocument (brondocument).

Regel 47 bevat de closing tag van het registrationRequest (registratieverzoek).

    </GMN_MeasuringPoint>
  </sourceDocument>
</registrationRequest>

03registrationRequestTubeReference

Het voorbeeldbericht 03registrationRequestTubeReference.xml bevat een registratieverzoek, waarmee van een meetpunt de actuele buisverwijzing wordt vervangen door een andere buisverwijzing. De vervangende buisverwijzingen vormt vanaf de eventDate (datum gebeurtenis) in het brondocument de monitoringbuis waarin een (de) gerelateerd(e) grondwaterstandonderzoek(en) en/of grondwatersamenstellingsonderzoek(en) uitgevoerd worden. Het voorbeeldbericht borduurt voort op de voorbeeldberichten 01registrationRequestStartRegistration.xml en 02registrationRequestMeasuringPoint.xml.

NB 1: De combinatie van EventName (NaamGebeurtenis), eventDate (datum gebeurtenis) en measuringPointCode (meetpuntcode) moet uniek zijn binnen een registratieobject. Dit heeft tot gevolg er per veranderende buisverwijzingen een GMN_TubeReference (GMN-Buisverwijzing) brondocument in een registrationRequest (registratieverzoek) aangeboden moeten worden.

Onderstaande figuur toont op hoofdlijnen de structuur van het registratieverzoek en het brondocument. 

Dan volgt hier regel voor regel een beschrijving van het voorbeeldbericht. Zie de onderstaande tabellen met regelnummers en XML-code van de regel.

De eerste regel van het voorbeeldbericht bevat de XML-proloog. Merk op dat de tekens volgens UTF-8 gecodeerd moeten worden. Dit is met name van belang voor speciale tekens, zoals à, á, ï.

Regel 2 t/m 8 bevatten de opening tag van het registrationRequest (registratieverzoek) als root XML-element en de namespaces van de gebruikte XML-schemadefinities (XSD's).

Regel 13 t/m 21 bevatten de transactiegegevens.

Regel 13 bevat de requestReference (verzoekkenmerk), een voor de dataleverancier unieke aanduiding van het BRO-verzoek.

Regel 15 bevat het optionele element deliveryAccountableParty (bronhouder). De waarde is het KvK-nummer van de bronhouder. Dit element is opgenomen in het voorbeeldbericht, omdat in dit voorbeeld de dataleverancier niet de bronhouder is.

Regel 17 bevat de broId (BRO-id) als unieke identificatie van het registratieobject waarvoor bij een meetpunt de actuele buisverwijzing vervangen moet worden.

Regel 18 bevat het qualityRegime (kwaliteitsregime) als aanduiding van de kwaliteitseis waaraan de gegevens in het brondocument voldoen.

<registrationRequest 
      xmlns="http://www.broservices.nl/xsd/isgmn/1.0"
      xmlns:brocom="http://www.broservices.nl/xsd/brocommon/3.0"
      xmlns:gml="http://www.opengis.net/gml/3.2"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://www.broservices.nl/xsd/isgmn/1.0 ../../XSD/isgmn-messages.xsd"
      >

  <!-- Disclaimer: dit voorbeeldbericht valideert tegen de XSD van de innamewebservice.
       Het is niet gevalideert door de innamewebservice en is vaktechnisch/inhoudelijk niet voorbeeldig.
  -->
  <brocom:requestReference>Groningen_03</brocom:requestReference>
  <!--Optional: dataleverancier is niet de bronhouder, dus is het gegeven aanwezig. -->
  <brocom:deliveryAccountableParty>27376655</brocom:deliveryAccountableParty>
  <!--Optional: brondocument is GMN_AddMeasuringPoint, dus moet het gegeven aanwezig zijn. -->
  <brocom:broId>GMN123456789012</brocom:broId>
  <brocom:qualityRegime>IMBRO</brocom:qualityRegime>
  <!--Optional: niet toegestaan bij GMN.
  <brocom:underPrivilege>ja</brocom:underPrivilege>
  -->

Regel 22 bevat de opening tag van het sourceDocument (brondocument).

Regel 23 geeft aan dat GMN_TubeReference het type is van het brondocument. Het attribuut gml:id bevat een door de dataleverancier aangeleverde waarde die uniek moet zijn binnen dit bericht.

Regel 24 t/m 33 bevat de eventDate (datum gebeurtenis) waarop de gegevens in de werkelijkheid hun geldigheid hebben gekregen. In het voorbeeldbericht heeft dit de waarde 2021-11-27 (27 november 2021). Volgens de catalogus kan er naast een volledige datum (jaar, maand, dag) ook sprake zijn van 3 minder nauwkeurige varianten. Regel 27 t/m 30 bevatten als commentaar alle 4 varianten voor 27 november 2021 met een afnemende nauwkeurigheid.

  <sourceDocument>
    <GMN_TubeReference gml:id="id_0001">
        <eventDate>
          <!--You have a CHOICE of the next 4 items at this level-->
          <!-- 
          <brocom:date>2021-11-27</brocom:date>
          <brocom:yearMonth>2021-11</brocom:yearMonth>
          <brocom:year>2021</brocom:year>
          <brocom:voidReason>onbekend</brocom:voidReason>
           -->
          <brocom:date>2021-11-27</brocom:date>
        </eventDate>

Regel 34 t/m 44 bevat het measuringPoint (meetpunt) waarvan de actuele buisverwijzing moet worden vervangen door de gegevens in het brondocument.

Regel 35 geeft aan dat MeasuringPoint (Meetpunt) het type is van het element measuringPoint (meetpunt). Het attribuut gml:id bevat een door de dataleverancier aangeleverde waarde die uniek moet zijn binnen dit bericht.

Regel 36 bevat de measuringPointCode (meetpuntcode) van het meetpunt waarvan de actuele buisverwijzing moet worden vervangen.

Regel 37 bevat de opening tag van de monitoringTube (monitoringbuis).

Regel 38 geeft aan dat GroundwaterMonitoringTube (GMW-monitoringbuis) het type is van het element monitoringTube (monitoringbuis). Het attribuut gml:id bevat een door de dataleverancier aangeleverde waarde die uniek moet zijn binnen dit bericht.

Regel 39 en 40 bevatten de broID (BRO-id) en de tubeNumber (buisnummer) als unieke identificatie van de monitoringbuis die de huidige actuele buisverwijzing moet vervangen.

Regel 41 bevat de closing tag van de GroundwaterMonitoringTube (GMW-monitoringbuis) als type van de monitoringTube (monitoringbuis).

Regel 42 bevat de closing tag van de monitoringTube (monitoringbuis).

Regel 43 bevat de closing tag van de MeasuringPoint (Meetpunt) als type van het measuringPoint (meetpunt).

Regel 44 bevat de closing tag van de measuringPoint (meetpunt) van het meetpunt.

        <measuringPoint>
          <MeasuringPoint gml:id="id_0002">
            <measuringPointCode>GMW07F000002</measuringPointCode>
            <monitoringTube>
              <GroundwaterMonitoringTube gml:id="id_0003">
                <broId>GMW123456789007</broId>
                <tubeNumber>1</tubeNumber>
              </GroundwaterMonitoringTube>
            </monitoringTube>
          </MeasuringPoint>
        </measuringPoint>

Regel 45 bevat de closing tag GMN_TubeReference als type van het sourceDocument (brondocument).

Regel 46 bevat de closing tag van het sourceDocument (brondocument).

Regel 47 bevat de closing tag van het registrationRequest (registratieverzoek).

    </GMN_TubeReference>
  </sourceDocument>
</registrationRequest>

04registrationRequestMeasuringPointEndDate

Het voorbeeldbericht 04registrationRequestMeasuringPointEndDate.xml bevat een registratieverzoek, waarmee een meetpunt wordt beëindigd (buiten gebruik gesteld). Het meetpunten wordt vanaf de eventDate (datum gebeurtenis) in het brondocument niet meer gebruikt binnen de context van dit grondwatermonitoringnet. Het voorbeeldbericht borduurt voort op de voorbeeldberichten 01registrationRequestStartRegistration.xml en 02registrationRequestMeasuringPoint.xml.

NB 1: De combinatie van EventName (NaamGebeurtenis), eventDate (datum gebeurtenis) en measuringPointCode (meetpuntcode) moet uniek zijn binnen een registratieobject. Dit heeft tot gevolg dat per buiten gebruik gesteld meetpunt een GMN_MeasuringPointEndDate (GMN-EinddatumMeetpunt) brondocument in een registrationRequest (registratieverzoek) aangeboden moeten worden.

Onderstaande figuur toont op hoofdlijnen de structuur van het registratieverzoek en het brondocument. 

Dan volgt hier regel voor regel een beschrijving van het voorbeeldbericht. Zie de onderstaande tabellen met regelnummers en XML-code van de regel.

De eerste regel van het voorbeeldbericht bevat de XML-proloog. Merk op dat de tekens volgens UTF-8 gecodeerd moeten worden. Dit is met name van belang voor speciale tekens, zoals à, á, ï.

Regel 2 t/m 8 bevatten de opening tag van het registrationRequest (registratieverzoek) als root XML-element en de namespaces van de gebruikte XML-schemadefinities (XSD's).

Regel 13 t/m 21 bevatten de transactiegegevens.

Regel 13 bevat de requestReference (verzoekkenmerk), een voor de dataleverancier unieke aanduiding van het BRO-verzoek.

Regel 15 bevat het optionele element deliveryAccountableParty (bronhouder). De waarde is het KvK-nummer van de bronhouder. Dit element is opgenomen in het voorbeeldbericht, omdat in dit voorbeeld de dataleverancier niet de bronhouder is.

Regel 17 bevat de broId (BRO-id) als unieke identificatie van het registratieobject dat aangevuld moet worden met de gegevens in het brondocument van dit registratieverzoek .

Regel 18 bevat het qualityRegime (kwaliteitsregime) als aanduiding van de kwaliteitseis waaraan de gegevens in het brondocument voldoen .

<registrationRequest 
      xmlns="http://www.broservices.nl/xsd/isgmn/1.0"
      xmlns:brocom="http://www.broservices.nl/xsd/brocommon/3.0"
      xmlns:gml="http://www.opengis.net/gml/3.2"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://www.broservices.nl/xsd/isgmn/1.0 ../../XSD/isgmn-messages.xsd"
      >

  <!-- Disclaimer: dit voorbeeldbericht valideert tegen de XSD van de innamewebservice.
       Het is niet gevalideert door de innamewebservice en is vaktechnisch/inhoudelijk niet voorbeeldig.
  -->
  <brocom:requestReference>Groningen_04</brocom:requestReference>
  <!--Optional: dataleverancier is niet de bronhouder, dus is het gegeven aanwezig. -->
  <brocom:deliveryAccountableParty>27376655</brocom:deliveryAccountableParty>
  <!--Optional: brondocument is GMN_AddMeasuringPoint, dus moet het gegeven aanwezig zijn. -->
  <brocom:broId>GMN123456789012</brocom:broId>
  <brocom:qualityRegime>IMBRO</brocom:qualityRegime>
  <!--Optional: niet toegestaan bij GMN.
  <brocom:underPrivilege>ja</brocom:underPrivilege>
  -->

Regel 22 bevat de opening tag van het sourceDocument (brondocument).

Regel 23 geeft aan dat GMN_MeasuringPointEndDate het type is van het brondocument. Het attribuut gml:id bevat een door de dataleverancier aangeleverde waarde die uniek moet zijn binnen dit bericht.

Regel 24 t/m 33 bevat de eventDate (datum gebeurtenis) waarop de gegevens in de werkelijkheid hun geldigheid hebben gekregen. In het voorbeeldbericht heeft dit de waarde 2021-12-02 (2 december 2021). Volgens de catalogus kan er naast een volledige datum (jaar, maand, dag) ook sprake zijn van 3 minder nauwkeurige varianten. Regel 27 t/m 30 bevatten als commentaar alle 4 varianten voor 2 december 2021 met een afnemende nauwkeurigheid.

Regel 35 bevat de measuringPointCode (meetpuntcode) van het meetpunt dat moet worden beëindigd.

Regel 36 bevat de closing tag GMN_MeasuringPointEndDate als type van het sourceDocument (brondocument).

Regel 37 bevat de closing tag van het sourceDocument (brondocument).

Regel 38 bevat de closing tag van het registrationRequest (registratieverzoek).

  <sourceDocument>
    <GMN_MeasuringPointEndDate gml:id="id_0001">
        <eventDate>
          <!--You have a CHOICE of the next 4 items at this level-->
          <!-- 
          <brocom:date>2021-12-02</brocom:date>
          <brocom:yearMonth>2021-12</brocom:yearMonth>
          <brocom:year>2021</brocom:year>
          <brocom:voidReason>onbekend</brocom:voidReason>
           -->
          <brocom:date>2021-12-02</brocom:date>
        </eventDate>
        <measuringPointCode>GMW07E000002</measuringPointCode>
    </GMN_MeasuringPointEndDate>
  </sourceDocument>
</registrationRequest>

05registrationRequestClosure

Het voorbeeldbericht 05registrationRequestClosure.xml bevat een registratieverzoek, waarmee de registratie van het gehele grondwatermonitoringnet wordt beëindigd.

Onderstaande figuur toont op hoofdlijnen de structuur van het registratieverzoek en het brondocument. 

Dan volgt hier regel voor regel een beschrijving van het voorbeeldbericht. Zie de onderstaande tabellen met regelnummers en XML-code van de regel.

De eerste regel van het voorbeeldbericht bevat de XML-proloog. Merk op dat de tekens volgens UTF-8 gecodeerd moeten worden. Dit is met name van belang voor speciale tekens, zoals à, á, ï.

Regel 2 t/m 8 bevatten de opening tag van het registrationRequest (registratieverzoek) als root XML-element en de namespaces van de gebruikte XML-schemadefinities (XSD's).

Regel 13 t/m 21 bevatten de transactiegegevens.

Regel 13 bevat de requestReference (verzoekkenmerk), een voor de dataleverancier unieke aanduiding van het BRO-verzoek.

Regel 15 bevat het optionele element deliveryAccountableParty (bronhouder). De waarde is het KvK-nummer van de bronhouder. Dit element is opgenomen in het voorbeeldbericht, omdat in dit voorbeeld de dataleverancier niet de bronhouder is.

Regel 17 bevat de broId (BRO-id) als unieke identificatie van het registratieobject waarvan de registratie beëindigd moet worden .

Regel 18 bevat het qualityRegime (kwaliteitsregime) als aanduiding van de kwaliteitseis waaraan de gegevens in het brondocument voldoen .

<registrationRequest 
      xmlns="http://www.broservices.nl/xsd/isgmn/1.0"
      xmlns:brocom="http://www.broservices.nl/xsd/brocommon/3.0"
      xmlns:gml="http://www.opengis.net/gml/3.2"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://www.broservices.nl/xsd/isgmn/1.0 ../../XSD/isgmn-messages.xsd"
      >

  <!-- Disclaimer: dit voorbeeldbericht valideert tegen de XSD van de innamewebservice.
       Het is niet gevalideert door de innamewebservice en is vaktechnisch/inhoudelijk niet voorbeeldig.
  -->
  <brocom:requestReference>Groningen_05</brocom:requestReference>
  <!--Optional: dataleverancier is niet de bronhouder, dus is het gegeven aanwezig. -->
  <brocom:deliveryAccountableParty>27376655</brocom:deliveryAccountableParty>
  <!--Optional: brondocument is GMN_AddMeasuringPoint, dus moet het gegeven aanwezig zijn. -->
  <brocom:broId>GMN123456789012</brocom:broId>
  <brocom:qualityRegime>IMBRO</brocom:qualityRegime>
  <!--Optional: niet toegestaan bij GMN.
  <brocom:underPrivilege>ja</brocom:underPrivilege>
  -->

Regel 22 bevat de opening tag van het sourceDocument (brondocument).

Regel 23 geeft aan dat GMN_Closure het type is van het brondocument. Het attribuut gml:id bevat een door de dataleverancier aangeleverde waarde die uniek moet zijn binnen dit bericht.

Regel 24 t/m 33 bevat de endDateMonitoring (einddatum monitoring) waarop de registratie is beëindigd. In het voorbeeldbericht heeft dit de waarde 2021-12-30 (30 december 2021). Volgens de catalogus kan er naast een volledige datum (jaar, maand, dag) ook sprake zijn van 3 minder nauwkeurige varianten. Regel 27 t/m 30 bevatten als commentaar alle 4 varianten voor 30 december 2021 met een afnemende nauwkeurigheid.

Regel 34 bevat de closing tag GMN_Closure als type van het sourceDocument (brondocument).

Regel 35 bevat de closing tag van het sourceDocument (brondocument).

Regel 36 bevat de closing tag van het registrationRequest (registratieverzoek).

  <sourceDocument>
    <GMN_Closure gml:id="id_0001">
      <endDateMonitoring>
        <!--You have a CHOICE of the next 4 items at this level-->
        <!-- 
        <brocom:date>2021-12-30</brocom:date>
        <brocom:yearMonth>2021-12</brocom:yearMonth>
        <brocom:year>2021</brocom:year>
        <brocom:voidReason>onbekend</brocom:voidReason>
         -->
        <brocom:date>2021-12-30</brocom:date>
      </endDateMonitoring>
    </GMN_Closure>
  </sourceDocument>
</registrationRequest>

Gegevens corrigeren

Dit hoofdstuk bevat enkele voorbeeldberichten voor het corrigeren van bestaande gegevens (vervangen, verplaatsen, invoegen, verwijderen).

11replaceRequestStartRegistrationBronhouder

Het voorbeeldbericht 11replaceRequestStartRegistrationBronhouder.xml bevat een correctieverzoek, waarmee de waarde voor de bronhouder van een grondwatermonitoringnet wordt vervangen.

Onderstaande figuur toont op hoofdlijnen de structuur van het registratieverzoek en het brondocument. 

Merk op dat het brondocument GMN_StartRegistration alle gegevens van de entiteit GroundwaterMonitoringNet (GrondwaterMonitoringNet) bevat, maar niet de lijst met measuringPoints (meetpunten).

Dan volgt hier regel voor regel een beschrijving van het voorbeeldbericht. Zie de onderstaande tabellen met regelnummers en XML-code van de regel.

De eerste regel van het voorbeeldbericht bevat de XML-proloog. Merk op dat de tekens volgens UTF-8 gecodeerd moeten worden. Dit is met name van belang voor speciale tekens, zoals à, á, ï.

Regel 2 t/m 8 bevatten de opening tag van het correctionRequest (correctieverzoek) als root XML-element en de namespaces van de gebruikte XML-schemadefinities (XSD's).

Regel 13 t/m 21 bevatten de transactiegegevens.

Regel 13 bevat de requestReference (verzoekkenmerk), een voor de dataleverancier unieke aanduiding van het BRO-verzoek.

Regel 15 bevat het optionele element deliveryAccountableParty (bronhouder). De waarde is het KvK-nummer van de bronhouder. Deze waarde moet de momenteel geregistreerde waarde vervangen.

Regel 16 bevat de broId (BRO-id) als unieke identificatie van het registratieobject waarvan we de waarde voor het gegeven deliveryAccountableParty (bronhouder) willen corrigeren.

Regel 17 bevat het qualityRegime (kwaliteitsregime) als aanduiding van de kwaliteitseis waaraan de gegevens in het brondocument voldoen. De waarde IMBRO/A is nodig, omdat de waarde van startDateMonitoring (begindatum monitoring) niet een volledige datum is.

Regel 21 bevar de correctionReason (correctie reden), met in dit voorbeeldbericht de waarde bronhouder, omdat we de waarde voor het gegeven deliveryAccountableParty (bronhouder) willen corrigeren.

<?xml version="1.0" encoding="UTF-8"?>
<replaceRequest
      xmlns="http://www.broservices.nl/xsd/isgmn/1.0"
      xmlns:brocom="http://www.broservices.nl/xsd/brocommon/3.0"
      xmlns:gml="http://www.opengis.net/gml/3.2"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://www.broservices.nl/xsd/isgmn/1.0 https://schema.broservices.nl/xsd/isgmn/1.0/isgmn-messages.xsd"
      >
  <!-- Disclaimer: dit voorbeeldbericht valideert tegen de XSD van de innameservice.
       Het is niet gevalideerd door de innamewebservice en is vaktechnisch/inhoudelijk niet voorbeeldig.
  -->
  <brocom:requestReference>Groningen_11</brocom:requestReference>
  <!--Optional: we willen de waarde van de bronhouder corrigeren, dus is het gegeven aanwezig. -->
  <brocom:deliveryAccountableParty>55667372</brocom:deliveryAccountableParty>
  <brocom:broId>GMN123456789012</brocom:broId>
  <brocom:qualityRegime>IMBRO/A</brocom:qualityRegime>
  <!--Optional: niet toegestaan bij GMN.
  <brocom:underPrivilege>ja</brocom:underPrivilege>
  -->
  <correctionReason codeSpace="urn:bro:gmn:CorrectionReason">bronhouder</correctionReason>

Regel 22 bevat de opening tag van het sourceDocument (brondocument).

Regel 23 geeft aan dat GMN_StartRegistration het type is van het brondocument. Het attribuut gml:id bevat een door de dataleverancier aangeleverde waarde die uniek moet zijn binnen dit bericht.

Regel 24 t/m 38 bevatten de elementen van de entiteit GroundwaterMonitoringNet (GrondwaterMonitoringNet).

  <sourceDocument>
    <GMN_StartRegistration gml:id="id_0001">
      <objectIdAccountableParty>meetnet_07</objectIdAccountableParty>
      <name>Provinciaal meetnet grondwater Groningen; Delfzijl</name>
      <deliveryContext codeSpace="urn:bro:gmn:DeliveryContext">kaderrichtlijnWater</deliveryContext>
      <monitoringPurpose codeSpace="urn:bro:gmn:MonitoringPurpose">strategischBeheerKwaliteitRegionaal</monitoringPurpose>
      <groundwaterAspect codeSpace="urn:bro:gmn:GroundwaterAspect">kwantiteit</groundwaterAspect>
      <startDateMonitoring>
        <!--You have a CHOICE of the next 4 items at this level-->
        <!-- 
        <brocom:date>2021-03-01</brocom:date>
        <brocom:yearMonth>2021-03</brocom:yearMonth>
        <brocom:year>2021</brocom:year>
        <brocom:voidReason>onbekend</brocom:voidReason>
        -->
        <brocom:year>2021</brocom:year>
      </startDateMonitoring>

Regel 39 bevat de closing tag GMN_StartRegistration als type van het sourceDocument (brondocument).

Regel 40 bevat de closing tag van het sourceDocument (brondocument).

Regel 41 bevat de closing tag van het correctionRequest (correctieverzoek).

    </GMN_StartRegistration>
  </sourceDocument>
</replaceRequest>

12replaceRequestStartRegistrationAspect

Het voorbeeldbericht 12replaceRequestStartRegistrationAspect.xml bevat een correctieverzoek, waarmee de waarde voor het groundwaterAspect (grondwateraspect) van een grondwatermonitoringnet wordt vervangen.

Onderstaande figuur toont op hoofdlijnen de structuur van het registratieverzoek en het brondocument. 

Merk op dat het brondocument GMN_StartRegistration alle gegevens van de entiteit GroundwaterMonitoringNet (GrondwaterMonitoringNet) bevat, maar niet de lijst met measuringPoints (meetpunten).

Dan volgt hier regel voor regel een beschrijving van het voorbeeldbericht. Zie de onderstaande tabellen met regelnummers en XML-code van de regel.

De eerste regel van het voorbeeldbericht bevat de XML-proloog. Merk op dat de tekens volgens UTF-8 gecodeerd moeten worden. Dit is met name van belang voor speciale tekens, zoals à, á, ï.

Regel 2 t/m 8 bevatten de opening tag van het correctionRequest (correctieverzoek) als root XML-element en de namespaces van de gebruikte XML-schemadefinities (XSD's).

Regel 13 t/m 21 bevatten de transactiegegevens.

Regel 13 bevat de requestReference (verzoekkenmerk), een voor de dataleverancier unieke aanduiding van het BRO-verzoek.

Regel 15 bevat het optionele element deliveryAccountableParty (bronhouder). De waarde is het KvK-nummer van de bronhouder. Dit element is opgenomen in het voorbeeldbericht, omdat in dit voorbeeld de dataleverancier niet de bronhouder is.

Regel 16 bevat de broId (BRO-id) als unieke identificatie van het registratieobject waarvan we de waarden van enkele administratieve gegevens willen corrigeren .

Regel 17 bevat het qualityRegime (kwaliteitsregime) als aanduiding van de kwaliteitseis waaraan de gegevens in het brondocument voldoen. De waarde IMBRO/A is nodig, omdat de waarde van startDateMonitoring (begindatum monitoring) niet een volledige datum is.

Regel 21 bevar de correctionReason (correctie reden), met in dit voorbeeldbericht de waarde eigenCorrectie, omdat we de waarden van enkele administratieve gegevens op eigen initiatief (d.w.z. niet naar aanleiding van een terugmelding en in-onderzoek plaatsing) willen corrigeren.

<?xml version="1.0" encoding="UTF-8"?>
<replaceRequest
      xmlns="http://www.broservices.nl/xsd/isgmn/1.0"
      xmlns:brocom="http://www.broservices.nl/xsd/brocommon/3.0"
      xmlns:gml="http://www.opengis.net/gml/3.2"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://www.broservices.nl/xsd/isgmn/1.0 https://schema.broservices.nl/xsd/isgmn/1.0/isgmn-messages.xsd"
      >
  <!-- Disclaimer: dit voorbeeldbericht valideert tegen de XSD van de innameservice.
       Het is niet gevalideerd door de innamewebservice en is vaktechnisch/inhoudelijk niet voorbeeldig.
  -->
  <brocom:requestReference>Groningen_12</brocom:requestReference>
  <!--Optional: dataleverancier is niet de bronhouder, dus is het gegeven aanwezig. -->
  <brocom:deliveryAccountableParty>55667372</brocom:deliveryAccountableParty>
  <brocom:broId>GMN123456789012</brocom:broId>
  <brocom:qualityRegime>IMBRO/A</brocom:qualityRegime>
  <!--Optional: niet toegestaan bij GMN.
  <brocom:underPrivilege>ja</brocom:underPrivilege>
  -->
  <correctionReason codeSpace="urn:bro:gmn:CorrectionReason">eigenCorrectie</correctionReason>

Regel 22 bevat de opening tag van het sourceDocument (brondocument).

Regel 23 geeft aan dat GMN_StartRegistration het type is van het brondocument. Het attribuut gml:id bevat een door de dataleverancier aangeleverde waarde die uniek moet zijn binnen dit bericht.

Regel 24 t/m 38 bevat de elementen van de entiteit GroundwaterMonitoringNet (GrondwaterMonitoringNet).

Regel 28 bevat het element groundwaterAspect (grondwateraspect) met daarin de waarde die de momenteel geregistreerde waarde moet vervangen.

  <sourceDocument>
    <GMN_StartRegistration gml:id="id_0001">
      <objectIdAccountableParty>meetnet_07</objectIdAccountableParty>
      <name>Provinciaal meetnet grondwater Groningen; Delfzijl</name>
      <deliveryContext codeSpace="urn:bro:gmn:DeliveryContext">kaderrichtlijnWater</deliveryContext>
      <monitoringPurpose codeSpace="urn:bro:gmn:MonitoringPurpose">strategischBeheerKwaliteitRegionaal</monitoringPurpose>
      <groundwaterAspect codeSpace="urn:bro:gmn:GroundwaterAspect">kwaliteit</groundwaterAspect>
      <startDateMonitoring>
        <!--You have a CHOICE of the next 4 items at this level-->
        <!-- 
        <brocom:date>2021-03-01</brocom:date>
        <brocom:yearMonth>2021-03</brocom:yearMonth>
        <brocom:year>2021</brocom:year>
        <brocom:voidReason>onbekend</brocom:voidReason>
         -->
        <brocom:year>2021</brocom:year>
      </startDateMonitoring>

Regel 39 bevat de closing tag GMN_StartRegistration als type van het sourceDocument (brondocument).

Regel 40 bevat de closing tag van het sourceDocument (brondocument).

Regel 41 bevat de closing tag van het correctionRequest (correctieverzoek).

    </GMN_StartRegistration>
  </sourceDocument>
</replaceRequest>

13replaceRequestStartRegistrationQualityRegime

Het voorbeeldbericht 13replaceRequestStartRegistrationQualityRegime.xml bevat een correctieverzoek, waarmee de waarde voor het qualityRegime (kwaliteitsregime) van een grondwatermonitoringnet wordt vervangen.

Onderstaande figuur toont op hoofdlijnen de structuur van het registratieverzoek en het brondocument.

Merk op dat het brondocument GMN_StartRegistration alle gegevens van de entiteit GroundwaterMonitoringNet (GrondwaterMonitoringNet) bevat, maar niet de lijst met measuringPoints (meetpunten).

Dan volgt hier regel voor regel een beschrijving van het voorbeeldbericht. Zie de onderstaande tabellen met regelnummers en XML-code van de regel.

De eerste regel van het voorbeeldbericht bevat de XML-proloog. Merk op dat de tekens volgens UTF-8 gecodeerd moeten worden. Dit is met name van belang voor speciale tekens, zoals à, á, ï.

Regel 2 t/m 8 bevatten de opening tag van het correctionRequest (correctieverzoek) als root XML-element en de namespaces van de gebruikte XML-schemadefinities (XSD's).

Regel 13 t/m 21 bevatten de transactiegegevens.

Regel 13 bevat de requestReference (verzoekkenmerk), een voor de dataleverancier unieke aanduiding van het BRO-verzoek.

Regel 15 bevat het optionele element deliveryAccountableParty (bronhouder). De waarde is het KvK-nummer van de bronhouder. Dit element is opgenomen in het voorbeeldbericht, omdat in dit voorbeeld de dataleverancier niet de bronhouder is.

Regel 16 bevat de broId (BRO-id) als unieke identificatie van het registratieobject waarvan we de waarde voor het gegeven qualityRegime (kwaliteitsregime) willen corrigeren.

Regel 17 bevat het qualityRegime (kwaliteitsregime) welke waarde de momenteel geregistreerde waarde moet vervangen. Deze waarde is zowel een aanduiding van de kwaliteitseis waaraan de gegevens in het brondocument voldoen, als waaraan de geregistreerde gegevens moeten voldoen na verwerking van dit verzoek.

Regel 21 bevar de correctionReason (correctie reden), met in dit voorbeeldbericht de waarde kwaliteitsRegime, omdat we de waarde voor het gegeven qualityRegime (kwaliteitsregime) willen corrigeren.

<?xml version="1.0" encoding="UTF-8"?>
<replaceRequest
      xmlns="http://www.broservices.nl/xsd/isgmn/1.0"
      xmlns:brocom="http://www.broservices.nl/xsd/brocommon/3.0"
      xmlns:gml="http://www.opengis.net/gml/3.2"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://www.broservices.nl/xsd/isgmn/1.0 https://schema.broservices.nl/xsd/isgmn/1.0/isgmn-messages.xsd"
      >
  <!-- Disclaimer: dit voorbeeldbericht valideert tegen de XSD van de innameservice.
       Het is niet gevalideerd door de innamewebservice en is vaktechnisch/inhoudelijk niet voorbeeldig.
  -->
  <brocom:requestReference>Groningen_13</brocom:requestReference>
  <!--Optional: dataleverancier is niet de bronhouder, dus is het gegeven aanwezig. -->
  <brocom:deliveryAccountableParty>55667372</brocom:deliveryAccountableParty>
  <brocom:broId>GMN123456789012</brocom:broId>
  <brocom:qualityRegime>IMBRO</brocom:qualityRegime>
  <!--Optional: niet toegestaan bij GMN.
  <brocom:underPrivilege>ja</brocom:underPrivilege>
  -->
  <correctionReason codeSpace="urn:bro:gmn:CorrectionReason">kwaliteitsRegime</correctionReason>

Regel 22 bevat de opening tag van het sourceDocument (brondocument).

Regel 23 geeft aan dat GMN_StartRegistration het type is van het brondocument. Het attribuut gml:id bevat een door de dataleverancier aangeleverde waarde die uniek moet zijn binnen dit bericht.

Regel 24 t/m 31 bevatten de elementen van de entiteit GroundwaterMonitoringNet (GrondwaterMonitoringNet).

Regel 32 bevat de closing tag GMN_StartRegistration als type van het sourceDocument (brondocument).

Regel 33 bevat de closing tag van het sourceDocument (brondocument).

Regel 34 bevat de closing tag van het correctionRequest (correctieverzoek).

  <sourceDocument>
    <GMN_StartRegistration gml:id="id_0001">
      <objectIdAccountableParty>meetnet_07</objectIdAccountableParty>
      <name>Provinciaal meetnet grondwater Groningen; Delfzijl</name>
      <deliveryContext codeSpace="urn:bro:gmn:DeliveryContext">kaderrichtlijnWater</deliveryContext>
      <monitoringPurpose codeSpace="urn:bro:gmn:MonitoringPurpose">strategischBeheerKwaliteitRegionaal</monitoringPurpose>
      <groundwaterAspect codeSpace="urn:bro:gmn:GroundwaterAspect">kwantiteit</groundwaterAspect>
      <startDateMonitoring>
        <brocom:date>2021-03-01</brocom:date>
      </startDateMonitoring>
    </GMN_StartRegistration>
  </sourceDocument>
</replaceRequest>

14moveRequestStartRegistration

Het voorbeeldbericht 14moveRequestStartRegistration.xml bevat een correctieverzoek, waarmee de startDateMonitoring (begindatum monitoring) van een grondwatermonitoringnet wordt gecorrigeerd, waardoor het punt op de tijdlijn van de materiële historie wordt verplaatst.

Onderstaande figuur toont op hoofdlijnen de structuur van het registratieverzoek en het brondocument.

Merk op dat het brondocument GMN_StartRegistration twee meetpunten bevat. Van de in de registratie opgenomen meetpunten zal alleen voor deze meetpunten de startDate (startdatum meetpunt) worden aangepast.

Dan volgt hier regel voor regel een beschrijving van het voorbeeldbericht. Zie de onderstaande tabellen met regelnummers en XML-code van de regel.

De eerste regel van het voorbeeldbericht bevat de XML-proloog. Merk op dat de tekens volgens UTF-8 gecodeerd moeten worden. Dit is met name van belang voor speciale tekens, zoals à, á, ï.

Regel 2 t/m 8 bevatten de opening tag van het moveRequest (verplaatsverzoek) als root XML-element en de namespaces van de gebruikte XML-schemadefinities (XSD's).

Regel 13 t/m 21 bevatten de transactiegegevens.

Regel 13 bevat de requestReference (verzoekkenmerk), een voor de dataleverancier unieke aanduiding van het BRO-verzoek.

Regel 15 bevat het optionele element deliveryAccountableParty (bronhouder). De waarde is het KvK-nummer van de bronhouder. Dit element is opgenomen in het voorbeeldbericht, omdat in dit voorbeeld de dataleverancier niet de bronhouder is.

Regel 16 bevat de broId (BRO-id) als unieke identificatie van het registratieobject waarvan we de startDateMonitoring (begindatum monitoring) van het grondwatermonitoringnet en de startDate (startdatum meetpunt) van enkele meetpunten willen corrigeren.

Regel 17 bevat het qualityRegime (kwaliteitsregime) als aanduiding van de kwaliteitseis waaraan de gegevens in het brondocument voldoen.

Regel 21 bevar de correctionReason (correctie reden), met in dit voorbeeldbericht de waarde eigenCorrectie, omdat we de correcties uitvoeren op eigen initiatief, d.w.z. niet naar aanleiding van een terugmelding en in-onderzoek plaatsing.

<?xml version="1.0" encoding="UTF-8"?>
<moveRequest
      xmlns="http://www.broservices.nl/xsd/isgmn/1.0"
      xmlns:brocom="http://www.broservices.nl/xsd/brocommon/3.0"
      xmlns:gml="http://www.opengis.net/gml/3.2"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://www.broservices.nl/xsd/isgmn/1.0 https://schema.broservices.nl/xsd/isgmn/1.0/isgmn-messages.xsd"
      >
  <!-- Disclaimer: dit voorbeeldbericht valideert tegen de XSD van de innameservice.
       Het is niet gevalideerd door de innamewebservice en is vaktechnisch/inhoudelijk niet voorbeeldig.
  -->
  <brocom:requestReference>Groningen_14</brocom:requestReference>
  <!--Optional: dataleverancier is niet de bronhouder, dus is het gegeven aanwezig. -->
  <brocom:deliveryAccountableParty>55667372</brocom:deliveryAccountableParty>
  <brocom:broId>GMN123456789012</brocom:broId>
  <brocom:qualityRegime>IMBRO/A</brocom:qualityRegime>
  <!--Optional: niet toegestaan bij GMN.
  <brocom:underPrivilege>ja</brocom:underPrivilege>
  -->

Regel 22 bevat de opening tag van het sourceDocument (brondocument).

Regel 23 geeft aan dat GMN_StartRegistration het type is van het brondocument. Het attribuut gml:id bevat een door de dataleverancier aangeleverde waarde die uniek moet zijn binnen dit bericht.

Regel 24 t/m 38 bevat de elementen van de entiteit GroundwaterMonitoringNet (GrondwaterMonitoringNet).

Regel 29 t/m 38 bevat de startDateMonitoring (begindatum monitoring) met daarin de waarde die die momenteel geregistreerde waarde gaat vervangen. In het voorbeeldbericht heeft dit de waarde 2021-03-01 (1 maart 2021). Volgens de catalogus kan er naast een volledige datum (jaar, maand, dag) ook sprake zijn van 3 minder nauwkeurige varianten. Regel 32 t/m 35 bevatten als commentaar alle 4 varianten voor 1 maart 2021 met een afnemende nauwkeurigheid.

  <sourceDocument>
    <GMN_StartRegistration gml:id="id_0001">
      <objectIdAccountableParty>meetnet_07</objectIdAccountableParty>
      <name>Provinciaal meetnet grondwater Groningen; Delfzijl</name>
      <deliveryContext codeSpace="urn:bro:gmn:DeliveryContext">kaderrichtlijnWater</deliveryContext>
      <monitoringPurpose codeSpace="urn:bro:gmn:MonitoringPurpose">strategischBeheerKwaliteitRegionaal</monitoringPurpose>
      <groundwaterAspect codeSpace="urn:bro:gmn:GroundwaterAspect">kwaliteit</groundwaterAspect>
      <startDateMonitoring>
        <!--You have a CHOICE of the next 4 items at this level-->
        <!-- 
        <brocom:date>2021-03-01</brocom:date>
        <brocom:yearMonth>2021-03</brocom:yearMonth>
        <brocom:year>2021</brocom:year>
        <brocom:voidReason>onbekend</brocom:voidReason>
        -->
        <brocom:date>2021-03-01</brocom:date>
      </startDateMonitoring>

Vanaf regel 39 volgen één of meer voorkomens van een measuringPoint (meetpunt) waaruit het grondwatermonitoringnet bestaat. Het voorbeeldbericht bevat er 2, maar dat hadden er ook meer of minder kunnen zijn.

Regel 41 geeft aan dat MeasuringPoint (Meetpunt) het type is van het element measuringPoint (meetpunt). Het attribuut gml:id bevat een door de dataleverancier aangeleverde waarde die uniek moet zijn binnen dit bericht.

Regel 42 bevat de measuringPointCode (meetpuntcode) van het meetpunt. Van dit meetpunt wordt de momenteel geregistreerde waarde voor startDate (startdatum meetpunt) vervangen door de waarde van het element startDateMonitoring (begindatum monitoring) in dit brondocument.

Regel 53 bevat idem dito de measuringPointCode (meetpuntcode) van een meetpunt waarvan de startDate (startdatum meetpunt) zal worden aangepast.

      <!-- 1 or more repetitions: -->
      <measuringPoint>
        <MeasuringPoint gml:id="id_0002">
          <measuringPointCode>GMW07F000002</measuringPointCode>
          <monitoringTube>
            <GroundwaterMonitoringTube gml:id="id_0003">
              <broId>GMW123456789002</broId>
              <tubeNumber>3</tubeNumber>
            </GroundwaterMonitoringTube>
          </monitoringTube>
        </MeasuringPoint>
      </measuringPoint>
      <measuringPoint>
        <MeasuringPoint gml:id="id_0004">
          <measuringPointCode>GMW07F000004</measuringPointCode>
          <monitoringTube>
            <GroundwaterMonitoringTube gml:id="id_0005">
              <broId>GMW123456789006</broId>
              <tubeNumber>1</tubeNumber>
            </GroundwaterMonitoringTube>
          </monitoringTube>
        </MeasuringPoint>
      </measuringPoint>

Regel 62 bevat de closing tag GMN_StartRegistration als type van het sourceDocument (brondocument).

Regel 63 bevat de closing tag van het sourceDocument (brondocument).

Regel 64 t/m 73 bevat de dateToBeCorrected (te corrigeren datum). De waarde moet overeenkomen met de momenteel geregistreerde waarde voor startdateMonitoring (startdatum monitoring). In het voorbeeldbericht heeft dit de waarde 2021 (het jaar 2021). Volgens de catalogus kan er naast een jaartal ook sprake zijn van 3 andere varianten. Regel 67 t/m 70 bevatten als commentaar 4 varianten met een grotere of kleinere nauwkeurigheid dan het jaartal 2021.

Regel 74 bevat de closing tag van het moveRequest (verplaatsverzoek).

    </GMN_StartRegistration>
  </sourceDocument>
  <dateToBeCorrected>
    <!--You have a CHOICE of the next 4 items at this level-->
    <!--
    <brocom:date>2021-03-01</brocom:date>
    <brocom:yearMonth>2021-03</brocom:yearMonth>
    <brocom:year>2021</brocom:year>
    <brocom:voidReason>onbekend</brocom:voidReason>
    -->
    <brocom:year>2021</brocom:year>
  </dateToBeCorrected>
</moveRequest>

Code snippets.

Deze paragraaf bevat voor een aantal kleine, bijzondere stukken XML-code uit de voorbeeldberichten een gedetailleerde beschrijving.

De kop van een registrationRequest

De eerste regel van het voorbeeldbericht bevat de XML-proloog. Merk op dat de tekens volgens UTF-8 moeten worden gecodeerd. Dit is met name van belang voor speciale tekens, zoals à, á, ï.

Regel 2 t/m 9 bevatten de opening tag van het registrationRequest (registratieverzoek) als root XML-element en de namespaces van de gebruikte XML-schemadefinities (XSD's). De laatste twee XML-attributen (xmlns:xsi en xsi:schemaLocation) maken het mogelijk om het BRO-verzoek te valideren tegen de XSD-bestanden van de innamewebservice. Deze twee attributen mogen worden weggelaten. Regel 2 mag ook de opening tag van een replaceRequest(vervangverzoek), insertRequest (invoegverzoek), moveRequest (verplaatsverzoek) of deleteRequest (verwijderverzoek) zijn.

Na de disclaimer volgen vier transactiegegevens: requestReference (verzoekkenmerk), deliveryAccountableParty (bronhouder),broId(BRO-ID) en qualityRegime (kwaliteitsregime). Zie hoofdstuk 2 voor nadere informatie. Het attributbroID(BRO-ID) is bij eenregistrationRequest(registratieverzoek) niet toegestaan als hetsourceDocument(brondocument) een GMN_StartRegistrationis. Bij de andere types brondocumenten en bij de correctieverzoeken is dit attribuut verplicht.

Na de transactiegegevens volgt de opening tag van het sourceDocument (brondocument). Daarbinnen volgt het aan te bieden brondocument.

Het BRO-verzoek wordt afgesloten met de closing tags van het sourceDocument (brondocument) en het registrationRequest (registratieverzoek) c.q. het betreffende correctieverzoek.

<?xml version="1.0" encoding="UTF-8"?>
<ns1:registrationRequest 
        xmlns:ns="http://www.broservices.nl/xsd/brocommon/3.0" 
        xmlns:ns1="http://www.broservices.nl/xsd/isgmn/1.0" 
        xmlns:ns2="http://www.opengis.net/gml/3.2" 
        xmlns:xlin="http://www.w3.org/1999/xlink"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://www.broservices.nl/xsd/isgmn/1.0 https://schema.broservices.nl/xsd/isgmn/1.0/isgmn-messages.xsd"
    >
    <!-- Disclaimer: dit voorbeeldbericht valideert tegen de XSD van de innameservice.
         Het is niet gevalideert door de innamewebservice en is vaktechnisch/inhoudelijk niet voorbeeldig.
    -->
    <ns:requestReference>requestReference</ns:requestReference>
    <!--Optional:-->
    <!--ns:deliveryAccountableParty>27376655</ns:deliveryAccountableParty-->
    <!--Optional:-->
    <!--ns:broId>?</ns:broId-->
    <ns:qualityRegime>IMBRO</ns:qualityRegime>
    <!--Optional:-->
    <!--ns:underPrivilege>?</ns:underPrivilege-->
    <ns1:sourceDocument>
        ...
    </ns1:sourceDocument>
</ns1:registrationRequest>

Brondocument

Een BRO-verzoek bevat een brondocument. Een brondocument is de eenheid van aanleveren. De <<GMN>> innamewebservice kent meerdere types brondocumenten. Alle brondocumenten hebben het stereotype FeatureType.

Conform de GML XML encoding rules wordt voor de brondocumenten het property type pattern toegepast. Zie ook de paragraaf Property type pattern 26407089.

Onderstaand stukje XML van een voorbeeldbericht laat zien hoe dat uitpakt. Na de opening tag sourceDocument van het brondocument volgt een regel als tag de naam van het type brondocument, bijvoorbeeld GMN_StartRegistration. Deze regel geeft aan dat in dit bericht dat type brondocument is opgenomen. Het element GMN_StartRegistration is als root element gedefinieerd in het XSD-bestand isgmn-messages.xsd van de GMN innamewebservice. Na deze regel komt het eerste XML element van het brondocument.

Property type pattern

De GMN gegevenscatalogus maakt een onderscheid tussen objecttypes en gegevensgroeptypes. Bij de opstellen van de berichtdefinities worden deze stereotypes vertaald naar FeatureType en AttributeGroupType. Beide kunnen in software omgezet worden naar classes. Beide hebben attributen (attributes), gegevensgroepen (attributeGroups) of associations (relaties) naar andere Featuretypes als onderdelen. De verschillen zijn onder meer dat een Feature identificeerbaar is en dat een AttributeGroup alleen bestaat bij de gratie van het Feature waarvan het, direct of indirect, een onderdeel is.

Conform de GML XML encoding rules leidt ieder FeatureType in een XSD-bestand tot:

• Een complex type, wat de inhoud van het FeatureType definieert en direct of indirect een specialisatie is van gml:AbstractFeatureType.
• Een root element, zodat objecten van het ComplexType geïnstantieerd kunnen worden.
• Een property type ComplexType, wat in de XSD-bestanden gebruikt wordt als het type van een element dat fungeert als realisatie van de associatie relatie naar het FeatureType.

Als gevolg van de eerste bullet krijgt in een XML-bericht ieder XML-element met zo'n complex type als datatype een XML-attribuut gml:id. 

In een XML bericht heeft dit tot gevolg dat, bij bijvoorbeeld het XML-element measuringPoint (meetpunt), na de opening tag een tweede tag volgt, in dit geval MeasuringPoint (Meetpunt) met de naam van het type van het (gerelateerde) FeatureType (Objecttype) en een XML-attribuut gml:id. Daarna volgt de reeks van XML-elementen van het (gerelateerde) FeatureType (Objecttype), afgesloten met de closing tag van het (gerelateerde) FeatureType (Objecttype) en de closing tag van, in dit voorbeeld, het XML-element measuringPoint (meetpunt). Daardoor is voor een ontvangend systeem eenduidige bekend is hoe de inhoud geparsed moet worden. Voorbeeld:

    <ns1:measuringPoint>
        <ns1:MeasuringPoint ns2:id="id_0002">
            ...
        </ns1:MeasuringPoint>
    </ns1:measuringPoint>

gml:id

Conform de GML XML encoding rules krijgt ieder ieder XML-element, waarvan het datatype een specialisatie is van gml:AbstractFeatureType, een XML-attribuut gml:id.

De waarde van deze gml:id moet uniek zijn binnen het BRO-verzoek. In de voorbeeldberichten is dit gedaan met een waarde die begint met 'id_', gevolgd door een volgnummer.

Het BRO-systeem negeert het XML-attribuut gml:id en slaat de waarde ervan niet op.

Voorbeeld:

    <GMN_StartRegistration gml:id="id_0001">

Waarde uit een codelijst

Zie Codelist (Codelijst) voor een algemene beschrijving van het gebruik van codelijsten in de BRO.

Datum en DatumTijd

De waarde van een XML-element met als type een xs:Date (Datum) wordt gecodeeerd volgens de ISO-8601 standaard: yyyy-mm-dd. Bijvoorbeeld:

De waarde van een XML-element met als type een  xs:DateTime  (Datum) wordt ook gecodeeerd volgens de ISO-8601 standaard: yyyy-mm-ddThh:mm:ss+hh:mm. Daarbij is de tijdzone (+hh:mm) verplicht. De uren en minuten na het plus teken is de tijdzone ten opzichte van UTC (aka GMT). In theorie kan dit ook een min teken zijn (tijdzones ten westen van Greenwich), maar voor Nederland is de tijdzone + 1 uur (wintertijd) of + 2 uur (zomertijd). In het voorbeeld is de lokale tijd 09:01:52, terwijl het 'in Londen' 08:01:52 is. Bijvoorbeeld:

PartialDate

In de gegevenscatalogus hebben diverse gegevens een Datum onder kwaliteitsregime IMBRO en een OnvolledigeDatum onder IMBRO/A. In de XSD-bestanden is de OnvolledigeDatum gerealiseerd door het complexType PartialDateType. Deze ondersteunt 4 mogelijkheden met afnemende nauwkeurigheid:

• date (volledige datum)
• yearMonth (datum en jaartal)
• year (jaartal)
• voidReason (de vaste waarde 'onbekend').

Bijvoorbeeld:

Bij een PartialDate (OnvolledigeDatum) geldt dat binnen hetzelfde jaar (of jaar en maand) een minder volledige datum voorafgaat aan een meer volledige datum:

• het jaartal 2015 voor de datum en jaartal juli 2015
• de datum en jaartal juli 2015  gaat voor de volledige datum 17 juli 2015.

In het algemeen kan een datum met de waarde 'onbekend' niet worden vergeleken met een andere datum. Daarom wordt bij het toepassen van een regel, waarin twee datums met elkaar worden vergeleken waarvan één (of beide) de waarde 'onbekend' heeft, de bedrijfsregel genegeerd.

Uitzondering is het sorteren van gebeurtenissen op een tijdlijn. Daarbij wordt op basis van de betekenis van de gebeurtenis een begin/inrichten/start gebeurtenis altijd vooraan in de lijst met gebeurtenissen geplaatst, ook als de datum van de gebeurtenis de waarde 'onbekend' heeft. En wordt een eind/opruimen/voltooien gebeurtenis altijd achteraan in de lijst met gebeurtenissen geplaatst, ook als de datum van de gebeurtenis de waarde 'onbekend' heeft. Opdat een lijst met gebeurtenissen eenduidig kan worden gesorteerd, mag bij andere gebeurtenissen de datum van de gebeurtenis niet de waarde 'onbekend' hebben. Dit wordt expliciet als aanvullende regel vermeld bij de betreffende brondocumenten.