Koppelvlak BAG – Dienst Extract Schema’s
IMBAG versie v20090901 (UML) Automatisch downloaden bestanden
Versie
2.1.1
Auteur(s)
Kadaster
Inhoudsopgave
1 INLEIDING ... 3
1.1 KOPPELVLAK ... 3
1.2 GEBRUIK ... 4
1.3 LEESWIJZER ... 4
1.4 REFERENTIE DOCUMENTATIE ... 4
1.5 WIJZIGINGEN IN VERSIE V20090901 (PATCH VAN SEPTEMBER 2011) ... 5
1.6 AUTOMATISCH OPVRAGEN VAN TE DOWNLOADEN BESTANDEN ... 6
2 SCHEMA: INFORMATIE MODEL IMBAG V0.70(01-09-2009) ... 8
2.1 EXTRACTPRODUCTEN ... 9
2.2 BESTANDSTRUCTUUR ALGEMENE SCHEMA’S ... 9
2.3 FORMAAT NAAMGEVING DEELBESTANDEN BAGEXTRACT ... 9
2.4 FORMAAT NAAMGEVING BAGEXTRACT LEVERBESTAND ... 9
2.4.1 IMBAG onderdelen ... 10
2.5 GEOMETRIE ... 10
3 UITGANGSSCHEMA’S VOOR DE PRODUCTEN EN GEGEVENSVARIANTEN ... 11
3.1 LEVENSCYCLUS ... 11
▪ Woonplaats ... 12
▪ Openbareruimte ... 13
▪ Nummeraanduiding ... 14
▪ Verblijfsobject ... 15
▪ Ligplaats ... 16
▪ Standplaats ... 17
▪ Pand ... 18
4 PRODUCTSCHEMA’S EXTRACT. ... 19
4.1 PRODUCTSTRUCTUREN ... 19
4.2 STRUCTUUR VAN HET EXTRACT BESTAND ... 21
4.3 LEVERSDOCUMENT (KORT):BAGVSEXTRACTLEVERINGSDOCUMENT-1.3.XSD ... 22
4.3.1 Metadatagegevens: ... 22
4.3.2 Antwoord: Selectiegegevens ... 23
4.4 HET EXTRACT DEELBESTAND: ... 24
4.4.1 XML: BagvsExtractDeelbestandExtractLvc-1.4.xsd ... 24
4.5 MUTATIEBESTAND ... 25
5 BIJLAGE -1 PRODUCTCODES BAG EXTRACT V20090901 ... 26
6 BIJLAGE-2 LEVERINGSDOCUMENT (XML) ... 27
6.1.1 BagvsExtractLeveringsdocument / BagvsExtractLeveringsdocument-1.3.xsd... 28
6.1.2 Voorbeeld ... 34
1 Inleiding
Dit document beschrijft kort het koppelvlak van de dienst Extract van de Landelijke Voorziening BAG, specificatie release v20090901. Op deze release is een patch uitgebracht zoals beschreven in hoofdstuk
“Wijzigingen in versie v20090901”. Deze release van het koppelvlak is in september 2011 in productie genomen en wordt beheerd door het Kadaster.
Voor meer informatie kunt u terecht op http://www.kadaster.nl/bag → BAG producten → Bag Extract
1.1 Koppelvlak
Het begrip koppelvlak is een breed begrip. Dit document gaat in op het bestellen en leveren van Extracten in de vorm van bestanden, op basis van schema’s. Deze activiteiten vinden plaats tussen de Landelijke Voorziening BAG en de afnemers van de dienst BAG Extract.
De producten kunnen worden besteld via het portaal “Mijn Kadaster” m.b.v. de webapplicatie BAG Bestellen.
U komt dan uit op Mijn Kadaster, waar u kunt inloggen om te gaan bestellen:
Nadat een product is aangemaakt en de levering is voorbereid wordt de afnemer hiervan op de hoogte gesteld per e-mail. In dit bericht is een url opgenomen waar het product rechtstreeks kan worden gedownload via http.
Vanaf 21 oktober 2013 is het mogelijk om automatisch te downloaden, via de afgifte webservice, zie §1.6.
1.2 Gebruik
Het koppelvlak voor de dienst Extract speelt in op de behoefte om grote hoeveelheden BAG gegevens af te nemen en in een eigen omgeving in te laden en te onderhouden. De voordelen hiervan zijn onder andere dat vrijwel alle mogelijke vragen te stellen zijn, ook als de LV hiervoor (nog) geen services aanbiedt en dat de gegevens direct te benaderen zijn terwijl het beheer om de gegevens actueel en juist te houden bij de LV is belegd. De producten van de dienst Extract omvatten:
▪ Producten voor de registratieve gebieden geheel Nederland of (een collectie van) Woonplaats(en)
▪ Het leveren van mutaties per registratief gebied via een mutatie abonnement
▪ Producten in de vorm van XML met als basis het Informatie Model BAG. De schema’s zijn alleen van toepassing voor de release van 1 december 2009 met versie indicatie v20090901.
1.3 Leeswijzer
De Landelijke Voorziening BAG ontsluit via de genoemde dienst de BAG-gegevens, zoals beschreven in de Grondslagen, de PDC en het informatiemodel IMBAG in de UML modelleringstechniek. De berichten van het koppelvlak bevatten deelverzamelingen van deze gegevens. De schema’s waarop deze zijn gebaseerd worden eerst beschreven, te weten in H2 en H3. De berichten (XSD) staan beschreven in H4 en H5.
1.4 Referentie documentatie
Document Omschrijving
[1] Producten en Diensten Catalogus - versie 4.0 pdc_bag_verstrekkingen.pdf
[2] informatieproducten BAG Verstrekkingen voor Extract V 2.8 Informatieproducten_BAG_Verstrekkingen_Extract.pdf [3] Productie Diensten Niveau Overeenkomst BAG LV
BAG_Levertermijnen_en_tarieven_v1_1.pdf (of t.z.t. een latere versie) [4] Gemeente Woonplaats Relatie product.
Informatieproduct en koppelvlakbeschrijving GWR v1.1 .pdf
1.5 Wijzigingen in versie v20090901 (patch van september 2011)
M.b.t. IMBAG:
Aanpassing domein van Bouwjaar, geldt voor BAG Extract en Mutatielevering. Was: GYear , Wordt:
Integer, Min 0, Max 9999, maxlengte=4
De xsd's waarin het pand voorkomt hebben een versieverhoging gekregen in de bestandsnaam (niet de namespace).
- BagvsImbagLvc-070.xsd wordt BagvsImbagLvc-0.71.xsd
Extracten:
De xsd's welke de imbag schema's gebruiken hebben een versieverhoging gekregen in de bestandsnaam (niet de namespace).
- BagvsExtractDeelbestandExtractLvc-1.3.xsd wordt BagvsExtractDeelbestandExtractLvc-1.4.xsd - BagvsExtractProductenLvc-070.xsd wordt BAGvsExtractProductenLvc-071.xsd
Mutatieverwerking:
- BagvsExtractDeelbestandMutatieLvc-1.3.xsd wordt BagvsExtractDeelbestandMutatieLvc-1.4.xsd
• Aanpassing domein TijdstipVerwerking, geldt voor mutatielevering van Extractproducten Was Type: DatumTijd str. 8/16
Wordt Type: DatumTijdstip met domein datetime
• Aanpassing Volgnummer verwerking, geldt voor mutatielevering van Extractproducten Volgnummer verwerking wordt integer maxlen 3 dus 0… 999
• Het kan zijn dat er op een dag 0 mutaties plaatsvinden, bijvoorbeeld in het weekend. Een
mutatiebestand kan dus 0 mutaties bevatten. Mutatiebestanden moeten echter in de juiste volgorde verwerkt worden en waneer er dan 1 mist ontstaan er vragen waar dit bestand is en of deze wel of niet is geleverd. Een "leeg" mutatiebestand wordt daarom wel/toch geleverd. De kardinaliteit van mutaties in het mutatiebestand is daarom veranderd van 1..N naar 0..N.
1.6 Automatisch opvragen van te downloaden bestanden
Deze paragraaf is geschreven voor de gebruikers van producten van de dienst BAG-Extract en/of BAG- Compact, die bestanden automatisch willen laten downloaden door systemen. Het downloaden gebeurt via de generieke afgifte service van het Kadaster. Er zijn twee kanalen beschikbaar voor u als BAG Afnemer:
- Notificatie (E-mail)
- Webservice (Een loket voor grote bestanden)
Als u uitsluitend gebruik maakt van de url in de e-mail dan verandert er niets. In dat geval bevat deze paragraaf voor u geen relevante informatie. Als u gebruik wilt maken van de mogelijkheid om gebruik te maken van een webservice voor het opvragen van bestanden, dan is de informatie in deze paragraaf wel van belang. Via de webservice kan automatisch opgevraagd worden of er nog te downloaden LVBAG bestanden voor u klaar staan.
Ongeacht de keuze om hier gebruik van te maken ontvangt (nog steeds) de e-mail. Het is niet nodig om een nieuwe bestelling te plaatsen.
Kanaal webservice
Dit is het webservice kanaal voor het grote bestanden loket, waarmee de LV BAG bestanden van de dienst Extract levert.
Via de webservice kunt u een bestandenlijst opvragen, van de voor u klaarstaande bestanden, met algemene informatie en voor elk bestand en een download url, (stap 1), om vervolgens via de url de bestanden te downloaden (stap 2).
In een plaatje staan de twee genoemde stappen beschreven:
Wij adviseren u voor de BAG een apart proces in te richten die de bestandenlijst opvraagt voor (alleen) de LVBAG. Op deze manier kunt u via een eigen BAG applicatie de bestanden automatisch ophalen en verwerken.
Authenticatie via PKI Overheidscertificaten
Bij gebruik van deWebservice is authenticatie altijd vereist.
Het downloaden zelf van de url's die via deze webservice worden verkregen is geen authenticatie vereist. Dit betekent dat voor het gebruik van de webservice een PKI
overheidscertificaat nodig is. Bron: Gebruikershandleiding – paragraaf 1.3 Authenticatie URL en anonieme URL
Opvraagtermijn
De bestanden BAG Extract en BAG Compact worden 1 jaar bewaard. Dagelijke mutaties worden 3 maanden bewaard. Hierna zijn de bestanden niet meer op te vragen.
Handreiking voor ontwerpers en software ontwikkelaars
Documentatie van de afgifte (web) service
Deze leeswijzer van de BAG is een eenvoudige korte versie van de originele documenten van deze generieke downloadservice. Waar nodig wordt hiernaar gerefereerd:
- Gebruikershandleiding voor klanten van GDS.pdf - Handleiding Koppelvlak GDS.pdf
Te vinden via: www.kadaster.nl - Zakelijk - Aandachtsgebieden - Direct naar - tabblad GDS2.
Rechtstreekse link: https://developer.kadaster.nl/schemas- tabblad GDS2
Voor ontwerpers: hierin staan UML diagrammen met alle gegevens die worden uitgewisseld. De meeste gegevens zijn nuttig, maar niet vereist.
Voor ontwikkelaars: hier zijn de wsdl, xsd's en een deployable Stub met voorbeeldberichten te vinden.
Aanbevelingen vanuit de LVBAG bij de Afgifte (web) service
Op Handleiding Koppelvlak GDS pagina 12 staan Afgifte bestandenlijst Selectiecriteria genoemd. Maak in ieder geval gebruik van de volgende mogelijkheden.
- Alle(en) nieuwe bestanden sinds de vorige keer: geef het veld Selectiecriteria.nogNietGerapporteerd de waarde 1. Het advies is om deze voor automatische download te gebruiken. U ontvangt dan alleen de nieuwe url's en niet al eerder verkregen url's. Per url kan vervolgens elk bestand worden gedownload.
- Alle bestanden behorende bij een bestelling1: geef het veld
AfgifteSelectieCriteria.Bestandkenmerken.contractnummer de waarde ordernummer. U heeft deze gekregen in de e-mail bestelling bevestiging. Als u (tot nu toe) handmatig heeft gedownload dan is het ordernummer tevens deze te vinden in levering.xml in het veld ordernummer.
Wij adviseren u bij automatische download beide velden in te vullen. U krijgt dan voor de opgegeven
bestelling de nog niet ontvangen url's. Alle niet ontvangen url's opvragen kan ook, maar dit kan verkeerd gaan indien een ander organisatie onderdeel met een eigen downloader eigen downloads doet en ook bestanden opvraagt. Het is handig om deze url's eerst zelf op te slaan, met de afgifte id erbij, en daarna de opgeslagen url's te gebruiken om voor elke url een bestand te downloaden via de url. Op deze manier is er eigenlijk nooit sprake van lastige foutsituaties. Mocht er toch iets fout gaan, dan zijn er mogelijkheden zoals genoemd in paragraaf 1.5 van de handleiding.
Download snelheid
Het is niet mogelijk garanties te geven voor de downloadsnelheid. In de praktijk is de downloadsnelheid onder normale omstandigheden voor een volledig bag extract van heel Nederland (~1.5 GB) circa 15 minuten en voor een dagelijks mutatiebestand (~10MB) circa 10 seconden. Dit is ook afhankelijk van uw eigen netwerk.
1 LVBAG levert de bestanden in een levering, met een leveringsnummer, welke per levering uniek is. Het ordernummer is stabiel over alle leveringen heen en kent u. Voor communicatie over specifieke leveringen kan het handig zijn om ook het leveringnummer op te slaan of om deze door te geven bij contact met klantenservice LVBAG.
2 Schema: Informatie model IMBAG V0.70(01-09-2009)
De gegevens van de BAG zijn beschreven in de documenten Grondslagen Adressen en Grondslagen Gebouwen van VROM. Vervolgens zijn deze gegevens in samenhang gemodelleerd in de vorm van een UML class diagram: het Informatie Model BAG, en wordt beheerd door het Kadaster. Het model vormt de basis voor het ontwerp van alle gegevens gerelateerde zaken, zoals database, producten, diensten en berichten.
De Class diagram is beschikbaar in twee smaken: een voor het genereren van XML:
2.1 Extractproducten
De Extractproducten waarop dit koppelvlak betrekking op heeft zijn:
▪ Levering van Extract bestanden in XML van het type levenscylus of waarde op peildatum voor gebied heel Nederland en op Woonplaatsen. Zie §4.2
▪ Mutatiebestanden in XML voor gebied heel Nederland en op Woonplaatsen. Zie §4.5
▪ Het gemeente woonplaats relatie product in XML. Deze heeft een eigen document: [4], zie §1.4.
Producten worden gerealiseerd met een eigen schema, zie desbetreffende §, en met algemene schema’s.
2.2 Bestandstructuur algemene schema’s
De volgende schema’s hebben een generieke vorm die bij Extract- en Mutatiebestanden worden gebruikt
▪ Een schema met meta data, bestel- en levergegevens en de selectiegegevens
▪ Een schema met de BAG-data
Het Extract wordt geleverd in de vorm van een bestand dat via het internet kan worden betrokken.
Dit product wordt geleverd als 1 gecomprimeerde ZIP bestand. Deze Zip bestaat uit meerdere XML bestanden. De bestandsgrootte zal, zelfs met een volledige gevulde BAG, de 1 GB niet overstijgen. Dit komt omdat de compressie factor van XML rond de 40 ligt. Bij het uitpakken ontstaan, afhankelijk van de selectie, diverse deel bestanden.
▪ Voor geheel Nederland worden deelbestanden per objecttype geleverd. Indien een deelbestand een vooraf vastgestelde grootte overschrijdt wordt deze opgedeeld in meer deelbestanden van dezelfde objecttype ahv. een volgnummer.
▪ Bij een Extract op Woonplaats(en) worden de deelbestanden per Woonplaats gezipped. De verzameling Woonplaatsen wordt bij de levering gezipped tot het te leveren Extract bestand.
De deelbestanden2 betreffen in chronologische volgorde (Objecttype):
1: Woonplaatsen (WPL), 2: Openbareruimten (OPR), 3: Nummeraanduidingen. (NUM),
4: Panden (PND),
5: Verblijfsobjecten (VBO), 6: Ligplaatsen (LIG), 7: Standplaatsen (STA),
2.3 Formaat naamgeving deelbestanden BAG Extract Voor deelbestanden van gebied GeheelNederland:
Woonplaatscode(AN4), default”9999”, objecttype (AN3), StandTechnischeDatum(AN8), Peildatum(optioneel) (AN8), volgnummer bij splitsing (N4)
Voor deelbestanden van Woonplaats(en):
Woonplaatscode(AN4), objecttype (AN3), StandTechnischeDatum(AN8), Peildatum(optioneel) (AN8), volgnummer(N4) bij splitsing.
2.4 Formaat naamgeving BAG Extract leverbestand
Product code(AN10), klantnummer(AN10), bestelling/ordernummer(AN8), StandTechnDatum(AN8), Peildatum of vanafPeildatum(AN8).
2 In deze zelfde volgorde moeten de bestanden door de afnemer worden verwerkt.
2.4.1 IMBAG onderdelen
Dit schema beschrijft de datatypes welke gebruikt worden in IMBAG: BagvsImbagOnderdelen-0.7.xsd targetNamespace = “http://www.kadaster.nl/schemas/imbag-types/v20090901”
xmlns:bagtype = “http://www.kadaster.nl/schemas/imbag-types/v20090901”
2.5 Geometrie
De BAG kent geometrie. Geometrie attributen zijn gemodelleerd in GML3 3.1.1. Het informatiemodel IMBAG maakt gebruik van de GML definities zoals uitgegeven door OGC. Zie import. /gml/ bag-gml.xsd.
Documentatie staat op: http://www.opengeospatial.org/ en schemas.opengis.net. Het volstaat om de geometrie in de XML berichten te interpreteren. Er zijn geen bijzondere libraries nodig.
targetNamespace = “http://www.opengis.net/gml”
Prefix xmlns:gml = “http://www.opengis.net/gml”
3 GML is een product van OGC en is de standaard voor de aanduiding en definitie van Geo-objecten.
3 Uitgangsschema’s voor de producten en gegevensvarianten
Alle informatieproducten van de BAG, zoals deze worden geleverd aan Afnemers, zijn gebaseerd op het informatiemodel IMBAG. Dit betekent dat alle attributen en types, indien gebruikt in een informatieproduct, dit model volgen. Voor de betekenis en definitie van de gegevens zelf wordt verwezen naar de Grondslagen BAG. Met relaties is iets bijzonder aan de hand. Omdat voorkomens van objecten in historisch perspectief altijd als kardinaliteit een M:N relatie kennen is het (vrijwel) niet mogelijk om gegevens in een geneste structuur en aan elkaar gerelateerd te leveren. Daarnaast is het van belang dat gegevens met een goede performance zijn in te laden en dat een systeem dat de gegevens inleest maar met één schema te maken krijgt. Daarom is er gekozen om voor de levering alle producten de structuur van tijdvak producten te gebruiken, te weten ontkoppelt. Deze structuur wordt in dit document de Levenscyclus structuur genoemd.
Voor meer informatie over relaties in historisch perspectief wordt verwezen naar het document Informatieproducten [1]. De BAG Objecten worden bij mutaties in dezelfde structuur geleverd.
3.1 Levenscyclus XML
targetNamespace = “http://www.kadaster.nl/schemas/imbag-lvc/v20090901”
Omdat de BAG structuur van de levering anders is hebben deze een eigen prefix en namespace:
Prefix xmlns:bag_LVC =
“http://www.kadaster.nl/schemas/imbag-lvc/v20090901”
De onderstaande schema’s zijn een presentatie van de basis van de BAG, de BAG Objecten Woonplaats, Openbare Ruimte, Nummeraanduiding, Ligplaats ,Standplaats, Verblijfsobject en Pand. Deze worden als basis gebruikt voor het samenstellen van de Extract producten in XML.
▪ Woonplaats
▪ Openbareruimte
▪ Nummeraanduiding
▪ Verblijfsobject
▪ Ligplaats
▪ Standplaats
▪ Pand
4 Productschema’s Extract.
4.1 Productstructuren
Extract informatieproducten worden in 2 structuren in XML vorm geleverd:
Extractlevering-schema
Dit (generieke) schema kent een structuur om de levenscyclus van een Object te leveren. Een levenscyclus bestaat uit meerdere voorkomens door de tijd in één schema. Hierin kan een Openbare Ruimte (Object met Voorkomens) door de tijd heen bijvoorbeeld gekoppeld zijn aan meer dan één Woonplaats (Objecten met elk meerdere Voorkomens). Het schema voor Levenscyclus komt sterk overeen met het basisschema van het informatiemodel voor zowel naamgeving en attributen, maar niet voor relaties. De producten bestaan veelal uit voorkomens van het gevraagde Objectype. Voor relaties, te weten de gerelateerde Objecten en Voorkomens, is echter alleen het attribuut identificatie opgenomen (van het type Objectnummer of Woonplaatscode). De structuur is niet genest. De attributen van BAG-objecten zijn in zowel XML als GML identiek.
Handreiking bij het inladen van de gegevens:
1. Pak het zipbestand uit
2. Laad elk objecttype in een aparte tabel, in de juiste volgorde: Woonplaats, Openbare Ruimte, Nummeraanduiding, Ligplaats, Standplaats, Pand, Verblijfsobject
3. Relateer de voorkomens pas aan elkaar wanneer er een vraag beantwoord moet worden op een momentopname en gebruik hiervoor een query met een JOIN op het attribuut ‘identificatie’ of
‘woonplaatscode’
Mutatielevering-schema
Het schema voor het leveren van mutaties heeft als uitgangspunt dat de Afnemer de mutaties goed en eenvoudig moet kunnen verwerken. Hierbij gelden twee uitgangspunten. Ten eerste moeten mutaties in de juiste volgorde worden verwerkt, op basis van het attribuut ‘tijdstip verwerking’ en alle bij elkaar behorende mutaties moeten in één keer worden verwerkt om zo tot een juiste situatie te komen. Deze mutaties zijn herkenbaar aan hetzelfde ‘tijdstip verwerking’. Ten tweede is het van groot belang dat de verwerking simpel en recht toe, recht aan is. Dit wordt gerealiseerd door van elke wijziging aan te geven hoe het voorkomen voor de wijziging eruit zag en hoe erna. Hierdoor is het mogelijk om alle wijzigingen met een eenvoudige update (bij een gewijzigd voorkomen) of insert (bij een nieuw voorkomen) door te voeren. Bijkomende voordelen zijn dat het te zien is welke attributen precies gewijzigd zijn, dat er gecontroleerd kan worden of de lokale database nog synchroon loopt met de Landelijke Voorziening, ook indien er gekozen is om een deelverzameling van de attributen selectie over te nemen.
Handreiking bij de verwerking van het mutatiebestand:
1. Selecteer alle mutaties met dezelfde 'tijdstip verwerking'. De selectie bevat 1 consistente set aan mutaties (Mutatie-product).
2. Sorteer de mutaties binnen de consistente set op volgnummerVerwerking.
3. Doe een insert als het type 'Nieuw' is gevuld, doe een update indien het type 'Wijziging' is gevuld, in de bij het objecttype behorende tabel.
Aandachtspunt bij woonplaatsen: indien twee aangrenzende woonplaatsen zijn besteld dan is het mogelijk dat een object of een mutatie is toegekend aan beide aangrenzende woonplaatsen. In een dergelijk situatie is het aan te bevelen om de mutatie over te slaan of om te werken met een insertOrUpdate strategie op basis van de logische identificatie van een voorkomen.
Optioneel: laad eerst alle mutaties in het mutatiebestand naar een database tabel. Op deze manier kan er eenvoudiger per bulk verwerkt worden, eenvoudiger herstart worden in foutsituaties en kunnen dubbel voorkomende objecten of mutaties er op voorhand uitgefilterd worden.
4.2 Structuur van het Extract bestand
Het Extractbestand is een verzameling van objectbestanden, Elk object is geplaatst in een deelbestand. Deze is in omvang gemaximeerd. Er kunnen dus meer dan een deelbestand voorkomen voor een bepaalde object.
Het Extract bestand is een verzameling van alle gecomprimeerde deelbestanden (zip) behorende bij een specifieke bestel opdracht. Extract word als één bestand (zip) geleverd.
Een Extractbestand wordt gekenmerkt door twee XML tags:
1- BagvsExtractLeveringsdocument
Stuurgegevens
Metadata algemene bestelgegevens antwoord selectiegegevens bestelgebieden
2 - BagvsExtractDeelbestandExtractLvc-1.4.xsd of BagvsExtractDeelbestandMutatieLvc-1.4.xsd Antwoord
Bagobjecten
4.3 Leversdocument (kort): BagvsExtractLeveringsdocument-1.3.xsd Het leveringsdocument wordt bijgesloten bij elke levering. Voor meer informatie, zie bijlage 6
4.3.1 Metadatagegevens:
Deze gegevens zijn nader toegelicht in bijlage 6
4.3.2 Antwoord: Selectiegegevens
Deze gegevens zijn nader toegelicht in bijlage 6
4.4 Het Extract deelbestand:
4.4.1 XML: BagvsExtractDeelbestandExtractLvc-1.4.xsd
4.5 Mutatiebestand BagvsExtractDeelbestandMutatieLvc-1.4.xsd
5 Bijlage -1 Productcodes BAG Extract V20090901
Productcodes BAG Extract / Mutaties
Voorbeeld Productcode voor een Extractbestand voor geheel Nederland op DvD van type levenscyclus in XML:
PNLDLXAM01 → P-NLD-L-X-AM-01 | | | | | | versie
| | | | | Abonnement mutatiebestand | | | | XML
| | | Levenscyclus | | geheel Nederland | Levering per post op DVD
6 Bijlage-2 Leveringsdocument (xml)
Elke levering vanuit de LVBAG (voor de dienst Extract) bevat, bij elke klantspecifieke levering, een kort overzicht van de inhoud van een levering. Dit zijn extra gegevens die niet tot bij de producten van de LVBAG zelf behoren en dus ook niet nodig zijn om de producten te verwerken. Denk hierbij aan:
- De klant die de bestelling heeft gedaan.
- De Bestelling, te weten ordergegevens, de besteldatum, de opgegeven bestellabel en productgegevens.
- De levering (het zip bestand), welke een resultaat is van een bestelling.
- De inhoud van de levering zelf, een opsomming van de bestanden in de levering.
Het leveringsdocument is momenteel een XML bestand, genaamd leverings.xml. Deze bevindt zich in de levering, het zip bestand, op het hoogste niveau in de zip. Dit document kan bijvoorbeeld gebruikt worden door een beheerder die met een beheertool de bestanden verwerkt. De levering.xml kan in dit opzicht gezien worden als MS-Word of PDF document, maar dan in XML.
NB. De overige schema’s in het koppelvlak document zijn vereist voor het verwerken van de bestanden van de LVBAG. Dit is niet echter het geval voor de leveringsdocument schema’s. Deze schema’s hoeven niet geïmplementeerd te worden. Maar het is wel mogelijk om de gegevens in XML te gebruiken en om deze te tonen in bijvoorbeeld een beheertool of beheerapplicatie. Indien u dit doet, dan is het aan te raden om deze leverings.xml losstaand, onafhankelijk van de productverwerking, te implementeren. Dus dat uw
productverwerking hier niet op vastloopt en gewoon verder kan, ook als dit document qua inhoud of xsd veranderd.
Op de volgende pagina’s staan de schema’s behorende bij het leveringsdocument toegelicht.
6.1.1 BagvsExtractLeveringsdocument / BagvsExtractLeveringsdocument-1.3.xsd
Dit schema bevat:
- Stuurgegevens (wordt niet gevuld in huidige implementatie).
- Metadata staat in een volgende paragraaf beschreven
- Het antwoord met daarin de vraag is een reflectie van wat de klant besteld heeft. De selectie-extract namespace verwijst naar het schema in een volgende paragraaf.
BagvsExtractLeveringsdocument-1.3.xsd
Metagegevens van de levering
BagvsExtractMeta-1.3.xsd
- Het ordernummer is en blijft constant, ook bij een abonnement van meerdere leveringen (dagelijks of maandelijks). Elke levering heeft zelf een uniek identificerend leveringnummer.
- Het label wordt door de besteller zelf opgegeven tijdens de bestelling (ook wel: naam selectiegebied).
- De productcode staat beschreven in het document Productdefinitie BAG Extract.
- Bestandinfo bestaat uit info van het levering bestand zelf. Info over deelbestanden wordt nu niet geleverd.
- Draaimoment is het tijdstip dat de LVBAG het bestand heeft aangemaakt.
Selectie-gegevens
BagvsBevragingenSelecties-0.7.xsd
In de volgende paragrafen staat deze per onderdeel nader toegelicht.
Deel 1: algemeen
- De standTechnischeDatum geeft aan welke gegevens op deze datum in de LV bekend waren. Dus niet welke geldig waren, maar of ze voor of na deze datum bekend geworden zijn in de LV. Deze is altijd aanwezig.
- Leverfrequentie.looptijdTot en aantal leveringen (bv. als de afspraak is om een jaar te leveren) is in de huidige implementatie niet opgenomen.
Deel 2: intern binnen de LV bekende informatie van het bestelde gebied
Bijzonderheden:
• GebiedIdentificatie in de leverings.xml : dit is een intern in de LV bekende identificatie van het bestelde gebied, met daarin de bestelde gemeentes. De identificatie is een vaststaand betekenisloos volgnummer.
De GebiedIdentificatie is dus niet de identificatie van woonplaats(code) of gemeente(code).
• GebiedNaam in de leverings.xml. Dit is een interne in de LV bekende naam behorende bij het gestelde gebied. Deze heeft geen relatie met het selectiegebied wat (indien gekozen) in de bestelapplicatie (scherm) eventueel is opgeslagen.
Deel 3: schema info c.q. koppelvlak versie
Dit onderdeel van het leveringsdocument geeft het root schema aan van de producten die (dieper) in de levering.zip zitten. Wanneer er meerdere koppelvlakken naast elkaar draaien is aan dit veld o.a. te zien om welk koppelvlak het gaat. Het is dus handig om dit veld te controleren, om te beoordelen of de software, die de bestanden verwerkt, wel past bij de schema’s die in de levering gebruikt zijn.
Voor dit koppelvlak:
- BagvsExtractDeelbestandExtractLvc-1.4.xsd versie 20090901 - BagvsExtractDeelbestandMutatieLvc-1.4.xsd versie 20090901
6.1.2 Voorbeeld
<?xml version="1.0" encoding="UTF-8" ?>
- <v20:BAG-Extract-Levering xsi:schemaLocation="http://www.kadaster.nl/schemas/bag- verstrekkingen/extract-levering/v20090901 http://www.kadaster.nl/schemas/bag- verstrekkingen/extract-levering/v20090901/BagvsExtractLeveringsdocument-1.3.xsd"
xmlns:v20="http://www.kadaster.nl/schemas/bag-verstrekkingen/extract-levering/v20090901"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:v201="http://www.kadaster.nl/schemas/bag-verstrekkingen/extract-meta/v20090901"
xmlns:v202="http://www.kadaster.nl/schemas/bag-verstrekkingen/extract-selecties/v20090901">
<v20:metadata>
<v201:Klantgegevens>
<v201:Klantnummer>0000444222</v201:Klantnummer>
<v201:Klantnaam>Kadaster GIS Maatwerk & advies</v201:Klantnaam>
</v201:Klantgegevens>
<v201:Ordergegevens>
<v201:Ordernummer>0086002619</v201:Ordernummer>
<v201:Leveringnummer>6000643820</v201:Leveringnummer>
</v201:Ordergegevens>
<v201:Bestelgegevens>
<v201:Besteldatum>2013-04-12</v201:Besteldatum>
<v201:Label>BAG_201304</v201:Label>
</v201:Bestelgegevens>
<v201:Productgegevens>
<v201:Productcode>DNLDLXEE02</v201:Productcode>
<v201:Kanaal>DOWNLOAD</v201:Kanaal>
<v201:GebiedType>NLD</v201:GebiedType>
<v201:Gegevensvariant>LEVENSCYCLUS</v201:Gegevensvariant>
<v201:Formaat>XML</v201:Formaat>
<v201:Producttype>EXTRACT</v201:Producttype>
<v201:Productversie>02</v201:Productversie>
</v201:Productgegevens>
<v201:BestandInfo>
<v201:Bestandsnaam>DNLDLXEE02-0000444222-0086002619-08042013.zip</v201:Bestandsnaam>
<v201:Draaimoment>2013-04-12T13:38:10.265+02:00</v201:Draaimoment>
</v201:BestandInfo>
</v20:metadata>
<v20:antwoord>
<v20:vraag>
<v202:LVC-Extract>
<v202:gegVarLevenscyclus>true</v202:gegVarLevenscyclus>
<v202:productcode>DNLDLXEE02</v202:productcode>
<v202:StandTechnischeDatum>20130408</v202:StandTechnischeDatum>
</v202:LVC-Extract>
<v202:Leverfrequentie>
<v202:eenmalig>true</v202:eenmalig>
</v202:Leverfrequentie>
<v202:Gebied-Registratief>
<v202:Gebied-NLD>
<v202:GebiedIdentificatie>3318</v202:GebiedIdentificatie>
<v202:GebiedNaam>NLD-0086002619</v202:GebiedNaam>
<v202:gebiedTypeNederland>true</v202:gebiedTypeNederland>
</v202:Gebied-NLD>
</v202:Gebied-Registratief>
<v202:SchemaInfo>
<v202:Schemanaam>BagvsExtractDeelbestandExtractLvc-1.4.xsd</v202:Schemanaam>
<v202:Schemaversie>20090901</v202:Schemaversie>
<v202:XML>true</v202:XML>
</v202:SchemaInfo>
</v20:vraag>
<v20:producten />
</v20:antwoord>
</v20:BAG-Extract-Levering>
