0.1 LVBAG Bevragen Productbeschrijving versie 1.0 Datum 10 augustus 2016 Document versie 1.0 ConceptICT Services Keten RZDirectie IT
Versiehistorie Versie datum Omschrijving 1.0 10-08-2016 Definitieve versie Versie 1.0 10-08-2016 2 / 11
Inhoudsopgave 1 Inleiding... 4 1.1 Leeswijzer... 4 1.2 Referentie documentatie... 4 2 Doelstelling en uitgangspunten... 4 2.1 Doelstelling... 4 2.2 Uitgangspunten... 4 3 Datamodel... 6 3.1 Datamodel schema... 6 3.2 Toelichting... 7 3.3 Bronhouder... 8 4 Aanroep... 8 4.1 Wijze van activeren... 8 4.2 Zoekmogelijkheden... 8 5 Productstructuur... 9 5.1 Basiscomponent en gerelateerde componenten... 9 5.2 Momentopname versus levenscyclus... 9 5.3 Relatieservices op momentopname... 9 5.4 Voorkomen redundantie... 9 6 Extra functie Bepalen Bronhouder.... 10 6.1 Inleiding... 10 6.2 Via het ID van het object... 10 6.3 Via een coördinaat... 10 7 Bijlagen... 11 Versie 1.0 10-08-2016 3 / 11
1 Inleiding Dit document beschrijft de dienst Bevragen van de Landelijke Voorziening BAG. 1.1 Leeswijzer Dit document beschrijft de hoofdlijnen van de dienst Bevragen van de Landelijke Voorziening BAG. Enkele onderwerpen worden in een apart verdiepingsdocument toegelicht. Een onderdeel van BAG Bevragen is de service Bepalen Bronhouder bronhouder. We gaan in dit document in op deze service in een apart hoofdstuk. 1.2 Referentie documentatie Koppelvlakbeschrijving: http://www.kadaster.nl/bag-documentatie kopje technische informatie producten Verklarende woordenlijst: http://www.kadaster.nl/bag-documentatie kopje Productinformatie Verdiepingsdocument BAG Bevragen: http://www.kadaster.nl/-/bag-bevragen 2 Doelstelling en uitgangspunten 2.1 Doelstelling Met deze dienst kunnen afnemers via een applicatie direct de Landelijke voorziening BAG bevragen. De dienst is ontwikkeld voor regelmatig tot veelvuldig gebruik. BAG bevraging is een Application to Application (A2A) koppeling tussen de Landelijke voorziening BAG en de applicatie van de afnemer. Gegevens kunnen in de afnemersapplicatie worden overgenomen en/of worden gekoppeld met gegevens in de Landelijke voorziening BAG via de object identificatiecodes. Via de dienst bevraging kunnen de producten adresgegevens, gegevens van adresseerbare objecten en pandgegevens worden ontsloten. Daarnaast is aan BAG Bevragen de extra functie Bevragen Bronhouder toegevoegd. 2.2 Uitgangspunten 2.2.1 Gegevens conform vorm en inhoud van de grondslagen De vorm (structuur en naamgeving) waarin gegevens uit BAG Verstrekkingen worden aangeboden, voldoet aan de BAG Grondslagen. 2.2.2 Geen controle op gegevens bij levering Het systeem levert gegevens zonder inhoudelijke controle en controle op consistentie van de gegevens. Eventuele ontbrekende gegevens of inconsistenties in de gegevens in de LV BAG worden meegeleverd in het resultaat aan de afnemer. 2.2.3 Volgorde waarin objecten en voorkomens geleverd worden De BAG objecten worden in het resultaat van een bevraging in ongesorteerde, dus willekeurige volgorde, geleverd. Versie 1.0 10-08-2016 4 / 11
De voorkomens worden, per BAG object, in chronologische volgorde geleverd, met oplopende Datum begin geldigheid (incl. tijdstip). 2.2.4 Compleet gegevensmodel leveren In de te leveren producten worden van de objecten alle gegevens uit het gegevensmodel opgenomen. De geometrische gegevens van ruimtelijke objecten worden alleen geleverd wanneer de gebruiker dat bij de aanvraag heeft aangegeven. 2.2.5 Formaat van product De producten die via BAG bevraging tot stand komen worden aangeboden in XML formaat, de geometrische gegevens in GML-formaat. 2.2.6 Gegevensvarianten De dienst Bevraging levert gegevens in alle gegevensvarianten (actueel, peildatum en levenscyclus). 2.2.7 Actieve en inactieve gegevens De gegevensvarianten actief en peildatum leveren voor een bevraging alleen actieve voorkomens; de gegevensvariant levenscyclus levert ook inactieve voorkomens. 2.2.8 Ingang bevraging Voor alle gegevensvarianten geldt dat de primaire ingang voor bevraging bestaat uit het attribuut 'identificatie' van een BAG object. Het is ook mogelijk om te zoeken op andere zoektermen zoals een postcode en een huisnummer of via de naamgeving van een object. Bij de gegevensvarianten actueel en peildatum is het opgeven een datum verplicht. 2.2.9 Structuur van het product Voor de gegevensvarianten actueel en peildatum worden de gegevens van de gerelateerde gegevens meegeleverd in een productstructuur die bestaat uit de structuur van de relaties uit het BAG-datamodel en waarbij, om redundantie te voorkomen, alleen de identificatie van de objecten is opgenomen. Daarnaast wordt ieder gerefereerd object volledig en uniek opgenomen in het product. Voor de gegevensvariant levenscyclus worden alle voorkomens van zowel het gevraagde object als van gerelateerde objecten geleverd. Hierbij worden de voorkomens op volgorde van tijdvak geleverd. 2.2.10 Volledigheid en consistentie Elk object waarnaar via een identificatiecode wordt verwezen is aanwezig in het product. Voor gegevensvarianten actueel en peildatum zijn dan de objectgegevens op de gewenste datum opgenomen. Voor gegevensvariant levenscyclus zijn dat alle voorkomens van de objecten waarnaar wordt verwezen. Enige uitzonderingen hierop zijn: Situaties als gevolg van een eventuele fout. Afhankelijk van de fout wordt in bepaalde situaties geen product geleverd, omdat dit product niet samengesteld kan worden. Versie 1.0 10-08-2016 5 / 11
2.2.11 Objecten Als men de actuele situatie van objecten nodig heeft is het mogelijk om het BAG object-id in de afnemersapplicatie op te nemen en deze applicatie de bijbehorende BAG gegevens op te laten halen uit de Landelijke Voorziening BAG. Dit is een toepassing van een bevraging op BAG object-id waarbij de peildatum nu is. 2.2.12 Zoeken Zoeken op unieke zoekargumenten Via BAG bevragen is het mogelijk om op unieke zoekargumenten te zoeken. Hierbij betreft het steeds een zoekargument dat tot nul of één resultaat kan leiden. Een voorbeeld hiervan is het zoeken op BAG object-id. Zoeken op niet-unieke zoekargumenten Via BAG bevragen is het mogelijk om op niet-unieke zoekargumenten te zoeken. Hierbij betreft het steeds een zoekargument dat tot nul, één of meerdere resultaten kan leiden. Een voorbeeld hiervan is het zoeken op een postcode + huisnummer (bij toevoegingen op het huisnummer worden meerdere resultaten gevonden) en het zoeken op de naamgeving van een object waarbij aan verschillende objecten dezelfde naam is toegekend. 3 Datamodel 3.1 Datamodel schema Onderstaand figuur toont het gegevensmodel van BAG zoals gedefinieerd in de BAG grondslagen: Versie 1.0 10-08-2016 6 / 11
Dit gegevensmodel vormt de basis voor de definities van het XML-formaat waarin de producten van BAG Verstrekkingen worden geleverd. In het verdiepingsdocument [verdieping] staat een uitgebreider model, waarin ook de attributen zijn vermeld. 3.2 Toelichting In het datamodel; dat relevant is voor BAG-bevragen zijn te onderscheiden: De 7 objecttypen van de BAG: Versie 1.0 10-08-2016 7 / 11
woonplaats (WPL), openbareruimte (OPR), nummeraanduiding (NUM), verblijfsobject (VBO), pand (PND), ligplaats (LIG), standplaats (STA). De objecttypen nummeraanduiding, openbare ruimte en woonplaats vormen samen de adresgegevens. Adresseerbaar object is een generalisatie van de objecttypen verblijfsobject, ligplaats en standplaats. Een nummeraanduiding hoort bij een adresseerbaar object: ofwel als hoofdadres, ofwel als één van de mogelijke nevenadressen. 3.3 Bronhouder Gemeenten zijn niet als entiteit in het datamodel van de BAG opgenomen. De gemeente is hiermee geen objecttype. De gemeente is als bronhouder wel verantwoordelijk voor de inhoud van de registratie. Omdat de gemeente een fundamentele rol speelt in de BAG registratie, biedt BAG bevragen de mogelijkheid op te vragen welke gemeente in de rol van bronhouder verantwoordelijk is voor een object. 4 Aanroep 4.1 Wijze van activeren De functie BAG Bevragen kan vanuit een applicatie via een webservice worden geactiveerd. Een voorbeeld van een applicatie die gebruik maakt van BAG bevragen is de BAG-viewer. De resultaten van de zoektermen die gebruikers opgeven in de BAG-viewer worden via BAG bevragen opgevraagd bij de LV BAG. Zie verder de bijlagen 1 en 2 voor een beschrijving van de aanroepmogelijkheden. 4.2 Zoekmogelijkheden De volgende vormen van bevraging zijn mogelijk: Bevraging op identificatiecode: Primaire ingang voor het opvragen van gegevens is de identificatiecode van een BAG object. Zoeken Op niet unieke kenmerken: Het systeem biedt zoekmogelijkheden om gegevens van BAG objecten te leveren op basis van kenmerkende (maar niet noodzakelijk unieke) eigenschappen zoals een deel van het adres. Bij het zoeken geldt verder dat het zoeken niet case sensitive is: Bij het zoeken op niet-unieke kenmerken wordt geen onderscheid gemaakt tussen hoofd- en kleine letters in het zoekcriterium en overeenkomende waardes: KERKWEG = kerkweg Versie 1.0 10-08-2016 8 / 11
5 Productstructuur 5.1 Basiscomponent en gerelateerde componenten Een product bestaat uit twee onderdelen. Het eerste deel bestaat uit productinformatie over het product. Uit deze informatie kan opgemaakt worden om welk product het gaat. Het tweede deel bestaat uit de inhoudelijke BAGinformatie. Dit tweede deel bestaat uit componenten, de voorkomens van het gevraagde object. Een product is altijd een samenstelling bestaande uit productinformatie en een basiscomponent. Dit basiscomponent bestaat uit één of meerdere voorkomen(s) van het gevraagde objecttype. Naast het basiscomponent bestaat het product uit 0..* gerelateerde componenten van andere objecttypes. Ook dit zijn voorkomens. Het aantal gerelateerde componenten hangt af van het aantal gerelateerde objecten. Een bevraging van een woonplaats levert geen gerelateerde componenten op omdat er vanuit woonplaatsen niet naar andere objecten wordt verwezen. In de bijlagen 3A, 3B en 3C is per product de structuur schematisch aangegeven. 5.2 Momentopname versus levenscyclus Deze paragraaf beschrijft op algemene wijze hoe gegevens in de BAG aan elkaar zijn gerelateerd voor informatieproducten. En met name gericht op de verschillen tussen momentopname-producten en levenscyclusproducten: Product op basis van een momentopname: Een doorsnede van de gegevens wordt gemaakt op één datum, te weten de peildatum/actuele datum. Product op basis van levenscyclus: Van een bepaald object wordt de gehele levenscyclus gegeven. De selectie daarbij is niet op basis van een datum of tijdvak. Het product bestaat uit alle objectvoorkomens van alle objecten. De afnemer kan de situatie op ieder moment afleiden. Hiervoor moet deze dan zelf een momentopname afleiden en m.b.v. de objectrelaties uit het datamodel zelf de gegevens aan elkaar relateren en zo een momentopname-structuur invullen. 5.3 Relatieservices op momentopname De relaties tussen de verschillende objecttypen werken in één richting. Vanuit een nummeraanduiding wordt verwezen naar een openbare ruimte, maar andersom niet. Via de relatieservices is het mogelijk in tegengestelde richting de relaties op te vragen. Zo is ook op te vragen wat de openbare ruimtes in een woonplaats en wat de nummeraanduidingen in een openbare ruimte zijn. Per relatie is de selectie ingang altijd alleen de bag identificatie van het object die de relatie in IMBAG bevat. Optioneel kan een peildatum opgegeven worden. Met behulp van de verkregen ID s kunnen dan de gegevens van deze gerelateerde objecten opgevraagd worden. 5.4 Voorkomen redundantie Voor levenscyclus-producten worden alle voorkomens van objecten als een afzonderlijk bestandsdeel van het product geleverd, en wel zodanig dat elk voorkomen slechts éénmaal in het product voorkomt. Voor momentopname-producten zouden dezelfde gegevens vaker in de productstructuur kunnen voorkomen, ware het niet dat de maatregel is genomen om ieder object slechts éénmaal op te nemen. m.a.w.: ook voor momentopname-producten wordt een z.g. 'platte structuur' gehanteerd, waarbij ieder object uniek in het product voorkomt. Versie 1.0 10-08-2016 9 / 11
6 De service bepalen Bronhouder. 6.1 Inleiding Er zijn situaties waarin het wenselijk is te kunnen achterhalen bij welke bronhouder een object hoort. Het kunnen bepalen van de bronhouder is bijvoorbeeld een vereiste om terugmeldingen geautomatiseerd naar de juiste bronhouder te kunnen sturen. Ook voor (gemeentelijke) afnemers kan het handig zijn om te kunnen achterhalen welke bronhouder bij een object hoort. Bij BAG extract leveren wij de GWR tabel. In deze tabel wordt de relatie tussen de woonplaatscode en de gemeentecode geleverd. Aan de hand van deze tabel is via de woonplaats te achterhalen bij welke bronhouder een object hoort. Het Kadaster heeft de service bepalen bronhouder die wordt gebruikt om de bronhouder te bepalen bij terugmeldingen opgenomen in de nieuwste BAG bevragen webservice. Hierdoor is het mogelijk de bronhouder te bepalen via de webservice BAG bevragen. Het resultaat van de service levert de bronhouder uit de BAG als rol. De service levert expliciet niet de gemeente als objecttype. Gemeenten zijn namelijk niet als objecttype in de BAG opgenomen. Werking van de service. Afnemers hebben de keuze uit twee ingangen om de bronhouder te achterhalen. 1. Via het ID van het object 2. Via het coördinaat van de gekozen locatie. Gebruikers die bijvoorbeeld op basis van een postcode en huisnummer willen achterhalen welke bronhouder bij het object horen kunnen via twee bevragingen de bronhouder bepalen. Eerst kan via de postcode en het huisnummer het ID van het object achterhaald worden. Vervolgens kan op basis van dit ID de bronhouder bepaald worden. Bij bevragingen op basis van een PandID of een coördinaat wordt de bronhouder bepaald op basis van geometrische afleiding. Bij overige zoekingangen (het ID van een ander objecttype dan een pand) wordt de bronhouder bepaald op basis van administratieve afleiding. Als een pand op de grens van meerdere gemeenten ligt, dan worden alle gevonden gemeenten als bronhouder geleverd. 6.2 Via het ID van het object De afnemer kan het ID van het object opgeven. De service bepalen bronhouder levert vervolgens de gemeentecode en de gemeentenaam van de verantwoordelijke bronhouder. 6.3 Via een coördinaat Het is mogelijk van een specifieke locatie te achterhalen bij welke bronhouder deze locatie hoort. Dit is bijvoorbeeld nodig om terugmeldingen te kunnen verwerken waarbij wordt teruggemeld dat op een specifieke locatie een object ontbreekt. De service bepalen bronhouder levert vervolgens de gemeentecode en de gemeentenaam van de verantwoordelijke bronhouder. Versie 1.0 10-08-2016 10 / 11
7 Bijlagen Bijlage 1 geeft een schematisch overzicht van de aanroepen: Bijlage 1 Aanroepoverzicht (Hierbij is een apart tabblad opgenomen voor de extra functie Bevragen Bronhouder ) Bijlagen 2A, 2B en 2C beschrijven het resultaat per aanroep. Deze beschrijvingen zijn een aanvulling op het schematische aanroepoverzicht 1: Bijlage 2A Resultaat beschrijving Uniek Zoeken MO. Bijlage 2B Resultaat beschrijving Uniek Zoeken LVC. Bijlage 2C Resultaat beschrijving Niet-uniek Zoeken MO. Bijlagen 3A, 3B en 3C geven de productstructuur in schemavorm: Bijlage 3A Productschemas MO Bijlage 3B Productschemas MO - Relatieservices Bijlage 3C Productschemas LVC Versie 1.0 10-08-2016 11 / 11