GMN BCI BRO-Verzoeken
BRO-Verzoeken
Om gegevens te registreren in de Landelijke Voorziening BRO (LV BRO) moet u deze aanleveren bij het Bronhouderportaal in de vorm van een BRO-verzoek (zie basisregistratieondergrond.nl).
Vervolgens is het BRO-verzoek het bestand in IMBRO/XML-formaat dat het BRO-brondocument bevat en als verzoek wordt aangeboden in het Bronhouderportaal.
De GMN innamewebservice ondersteunt drie requests (verzoeken). Zie onderstaande tabel (het insertRequest (invoegverzoek) en het deleteRequest (verwijderverzoek) zijn op dit moment nog buiten scope).
Naam in XML-bestand | Nederlandse naam | Doel |
|---|---|---|
| registrationRequest | registratieverzoek | Nieuwe gegevens aanbieden bij de BRO door een registratie te starten, aan te vullen of te beëindigen. |
| replaceRequest | vervangverzoek | Vervangen van een eerder aangeleverd brondocument op een bepaald punt op de tijdlijn bij een registratieobject met materiële geschiedenis. |
| insertRequest | invoegverzoek | Invoegen van een brondocument op de tijdlijn bij een registratieobject met materiële geschiedenis. |
| moveRequest | verplaatsverzoek | Verplaatsen van een brondocument op de tijdlijn (wijzigen van de datum van een gebeurtenis) bij een registratieobject met materiële geschiedenis. |
| deleteRequest | verwijderverzoek | Verwijderen van een brondocument uit de tijdlijn bij een registratieobject met materiële geschiedenis. |
De volgende paragrafen beschrijven in detail de opbouw van de diverse BRO-verzoeken.
RegistrationRequest
Met dit verzoek kan een bronhouder en/of dataleverancier nieuwe gegevens overdragen aan de BRO (registreren). Afhankelijk van het brondocument kan het gaan om:
- Het starten van de registratie, waarbij de initiële waarden van gegevens die op dat moment beschikbaar zijn worden aangeboden.
- Het aanvullen van de registratie, waarbij er materiële geschiedenis opgebouwd:
- Door nieuwe gegevens toe te voegen.
- Door voor bestaande gegevens een nieuwe waarde toe te voegen .
- Het beëindigen van de registratie (voltooien van de registratie). Vanaf dat moment kan de registratie niet meer worden aangevuld. Geregistreerde gegevens kunnen nog wel gecorrigeerd worden (zie paragraaf 2.2.2 t/m 2.2.5).
De gegevens worden aangeboden met één van de gedefinieerde brondocumenten. Zie paragraaf Brondocumenten. De aangeboden gegevens worden opgenomen in de BRO registratie. Bij het aanvullen of beëindigen van de registratie moeten de gebeurtenissen in chronologische volgorde van eventDate (datum gebeurtenis) worden aangeleverd. Zie paragraaf 2.1 26405843 voor een nadere toelichting.
De inhoud van een registrationRequest (innameverzoek) wordt gedefinieerd door het type RegistrationRequest. Zie onderstaande figuur. De inhoud bestaat uit enkele transactiegegevens en een sourceDocument (brondocument). Het type SourceDocument komt aan de orde in paragraaf Brondocumenten.
De definities van de transactiegegevens staan in onderstaande tabel:
Naam in XML-bestand | Nederlandse naam | Type | Kardinaliteit | Definitie |
|---|---|---|---|---|
| requestReference | verzoekkenmerk | CharacterString | 1..1 | Een voor de dataleverancier unieke aanduiding van het innameverzoek. |
| deliveryAccountableParty | bronhouder | ChamberOfCommerceNumber | 0..1 | Het KvK-nummer van de bronhouder. Regels: Dit element moet aanwezig zijn als de dataleverancier niet de bronhouder is. |
| broId | BRO-ID | RegistrationObjectCode | 0..1 | De unieke aanduiding van een registratieobject, dat is opgenomen in de BRO. Regels: Dit element moet aanwezig zijn bij het aanvullen of beëindigen van de registratie, met andere woorden in combinatie met het brondocument GMN_MeasuringPoint, GMN_MeasuringPointEndDate, GMN_TubeReference, of GMN_Closure. In de BRO moet een registratieobject met een broId gelijk aan deze waarde aanwezig zijn, als dit element aanwezig is. |
| qualityRegime | kwaliteitsregime | QualityRegime | 1..1 | De aanduiding van het kwaliteitsregime waaraan de gegevens in het brondocument voldoen. Regels: De waarde IMBRO/A is bij het aanvullen of beëindigen van een registratie alleen toegestaan als de registratie is gestart met een kwaliteitsregime IMBRO/A. Toelichting: |
| underPrivilege | onder voorrecht | IndicationYesNo | 0..1 | Regels: |
| sourceDocument | brondocument | SourceDocument | 1..1 | Dit element bevat één van de gedefinieerde brondocumenten (zie paragraaf Brondocumenten). Regels: Toelichting: De gegevens in het brondocument zijn gespecificeerd in de gegevenscatalogus. Zie paragraaf Brondocumenten voor nadere informatie. |
ReplaceRequest
Met dit verzoek kan een bronhouder en/of dataleverancier onjuiste gegevens in de BRO op een bepaald punt op de tijdlijn vervangen door de juiste gegevens. De juiste gegevens worden aangeboden met één van de brondocumenten, zoals gedefinieerd in de Berichtencatalogus innamewebservice van het betreffende registratieobject; zie de paragraaf Samenhang met andere documentatie voor nadere informatie. Het aangeboden brondocument vervangt het momenteel geregistreerde brondocument.
Het is niet mogelijk de waarde van een individueel gegeven te corrigeren. Immers, de eenheid van aanleveren is een brondocument.
Met dit verzoek is het niet mogelijk de identificerende gegevens te corrigeren.
Met dit verzoek is niet mogelijk de datum van de gebeurtenis te corrigeren (de gebeurtenis te verplaatsen op de tijdlijn).
Vervangen is een correctie die op geen enkele wijze iets verandert in de tijdlijn van een registratieobject. De dataleverancier dient een vervangverzoek in wanneer er eerder een brondocument is aangeleverd met daarin de goede datum van de gebeurtenis, maar met fouten in een of meer van de andere gegevens. Alle gebeurtenissen zijn in de juiste volgorde en met de juiste datum geregistreerd. Bij het verwerken van een vervangverzoek wordt er formele geschiedenis opgebouwd. Zie voor nadere toelichting de inleiding in de gegevenscatalogus.
Onderstaande figuur geeft weer dat de (waarden van) gegevens op het punt T2 op de tijdlijn worden vervangen.
De inhoud van een replaceRequest (vervangverzoek) wordt gedefinieerd door het type CorrectionRequest. Zie onderstaande figuur. De inhoud bestaat uit enkele transactiegegevens, een correctionReason (correctie reden) en een sourceDocument (brondocument).
De definities van de transactiegegevens staan in onderstaande tabel:
Naam in XML-bestand | Nederlandse naam | Type | Kardinaliteit | Definitie |
|---|---|---|---|---|
| requestReference | verzoekkenmerk | CharacterString | 1..1 | Een voor de dataleverancier unieke aanduiding van het innameverzoek. |
| deliveryAccountableParty | bronhouder | ChamberOfCommerceNumber | 0..1 | Het KvK-nummer van de bronhouder. Regels: Dit element moet aanwezig zijn als de dataleverancier niet de bronhouder is. |
| broId | BRO-ID | RegistrationObjectCode | 1..1 | De unieke aanduiding van een registratieobject, dat is opgenomen in de BRO. Regels: In de BRO moet een registratieobject aanwezig zijn met deze waarde voor broId. |
| qualityRegime | kwaliteitsregime | QualityRegime | 1..1 | De aanduiding van het kwaliteitsregime waaraan de gegevens in het brondocument voldoen. Regels: Toelichting: |
| underPrivilege | onder voorrecht | IndicationYesNo | 0..1 | Regels: Dit gegeven mag niet aanwezig zijn bij een GMN BRO-verzoek. |
| correctionReason | correctie reden | CorrectionReason | 1..1 | Aanduiding voor de reden waarom het registratieobject wordt vervangen/ingevoegd/verplaatst/verwijderd. Regels: |
| sourceDocument | brondocument | SourceDocument | 1..1 | Dit element bevat één van de gedefinieerde brondocumenten, met uitzondering van het GMN_WithHistory (GMN-MetGeschiedenis) brondocument. Regels: Toelichting: De gegevens in het brondocument zijn gespecificeerd in de gegevenscatalogus. Zie paragraaf Brondocumenten voor nadere informatie. |
InsertRequest
Met dit verzoek kan een bronhouder en/of dataleverancier de materiële geschiedenis corrigeren door het invoegen van een gebeurtenis op de tijdlijn. Het kan daarbij gaan om het invoegen van nieuwe gegevens op een bepaalde datum, of om het invoegen van nieuwe waarden voor bestaande gegevens op een bepaalde datum. In beide gevallen ligt de bepaalde datum vóór de datum van de meest recente, geregistreerde gebeurtenis.
Invoegen is een correctieverzoek dat ingrijpt in de materiële geschiedenis van een registratieobject. Het gaat om de eenvoudigste variant, namelijk de situatie waarin de dataleverancier vergeten was een gebeurtenis te registreren terwijl er ondertussen een andere gebeurtenis is geregistreerd.
De tussen te voegen (waarden van) gegevens worden aangeboden met één van de brondocumenten, zoals gedefinieerd in de Berichtencatalogus innamewebservice van het betreffende registratieobject; zie de paragraaf Samenhang met andere documentatie voor nadere informatie.
Het is niet mogelijk de waarde van een individueel gegeven tussen te voegen. Immers, de eenheid van aanleveren is een brondocument.
De tussen te voegen (waarden van) gegevens zijn geldig vanaf de datum gebeurtenis opgenomen in het brondocument tot en met de datum van de chronologisch eerstvolgende gebeurtenis, waarin hetzelfde feature (object) met dezelfde identificerende gegevens voorkomt. De (waarden van) gegevens van het feature (object) met dezelfde identificerende gegevens, dat voorkomt in een chronologisch voorafgaande gebeurtenis, verliezen hun geldigheid vanaf de datum gebeurtenis opgenomen in het brondocument.
Onderstaande figuur geeft weer dat nieuwe (waarden voor) gegevens worden ingevoegd op het punt T3 van de tijdlijn tussen de punten T2 en Tn.
De tussen te voegen gegevens (of waarden) worden aangeboden met één van de gedefinieerde brondocumenten. Zie paragraaf Brondocumenten. Het is niet mogelijk de waarde van een individueel gegeven tussen te voegen.
De tussen te voegen (waarde van de) gegevens zijn geldig vanaf het moment dat in het brondocument is opgenomen tot en met het moment van de chronologisch eerstvolgende tussentijdse gebeurtenis, waarin hetzelfde feature (object) met dezelfde identificerende gegevens voorkomt. De (waarde van de) gegevens van het feature (object) met dezelfde identificerende gegevens, dat voorkomt in een chronologisch voorafgaande tussentijdse gebeurtenis, verliezen hun geldigheid vanaf het moment dat in het brondocument is opgenomen.
De inhoud van een insertRequest (invoegverzoek) wordt gedefinieerd door het type CorrectionRequest. Zie paragraaf 26405843. Aanvullende regels staan beschreven bij de brondocumenten; zie paragraaf Brondocumenten.
MoveRequest
Met dit verzoek kunnen gegevens worden verplaatst op de tijdlijn.
Verplaatsen is een correctie die ingrijpt in de materiële geschiedenis van een registratieobject. Het gaat om de situatie waarin de dataleverancier de juiste gegevens heeft aangeleverd maar met de verkeerde datum voor de gebeurtenis. Om de fout te herstellen, levert de dataleverancier het brondocument nogmaals aan maar nu met de juiste datum erin en met het verzoek de gegevens te verplaatsen. Om aan te geven over welke gebeurtenis het precies gaat geeft hij de onjuiste datum mee in het attribuut dateToBeCorrected (te corrigeren datum) van de transactiegegevens van het moveRequest.
De te verplaatsen gegevens, inclusief de gewenste nieuwe datum van de gebeurtenis, worden aangeboden met één van de brondocumenten, zoals gedefinieerd in de Berichtencatalogus innamewebservice van het betreffende registratieobject; zie de paragraaf Samenhang met andere documentatie voor nadere informatie.
Het is niet mogelijk de begingeldigheid van een individueel gegeven te verplaatsen in de tijd. Immers, de eenheid van aanleveren is een brondocument.
Onderstaande figuur geeft weer dat de begingeldigheid van de (waarden van) gegevens op het punt T2 op de tijdlijn wordt verschoven naar T2'. Merk op dat de eindgeldigheid van de (waarden van) gegevens, die op T2 gewijzigd werden, nu een eindgeldigheid T2' hebben. De gecorrigeerde datum T2' mag niet liggen voor T0 (de datum waarmee de registratie wordt gestart). De gecorrigeerde datum T2' mag niet liggen na Te (de datum waarmee de registratie wordt beëindigd).
Met een moveRequest (verplaatsverzoek) kan de dataleverancier de materiële geschiedenis corrigeren door een gebeurtenis te verplaatsen op de tijdlijn (wijzigen van de datum van een gebeurtenis). De te verplaatsen gegevens, inclusief de gewenste nieuwe datum van de gebeurtenis, worden aangeboden met één van de gedefinieerde brondocumenten. Zie paragraaf Brondocumenten. De huidige, onjuiste datum van de gebeurtenis moet ook aangeboden worden, als één van de transactiegegevens van het BRO-verzoek.
De inhoud van een moveRequest (verplaatsverzoek) wordt gedefinieerd door het type MoveRequest. Zie onderstaande figuur.
De definities van het transactiegegeven dateToBeCorrected staat in onderstaande tabel. De definities van de overige gegevens zijn al beschreven in paragraaf 26405843.
Naam in XML-bestand | Nederlandse naam | Type | Kardinaliteit | Definitie |
|---|---|---|---|---|
| dateToBeCorrected | te corrigeren datum | PartialDate | 1..1 | De (mogelijkerwijs onvolledige) datum gebeurtenis van de geregistreerde gegevens die vervangen moet worden. Regels: De waarde moet een volledige datum zijn als de waarde van het attribuut qualityRegime (kwaliteitsregime) gelijk is aan IMBRO. Toelichting: |
DeleteRequest
Met dit verzoek kan een bronhouder en/of dataleverancier gegevens verwijderen uit de tijdlijn, omdat de dataleverancier een gebeurtenis heeft geregistreerd die nooit heeft plaatsgevonden (voor dit registratieobject).
Verwijderen is een correctie die ingrijpt in de materiële geschiedenis van een registratieobject. Het gaat om de situatie waarin de dataleverancier ten onrechte een brondocument heeft aangeleverd. Om de fout te herstellen, levert de dataleverancier het eerder aangeleverde brondocument nogmaals aan maar nu met het verzoek de gegevens die erin staan uit de registratie te verwijderen.
Met een deleteRequest (verwijderverzoek) kan de dataleverancier de materiële geschiedenis corrigeren door een gebeurtenis te verwijderen van de tijdlijn (verwijderen van gegevens op een bepaalde datum). De te verwijderen gegevens worden aangeboden met één van de brondocumenten, zoals gedefinieerd in de Berichtencatalogus innamewebservice van het betreffende registratieobject; zie de paragraaf Samenhang met andere documentatie voor nadere informatie.
Het is niet mogelijk de waarde van een individueel gegeven te verwijderen. Immers, de eenheid van aanleveren is een brondocument.
Onderstaande figuur geeft weer dat de (waarden voor) gegevens op het punt T3 op de tijdlijn worden verwijderd. Merk op dat dit complexe gevolgen heeft voor de begingeldigheid en de eindgeldigheid van de (waarden van) gegevens (hoogstwaarschijnlijk T1 en Tn, maar misschien T0 .. Te).
Met een deleteRequest (verwijderverzoek) kan de dataleverancier de materiële geschiedenis corrigeren door een gebeurtenis te verwijderen van de tijdlijn (verwijderen van gegevens op een bepaalde datum). De te verwijderen gegevens worden aangeboden met één van de gedefinieerde brondocumenten. Zie paragraaf Brondocumenten. Het is niet mogelijk de waarde van een individueel gegeven te verwijderen.
De inhoud van een deleteRequest (verwijderverzoek) wordt gedefinieerd door het type CorrectionRequest. Aanvullende regels staan beschreven bij de brondocumenten; zie paragraaf Brondocumenten.