EPC Berichtencatalogus uitgiftewebservice
Dit document beschrijft het afnemen van gegevens van een mijnbouwconstructie (EPC). De inhoud zal definitief gemaakt worden nadat de EPC innameservices zijn gerealiseerd. Op 1 juli 2022 gaat EPC in productie.
Inleiding
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).
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 Mijnbouwconstructie (EPC) op te vragen en wat is de structuur van de diverse uitgiftedocumenten?
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).
Samenhang met andere documentatie
De informatievoorziening over de afname van BRO-gegevens vindt plaats op 3 niveaus.
- Het startpunt met algemene informatie over de diverse uitgiftekanalen is het document Handreiking Afname BRO Gegevens. Dit document verwijst door naar het volgende niveau.
- Het tweede niveau bevat algemene informatie per uitgiftekanaal (zie https://basisregistratieondergrond.nl/inhoud-bro/aanleveren-opvragen/gegevens-opvragen/):
- 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
- 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/
- 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 EPC-specifieke informatie in de BRO productomgeving, waaronder de EPC gegevenscatalogus en eventuele werkafspraken en in het bijzonder dit document, de EPC berichtencatalogus uitgiftewebservice.
Leeswijzer
Hoofdstuk 2 beschrijft de algemene werking van de EPC 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.
Versiehistorie
Versie | Datum | Omschrijving |
---|---|---|
1.0 | 08-11-2021 | Eerste versie. |
Contactinformatie
Algemene informatie en documentatie over de BRO kunt u vinden op https://basisregistratieondergrond.nl/.
Heeft u een vraag over de BRO? Wij staan voor u klaar om u te helpen. Voor vragen, suggesties of opmerkingen kunt contact opnemen met de BRO Servicedesk via een mail naar support@broservicedesk.nl.
Als u toegang heeft tot de BRO Selfservicedesk via http://topdeskbro.gdnnet.lan/ kunt u daar inloggen en uw vraag stellen voor een extra snelle afhandeling.
Of bel ons op telefoonnummer 088 - 8664 999. Wij zijn bereikbaar op werkdagen van 8.00 tot 17.00 uur.
Algemene werking van de EPC uitgiftewebservice
Dit hoofdstuk beschrijft de algemene werking van de EPC uitgiftewebservice.
Paragraaf 2.1 beschrijft de operaties die de EPC uitgiftewebservice ondersteunt.
Paragraaf 2.2 beschrijft de BRO-berichten (request en response) die een rol spelen bij die operaties.
Operaties
De EPC 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/dsepc-v1.0.wsdl
De EPC 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 ieder 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.
BRO-berichten
Deze paragraaf beschrijft de vier verschillende BRO-berichten (requests en responses) die een rol spelen in de EPC uitgiftewebservice.
DispatchCharacteristicsRequest
Het BRO-bericht DispatchCharacteristicsRequest bevat het uitgifteverzoek tot het leveren van de in het BRO-register opgenomen kengegevens van de EPC registratieobjecten die voldoen aan bepaalde kenmerken. Het DispatchCharacteristicsRequest (Verzoek tot uitgifte van kengegevens) van de EPC uitgiftewebservice is een specialisatie van AbstractDispatchCharacteristicsRequest in de package brocommon, waaraan het het attribuut criteria (kenmerken) toevoegt met de EPC specifieke kenmerken.
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 afnemer unieke aanduiding van het uitgifteverzoek. |
criteria | kenmerken | EPC_CriteriaSet | 1..1 | De afzonderlijke kenmerken waaraan de registratieobjecten moeten voldoen. Toelichting: |
De criteria (kenmerken) worden gedefinieerd door het type EPC_CriteriaSet van de EPC uitgiftewebservice. De EPC_CriteriaSet (kenmerkenverzameling) is een specialisatie van CriteriaSet uit package brommon, waaraan het een aantal optionele attributen toevoegt.
De definities van de attributen van de CriteriaSet uit brocommon staan in onderstaande tabel:
Naam in XML-bestand | Nederlandse naam | Type | Kardinaliteit | Definitie |
---|---|---|---|---|
deliveryAccountableParty | bronhouder | CharacterString | 0..1 | Het KvK-nummer van de maatschappelijke activiteit van de publiekrechtelijke rechtspersoon die bronhouder is van de gegevens in de basisregistratie ondergrond. |
qualityRegime | kwaliteitsregime | Enumeration | 0..1 | De aanduiding van de kwaliteitseis waaraan de gegevens van het registratieobject moeten voldoen. |
registrationPeriod | periode van registreren | DatePeriod | 0..1 | Het datuminterval waarbinnen de datum van het tijdstip registratie van het registratieobject moet liggen. |
correctionPeriod | periode van corrigeren | DatePeriod | 0..1 | Het datuminterval waarbinnen het laatste correctietijdstip van het registratieobject moet liggen. |
underReview | in onderzoek | IndicationYesNo | 0..1 | De aanduiding die aangeeft of het registratieobject door de registerbeheerder in onderzoek moet zijn genomen of niet. |
area | begrenzing | CharacterString | 1 | De begrenzing van een geografisch gebied aan het aardoppervlak, in de vorm van een rechthoek of een cirkel, waarbinnen het registratieobject moet liggen. |
De definities van de attributen, die EPC_CriteriaSet uit dsepc-messages.xsd toevoegt aan CriteriaSet uit brocommon, staan in onderstaande tabel:
Naam in XML-bestand | Nederlandse naam | Type | Kardinaliteit | Definitie |
---|---|---|---|---|
miningConstructionKind | soort mijnbouwconstructie | MiningConstructionKind | 0..1 | Het soort mijnbouwconstructie. |
operationalAreaFilter | filter gemijnd gebied | OperationalAreaFilter | 0..1 | De locatie of contour, geprojecteerd op het aardoppervlak, van het operationele gebied van de mijnbouwconstructie. |
legalStatus | wettelijke status | LegalStatus | 0..1 | De status van een mijnbouwconstructie op basis van de mijnbouwwetgeving. |
purpose | boringdoel | MiningActivity | 0..1 | Het oorspronkelijke doel waarvoor het boortraject is aangelegd. |
drillingStartDate | startdatum aanleg | Date | 0..1 | De datum waarop het boren van het boortraject is begonnen. |
drillingEnddate | einddatum aanleg | Date | 0..1 | De datum waarop de aanleg van het boortraject is beëindigd. |
explorationProductionLicence | mijnbouwwetvergunning | Registratieobjectcode | 0..1 | De identificatie van een mijnbouwwetvergunning in de registratie ondergrond. |
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 EPC 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 en uit dsepc) staan in onderstaande tabel:
Naam in XML-bestand | Nederlandse naam | Type | Kardinaliteit | Definitie |
---|---|---|---|---|
requestReference | verzoekkenmerk | CharacterString | 1..1 | Een voor de afnemer unieke aanduiding van het uitgifteverzoek. |
broId | BRO-ID | RegistrationObjectCode | 1..1 | De unieke aanduiding van het registratieobject in de Basisregistratie Ondergrond. Toelichting: |
dataToBeDelivered | te leveren gegevens | DataToBeDelivered | 1 | Aanduiding welke gegevens over het registratieobject worden opgevraagd: alleen de actuele gegevens of de volledige materiële geschiedenis. |
Het gegeven dataToBeDelivered (te leveren gegevens) geeft aan welke gegevens over het registratieobject worden opgevraagd. Zie onderstaande tabel voor de lijst met toegestane waarden en hun betekenis:
Waarde | Omschrijving |
---|---|
actueel | Alleen de actuele gegevens (present object data) worden opgevraagd. |
actueelHistorisch | De actuele en historische gegevens (past and present object data) worden opgevraagd. |
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:
Naam in XML-bestand | Nederlandse naam | Type | Kardinaliteit | Definitie |
---|---|---|---|---|
faultcode | foutcode | CharacterString | 1..1 | Aanduiding waar de fout is opgetreden. Toelichting: |
faultstring | fouttekst | CharacterString | 1..1 | Summiere beschrijving van de fout. Toelichting: |
detail | details | AnyType | 0..1 | Aanvullende informatie over de opgetreden fout en de vermoedelijke oorzaak. Toelichting: |
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:
Naam in XML-bestand | Nederlandse naam | Type | Kardinaliteit | Definitie |
---|---|---|---|---|
faultcode | foutcode | CharacterString | 1..1 | Aanduiding waar de fout is opgetreden. Toelichting: |
faultstring | fouttekst | CharacterString | 1..1 | Summiere beschrijving van de fout. Toelichting: |
detail | details | ParseFault | 0..1 | Aanvullende informatie over de opgetreden fout en de vermoedelijke oorzaak. Regel: |
De ParseFault (Validatiefout) bestaat uit drie gegevens en een lijst met abortReasons. De definities van de gegevens van ParseFault (Validatiefout) staan in onderstaande tabel:
Naam in XML-bestand | Nederlandse naam | Type | Kardinaliteit | Definitie |
---|---|---|---|---|
requestReference | verzoekkenmerk | CharacterString | 0..1 | Een voor de dataleverancier unieke aanduiding van het uitgifteverzoek. Toelichting: |
transactionId | transactiecode | CharacterString | 0..1 | Een voor het BRO-systeem unieke aanduiding voor de verwerking van een innameverzoek of uitgifteverzoek. Toelichting: |
abortTime | moment van afbreken | DateTime | 1..1 | Tijdstip, toegekend door de webservice, waarop de verwerking van het uitgifteverzoek is afgebroken. |
abortReason | reden afbreken | AbortReason | 1..* | Lijst met redenen waarom de verwerking van het uitgifteverzoek is afgebroken. Toelichting: |
Iedere AbortReason (Reden afbreken) bestaat uit twee gegevens. De definities staan in onderstaande tabel:
Naam in XML-bestand | Nederlandse naam | Type | Kardinaliteit | Definitie |
---|---|---|---|---|
sequenceNumber | volgnummer | Integer | 1..1 | Een binnen deze lijst van abortReasons (redenen afbreken) uniek nummer. Toelichting: |
specification | foutmelding | CharacterString | 1..1 | Omschrijving van de validatie fout. |
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 dsepc-messages.xsd. Het is een specialisatie van DispatchResponse zoals gedefinieerd in brocommon.xsd. Het voegt daaraan toe het attribuut numberOfDocuments (aantal documenten) en een 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.
Gegeven | Afwijzing | Verzending |
---|---|---|
responseType | √ | √ |
requestReference | √ | √ |
rejectionTime | √ | |
dispatchTime | √ | |
rejectionReason | √ | |
criterionError | √ | |
dispatchDocument | √ |
Onderstaande tabel bevat de definities van de gegevens van de DispatchResponse:
Naam in XML-bestand | Nederlandse naam | Type | Kardinaliteit | Definitie |
---|---|---|---|---|
responseType | type antwoord | ResponseType | 1..1 | Aanduiding van de betekenis van het antwoord. Regels: Als het BRO-systeem het uitgifteverzoek succesvol heeft verwerkt, dan heeft het attribuutde waarde dispatch. |
requestReference | verzoekkenmerk | CharacterString | 1..1 | Een voor de afnemer unieke aanduiding van het uitgifteverzoek. Toelichting: |
rejectionTime | tijdstip van afwijzing | DateTime | 0..1 | Tijdstip, toegekend door de webservice, waarop het uitgifteverzoek is afgewezen. Regels: |
dispatchTime | tijdstip van uitgifte | DateTime | 0..1 | Tijdstip, toegekend door de webservice, waarop de opgevraagde gegevens zijn verzonden. Regels: |
rejectionReason | reden afwijzing | CharacterString | 0..1 | De reden waarom het uitgifteverzoek is afgewezen. Regels: Als dit antwoord wordt gegeven naar aanleiding van een dispatchCharacteristicsRequest (verzoek tot uitgifte van kengegevens) en de uitgiftewebservice heeft een of meer fouten geconstateerd in het uitgifteverzoek, dan heeft dit gegeven de vaste waarde "Er zijn 1 of meer fouten geconstateerd in de kenmerken". Als dit antwoord wordt gegeven naar aanleiding van een dispatchDataRequest (verzoek tot uitgifte van objectgegevens) en de uitgiftewebservice heeft geen registratieobject gevonden met de broId in het uitgifteverzoek, dan heeft dit gegeven de vaste waarde "Dit registratieobject bestaat niet". |
criterionError | kenmerkfout | CriterionError | 0..* | Lijst met foutmeldingen met betrekking tot een geconstateerde fout in de kenmerken van een uitgifteverzoek, bestaande uit een volgnummer en een omschrijving. Regels: Toelichting: |
Onderstaande tabel bevat de definities van de gegevens die DispatchCharacteristicsResponse uit dsepc-messages.xsd toevoegt aan DispatchResponse uit brocommon:
Naam in XML-bestand | Nederlandse naam | Type | Kardinaliteit | Definitie |
---|---|---|---|---|
numberOfDocuments | aantal uitgiftedocumenten | Integer | 0..1 | Het aantal registratieobjecten dat voldoet aan de criteria (kenmerken) in het uitgifteverzoek. Regels: |
dispatchDocument | uitgiftedocument | AbstractRegistrationObject | 0..* | Deze lijst van uitgiftedocumenten bevat de kengegevens van de registratieobjecten die voldoen aan de criteria (kenmerken) in het uitgifteverzoek. Regels: Een uitgiftedocument in de lijst is van het type BRO_DO als het betreffende registratieobject uit registratie is genomen. Een uitgiftedocument in de lijst is van het type EPC_C als het betreffende registratieobject niet uit registratie is genomen. Toelichting: |
De lijst met dispatchDocuments (uitgiftedocumenten) is leeg als er geen registratieobjecten zijn gevonden die voldoen aan de criteria (kenmerken) in het dispatchCharacteristicsRequest (verzoek tot levering kengegevens).
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 dsepc:EPC_C, met daarin de kengegevens van een mijnbouwconstructie dat niet uit registratie is genomen,
- óf van het type brocom:BRO_DO, met daarin de kengegevens van een registratieobject dat uit registratie is genomen.
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 EPC_C uit dsepc-messages.xsd is een specialisatie van AbstractCharacteristics in de package brocommon, wat op zijn beurt een specialisatie is van AbstractRegistrationObject.
- Het attribuut explorationLicenceAmount (aantal mijnbouwwetvergunningen) wordt gevuld met het aantal aan het registratieobject gerelateerde mijnbouwwetvergunningen.
- Het attribuut miningMapsAmount (aantal mijnkaarten) wordt gevuld met het aantal mijnkaarten waarop het mijnstelsel is weergegeven.
- Het attribuut miningConstructionKind (soort mijnbouwconstructie) wordt gevuld met het naam van het subtype van het registratieobject.
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 dsepc-messages.xsd. Het is een specialisatie van DispatchResponse zoals gedefinieerd in brocommon.xsd. Het voegt daaraan toe één optionele lijst met dispatchDocuments.
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.
Gegeven | Afwijzing | Verzending |
---|---|---|
responseType | √ | √ |
requestReference | √ | √ |
rejectionTime | √ | |
dispatchTime | √ | |
rejectionReason | √ | |
criterionError | ||
dispatchDocument | √ |
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 dsepc-messages.xsd toevoegt aan DispatchResponse uit brocommon:
Naam in XML-bestand | Nederlandse naam | Type | Kardinaliteit | Definitie |
---|---|---|---|---|
dispatchDocument | uitgiftedocument | AbstractRegistrationObject | 0..* | Het element dispatchDocument bevat de gegevens van een EPC mijnbouwconstructie registratieobject. Regels: Het element dispatchDocument is afwezig als de BRO geen registratieobject bevat met het opgegegeven broId. Het element dispatchDocument is van het type EPC_PO_DP of van het type EPC_PO als in het betreffende dispatchDataRequest het attribuut dataToBeDelivered de waarde 'actueel' heeft. Het element dispatchDocument is van het type EPC_PPO_DP of van het type EPC_PPO als in het betreffende dispatchDataRequest het attribuut dataToBeDelivered de waarde 'actueelHistorisch' heeft. Toelichting: |
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 EPC 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), de identiteit van de afnemer en de registratiestatus van het registratieobject.
Uitgiftedocument | Wordt uitgeleverd als: | ||
---|---|---|---|
Afnemer | Registratieobject | dataToBeDelivered | |
BRO_DO | Is niet de bronhouder en/of dataleverancier. | Uit registratie genomen. | Ongeacht |
EPC_PO | Is niet de bronhouder en/of dataleverancier. | Niet uit registratie genomen. | actueel |
EPC_PPO | Is niet de bronhouder en/of dataleverancier. | Niet uit registratie genomen. | actueelHistorisch |
EPC_PO_DP | Is tevens de bronhouder en/of dataleverancier. | Ongeacht. | actueel |
EPC_PPO_DP | Is tevens de bronhouder en/of dataleverancier. | Ongeacht. | actueelHistorisch |
Onderstaande figuur geeft de uitgiftedocumenten (blauwe achtergrond) weer inclusief de mogelijke inhoud: