Adress Direkt v2.0 - teknisk beskrivning

Transkript

1 Adress Direkt v2.0 - teknisk beskrivning Dokumentversion 1.1 Gränssnittsdefinition Produktion WSDL XML-schema dress-2.0.wsdl dress-2.0.xsd Verifiering WSDL XML-schema dress-2.0-ver.wsdl dress-2.0.xsd Frågor och svar Hitta och Hämta adress Id för adress Id för adress består alltid av 11 siffror och består av adressplatsprefix samt adressplatsid. När dessa tillsammans innehåller färre än 11 siffror fylls id:t ut med 0:or. Om tex prefixet är 1 och adressplatsid är 1234 blir id för adressen I svaret från en fritextsökning får man id utfyllt med 0:or som direkt kan användas i en sökning. När man får hela adressobjektet som svar är adressplatsprefix och adressplatsid olika element och innehåller inga 0:or, man får själv sätta ihop hela id:t om det ska användas för en ny sökning. Frågetyp

2 FindAdressRequest hitta Adress med något av nedanstående sökbegrepp AdressCriteria hitta en eller flera Adress m h a komplex filtrering Point hitta Adress närmast belägen angiven koordinat fastighetsnyckel hitta Adress med angiven fastighetsnyckel id hitta Adress med angiven identifierare AdressCriteria hitta en eller flera Adress m h a komplex filtrering kommunnamn adressomrade adressplatsnummer kommunnamn i klartext vanligen ett gatunamn, namnet på en väg eller ett torg vanligen ett portnummer, inklusive bokstavsbeteckningar (s k littera) maxantal önskat maximalt antal träffar (default 100, högst 400) <app:findadressrequest <app:adresscriteria> <app:kommunnamn>gävle</app:kommunnamn> <app:adressomrade match="starts_with">över</app:adressomrade> <app:adressplatsnummer match="equals">10</app:adressplatsnummer> <app:maxantal>20</app:maxantal> </app:adresscriteria> </app:findadressrequest> Point hitta Adress närmast belägen angiven koordinat pos koordinat angiven i Sweref 99 TM (enligt ordningen northing, easting) <app:findadressrequest <gml:point> <gml:pos> </gml:pos> </gml:point> </app:findadressrequest> fastighetsnyckel hitta Adress med angiven fastighetsnyckel

3 <app:findadressrequest <app:fastighetsnyckel> </app:fastighetsnyckel> </app:findadressrequest> id hitta Adress med angiven identifierare <app:findadressrequest <app:id> </app:id> </app:findadressrequest>

4 Svarstyp FindAdressResponse Adress behållare för sökningens resultat - ingen, en eller flera sökträffar av typen Adress belägenhetsadress som entydigt anger läget för en bestämd plats Adress fastighetsnyckel adressplatsprefix adressplatsid Innehåller information om adresser. Uppgifterna används även för att söka efter adressuppgifter. Unik identifierare för fastighet i fastighetsregistret. Anger vilken fastighet adressplatsen hör till. Bildar, tillsammans med Adressplatsid, unik identifierare för en Adressplats. Bildar, tillsammans med Adressplatsprefix, unik identifierare för en Adressplats. adressplatsnummer Adressplatsens nummer inklusive eventuell bokstav t.ex. 4, 12A, B. adressplatstyp Anger typ av adressplats. Adressplatsen kan vara Gatuadressplats, Metertalsadressplats, Byadressplats eller Gårdsadressplats. Kod för typ av adressplats: 1 = Nummer och ev. littera eller lägestillägg (ex gatuadress: Storgatan 12A, Storgatan 16A ÖG) 2 = Avståndsangivelse (ex metertalsadress: Byvägen ) 3 = Nummer och ev. littera (ex byadress: Storbyn 2, Storbyn 3A) 4 = Nummer och ev. littera (ex gårdsadress: Storbyn Sörgården 1, Storbyn Sörgården 2A) 5 = Odefinierad adressplats lanskod lansnamn kommunkod kommunnamn skiljenamn adressomradestyp Anger kod för län där adressplatsen är belägen. Anger namn på län där adressplatsen är belägen. Anger kod för kommun där adressplatsen är belägen. Anger namn på kommun där adressplatsen är belägen. Skiljenamn används inte längre. Attributet innehåller ingen information. Anger typ av adressområde. Adressområdet kan vara Gatuadressområde, Metertalsadressområde eller Byadressområde Kod för typ av adressområde: 1 = Gatu- eller vägnamn, nummerbaserade adresser 2 = Gatu- eller vägnamn, avståndsbaserade adresser 3 = Bynamn, namn och nummerbaserade adresser

5 adressomrade gardsadressomrade postnummer postort popularnamn belagenhetsadresstatus kommundelsprefix kommundelsid kommundelsnamn adressplatspunkt Anger namn på adressområdet för adressplatsen. Är ofta gatunamn eller bynamn. Anger namn på gårdsadressområdet för adressplatsen, t.ex. gårdsnamn. Postnummer. Postort. Anger namn som är känt och allmänt används för att lokalisera adressplatsen. Anger aktuell status för belägenhetsadressen. Statusen kan vara Gällande eller Reserverad. Bildar unik identifierare tillsammans med Kommundelsid för kommundel. Bildar unik identifierare tillsammans med Kommundelsprefix för kommundel. Anger namn på kommundel för adressplatsen. Används för att skilja flera adressområden med samma namn inom en kommun. Adressplatsens koordinatläge. Koordinaterna anges endast i plan. adressplatspunkt pos koordinat angiven i Sweref 99 TM (enligt ordningen northing, easting)

6 <app:findadressresponse <app:adress gml:id="id_ "> <app:fastighetsnyckel> </app:fastighetsnyckel> <app:adressplatsprefix>1</app:adressplatsprefix> <app:adressplatsid>91215</app:adressplatsid> <app:adressplatsnummer>10</app:adressplatsnummer> <app:adressplatstyp>01</app:adressplatstyp> <app:lanskod>21</app:lanskod> <app:lansnamn>gävleborgs LÄN</app:lansnamn> <app:kommunkod>80</app:kommunkod> <app:kommunnamn>gävle</app:kommunnamn> <app:skiljenamn/> <app:adressomradestyp>1</app:adressomradestyp> <app:adressomrade>överhammarsvägen</app:adressomrade> <app:gardsadressomrade/> <app:postnummer>81794</app:postnummer> <app:postort>axmar</app:postort> <app:popularnamn/> <app:belagenhetsadresstatus>2</app:belagenhetsadresstatus> <app:kommundelsprefix>1</app:kommundelsprefix> <app:kommundelsid>162</app:kommundelsid> <app:kommundelsnamn>hamrånge</app:kommundelsnamn> <app:adressplatspunkt> <gml:pos> </gml:pos> </app:adressplatspunkt> </app:adress> </app:findadressresponse> Hitta adress Frågetyp FindAdressreferensRequest hitta Adressreferens med nedanstående sökbegrepp FritextCriteria hitta en eller flera Adressreferens med etikett motsvarande angiven söktext

7 FritextCriteria hitta en eller flera Adresssreferens med etikett motsvarande angiven söktext fritext textmatchning (med operator EQUALS eller STARTS_WITH) maxantal önskat maximalt antal träffar (default 100, högst 400) <app:findadressreferensrequest <app:fritextcriteria> <app:fritext match="starts_with">norra kungsg</app:fritext> <app:maxantal>2</app:maxantal> </app:fritextcriteria> </app:findadressreferensrequest> Svarstyp FindAdressreferensResponse Adressreferens behållare för sökningens resultat - ingen, en eller flera sökträffar av typen Adressreferens enkel representation av Adress Adressreferens etikett id Utgör en förenklad representation av informationen om en adress inklusive dess identitet Adressplatsens sammansatta namn inkl. adressplatsnummer, t.ex. Gävle Nygatan 9C Anger adressplatsens unika identifierare <app:findadressreferensresponse <app:adressreferens> <app:etikett>falköping NORRA KUNGSGATAN 1A</app:etikett> <app:id> </app:id> </app:adressreferens> <app:adressreferens> <app:etikett>falköping NORRA KUNGSGATAN 1B</app:etikett> <app:id> </app:id> </app:adressreferens> </app:findadressreferensresponse>

8