Produktbeskrivning: Nedladdning uttag

Transkript

1 1 (9) Datum: Dokumentversion: Avser tjänstens gränssnittsversion: Produktbeskrivning: Nedladdning uttag Innehållsförteckning 1 Översiktlig beskrivning Funktioner Informationsinnehåll Informationsmängd belägenhetsadress Belägenhetsadress Basinformation Berörkrets Förändringsförteckning Översiktlig beskrivning I detta dokument beskrivs produkten Nedladdning uttag samt den information som kan tillhandahållas via denna. Uttaget är av engångskaraktär och ger en ögonblicksbild av informationen vid leveranstillfället (hämtningstillfället). Denna produkt används när man i förväg vet vilken information och för vilket bestånd man vill beställa information. T.ex. vi behöver ladda vår databas med belägenhetsadresser som finns i Gävle kommun för att uppdatera vårt adressregister. Beställning görs i Lantmäteriets Kundportal genom att ange informations- och beståndsurval som uttaget ska omfatta. Efter att beställningen är godkänd kan leverans hämtas med hjälp av unikt orderid och behörighetsnyckel som erhålls i samband med att beställningen godkänns. Produkten tillhandahålls via ett REST-api, maskin- till maskingränssnitt, där leveransen följer standardformaten XML/GML, se detaljer i den tekniska beskrivningen för produkten.

2 LANTMÄTERIET (9) 2 Funktioner Skapa uttag för order Med denna funktion skapas en order. Beroende på informationsurval skapas ett eller flera uttag. Svaret innehåller kvittensmeddelande att funktionen Skapa uttag har startats samt länk till skapat uttag. Hämta information om order Funktionen hämtar all information om urval, uttag och leveranser som finns kopplad till en order. En order innehåller ett eller flera uttag, beroende på informationsurval. Svaret innehåller information om vilka informationsurval som ordern omfattar samt information om uttag och leveranser som skapats för angiven order. Hämta information om uttag Funktionen hämtar information om ett specifikt uttag för en order. Ett uttag innehåller en eller flera leveranser, beroende på beståndsurval. Svaret innehåller information om uttaget och de leveranser som finns kopplade till detta. Hämta information om leverans Funktionen hämtar information om en specifik leverans för ett uttag kopplad till en order. Svaret innehåller information om vad en specifikt leverans, för ett uttag, innehåller samt dess status. Hämta information om leveranser Funktionen hämtar information om samtliga leveranser för ett uttag kopplad till en order. Svaret innehåller information om vad samtliga leveranser, för ett uttag, innehåller samt deras status. Hämta leverans för order Funktionen hämtar en specifik leverans kopplad till ett uttag. Svaret innehåller data för en specifik leverans.

3 Exempel 3 (9)

4 4 (9) 3 Informationsinnehåll De informationsmängder som kan tillhandahållas via produkten Uttag kommer att utökas successivt. 4 Informationsmängd belägenhetsadress En belägenhetsadress definieras enligt svensk standard bland annat som ett sätt att ange en plats utan att använda koordinater. Belägenhetsadressen kan ha viss tilläggsinformation, till exempel postnummer, postort, populärnamn och adressplatsanmärkning. 4.1 Belägenhetsadress Belägenhetsadress objektidentitet objektversion version giltig från objektstatus Sammanhållande objekt för information om belägenhetsadress. Unik identitet (UUID) för varje belägenhetsadress (adressplatsens UUID används). Anger vilken version adressplats har. Anger när versionen börjar gälla. Anger aktuell status för adressplatsen. Objektstatus kan vara: planerad gällande under utredning gällande. Adressplatsattribut Se tabell Adressplatsattribut i kap Adressplatsnamn Se tabell Adressplatsnamn i kap Adressområde Se tabell Adressområde i kap Gårdsadressområde Se tabell Gårdsadressområde i kap Adressplats anmärkning Se tabell Adressplatsanmärkning i kap Adressatt anläggning Se tabell Adressatt anläggning i kap Distrikttillhörighet Se tabell Distrikttillhörighet i kap Registerenhetsreferens Se tabell Registerenhetsreferens i kap Basinformation Adressplatsattribut Adressplatsbeteckning Innehåller information om adressplats inom ett gatu-, by-, gårds- eller metertalsadressområde. En adressplats är ett adresserbart objekt som utgörs av en geografisk plats som behöver beskrivas med en belägenhetsadress. Referens till Adressplatsbeteckning. Se tabell Adressplatsbeteckning.

5 LANTMÄTERIET (9) adressplatstyp insamlingsläge adressplatspunkt status för belägenhetsadress postnummer postort Anger typ av adressplats. Adressplatstyp kan vara: gatuadressplats metertalsadressplats byadressplats gårdsadressplats. Anger vad adressplatspunktens läge avser. Punktläget för adressplatsen kan vara: byggnad ingång infart tomtplats ungefärligt lägesbestämd övrigt läge. Adressplatsens koordinatläge. Koordinaterna anges endast i plan. Anger aktuell status för belägenhetsadressen. Status kan vara reserverad eller gällande. Adressplatsens postnummer fastställd av PostNord AB. Adressplatsens postort, fastställd av PostNord AB. Adressplatsbeteckning adressplatsnummer bokstavstillägg lägestillägg Av kommunen fastställd beteckning bestående av ett adressnummer och till detta underordnade adresskomponenter som inom ett adressområde identifierar en adressplats. Adressplatsbeteckningen är unik inom adressområdet och utgör en del av beteckningen för belägenhetsadress. Adressnummer som sätts på adressplatserna inom ett adress-område. Ett tillägg till adressplatsnumret i form av en eller två bokstäver. Ett tillägg till adressplatsnumret som identifierar en uppgång i en entré. Lägestillägg kan vara: UH = Uppgång höger UV = Uppgång vänster U = Uppgång. lägestilläggsnummer Ett unikt nummer tillhörande lägestillägget U, t.ex. U1, U2. avvikande adressplatsbeteckning avviker från standarden Anger den adressplatsbeteckning som avviker från standarden, t.ex. så kan adressplatsnummer saknas. Anger att adressplatsbeteckningen inte följer Svensk standard för belägenhetsadresser, SS637003:2015. Avvikelse anges med true.

6 LANTMÄTERIET (9) Adressplatsnamn populärnamn ortid Alternativ benämning på adressplatsen. Namn som inte är en del av adressen men som används som ett komplement till belägenhetsadressen för att identifiera en eller en samling av adressplatser. Referens till Lantmäteriets ortnamnsregister. Fältet används inte. Gårdsadressområde fastställt namn ortid objektstatus Adressområde Gårdsadressområde är ett adressområde inom ett byadressområde där gårdsadresser tillämpas och är underordnat ett byadressområde. Gårdsadressområden kan användas för en del av byadressområdet, till exempel en liten bebyggelsegrupp eller en gård, som kan beskrivas med ett gemensamt sammanfattande namn. Namnet på gårdsadressområdet ska vara unikt inom byadressområdet. Av kommunen fastställt namn för gårdsadressområdet. Namnet är unikt inom byadressområdet. Referens till Lantmäteriets ortnamnsregister. Fältet används inte. Anger aktuell status för gårdsadressområdet. Objektstatus kan vara: planerad gällande under utredning gällande. Referens med UUID till det adressområde som gårdsadressområdet tillhör. Se tabell Adressområde. Adressområde fastställt namn ortid Geografiskt område vars utbredning beskrivs av de adressplatser som tillhör adressområdet. Adressområde utgör en del av beteckningen för belägenhetsadress. Det geografiska området för ett adressområde kan exempelvis avse en gata/väg, by eller andra bebyggelseområden. Anger namnet på adressområdet. Namnet är unikt inom den geografiska kommundelen. För en kommun kan samma fastställda namn på adressområdet finnas i flera geografiska kommundelar. Referens till Lantmäteriets ortnamnsregister. Fältet används inte.

7 LANTMÄTERIET (9) adressområdestyp objektstatus Kommundel Anger typ av adressområde. Adressområdestypen kan vara: gatuadressområde metertalsadressområde byadressområde. Anger aktuell status för adressområdet. Objektstatus kan vara: planerad gällande under utredning gällande. Referens med UUID till den geografiska kommundel adressområdet tillhör. Se tabell Kommundel. Kommundel fastställt namn ortid objektstatus Kommun Geografiskt avgränsat, icke överlappande, vanligen sammanhängande område inom en kommun. Geografisk kommundel omfattar en del av en kommun och hela kommunen består av geografiska kommundelar. När en kommun inte har indelats i geografiska kommundelar betraktas hela kommunen som en enda geografisk kommundel. Används för att skapa unika belägenhetsadresser. Av kommunen fastställt namn för den geografiska kommundelen. Namnet ska vara unikt inom kommunen. Referens till Lantmäteriets ortnamnsregister. Fältet används inte. Anger aktuell status för den geografiska kommundelen. Objektstatus kan vara: planerad gällande under utredning gällande. Referens med kommunkod till den kommun den geografiska kommundelen tillhör. Ex Se tabell Kommun. Kommun kommunkod kommunnamn Adressplatsanmärkning Anger inom vilken kommun en belägenhetsadress är belägen. Anger kod för kommun. Anger namn på kommun. Kommunnamn utgör en del av beteckningen för en fullständig belägenhetsadress. Upplysning om en plats som inte adressätts, men som hittas via den adressplats som har anmärkning.

8 LANTMÄTERIET (9) anmärkningstyp anmärkningstext Anger typ av adressplatsanmärkning. Adressplatsanmärkning kan vara: angöringsplats för taxi busshållplats järnvägsstation/hållplats kajplats spårvagnshållplats stoppställe för postutdelning nedgång tunnelbanestation övrig anmärkning. Fritext som ytterligare beskriver anmärkningstypen. Adressatt anläggning anläggningstyp anläggningstext Anläggning som har en adress. Används när adressplatsen avser annan företeelse än adress till byggnad eller obebyggd fastighet. Anger typ av adressatt anläggning. Adressatt anläggning kan vara: avloppspumpstation brygga idrottsanläggning småbåtshamn tele- och radiomast transformation, transformatorstation, nätstation vattentäkt återvinningsstation. Fritext som beskriver anläggningstypen. Distriktstillhörighet distriktskod distriktsnamn Anger till vilket distrikt en belägenhetsadress tillhör. Anger kod för distrikt. Unik kod bestående av sex siffror. Anger namn för distrikt. Namnet är inte unikt. 4.3 Berörkrets Registerenhetsreferens objektidentitet Referens till den fastighet eller samfällighet belägenhetsadressen hör till. Unik identitet (UUID) för varje fastighet eller samfällighet.

9 LANTMÄTERIET (9) 5 Förändringsförteckning Version Datum Orsak samt ändring mot tidigare version Första versionen