Handleiding. CRAB Read. Bevragingen op Lite CRAB. Agentschap voor Geografische Informatie Vlaanderen

Transcriptie

1 Handleiding CRAB Read Bevragingen op Lite CRAB Agentschap voor Geografische Informatie Vlaanderen

2 Inhoud Inhoud 2 1 Inleiding 3 2 Operaties en datatypes Overzicht Lite CRAB entiteiten Adres Gebouw Perceel RrAdres Straat Wegverbinding RrStraat List operaties ListGemeente ListPostcodeByGemeente ListStraatnaamByGemeente ListRrStraatcodeByStraatnaam ListDomeinCategorie ListDomeinWaardeByCategorie Find operaties FindAdres FindGebouw FindPerceel FindStraat FindWegverbinding Query operaties QueryAdres QueryGebouw QueryPerceel QueryStraat QueryWegverbinding Get operaties GetAdres GetGebouw GetPerceel GetStraat GetWegverbinding GetWegverbindingen 21 3 Implementatie 22 2 / 22 Handleiding CRABTools

3 1 Inleiding De CRAB Read service biedt raadpleegfunctionaliteit aan op de Lite CRAB entiteiten. Handleiding CRABTools 3 / 22

4 2 Operaties en datatypes 2.1 Overzicht Er zijn vier soorten operaties: List: oplijsten van entiteiten op basis van nul of één parameter; oplijsten van domeinwaardes; Find: opzoeken van entiteiten via vaste parameters; Query: opzoeken van entiteiten via samenstel van predicaten; Get: opvragen van details van een enkel exemplaar. In wat volgt worden de operaties en hun response en request parameters nader toegelicht. 4 / 22 Handleiding CRABTools

5 2.2 Lite CRAB entiteiten Adres Handleiding CRABTools 5 / 22

6 Een adres kan ofwel een huisnummer ofwel een subadres zijn. In het eerste geval zijn busnummer en appnummer leeg, in het tweede geval is een van beide attributen ingevuld (maar nooit beide tegelijk). Het attribuut wkt bevat de puntgeometrie van de adrespositie. De postcode kan mogelijks leeg zijn Gebouw Het attribuut wkt bevat de vlakgeometrie van het gebouw. 6 / 22 Handleiding CRABTools

7 2.2.3 Perceel Het attribuut capakey is een unieke 17 karakters lange code voor het perceel en is een concatenatie van de deelsleutels kadastrale afdelingscode, kadastrale sectiecode en kadastraal perceelsnummer RrAdres Het attribuut rrindex kan leeg zijn. Het attribuut subkantoncode bevat een viercijferige code dat behoudens een paar uitzonderingen overeenkomt met de postcode. Handleiding CRABTools 7 / 22

8 2.2.5 Straat Het attribuut straatnaam bevat de Nederlandstalige schrijfwijze van de naam van de straat. Het attribuut straatnaam2 bevat de eventuele anderstalige schrijfwijze of is leeg. 8 / 22 Handleiding CRABTools

9 2.2.6 Wegverbinding Handleiding CRABTools 9 / 22

10 De entiteit wegverbinding bevat zowel informatie over het wegobject zelf als over de zogeheten straatkanten. Omdat het Full CRAB model het principe van dynamische segmentering kent en dus toelaat dat een wegobject over delen van eenzelfde kant aan verschillende straatnamen gekoppeld is, kan een wegverbinding meermaals voorkomen in Lite CRAB. Dat betekent dat eenzelfde waarde voor het attribuut id meermaals kan voorkomen. Het attribuut uniqueid is wel uniek en volgt het formaat [id]l[straatidlinks]r[straatidrechts]. Het attribuut wkt bevat de lijngeometrie van de wegverbinding. De attributen straatidlinks en straatidrechts kunnen leeg zijn. Als dat het geval is, zullen ook de respectievelijke kantattributen eerstehuisnummer, laatstehuisnummer en pariteit leeg zijn RrStraat Het attribuut subkantoncode bevat een viercijferige code dat behoudens een paar uitzonderingen overeenkomt met de postcode. 2.3 List operaties ListGemeente request De operatie ListGemeente wordt aangeroepen zonder parameters response De operatie ListGemeente geeft een <ListGemeenteResponse> element terug. Dit bevat een oplijsting van de Nederlandstalige namen van de gemeenten in Vlaanderen. 10 / 22 Handleiding CRABTools

11 2.3.2 ListPostcodeByGemeente request Aan de operatie ListPostcodeByGemeente wordt een <gemeente> meegegeven als parameter. Dit is de Nederlandstalige naam van de gemeente zoals gekend in CRAB response De operatie ListPostcodeByGemeente geeft een <ListPostcodeByGemeenteResponse> element terug. Dit bevat een oplijsting van de postcodes die voorkomen binnen de opgegeven gemeente ListStraatnaamByGemeente request Aan de operatie ListStraatnaamByGemeente wordt een <gemeente> meegegeven als parameter. Dit is de Nederlandstalige naam van de gemeente zoals gekend in CRAB response De operatie ListStraatnaamByGemeente geeft een <ListStraatnaamByGemeenteResponse> element terug. Dit bevat een oplijsting van de Nederlandstalige namen van de straten binnen de opgegeven gemeente ListRrStraatcodeByStraatnaam request Aan de operatie ListRrStraatcodeByStraatnaam worden de parameters <gemeente> en <straatnaam> meegegeven. Dit zijn respectievelijk de Nederlandstalige naam van de gemeente zoals gekend in CRAB en de Nederlandstalige naam van de betreffende straat. Handleiding CRABTools 11 / 22

12 response De operatie ListRrStraatcodeByStraatnaam geeft een <ListRrStraatcodeByStraatnaamResponse> element terug. Dit bevat een oplijsting van de straatcodes zoals gekend in het Rijksregister dewelke gekoppeld zijn aan de opgegeven straat. Een straatcode bestaat in principe uit een viercijferige code ListDomeinCategorie request De operatie ListDomeinCategorie wordt aangeroepen zonder parameters response De operatie ListDomeinCategorie geeft een <ListDomeinCategorieResponse> element terug. Deze bevat de verschillende categoriën van domeinwaarden. Dit zijn: - adres_herkomst - adres_status - gebouw_aardgebouw - gebouw_geometriemethode - gebouw_status - straat_status - wegverbinding_geometriemethode - wegverbinding_kant - wegverbinding_morfologie - wegverbinding_pariteit - wegverbinding_status - wegverbinding_verharding ListDomeinWaardeByCategorie request Aan de operatie ListDomeinWaardeByCategorie een <categorie> meegegeven als parameter. Dit is een van hogervermelde categoriën van domeinwaarden. 12 / 22 Handleiding CRABTools

13 response De operatie ListDomeinWaardeByCategorie geeft een <ListDomeinWaardeByCategorieResponse> element terug. Dit bevat een oplijsting van domeinwaardes voor de opgegeven categorie. Deze zelfde waardes komen terug in de attributen van de Lite CRAB entiteiten. 2.4 Find operaties Bij deze operaties zijn alle parameters optioneel. Hoe meer parameters worden ingevuld, hoe verfijnder het zoeken kan gebeuren. Wanneer er geen parameters worden ingevuld, dan worden in theorie alle exemplaren teruggegeven. Er is wel een maximum van Het jokerteken % kan worden meegegeven in de parameters, zowel in het begin, aan het einde als beide. Je kan dus zowel zoeken naar %weg als naar weg% als naar %weg%. De find operaties geven steeds alleen de entiteit terug waarop gezocht werd en nooit de gerelateerde entiteiten. Die worden bekomen met een get operatie FindAdres request Aan de operatie FindAdres worden volgende parameters meegegeven: Handleiding CRABTools 13 / 22

14 Het betreft dus parameters die overeenkomen met de attributen van de entiteit Adres response De operatie FindAdres geeft een <FindAdresResponse> element terug. Dit bevat een lijst van adressen die aan de opgegeven criteria voldoen FindGebouw request Aan de operatie FindAdres worden volgende parameters meegegeven: Het betreft dus parameters die ofwel overeenkomen met de attributen van de entiteit Gebouw zelf ofwel met attributen van de gekoppelde entiteit Adres response De operatie FindGebouw geeft een <FindGebouwResponse> element terug. Dit bevat een lijst van gebouwen die aan de opgegeven criteria voldoen FindPerceel request Aan de operatie FindPerceel worden volgende parameters meegegeven: 14 / 22 Handleiding CRABTools

15 Het betreft dus parameters die ofwel overeenkomen met de attributen van de entiteit Perceel ofwel met attributen van de gekoppelde entiteit Adres response De operatie FindPerceel geeft een <FindPerceelResponse> element terug. Dit bevat een lijst van percelen die aan de opgegeven criteria voldoen FindStraat request Aan de operatie FindStraat worden volgende parameters meegegeven: response De operatie FindStraat geeft een <FindStraatResponse> element terug. Dit bevat een lijst van straten die aan de opgegeven criteria voldoen. Handleiding CRABTools 15 / 22

16 2.4.5 FindWegverbinding request Aan de operatie FindWegverbinding worden volgende parameters meegegeven: Het betreft dus parameters die ofwel overeenkomen met de attributen van de entiteit Wegverbinding zelf ofwel met attributen van de gekoppelde entiteit Straat response De operatie FindWegverbinding geeft een <FindWegverbindingResponse> element terug. Dit bevat een lijst van wegverbindingen die aan de opgegeven criteria voldoen. 2.5 Query operaties De query operaties geven steeds alleen de entiteit terug waarop gezocht werd en nooit de gerelateerde entiteiten. Die worden bekomen met een get operatie. Aan alle query operaties wordt een <QueryObject> element meegegeven als parameter. ELEMENT Criterium Gemeente MaxResults OMSCHRIJVING Bevat de zoekvoorwaarden aan dewelke de exemplaren dienen te voldoen. Bevat de naam van de gemeente. Indien ingevuld dient dit als extra zoekvoorwaarde. Bevat een aanduiding van het maximale aantal exemplaren dat de operatie mag terug geven in het resultaat. Dat zijn er nooit meer dan / 22 Handleiding CRABTools

17 Een <Criterium> element kan bestaan uit een enkel <Predicate>. Er kan op alle attributen van de entiteit worden gezocht, maar niet op attributen van gekoppelde objecten. ELEMENT OMSCHRIJVING Bevat een vergelijkingsoperator. Geldige waarden zijn: ComparisonOperator EqualTo NotEqualTo LessThan LessThenEqualTo GreaterThan GreaterThenEqualTo IsNull IsNotNull Like FieldName Value Bevat de naam van het attribuut waaraan de voorwaarde wordt gesteld. Bevat de waarde die gesteld wordt aan de vergelijking. Merk op dat het te gebruiken datatype afhangt van het datatype van het betreffende attribuut. Dient leeg te zijn indien gebruik wordt gemaakt van de vergelijkingsoperatoren IsNull en IsNotNull. Een <Criterium> element kan ook bestaan uit een <CriteriaCombination>. Handleiding CRABTools 17 / 22

18 ELEMENT Criterium1 Criterium2 LogicalOperator OMSCHRIJVING Bevat een enkel criterium (<Predicate>) of een samenstel van criteria (<CriteriaCombination>). Bevat een enkel criterium (<Predicate>) of een samenstel van criteria (<CriteriaCombination>). Bevat een logische operator. Geldige waarden zijn: And: beide clausules moeten waar opleveren; Or: één van beide clausules moet waar opleveren QueryAdres request Aan de operatie QueryAdres wordt een <QueryObject> element meegegeven als parameter response De operatie QueryAdres geeft een <QueryAdresResponse> element terug. Dit bevat een lijst van adressen die aan de opgegeven criteria voldoen QueryGebouw request Aan de operatie QueryGebouw wordt een <QueryObject> element meegegeven als parameter response De operatie QueryGebouw geeft een <QueryGebouwResponse> element terug. Dit bevat een lijst van gebouwen die aan de opgegeven criteria voldoen. 18 / 22 Handleiding CRABTools

19 2.5.3 QueryPerceel request Aan de operatie QueryPerceel wordt een <QueryObject> element meegegeven als parameter response De operatie QueryPerceel geeft een <QueryPerceelResponse> element terug. Dit bevat een lijst van percelen die aan de opgegeven criteria voldoen QueryStraat request Aan de operatie QueryStraat wordt een <QueryObject> element meegegeven als parameter response De operatie QueryStraat geeft een <QueryStraatResponse> element terug. Dit bevat een lijst van straten die aan de opgegeven criteria voldoen QueryWegverbinding request Aan de operatie QueryWegverbinding wordt een <QueryObject> element meegegeven als parameter response De operatie QueryWegverbinding geeft een <QueryWegverbindingResponse> element terug. Dit bevat een lijst van wegverbindingen die aan de opgegeven criteria voldoen. 2.6 Get operaties De get operaties geven zowel de entiteit terug waarop gezocht werd als de gerelateerde entiteiten GetAdres request Aan de operatie GetAdres wordt volgende parameter meegegeven: response De operatie GetAdres geeft een <GetAdresResponse> element terug. Handleiding CRABTools 19 / 22

20 2.6.2 GetGebouw request Aan de operatie GetGebouw wordt volgende parameter meegegeven: response De operatie GetGebouw geeft een <GetGebouwResponse> element terug GetPerceel request Aan de operatie GetPerceel wordt volgende parameter meegegeven: response De operatie GetPerceel geeft een <GetPerceelResponse> element terug GetStraat request Aan de operatie GetStraat wordt volgende parameter meegegeven: response De operatie GetStraat geeft een <GetStraatResponse> element terug. 20 / 22 Handleiding CRABTools

21 2.6.5 GetWegverbinding request Aan de operatie GetWegverbinding wordt volgende parameter meegegeven: response De operatie GetWegverbinding geeft een <GetWegverbindingResponse> element terug. Dit is het eerste exemplaar dat wordt gevonden met het betreffende id. Indien er meerdere exemplaren zijn met hetzelfde id, dan wordt hoegenaamd geen uitspraak gedaan over welk van de exemplaren door deze operatie wordt terug gegeven GetWegverbindingen request Aan de operatie GetWegverbindingen wordt volgende parameter meegegeven: response De operatie GetWegverbindingen geeft een <GetWegverbindingenResponse> element terug. Dit bevat een lijst van alle wegverbinding met het opgegeven id. Handleiding CRABTools 21 / 22

22 3 Implementatie De CRAB Read service kan met deze URL worden geraadpleegd: De beschrijving van deze web service (het WSDL-bestand) kan als volgt worden bekomen: 22 / 22 Handleiding CRABTools