BBR OIOXML. Vejledning til snitfladen: Address.wsdl

Transkript

1 OIOXML Vejledning til snitfladen: En vejledning rettet mod 3. part.

2 Ændringer i forhold til forrige versioner Version 1.0 Første version, Version : Opdateret med de tilbagemeldinger som blev modtaget efter udsendelse af version 1.0. AddressAccessIdentifier optionel i AddressSpecificUserKeys RecordChangeDateTime tilføjet til AddressPoint- DeleteResponseStructure. RecordChangeDateTime tilføjet til AddressPoint- CreateRequestStructure. Præcisering vedr. brug af vejkoder, som ikke er valid i CPR. (afsnit 3.5.1) Diverse præciseringer vedrørende brug af metoderne. Nyt afsnit 4.6 skemavalidering Snitfladebeskrivelse Side 2 af 89

3 Indholdsfortegnelse 1. Introduktion Formål og målgrupper Formål Målgrupper Datasammenhæng Adgangsadresser og enhedsadresser Gældende adresser Foreløbige adresser og sagsadresser Adressesager Adressers entydighed Adgangsadresser uden husnummer Adresseforekomstens liv Adressepunkt Adressers tilknytning til matrikler Status for adresser webservice IgnoreWarningIndicator printenableindicator Opdateringsmekanisme RecordChangeDateTime Foreløbige koordinater Skemavalidering Metoder til adgangsadresser AddressAccessGetById AddressAccessGetByIdRequestStructure AddressAccessGetByIdResponseStructure AddressAccessGet AddressAccessGetRequestStructure AddressAccessGetResponseStructure AddressAccessCreate AddressAccessCreateRequestStructure AddressAccessCreateResponseStructure AddressAccessUpdate AddressAccessUpdateRequestStructure AddressAccessUpdateResponseStructure AddressAccessDelete AddressAccessDeleteRequestStructure AddressAccessDeleteResponseStructure Metoder til enhedsadresser AddressSpecificGetById AddressSpecificGetByIdRequestStructure AddressSpecificGetByIdResponseStructure AddressSpecificGet AddressSpecificGetRequestStructure AddressSpecificGetResponseStructure AddressSpecificCreate AddressSpecificCreateRequestStructure Snitfladebeskrivelse Side 3 af 89

4 AddressSpecificCreateResponseStructure AddressSpecificUpdate AddressSpecificUpdateRequestStructure AddressSpecificUpdateResponseStructure AddressSpecificDelete AddressSpecificDeleteRequestStructure AddressSpecificDeleteResponseStructure Metoder til adressesager AddressCaseGetById AddressCaseGetByIdRequestStructure AddressCaseGetByIdResponseStructure AddressCaseGet AddressCaseGetRequestStructure AddressCaseGetResponseStructure AddressCaseCreate AddressCaseCreateRequestStructure AddressCaseCreateResponseStructure AddressCaseUpdate AddressCaseUpdateRequestStructure AddressCaseUpdateResponseStructure AddressCaseDelete AddressCaseDeleteRequestStructure AddressCaseDeleteResponseStructure Metoder til adressegeometri AddressPointCreate AddressPointCreateRequestStructure AddressPointCreateResponseStructure AddressPointUpdate AddressPointUpdateRequestStructure AddressPointUpdateResponseStructure AddressPointDelete AddressPointDeleteRequestStructure AddressPointDeleteResponseStructure Metoder til søgningerne AddressSearch AddressSearchRequestStructure AddressSearchResponseStructure AddressCaseSearch AddressCaseSearchRequestStructure AddressCaseSearchResponseStructure Fælles strukturer AddressAccessRequestStructure AddressAccessResponseStructure AddressAccessUserKeys AddressAccessInformation AddressAccessRequestDates AddressAccessResponseDates AddressAccessCaseResponse AddressSpecificRequestStructure AddressSpecificResponseStructure AddressSpecificUserKeys Snitfladebeskrivelse Side 4 af 89

5 AddressSpecificInformation AddressSpecificRequestDates AddressSpecificResponseDates AddressSpecificCaseResponse AddressCaseRequestStructure AddressCaseResponseStructure AddressCaseAddressAccessRequestKeys AddressCaseAddressSpecificRequestKeys AddressCaseAddressAccessResponseKeys AddressCaseAddressSpecificResponseKeys ExternalReferences BBBlandParcelIdentityStructure addresspoint MunicipalityFields ReturnMessage Adgang til snitfladen Sikkerhed Autorisation Testmiljø Snitfladebeskrivelse Side 5 af 89

6 1. Introduktion Denne snitfladebeskrivelse beskriver en af de OIOXML snitflader, som systemet stiller til rådighed. Baggrunden for snitfladen er, at man ønsker at registrere og opdatere adresser i ved webservicebaseret overførsel fra et ekstern system i OIOXML format. Snitfladen findes på Kommune under Selve dokumentationen findes i biblioteket documents : Selve servicen/wsdl en i biblioteket servicegateway : Snitfladebeskrivelsen giver kort sagt mulighed for fremsøgning samt opdatering af adressedata i, herunder adgangsadresser og deres geometri, enhedsadresser, samt adressesager. Kapitel 2 giver en mere detaljeret beskrivelse af snitfladens formål samt dens målgruppe. Kapitel 3 beskriver de grundlæggende begreber og definitioner for adresser, herunder adgangsadresser, adressepunkter, enhedsadresser og adressesager. Kapitel 4 giver et overblik over den webservice og dens metoder, som udgør snitfladen. Det tilhørende WSDL-dokument, som kan betegnes som kontrakten på snitfladens interface/struktur, bliver beskrevet. Snitfladens metoder kan deles op i 5 områder. Disse 5 områder og de tilhørende metoder beskrives i detaljer i kapitel 5 til 9. kapitel 5 beskriver metoderne til entiteten adgangsadresse kapitel 6 beskriver metoderne til entiteten enhedsadresse kapitel 7 beskriver metoderne til entiteten adressessag kapitel 8 beskriver metoderne til entiteten adressepunkt kapitel 9 beskriver metoderne til søgninger på adresser og adressesager Beskrivelsen af metoderne indeholder også en beskrivelse af de anvendte strukturer. Kapitel 10 beskriver nogle fælles strukturer, som benyttes i mere end en metode. Kapitel 11 beskriver de betingelser, som skal være opfyldt for at få adgang til snitfladen, deriblandt sikkerheden omkring snitfladen. Der gøres opmærksom på, at notater på adresser opdateres og hentes ved en særskilt snitflade, kaldt Note.wsdl. Der henvises til vejledningen for denne snitfalde hvis man gerne vil hente, opdatere eller oprette notater for adresser. Snitfladebeskrivelse Side 6 af 89

7 Der gøres endvidere opmærksom på, at denne snitflade ikke indeholder en funktion til at hente alle vejnavne og vejkoder i en kommune. Denne funktion stilles til rådighed i en særskilt webservice. Der henvises til vejledningen for denne snitflade, hvis man har behov for at hente alle vejnavne/vejkoder i en kommune. Snitfladebeskrivelse Side 7 af 89

8 2. Formål og målgrupper 2.1. Formål Snitfladen har til formål at gøre det muligt for kommunerne at fremsøge og ajourføre adressedata i. Snitfladen er en tovejskommunikation mellem en leverandør/kommune og systemet. Den gør det muligt at hente adressedata fra systemet og den gør det muligt at sende adressedata til opdatering af. Når der skrives adressedata dækker det over følgende entiteter: adgangsadresser enhedsadresser adressesager adressepunkter hørende til adgangsadresser 2.2. Målgrupper Snitfladens funktioner henvender sig hovedsaglig til private eller offentlige itvirksomheder som ønsker udvikle it- eller GIS-løsninger eller andre komponenter, der ved hjælp af webservicebaseret overførsel kan anvendes til at registrere eller opdatere s adresseoplysninger inkl. adressepunkter (dvs. adressekoordinater). Snitfladebeskrivelse Side 8 af 89

9 3. Datasammenhæng Snitfladen indeholder metoder hørende til følgende 4 entiteter o Adgangsadresse o Enhedsadresse o Adressesag o Adressepunkt For at kunne forstå den efterfølgende vejledning er det vigtigt at kende de følgende begreber og definitioner, samt begrebernes sammenhæng Adgangsadresser og enhedsadresser Ved en adgangsadresse forstås en betegnelse, som ved hjælp af vejnavn, husnummer og postnummer, angiver beliggenheden af en bestemt adgang til en bygning, et teknisk anlæg, samt til et bebygget eller ubebygget areal. Ved en enhedsadresse forstås en betegnelse, som supplerer adgangsadressen med en evt. etage- og en evt. dørbetegnelse (side- eller dørnummer) således at den angiver beliggenheden af en bestemt indgangsdør eller lignende, inden for den pågældende bygning. For enfamiliehuse, rækkehuse o.l. hvor den udvendige indgangsdør samtidig udgør indgangen til en enkelt bolig-, erhvervs- eller brugsenhed, er enhedsadressen sammenfaldende med adgangsadressen, hvorfor der ikke fastsættes etage- eller dørbetegnelse. En enhedsadresse er knyttet til en og kun én adgangsadresse. En adgangsadresse kan have 0 eller flere enhedsadresser. Adgangsadresse hedder på engelsk access address og i servicen AddressAccess. Enhedsadresse hedder på engelsk specific address og i servicen Address- Specific Gældende adresser Der skelnes mellem gældende adresser med status 1 og sagsadresser med status 3. Gældende adresser er godkendte adresser, sagsadresser er nye (ikke godkendte) adresser eller rettelser til gældende adresser under sagsbehandling. Hvis du vil rette, oprette eller slette en gældende adresse, kan dette gøres direkte via de respektive metode kald. Alternativt kan adresser rettes og oprettes via en adressesag, hvor ændringer først bliver gældende ved godkendelse af sagen. Dette er nærmere forklaret i næste afsnit. Snitfladebeskrivelse Side 9 af 89

10 3.3. Foreløbige adresser og sagsadresser Ved at rette en adresse gennem en adressesag sikres det, at en adresseforekomst kan oprettes foreløbigt og sagsbehandles (som udkast, sendes i høring, gives som indstilling, eller indberettes af en ekstern part mv.) forud for den egentlige fastsættelse eller godkendelse af adressen. Oprettes en ny adresse via en adressesag eller rettes en eksisterende adresse via en adressesag, skal der oprettes enten En ny foreløbig adresse eller En sagsadresse En ny foreløbig adresse er en helt ny adresse, som endnu ikke er godkendt. En ny foreløbig adresse har IKKE nogen relation til en gældende adresse. En sagsadresse er en ændring af en eksisterende, dvs. gældende adresse. En sagsadresse har en relation til en anden gældende adresse nemlig den adresse, som ændres. Nye foreløbige adresser og sagsadresser har status 3. En adgangsadresse og de underliggende enhedsadresser vil altid have samme status, som illustreret nedenfor. AAD (N) AAD EAD EAD (N) EAD (N) EAD 3.4. Adressesager En foreløbig adresse eller en sagsadresse er altid knyttet til en adressesag. En adressesag kan samle en eller flere foreløbige adresser/sagsadresser, som hører sammen. En adressesag identificeres ved et sagsnummer. På selve adressesagen ligger feltet godkendelsesdato. Når godkendelsesdatoen udfyldes, afsluttes de tilhørende adresser og overføres til stamdata. Der må ikke være to sagsadresser hørende til samme gældende adresse i den samme adressesag. Adressesag hedder på engelsk address case og i servicen AddressCase Adressers entydighed Vedrørende adressernes entydighed er der formuleret følgende regler i : Gældende adgangsadresser (status 1) skal være entydig på kommunekode, vejkode og husnummer. Gældende enhedsadresser skal være entydig på adgangsadressen, etage og side/dørnummer. Dvs. der må ikke være to gældende adgangsadresser med samme vejkode og husnummer eller to gældende enhedsadresser med samme adgangsadresse, etage og side/dørnummer. Foreløbige nye adgangsadresser (status 3) med husnummer skal være entydig på kommunekode, vejkode og husnummer. Snitfladebeskrivelse Side 10 af 89

11 Foreløbige nye adgangsadresser (status 3) uden husnummer behøver ikke at være entydig, dvs. der må eksistere flere foreløbige adgangsadresser med samme kommunekode og vejkode. Foreløbige nye enhedsadresser (status 3) skal være entydige på adgangsadressen, etage og side/dørnummer. Dette gælder også hvis den tilhørende adgangsadresse ikke har et husnummer. Der må godt være en gældende adresse (status 1) og en ny foreløbig adresse (status 3) som har samme kommunekode, husnummer og vejkode. Disse kan skelnes ved deres status. Der findes ingen begrænsninger for sagsadresser Adgangsadresser uden husnummer Alle adgangsadresser (gældende adresser, nye foreløbige adresser og sagsadresser) skal have en vejkode. Man kan undgå den nuværende regel om, at ikke gældende adresser skal have en vejkode, ved at tilknytte en dummyvejkode til nye foreløbige adresser eller sagsadresser. Med dummy-vejkode menes en vejkode, som ikke er en valid vejkode i CPR, f.eks Når en ny adgangsadresse optræder som sagsdata, skal der dog ikke nødvendigvis være registeret et husnummer. Herved sikre det, at en sags adgangsadresse kan oprettes, selv om der endnu ikke er fastsat et husnummer. Adresser uden husnummer må kun findes med status 3 (altså som helt nye foreløbige adresser eller sagsadresser). En adressesag, som indeholder adresser uden husnummer kan altså ikke godkendes før husnummeret er angivet. Der må gerne eksistere flere foreløbige nye adgangsadresser uden husnummer Adresseforekomstens liv En adresse bibeholder altid sin entydige adresse-id. Dette gælder også når en adgangsadresse ændrer vejkode eller husnummer og når en enhedsadresse ændrer etage og side/dørnummer. En enhedsadresse kan ikke flyttes til en anden adgangsadresse, men vil altid være tilknyttet den samme adgangsadresse i sin levetid. Ændringer af adressernes vejkode eller husnummer kan fx være nødvendige ved omnummerering af en række husnumre eller ved ændring af en adresses tilknytning til et vejnavn. Det afgørende er, om der er tale om den samme adgangsadresse, dvs. som refererer til den samme bygning, opgang, grundstykke e.l. Tilsvarende principper gælder for enhedsadresser mht. etage- og dørbetegnelse Adressepunkt Ved et adressepunkt forstås et punkt, der beskriver beliggenheden af en bestemt adgangsadresse ved hjælp af geografiske koordinater (X,Y). En adgangsadresse kan have tilknyttet geometri, som angiver adgangsadressens beliggenhed på et digitalt kort. Geometrien består af et sæt koordinater samt nogle supplerende oplysninger. Snitfladebeskrivelse Side 11 af 89

12 Den logiske datamodel i knytter et geometriobjekt et adressepunkt - til en adgangsadresse og vice versa. Hvert geometri-objekt er tilknyttet én adgangsadresse og en adgangsadresse har tilknyttet ingen eller ét geometriobjekt. Dette er en forskel i forhold til den i dokumentationsguiden for adressepunktet beskrevne relation, hvor en adgangsadresse kan have flere adressepunkter. Hvis en adgangsadresse ændrer sin beliggenhed, vil adgangsadressen bibeholde samme geometri/adressepunkt. Adressepunktet vil blive opdateret med de ændrede koordinater og/eller ændrede oplysninger om adressepunktets status eller metadata. Der kan oprettes et adressepunkt for gældende adgangsadresser og nye foreløbige adgangsadresser, dog ikke for sagsadresser. For at rette adressegeometrien for en gældende adgangsadresse skal man således opdatere stamadgangsadressen og ikke oprette en sagsadresse. Koordinater i har UTM Euref 89 format, zone 32 og bliver således leveret og skal leveres til opdatering i det nævnte format. Adgangsadressens geometri går også tit under navnet adressekoordinater, og når der i det følgende skrives adressekoordinater, så menes der helt nøjagtig geometrien (adressepunktet) knyttet til en adgangsadresse i. Adressepunkt hedder på engelsk address point og i servicen AddressPoint Adressers tilknytning til matrikler I Adresser kan alle adgangsadresser være knyttet til 0 eller et matrikelnummer. For adgangsadressen skal det angives hvilket jordstykke adressen faktisk er beliggende på. Dette sker ved hjælp af ejerlav og matrikelnummer fra KMS' matrikel og tilhørende matrikelkort; for Københavns og Frederiksberg dog fra den kommunale matrikel. Disse matrikelbetegnelser svarer til en ESR matrikeloplysning og ejendomsnummer med artskode 00 eller 01. Der findes dog også tilfælde, hvor du ikke kan registrere en adresse på et KMS matrikelnummer. Som eksempel kan nævnes de tilfælde, hvor adressen er placeret på et umatrikuleret areal. I dette tilfælde kan der i stedet tilknyttes en ESRmatrikeloplysning om det umatrikulerede areal ved hjælp af artskoderne 5, 6, 7, 8, 9 eller 10. Snitfladebeskrivelse Side 12 af 89

13 Et andet eksempel er brug af foreløbige ESR-matrikeloplysninger i forbindelse med udstykninger. Her kan registreringen af det gældende matrikelnummer (som der udstykkes fra) suppleres af en oplysning om det foreløbige ESR deleller parcelnummer og det nye ejendomsnummer med artskode 30 til 40." På en adgangsadresse kan du se ejendomsnummeret for den grund, som adressens matrikelnummer indgår i. For nogle ESR matrikeloplysninger er ejendomsnummer med til at identificere ESR matrikeloplysningen entydigt Status for adresser En gældende adresse har status 1. En foreløbig adresse og en sagsadresse har status 3. Nedlæggelse af gældende adresse En gældende adresse kan nedlægges på tre forskellige måder. o Det er muligt at benytte Delete metoden for en gældende adresse. o Det er muligt at benytte Update metoden for en gældende adresse og angive nedlæggelsesdatoen. o Når en sagsadresse godkendes og sagsadressen har en nedlæggelsesdato angivet, nedlægges den gældende adresse. I først nævnte tilfælde udfyldes nedlæggelsesdatoen af systemet, i de to andre tilfælde benyttes det angivne nedlæggelsesdato. Når en gældende adresse bliver slettes (nedlagt), får den status 2. Godkendelse af adressesag Man godkender en adressesag ved at benytte Update metoden og udfylde godkendelsesdatoen. De underliggende sager vil så blive overført fra at være sager til at være gældende. Når en foreløbig adresse bliver godkendt via en adressesag får den status 1, idet den nu er gældende. Ikrafttrædelsesdato udfyldes med adressesagens godkendelsesdato. Når en sagsadresse bliver godkendt overføres data til den gældende adresse. Henlæggelse af adressesag Man nedlægger en adressesag ved at benytte Delete metoden for adressesagen. Når en adressesag henlægges, henlægges også de underliggende sager. Snitfladebeskrivelse Side 13 af 89

14 4. webservice Metoderne i servicen (WSDL en) kan inddeles i 5 grupper: o o o o o metoder til adgangsadresser metoder til enhedsadresser metoder til adressesager metoder til adgangsadressernes geometri metoder til fremsøgning af adgangsadresser, enhedsadresser og adressesager Servicen indeholder følgende 5 metoder til at hente, opdatere, oprette og slette adgangsadresser: AddressAccessGetById AddressAccessGet AddressAccessCreate AddressAccessUpdate AddressAccessDelete Servicen indeholder følgende 5 metoder til at hente, opdatere, oprette og slette enhedsadresser: AddressSpecificGetById AddressSpecificGet AddressSpecificCreate AddressSpecificUpdate AddressSpecificDelete Servicen indeholder følgende 5 metoder til at hente, opdatere, oprette og slette adressesager: AddressCaseGetById AddressCaseGet AddressCaseCreate AddressCaseUpdate AddressCaseDelete Servicen indeholder følgende 3 metoder til at opdatere, oprette og slette adressepunkter: AddressPointCreate AddressPointUpdate AddressPointDelete Servicen indeholder følgende 2 metoder til at fremsøge adresser og adressesager: AddressSearch AddressCaseSearch Alle metoder har en inputstruktur, som hedder <metodenavn>requeststructure og en outputstruktur, som hedder <metodenavn>responsestructure. Fx hedder strukturerne til AddressAccessGetById AddressAccessGetByIdRequestStructure og AddressAccess- GetByIdResponseStructure. Snitfladebeskrivelse Side 14 af 89

15 Webservicens mange metoder er beskrevet i detaljer i de næste kapitler. Hver struktur er vist på et billede, som på en god måde anskueliggør hvilke felter der er obligatoriske, dvs. skal udfyldes, når metoderne bliver kaldt. Derudover kan man se for mange forekomster af de forskellige strukturer der er mulige IgnoreWarningIndicator De fleste opdateringer i systemet (opdater, opret og slet metoder) har en indikator, som angiver, om man ønsker at ignorere advarsler. Med advarsler menes der i systemet implementerede sandsynlighedskontroller. Hvis indikatoren er true, ignoreres advarsler og opdateringen udføres hvis der ikke er fejl. Hvis indikatoren er false, udføres opdateringen kun hvis der ikke findes advarsler. Man vil typisk først kalde metoden med indikatoren sæt til false. De leverede advarsler tjekkes og hvis man ønsker at opdatere på trods af disse advarsler kaldes metoden med indikatoren sæt til true. Advarslerne leveres tilbage i samme struktur som fejl og andre returbeskeder. Læs mere om dette i afsnit printenableindicator Man kan benytte en indikator for at angive, om der skal udskrives en Meddelelse i forbindelse med den adresse rettelse man foretager. Hvis man sætter indikatoren til at være true, resulterer nedenstående ændringer af adresser i en bestilling af en automatisk - Meddelelse med årsagskode 60 ( Denne -Meddelelse er udskrevet på grund af adresseændringer. ) for relevante niveauer i Bygninger og boliger. Relevante niveauer er ejendomme/ejerlejligheder, som har den pågældende adresse tilknyttet. Vejkode eller husnummer for en gældende adgangsadresse AAD eller en ny foreløbig adgangsadresse (N)AAD ænders. Herved ændres også de enhedsadresser, som ligger under den ændrede adgangsadresse, idet adgangsadressen er en del af enhedsadressens identifikation Etage eller sidedør nummer ændres for en gældende enhedsadresse EAD eller en ny foreløbig enhedsadresse (N)EAD. Der bestilles ingen -Meddelelser ved ændringer af sagsniveauerne (S)AAD og (S)EAD, som er ændringer til gældende adresser. Dette sker først når sagen godkendes og de tilhørende gældende adresser bliver opdateret. Der udskrives ikke -Meddelelser når en (N)AAD eller en (N)EAD bliver til gældende adresser idet adresserne ved denne handling ikke ændrer deres identifikation. Indikatoren findes kun i de metoder hvor den giver mening. I Delete og Create metoderne giver indikatoren ikke mening, idet man kun kan slette adresser, som ikke har entiteter tilknyttet og fordi en ny oprettet adresse endnu ikke har entiteter tilknyttet Opdateringsmekanisme Det gælder generelt, at der kun opdateres de felter i Update metoderne, som sendes med. Et felt som ikke sendes med, berøres således ikke af opdateringen. Denne mekanisme betyder, at man ikke kan slette et felt Snitfladebeskrivelse Side 15 af 89

16 ved ikke at sende det med. Der er blevet defineret null værdier, som skal indikere, at man vil slette et felt. Disse felter er beskrevet under de enkelte Update funktioner RecordChangeDateTime Feltet RecordChangeTime er et felt som benyttes til at styre opdateringer. Når man henter en entitet, får man en RecordChangeDateTime med retur. Når man foretager en opdatering, skal denne sendes med tilbage. Servicen benytter dette felt til at kontrollere, om andre har opdateret entiteten i forvejen Foreløbige koordinater I forbindelse med opdatering og oprettelse af adresser hentes foreløbige koordinater via KMS i følgende situationer: Ved oprettelse af en gældende adgangsadresse (status 1) eller en ny foreløbig adgangsadresse (status 3) Ved opdatering af en eksisterende gældende adgangsadresse (enten ved direkte opdatering eller ved afslutning af en adressesag) Ved opdatering af en ny foreløbig adgangsadresse Det er kun muligt at hente foreløbige koordinater når adressen har tilknyttet et KMS matrikelnummer (se afsnit 3.8). Derudover hentes der kun koordinater når nøjagtighedsklassen er U (uden koordinater) eller når adgangsadressens koordinater har en kilde til geometri lig med 2, dvs. koordinaterne ikke er blevet opdateret igennem OIOXML snitfladen af en bedre kilde end fra KMS. Når en gældende eller en ny foreløbig adgangsadresse har en geometri, som er bedre en KMS (dvs. forskelligt fra kilde 2), bliver der kontrolleret, om koordinaterne ligger på samme matrikel som adgangsadressens (hvis denne har tilknyttet en matrikel). Denne kontrol gennemføres i følgende situationer: Ved opdatering af en eksisterende gældende adgangsadresse enten ved direkte opdatering i stam-data eller ved afslutning af en adressesag (S)AAD. Ved opdatering af en ny foreløbig adgangsadresse (N)AAD Hvis dette ikke er tilfælde returneres sandsynlighedsbeskeden Matriklen er ikke i overensstemmelse med adgangsadressepunktets matrikel fra KMS (<KMS matrikel>). Ligesom ovenfor gennemføres denne kontrol kun hvis adgangsadressen er knyttet til et KMS matrikelnummer. For København og Frederiksberg gennemføres disse kald til KMS ikke Skemavalidering Der foretages skemavalidering af de indsendte data. Hvis requested ikke overholder skemaerne returneres en SOAP fejl med en beskrivelse af problemet. Et eksempel for sådan en fejlbesked kunne være: <?xml version="1.0" encoding="utf-16"?> <s:envelope xmlns:s=" <s:body> <s:fault> Snitfladebeskrivelse Side 16 af 89

17 <faultcode xmlns:a="urn:oio:bbr:1.0.0">a:schemavalidationfault</faultcode> <faultstring xml:lang="en-us">the ' element is invalid - The value '461' is invalid according to its datatype ' - The Pattern constraint failed.</faultstring> </s:fault> </s:body> </s:envelope> Her har man sendt en 3-cifret kommunekode 461 i stedet for den 4-cifrede Snitfladebeskrivelse Side 17 af 89

18 5. Metoder til adgangsadresser De 5 metoder til at hente, opdatere, oprette og slette adgangsadresser er følgende: AddressAccessGetById AddressAccessGet AddressAccessCreate AddressAccessUpdate AddressAccessDelete Metoderne er beskrevet i de 5 næste afsnit. Vær opmærksom på, at adressepunktet leveres sammen med adgangsadressen når systemet leverer adgangsadressen som en del af et svar. Ønsker man dog at oprette, opdatere eller slette et adressepunkt, skal metoderne for adressepunkt entiteten benyttes (se kapitel 8) AddressAccessGetById Metoden AddressAccessGetById henter en adgangsadresse ved angivelse af adressens id. De i afsnit og viste tegninger viser metodens input og output struktur. Metoden har en adgangsadresse id og et kommunekode som input og får leveret den ønskede adgangsadresse samt et resultat for metode kaldet tilbage. Strukturen angiver også, at begge input felter er obligatoriske, dvs. skal udfyldes, når operationen AddressAccessGetById kaldes. Adgangsadressen leveres i en struktur kaldt AddressAccessResponseStructure, som beskriver en adgangsadresse i det tilfælde den bliver leveret som en del af et svar. Denne struktur genbruges i nogle af de andre metoder og er derfor beskrevet som en fælles struktur i kapitel 10. Resultatet for metode kaldet leveres i en struktur kaldt ReturnMessage, som også genbruges i de andre strukturer. Derfor er den beskrevet som en fælles struktur i kapitel AddressAccessGetByIdRequestStructure AddressAccessGetByIdRequestStructure Feltnavn i OIOXML navn Kommentar Snitfladebeskrivelse Side 18 af 89

19 AddressAccessGetByIdRequestStructure Feltnavn i OIOXML navn Kommentar AdgangsadresseID AddressAccessIdentifier Feltet skal udfyldes med adgangsadressens id. Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode AddressAccessGetByIdResponseStructure AddressAccessGetByIdResponseStructure Feltnavn i OIOXML navn Kommentar AddressAccessResponseStructure Den hentede adgangsadressen, se afsnit ReturnMessage Resultatet for metode kaldet, se afsnit AddressAccessGet Metoden AddressAccessGet henter en adgangsadresse ved angivelse af en brugervendt nøgle. De i afsnit og viste tegninger viser metodens input og output struktur. Snitfladebeskrivelse Side 19 af 89

20 Metoden har en brugervendt nøgle til en adgangsadresse som input og får leveret den eller de ønskede adgangsadresser samt et resultat for metode kaldet tilbage. Hvis husnummeret ikke sendes med, ledes efter en adresse uden husnummer. Metoden kan returnere en eller flere adgangsadresser. Dette skyldes at der kan findes flere adgangsadresser med den samme brugervendte nøgle. Som beskrevet i kapitel 2, kan en ny foreløbig adgangsadresse og en gældende adgangsadresse have den samme brugervendt nøgle, dvs. den samme kombination af kommunekode, vejkode og husnummer. De adskiller sig kun på deres status. Derudover kan flere sagsadresser med status 3 have de samme brugervendte nøgler og flere foreløbige adgangsadresser uden husnummer kan have samme kommunekode og vejkode. Hver adgangsadresse leveres i en struktur kaldt AddressAccessResponseStructure, som beskriver en adgangsadresse i det tilfælde den bliver leveret som en del af et svar. Denne struktur genbruges i nogle af de andre metoder og er derfor beskrevet som en fælles struktur i kapitel 10. Resultatet for metode kaldet leveres i en struktur kaldt ReturnMessage, som også genbruges i de andre strukturer. Derfor er den beskrevet som en fælles struktur i kapitel 10. Hvis der ikke findes en adresse med de angivne parametre returneres returnidentifier 0 og reasonidentifier AddressAccessGetRequestStructure AddressAccessGetRequestStructure Snitfladebeskrivelse Side 20 af 89

21 Feltnavn i OIOXML navn Kommentar Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode. Vejkode StreetCode Feltet skal udfyldes med adressens vejkode, hvis adressen har en vejkode. I nuværende version af har alle adresser, også dem med sagskode 3 en vejkode AddressAccessGetResponseStructure AddressAccessGetResponseStructure Feltnavn i OIOXML navn Kommentar Husnummer og husbogstav StreetBuidlingIdentifier Feltet skal udfyldes med husnummer/husbogstav, hvis adressen har et husnummer/husbogstav. Der findes adresser med sagstype 3, som ikke har et husnummer/husbogstav. AddressAccessResponseStructure En eller flere adgangsadresser, som har den ønskede brugervendte nøgle, se afsnit ReturnMessage Resultatet for metode kaldet, se afsnit Snitfladebeskrivelse Side 21 af 89

22 5.3. AddressAccessCreate Metoden AddressAccessCreate opretter en adgangsadresse ved angivelse af adgangsadressens attributter. De i afsnit og viste tegninger viser metodens input og output struktur. Adgangsadresse sendes som input til metoden i en struktur kaldt AddressAccessRequestStructure, som beskriver en adgangsadresse i det tilfælde den er et input til en metode. Denne struktur genbruges i nogle af de andre metoder og er derfor beskrevet som en fælles struktur i kapitel 10. Som en anden input parameter findes der en indikator, som angiver om advarsler skal ignoreres ved oprettelse af adressen eller om oprettelsen skal afvises i det tilfælde der gives advarsler. Som resultat for metoden returneres den oprettede adgangsadresse (hvis det lykkedes) i en struktur kaldt "AddressAccessResponseStructure. "AddressAccessResponseStructure beskriver en adgangsadresse i det tilfælde den bliver leveret som en del af et svar. Denne struktur genbruges i nogle af de andre metoder og er derfor beskrevet som en fælles struktur i kapitel 10. Resultatet for metode kaldet leveres i en struktur kaldt ReturnMessage, som også genbruges i de andre strukturer. Derfor er den beskrevet som en fælles struktur i kapitel 10. For at kunne oprette en adgangsadresse skal der som minimum angives følgende felter: Status (1 for gældende og 3 for sagsadresser og nye foreløbige adresser) Kommunenummer Vejkode Husnummer (kan være null for sagsadresser) Kilde til adresse (for gældende adresser med status 1) Adressesag id (hvis status 3) Adgangsadresse id (hvis sagsadresse) AddressAccessCreateRequestStructure AddressAccessCreateRequestStructure Snitfladebeskrivelse Side 22 af 89

23 Feltnavn i OIOXML navn Kommentar Status (objekttype) for adgangsadressen AddressAccessRequestStructure statuscode IgnoreWarningIndicator Adgangsadressen, som man ønsker at oprette, se afsnit Statuskoden er 1 for gældende adresser og 3 for nye foreløbige adresser og sagsadresser. Se også afsnit 3.9. Information om advarsler skal eller ikke skal ignoreres. Når indikatoren er true, bliver advarsler ignoreret AddressAccessCreateResponseStructure AddressAccessCreateResponseStructure Feltnavn i OIOXML navn Kommentar AddressAccessResponseStructure Den oprettede adgangsadresse, se afsnit ReturnMessage Resultatet for metode kaldet, se afsnit AddressAccessUpdate Metoden AddressAccessUpdate opdaterer en adgangsadresse ved angivelse af adgangsadressens attributter. Snitfladebeskrivelse Side 23 af 89

24 De i afsnit og viste tegninger viser metodens input og output struktur. For at opdatere en adgangsadresse, skal der sendes adgangsadressens id for at identificere den adgangsadresse man ønsker at opdatere. Adgangsadresse sendes som input til metoden i en struktur kaldt AddressAccessRequestStructure, som beskriver en adgangsadresse i det tilfælde den er et input til en metode. Denne struktur genbruges i nogle af de andre metoder og er derfor beskrevet som en fælles struktur i kapitel 10. Ud over selve adgangsadressen findes to andre input parameter. Der findes en indikator, som angiver om advarsler skal ignoreres ved opdatering af adressen eller om opdateringen skal afvises i det tilfælde der gives advarsler. Derudover findes der en indikator for, om man ønsker at opdateringen resulterer i udskrivning af Meddelelser for de berørte ejendomme. Som resultat for metoden returneres den opdaterede adgangsadresse i en struktur kaldt "AddressAccessResponseStructure. "AddressAccessResponseStructure beskriver en adgangsadresse i det tilfælde den bliver leveret som en del af et svar. Denne struktur genbruges i nogle af de andre metoder og er derfor beskrevet som en fælles struktur i kapitel 10. Resultatet for metode kaldet leveres i en struktur kaldt ReturnMessage, som også genbruges i de andre strukturer. Derfor er den beskrevet som en fælles struktur i kapitel 10. For at kunne opdatere en adgangsadresse skal der som minimum angives følgende felter: Adgangsadresse id Status (1 for gældende og 3 for sagsadresser og nye foreløbige adresser) Kommunenummer RecordChangeDateTime Alle andre felter angives kun hvis man ønsker at rette dem AddressAccessUpdateRequestStructure Snitfladebeskrivelse Side 24 af 89

25 AddressAccessUpdateRequestStructure Feltnavn i OIOXML navn Kommentar AdgangsadresseID AddressAccessIdentifier Feltet skal altid udfyldes med adgangsadressens id. AddressAccessRequestStructure Adgangsadressen, som man ønsker at opdatere, se afsnit RecordChangeDateTime Se afsnit 4.4. printenableindicator IgnoreWarningIndicator Feltet angiver om der skal udskrives en Meddelelse for relevante ejendomme og sendes til de respektive ejere. Når indikatoren er true, bliver der udskrevet Meddelelser. Information om advarsler skal eller ikke skal ignoreres. Når indikatoren er true, bliver advarsler ignoreret. For at kunne slette/nulstille et felt for adgangsadressen, skal der benyttes følgende værdier (kun angivet for relevante felter): Null-værdier for adgangsadressen Feltnavn i OIOXML navn Null-værdi Husnummer og husbogstav StreetBuidlingIdentifier Det er muligt at oprette en adgangsadresse uden husnummer (dvs. husnummer 0) ved ikke at angive husnummeret ved oprettelse. Det er dog ikke muligt at slette et husnummer for en adgangsadresse når det en gang er angivet. Årsagen er, at kernekomponenten for husnummeret ikke tillader værdien 0. Undlader man at sende husnummeret med opfattes dette som om man ikke vil opdatere husnummeret. Kilde til adgangsadresse AddressAccessSourceCode Kilde til adgangsadressen er et krævet felt og kan derfor ikke nulstilles/slettes. landparcelidentitystructure landparcelidentitystructure.matrlandparcelidentifi cationstructure.landparcelidentifier skal være blank og Snitfladebeskrivelse Side 25 af 89

26 Null-værdier for adgangsadressen Feltnavn i OIOXML navn Null-værdi landparcelidentitystructure.matrlandparcelidentifi cationstructure.cadastraldistrictidentifi er skal være 0. AddressAccessRequestDates MunicipalityFields Null værdien for en dato er DateTime.MinValue, dvs :00: To be defined Journalnummer FileNumberIdentifier Journalnummer kan slettes/nulstilles ved at sende en tom string. ESDH reference ESDHreferenceIdentifier ESDH refernce kan slettes/nulstilles ved at sende en tom string på 200 tegn (OIO definitionen på digitaliser prøves rettet) AddressAccessUpdateResponseStructure AddressAccessUpdateResponseStructure Feltnavn i OIOXML navn Kommentar AddressAccessResponseStructure Den opdaterede adgangsadresse, se afsnit Snitfladebeskrivelse Side 26 af 89

27 AddressAccessUpdateResponseStructure Feltnavn i OIOXML navn Kommentar ReturnMessage Resultatet for metode kaldet, se afsnit AddressAccessDelete Metoden AddressAccessDelete sletter en adgangsadresse. De i afsnit og viste tegninger viser metodens input og output struktur. Adgangsadressen slettes ved angivelse af adgangsadressens id og det kommunekode, som adgangsadressen hører til. Ud over adressens id findes en indikator, som angiver om advarsler skal ignoreres eller om sletningen skal afvises i det tilfælde der gives advarsler. Når adgangsadressen slettes, slettes også de underliggende enhedsadresser. Du skal være opmærksom på, at adgangsadresser, som er knyttet til et niveauer i Bygninger og boliger ikke kan slettes. Dette gælder også, hvis de underliggende enhedsadresser er knyttet til niveauer i Bygninger og boliger. Resultatet for metode kaldet leveres i en struktur kaldt ReturnMessage, som også genbruges i de andre strukturer. Derfor er den beskrevet som en fælles struktur i kapitel AddressAccessDeleteRequestStructure AddressAccessDeleteRequestStructure Feltnavn i OIOXML navn Kommentar AdgangsadresseID AddressAccessIdentifier Feltet skal altid udfyldes med adgangsadressens id. Kommunekode MunicipalityCode Feltet skal altid udfyldes med 4 cifret kommunekode, f.eks RecordChangeDateTime Se afsnit 4.4. Snitfladebeskrivelse Side 27 af 89

28 AddressAccessDeleteRequestStructure Feltnavn i OIOXML navn Kommentar IgnoreWarningIndicator Information om advarsler skal eller ikke skal ignoreres. Når indikatoren er true, bliver advarsler ignoreret AddressAccessDeleteResponseStructure AddressAccessDeleteResponseStructure Feltnavn i OIOXML navn Kommentar ReturnMessage Resultatet for metode kaldet, se afsnit Snitfladebeskrivelse Side 28 af 89

29 6. Metoder til enhedsadresser De 5 metoder til at hente, opdatere, oprette og slette enhedsadresser er følgende: AddressSpecificGetById AddressSpecificGet AddressSpecificCreate AddressSpecificUpdate AddressSpecificDelete Metoderne er beskrevet i de 5 næste afsnit AddressSpecificGetById Metoden AddressSpecificGetById henter en enhedsadresse ved angivelse af adressens id. De i afsnit og viste tegninger viser metodens input og output struktur. Metoden har en enhedsadresse id og et kommunekode som input og får leveret den ønskede enhedsadresse samt et resultat for metode kaldet tilbage. Enhedsadressen leveres i en struktur kaldt AddressSpecificResponseStructure, som beskriver en enhedsadresse i det tilfælde den bliver leveret som en del af et svar. Denne struktur genbruges i nogle af de andre metoder og er derfor beskrevet som en fælles struktur i kapitel 10. Resultatet for metode kaldet leveres i en struktur kaldt ReturnMessage, som også genbruges i de andre strukturer. Derfor er den beskrevet som en fælles struktur i kapitel AddressSpecificGetByIdRequestStructure AddressSpecificGetByIdRequestStructure Feltnavn i OIOXML navn Kommentar EnhedsadresseID AddressSpecificIdentifier Feltet skal udfyldes med enhedsadressens id. Kommunekode MunicipalityCode Feltet skal udfyldes med 4 cifret kommunekode, f.eks Snitfladebeskrivelse Side 29 af 89

30 AddressSpecificGetByIdResponseStructure AddressSpecificGetByIdResponseStructure Feltnavn i OIOXML navn Kommentar AddressSpecificResponseStructure Den hentede enhedsadresse, se afsnit ReturnMessage Resultatet for metode kaldet, se afsnit AddressSpecificGet Metoden AddressSpecificGet henter en enhedsadresse ved angivelse af en brugervendt nøgle. De i afsnit og viste tegninger viser metodens input og output struktur. Metoden har en brugervendt nøgle til en enhedsadresse som input og får leveret den eller de ønskede enhedsadresser samt et resultat for metode kaldet tilbage. Metoden kan returnere en eller flere enhedsadresser. Dette skyldes at der kan findes flere enhedsadresser med den samme brugervendte nøgle. Som beskrevet i kapitel 5.2, kan 2 adgangsadresser have samme kombination af kommunekode, vejkode og husnummer. Idet adgangsadressen er en del af enhedsadressens identifikation, betyder det også, at de enhedsadresser, som ligger under to adgangsadresser med samme kombination af kommunekode, vejkode og husnummer også kan have den samme etage og side/dørnummer. Enhedsadresser under en og den samme adgangsadresse er dog altid entydig på deres etage og side/dørnummer. Hver enhedsadresse leveres i en struktur kaldt AddressSpecificResponseStructure, som beskriver en enhedsadresse i det tilfælde den bliver leveret som en del af et svar. Denne struktur genbruges i nogle af de andre metoder og er derfor beskrevet som en fælles struktur i kapitel 10. Snitfladebeskrivelse Side 30 af 89

31 Resultatet for metode kaldet leveres i en struktur kaldt ReturnMessage, som også genbruges i de andre strukturer. Derfor er den beskrevet som en fælles struktur i kapitel 10. Hvis der ikke findes en adresse med de angivne parametre returneres returnidentifier 0 og reasonidentifier AddressSpecificGetRequestStructure AddressSpecificGetRequestStructure Feltnavn i OIOXML navn Kommentar Kommunekode MunicipalityCode Feltet skal udfyldes med 4 cifret kommunekode, f.eks Vejkode StreetCode Feltet skal udfyldes med vejkoden for den tilhørende adgangsadresse. Husnummer og husbogstav StreetBuidlingIdentifier Feltet skal udfyldes med husnummer/husbogstav for adgangsadressen, hvis Snitfladebeskrivelse Side 31 af 89

32 AddressSpecificGetRequestStructure Feltnavn i OIOXML navn Kommentar Etage FloorIdentifier Feltet skal udfyldes med enhedsadressens etage, hvis adressen har en etagebetegnelse. Side/dørnummer SuiteIdentifier Feltet skal udfyldes med enhedsadressens side/dør nummer, hvis adressen har et side/dørnummer AddressSpecificGetResponseStructure AddressSpecificGetResponseStructure Feltnavn i OIOXML navn Kommentar adressen har et husnummer/husbogstav. AddressSpecificResponseStructure En eller flere enhedsadresser, som har den ønskede brugervendte nøgle, se afsnit ReturnMessage Resultatet for metode kaldet, se afsnit AddressSpecificCreate Metoden AddressSpecificCreate opretter en enhedsadresse ved angivelse af enhedsadressens attributter. De i afsnit og viste tegninger viser metodens input og output struktur. Enhedsadressen sendes som input til metoden i en struktur kaldt Address- SpecificRequestStructure, som beskriver en enhedsadresse i det tilfælde den Snitfladebeskrivelse Side 32 af 89

33 er et input til en metode. Denne struktur genbruges i nogle af de andre metoder og er derfor beskrevet som en fælles struktur i kapitel 10. Som en anden input parameter findes der en indikator, som angiver om advarsler skal ignoreres ved oprettelse af adressen eller om oprettelsen skal afvises i det tilfælde der gives advarsler. Som resultat for metoden returneres den oprettede enhedsadresse (hvis det lykkedes) i en struktur kaldt "AddressSpecificResponseStructure. "Address- SpecificResponseStrcuture beskriver en enhedsadresse i det tilfælde den bliver leveret som en del af et svar. Denne struktur genbruges i nogle af de andre metoder og er derfor beskrevet som en fælles struktur i kapitel 10. Resultatet for metode kaldet leveres i en struktur kaldt ReturnMessage, som også genbruges i de andre strukturer. Derfor er den beskrevet som en fælles struktur i kapitel 10. For at kunne oprette en enhedsadresse skal der som minimum angives følgende felter: Status (1 for gældende og 3 for sagsadresser og nye foreløbige adresser) Kommunenummer Adgangsadresse id Adressesag id (hvis status 3) Enhedsadresse id (hvis sagsadresse) Kilde til adresse (for gældende adresser med status 1) AddressSpecificCreateRequestStructure Snitfladebeskrivelse Side 33 af 89

34 AddressSpecificCreateRequestStructure Feltnavn i OIOXML navn Kommentar Status (objekttype) for enhedsadressen AddressSpecificRequestStructure statuscode IgnoreWarningIndicator Enhedsadressen, som man ønsker at oprette, se afsnit Statuskoden er 1 for gældende adresser og 3 for nye foreløbige adresser og sagsadresser. Se også afsnit 3.9. Information om advarsler skal eller ikke skal ignoreres. Når indikatoren er true, bliver advarsler ignoreret AddressSpecificCreateResponseStructure Snitfladebeskrivelse Side 34 af 89

35 AddressSpecificCreateResponseStructure Feltnavn i OIOXML navn Kommentar AddressSpecificResponseStructure Den oprettede enhedsadresse, se afsnit ReturnMessage Resultatet for metode kaldet, se afsnit AddressSpecificUpdate Metoden AddressSpecificUpdate opdaterer en enhedsadresse ved angivelse af enhedsadressens attributter. De i afsnit og viste tegninger viser metodens input og output struktur. For at opdatere en enhedsadresse, skal der sendes enhedsadressens id for at identificere den enhedsadresse man ønsker at opdatere. Enhedsadressen sendes som input til metoden i en struktur kaldt Address- SpecificRequestStructure, som beskriver en enhedsadresse i det tilfælde den er et input til en metode. Denne struktur genbruges i nogle af de andre metoder og er derfor beskrevet som en fælles struktur i kapitel 10. Ud over selve enhedsadressen findes to andre input parameter. Der findes en indikator, som angiver om advarsler skal ignoreres ved opdatering af adressen eller om opdateringen skal afvises i det tilfælde der gives advarsler. Derudover findes der en indikator for, om man ønsker at opdateringen resulterer i udskrivning af Meddelelser for de berørte ejendomme. Som resultat for metoden returneres den opdaterede enhedsadresse i en struktur kaldt "AddressSpecificResponseStructure. "AddressSpecificResponseStructure beskriver en adgangsadresse i det tilfælde den bliver leveret som en del af et svar. Denne struktur genbruges i nogle af de andre metoder og er derfor beskrevet som en fælles struktur i kapitel 10. Resultatet for metode kaldet leveres i en struktur kaldt ReturnMessage, som også genbruges i de andre strukturer. Derfor er den beskrevet som en fælles struktur i kapitel 10. For at kunne opdatere en enhedsadresse skal der som minimum angives følgende felter: Enehdsadresse id Status (1 for gældende og 3 for sagsadresser og nye foreløbige adresser) Kommunenummer RecordChangeDateTime Alle andre felter angives kun hvis man ønsker at rette dem AddressSpecificUpdateRequestStructure Snitfladebeskrivelse Side 35 af 89

36 AddressSpecificUpdateRequestStructure Feltnavn i OIOXML navn Kommentar EnhedsadresseID AddressSpecificIdentifier Feltet skal udfyldes med enhedsadressens id. AddressSpecificRequestStructure Enhedsadressen, som man ønsker at opdatere, se afsnit RecordChangeDateTime Se afsnit 4.4. printenableindicator IgnoreWarningIndicator Feltet angiver om der skal udskrives en Meddelelse for relevante ejendomme og sendes til de respektive ejere. Når indikatoren er true, bliver der udskrevet Meddelelser. Information om advarsler skal eller ikke skal ignoreres. Når indikatoren er true, bliver advarsler ignoreret. For at kunne slette/nulstille et felt for enhedsadressen, skal der benyttes følgende værdier: Null-værdier for enhedsadressen Feltnavn i OIOXML navn Null-værdi Etage FloorIdentifier To be defined Side/dørnummer SuiteIdentifier Null værdien for side/dørnummer er en tom string. Kilde til enhedsadresse AddressSpecificSourceCode AddressSpecificRequest- Kilde til enhedsadressen er et krævet felt og kan derfor ikke nulstilles/slettes. Null værdien for en dato Snitfladebeskrivelse Side 36 af 89

37 Null-værdier for enhedsadressen Feltnavn i OIOXML navn Null-værdi Dates er DateTime.MinValue, dvs :00: MunicipalityFields To be defined Journalnummer FileNumberIdentifier Journalnummer kan slettes/nulstilles ved at sende en tom string. ESDH reference ESDHreferenceIdentifier ESDH refernce kan slettes/nulstilles ved at sende en tom string på 200 tegn (OIO definitionen på digitaliser prøves rettet) AddressSpecificUpdateResponseStructure AddressSpecificUpdateResponseStructure Feltnavn i OIOXML navn Kommentar AddressSpecificResponseStructure Den opdaterede enhedsadresse, se afsnit ReturnMessage Resultatet for metode kaldet, se afsnit AddressSpecificDelete Metoden AddressSpecificDelete sletter en enhedsadresse. De i afsnit og viste tegninger viser metodens input og output struktur. Enhedsadressen slettes ved angivelse af enhedsadressens id og det kommunekode, som enhedsadressen hører til. Snitfladebeskrivelse Side 37 af 89

38 Ud over dette findes der en input parameter, som angiver om advarsler skal ignoreres eller om sletningen skal afvises i det tilfælde der gives advarsler. Du skal være opmærksom på, at enhedsadresser, som er knyttet til et eller flere niveauer i Bygninger og boliger ikke kan slettes. Resultatet for metode kaldet leveres i en struktur kaldt ReturnMessage, som også genbruges i de andre strukturer. Derfor er den beskrevet som en fælles struktur i kapitel AddressSpecificDeleteRequestStructure AddressSpecificDeleteRequestStructure Feltnavn i OIOXML navn Kommentar EnhedsadresseID AddressSpecificIdentifier Feltet skal udfyldes med enhedsadressens id. Kommunekode MunicipalityCode Feltet skal udfyldes med 4 cifret kommunekode, f.eks RecordChangeDateTime Se afsnit 4.4. IgnoreWarningIndicator Information om advarsler skal eller ikke skal ignoreres. Når indikatoren er true, bliver advarsler ignoreret AddressSpecificDeleteResponseStructure AddressSpecificDeleteResponseStructure Feltnavn i OIOXML navn Kommentar ReturnMessage Resultatet for metode Snitfladebeskrivelse Side 38 af 89

39 AddressSpecificDeleteResponseStructure Feltnavn i OIOXML navn Kommentar kaldet, se afsnit Snitfladebeskrivelse Side 39 af 89

40 7. Metoder til adressesager De 5 metoder til at hente, opdatere, oprette og slette adressesager er følgende: AddressCaseGetById AddressCaseGet AddressCaseCreate AddressCaseUpdate AddressCaseDelete Metoderne er beskrevet i de 5 næste afsnit AddressCaseGetById Metoden AddressCaseGetById henter adressesag ved angivelse af adressesagens id. De i afsnit og viste tegninger viser metodens input og output struktur. Metoden har en adressesag id og et kommunekode som input og får leveret den ønskede adressesag samt et resultat for metode kaldet tilbage. Strukturen angiver også, at begge input felter er obligatoriske, dvs. skal udfyldes, når operationen AddressCaseGetById kaldes. Adressesager leveres i en struktur kaldt AddressCaseResponseStructure, som beskriver en adressesag i det tilfælde den bliver leveret som en del af et svar. Denne struktur genbruges i nogle af de andre metoder og er derfor beskrevet som en fælles struktur i kapitel 10. Resultatet for metode kaldet leveres i en struktur kaldt ReturnMessage, som også genbruges i de andre strukturer. Derfor er den beskrevet som en fælles struktur i kapitel AddressCaseGetByIdRequestStructure AddressCaseGetByIdRequestStructure Feltnavn i OIOXML navn Kommentar AdressesagID AddressCaseIdentifier Feltet skal udfyldes med adressesagens id. Kommunekode MunicipalityCode Feltet skal udfyldes med 4 cifret kommunekode, f.eks Snitfladebeskrivelse Side 40 af 89

41 AddressCaseGetByIdResponseStructure AddressCaseGetByIdResponseStructure Feltnavn i OIOXML navn Kommentar AddressCaseResponseStructure Den hentede adressesag, se afsnit ReturnMessage Resultatet for metode kaldet, se afsnit AddressCaseGet Metoden AddressCaseGet henter en adressesag ved angivelse af et sagsnummer. Et sagsnummer identificerer sagen entydigt. De i afsnit og viste tegninger viser metodens input og output struktur. Metoden har sagsnummeret for adressesagen som input og får leveret den ønskede adressesag samt et resultat for metode kaldet tilbage. Adressesagen leveres i en struktur kaldt AddressCaseResponseStructure, som beskriver en adressesag i det tilfælde den bliver leveret som en del af et svar. Denne struktur genbruges i nogle af de andre metoder og er derfor beskrevet som en fælles struktur i kapitel 10. Resultatet for metode kaldet leveres i en struktur kaldt ReturnMessage, som også genbruges i de andre strukturer. Derfor er den beskrevet som en fælles struktur i kapitel 10. Snitfladebeskrivelse Side 41 af 89

42 Hvis der ikke findes en adressesag med de angivne parametre returneres returnidentifier 0 og reasonidentifier AddressCaseGetRequestStructure AddressCaseGetByIdRequestStructure Feltnavn i OIOXML navn Kommentar Sagsnummer AddressCaseFileReference Feltet skal udfyldes med adressesagens sagsnummer. Kommunekode MunicipalityCode Feltet skal udfyldes med 4 cifret kommunekode, f.eks AddressCaseGetResponseStructure Snitfladebeskrivelse Side 42 af 89

43 AddressCaseGetResponseStructure Feltnavn i OIOXML navn Kommentar AddressCaseResponseStructure Den hentede adressesag, se afsnit ReturnMessage Resultatet for metode kaldet, se afsnit AddressCaseCreate Metoden AddressCaseCreate opretter en adressesag ved angivelse af adressesagens attributter. De i afsnit og viste tegninger viser metodens input og output struktur. Adressesagen sendes som input til metoden i en struktur kaldt AddressCase- RequestStructure, som beskriver en adressessag i det tilfælde den er et input til en metode. Denne struktur genbruges i nogle af de andre metoder og er derfor beskrevet som en fælles struktur i kapitel 10. Som en anden input parameter findes der en indikator, som angiver om advarsler skal ignoreres ved oprettelse af adressesagen eller om oprettelsen skal afvises i det tilfælde der gives advarsler. Som resultat for metoden returneres den oprettede adressesag i en struktur kaldt "AddressCaseResponseStructure. "AddressCaseResponseStructure beskriver en adressesag i det tilfælde den bliver leveret som en del af et svar. Denne struktur genbruges i nogle af de andre metoder og er derfor beskrevet som en fælles struktur i kapitel 10. Resultatet for metode kaldet leveres i en struktur kaldt ReturnMessage, som også genbruges i de andre strukturer. Derfor er den beskrevet som en fælles struktur i kapitel 10. For at kunne oprette en adressesag skal der som minimum angives følgende felter: Kommunenummer Sagsbehandler Sagsnummer AddressCaseCreateRequestStructure Snitfladebeskrivelse Side 43 af 89

44 AddressCaseCreateRequestStructure Feltnavn i OIOXML navn Kommentar AddressCaseRequestStructure IgnoreWarningIndicator Adressesagen, som man ønsker at oprette, se afsnit Information om advarsler skal eller ikke skal ignoreres. Når indikatoren er true, bliver advarsler ignoreret AddressCaseCreateResponseStructure AddressCaseCreateResponseStructure Feltnavn i OIOXML navn Kommentar AddressCaseResponseStructure Den oprettede adressesag, se afsnit ReturnMessage Resultatet for metode kaldet, se afsnit AddressCaseUpdate Metoden AddressCaseUpdate opdaterer en adressesag ved angivelse af adressesagens attributter. De i afsnit og viste tegninger viser metodens input og output struktur. For at opdatere en adressesag, skal der sendes adressesagens id for at identificere den adressesag man ønsker at opdatere. Snitfladebeskrivelse Side 44 af 89

45 Adressesagens attributter sendes som input til metoden i en struktur kaldt AddressCaseRequestStructure, som beskriver en adressesag i det tilfælde den er et input til en metode. Denne struktur genbruges i nogle af de andre metoder og er derfor beskrevet som en fælles struktur i kapitel 10. Ud over selve adressesagen findes der en inputparameter, som angiver om advarsler skal ignoreres ved opdatering af adressen eller om opdateringen skal afvises i det tilfælde der gives advarsler. Som resultat for metoden returneres den opdaterede adressesag i en struktur kaldt "AddressCaseResponseStructure. "AddressCaseResponseStructure beskriver en adressesag i det tilfælde den bliver leveret som en del af et svar. Denne struktur genbruges i nogle af de andre metoder og er derfor beskrevet som en fælles struktur i kapitel 10. Resultatet for metode kaldet leveres i en struktur kaldt ReturnMessage, som også genbruges i de andre strukturer. Derfor er den beskrevet som en fælles struktur i kapitel 10. For at kunne opdatere en adressesag skal der som minimum angives følgende felter: Adressesag id Kommunenummer Sagsbehandler Sagsnummer RecordChangeDateTime AddressCaseUpdateRequestStructure AddressCaseUpdateRequestStructure Feltnavn i OIOXML navn Kommentar AdressesagID AddressCaseIdentifier Feltet skal udfyldes med adressesagens id. AddressCaseRequestStructure Adressesagen, som man ønsker at opdatere, se Snitfladebeskrivelse Side 45 af 89

46 AddressCaseUpdateRequestStructure Feltnavn i OIOXML navn Kommentar afsnit RecordChangeDateTime Se afsnit 4.4. printenableindicator IgnoreWarningIndicator Feltet angiver om der skal udskrives en Meddelelse for relevante ejendomme og sendes til de respektive ejere. Når indikatoren er true, bliver der udskrevet Meddelelser. Information om advarsler skal eller ikke skal ignoreres. Når indikatoren er true, bliver advarsler ignoreret AddressCaseUpdateResponseStructure AddressCaseUpdateResponseStructure Feltnavn i OIOXML navn Kommentar AddressCaseResponseStructure Den opdaterede adressesag, se afsnit ReturnMessage Resultatet for metode kaldet, se afsnit Snitfladebeskrivelse Side 46 af 89

47 7.5. AddressCaseDelete Metoden AddressCaseDelete sletter en adressesag ved angivelse af adressesagens id og det kommunekode, som sagen hører til. De i afsnit og viste tegninger viser metodens input og output struktur. Ud over sagens id findes en indikator, som angiver om advarsler skal ignoreres eller om sletningen skal afvises i det tilfælde der gives advarsler. Du skal være opmærksom på, at adressesagen slettes sammen med de underliggende sagsentiteter, som kan være nye foreløbige adresser eller rettelser til gældende adresser. Adressesagen kan kun slettes hvis de underliggende foreløbige adresse ikke er knyttet til entiteter i Boliger og Byginger. Resultatet for metode kaldet leveres i en struktur kaldt ReturnMessage, som også genbruges i de andre strukturer. Derfor er den beskrevet som en fælles struktur i kapitel AddressCaseDeleteRequestStructure AddressCaseDeleteRequestStructure Feltnavn i OIOXML navn Kommentar AdressesagID AddressCaseIdentifier Feltet skal udfyldes med adressesagens id. Kommunekode MunicipalityCode Feltet skal udfyldes med 4 cifret kommunekode, f.eks RecordChangeDateTime Se afsnit 4.4. IgnoreWarningIndicator Information om advarsler skal eller ikke skal ignoreres. Når indikatoren er true, bliver advarsler ignoreret. Snitfladebeskrivelse Side 47 af 89

48 AddressCaseDeleteResponseStructure AddressCaseDeleteResponseStructure Feltnavn i OIOXML navn Kommentar ReturnMessage Resultatet for metode kaldet, se afsnit Snitfladebeskrivelse Side 48 af 89

49 8. Metoder til adressegeometri De 3 metoder til at opdatere, oprette og slette adressegeometrien er følgende: AddressPointCreate AddressPointUpdate AddressPointDelete Metoderne er beskrevet i de 3 næste afsnit. Vær opmærksom på, at kun gældende adgangsadresser (AAD er) og nye foreløbige adgangsadresser ((N)AAD er) kan have tilknyttet et adressepunkt. Sagsadresser ((S)AAD er) kan ikke få tilknyttet et adressepunkt, idet adressepunktet ikke kan ændres via en sag AddressPointCreate Metoden AddressPointCreate opretter et adressepunkt hørende til en adgangsadresse. De i afsnit og viste tegninger viser metodens input og output struktur. Adgangsadressen identificeres ved at angive af adgangsadressens id og kommunekoden. Adressepunktet sendes som input til metoden i en struktur kaldt addresspoint. Denne struktur genbruges i nogle af de andre metoder og er derfor beskrevet som en fælles struktur i kapitel 10. Som resultat for metoden returneres den oprettede adressepunkt. Resultatet for metode kaldet leveres i en struktur kaldt ReturnMessage, som også genbruges i de andre strukturer. Derfor er den beskrevet som en fælles struktur i kapitel 10. For at kunne oprette et adressepunkt skal der som minimum angives følgende felter: Kommunenummer Adgangsadresse id RecordChangeDateTime (for adgnagsadressen) Adressepunkt x-koordinat Adressepunkt y-koordinat Nøjagtighedsklasse Teknisk standard Kilde til adressegeometri AddressPointCreateRequestStructure Snitfladebeskrivelse Side 49 af 89

50 AddressPointCreateRequestStructure Feltnavn i OIOXML navn Kommentar Kommunekode MunicipalityCode Feltet skal udfyldes med 4 cifret kommunekode, f.eks AdgangsadresseID AddressAccessIdentifier Feltet skal udfyldes med adgangsadressens id hvis adressepunkt man ønsker at oprette. Adressepunkt addresspoint Adressepunktet, som man ønsker at oprette, se afsnit RecordChangeDateTime IgnoreWarningIndicator Se afsnit 4.4. (det er adgangsadressens RecordChangeDateTime) Information om advarsler skal eller ikke skal ignoreres. Når indikatoren er true, bliver advarsler ignoreret AddressPointCreateResponseStructure AddressPointCreateResponseStructure Feltnavn i OIOXML navn Kommentar Adressepunkt addresspoint Den oprettede adressepunkt, se afsnit RecordChangeDateTime Se afsnit 4.4. (det er adgangsadressens RecordChangeDateTime) ReturnMessage Resultatet for metode Snitfladebeskrivelse Side 50 af 89

51 AddressPointCreateResponseStructure Feltnavn i OIOXML navn Kommentar kaldet, se afsnit AddressPointUpdate Metoden AddressPointUpdate opdaterer et adressepunkt hørende til en adgangsadresse, som identificeres ved at angive af adgangsadressens id og kommunekoden. De i afsnit og viste tegninger viser metodens input og output struktur. Adgangsadressen identificeres ved at angive af adgangsadressens id og kommunekoden. Adressepunktet sendes som input til metoden i en struktur kaldt addresspoint. Denne struktur genbruges i nogle af de andre metoder og er derfor beskrevet som en fælles struktur i kapitel 10. Som resultat for metoden returneres den opdaterede adressepunkt. Resultatet for metode kaldet leveres i en struktur kaldt ReturnMessage, som også genbruges i de andre strukturer. Derfor er den beskrevet som en fælles struktur i kapitel 10. For at kunne opdatere et adressepunkt skal der som minimum angives følgende felter: Kommunenummer Adgangsadresse id RecordChangeDateTime (for adgnagsadressen) Adressepunkt x-koordinat Adressepunkt y-koordinat Nøjagtighedsklasse Teknisk standard Kilde til adressegeometri AddressPointUpdateRequestStructure AddressPointUpdateRequestStructure Feltnavn i OIOXML navn Kommentar Kommunekode MunicipalityCode Feltet skal udfyldes med 4 cifret kommunekode, f.eks Snitfladebeskrivelse Side 51 af 89

52 AddressPointUpdateRequestStructure Feltnavn i OIOXML navn Kommentar AdgangsadresseID AddressAccessIdentifier Feltet skal udfyldes med adgangsadressens id hvis adressepunkt man ønsker at oprette. Adressepunkt addresspoint Adressepunktet, som man ønsker at opdatere, se afsnit RecordChangeDateTime IgnoreWarningIndicator Se afsnit 4.4. (det er adgangsadressens RecordChangeDateTime) Information om advarsler skal eller ikke skal ignoreres. Når indikatoren er true, bliver advarsler ignoreret AddressPointUpdateResponseStructure AddressPointUpdateResponseStructure Feltnavn i OIOXML navn Kommentar Adressepunkt addresspoint Den oprettede adressepunkt, se afsnit RecordChangeDateTime Se afsnit 4.4. (det er adgangsadressens RecordChangeDateTime) ReturnMessage Resultatet for metode kaldet, se afsnit AddressPointDelete Metoden AddressPointDelete sletter adressepunktet hørende til en adgangsadresse. Bemærk at adressen heller ikke har foreløbige koordinater tilknyttet efter man eksplicit har kaldt AddressPointDelete funktionen. De i afsnit og viste tegninger viser metodens input og output struktur. Adgangsadressen identificeres ved at angive adgangsadressens id og kommunekoden. Snitfladebeskrivelse Side 52 af 89

53 Resultatet for metode kaldet leveres i en struktur kaldt ReturnMessage, som også genbruges i de andre strukturer. Derfor er den beskrevet som en fælles struktur i kapitel AddressPointDeleteRequestStructure AddressPointDeleteRequestStructure Feltnavn i OIOXML navn Kommentar AdgangsadresseID AddressAccessIdentifier Feltet skal udfyldes med adgangsadressens id hvis adressepunkt man ønsker at slette. Kommunekode MunicipalityCode Feltet skal udfyldes med 4 cifret kommunekode, f.eks RecordChangeDateTime IgnoreWarningIndicator Se afsnit 4.4. (det er adgangsadressens RecordChangeDateTime) Information om advarsler skal eller ikke skal ignoreres. Når indikatoren er true, bliver advarsler ignoreret AddressPointDeleteResponseStructure AddressPointDeleteResponseStructure Feltnavn i OIOXML navn Kommentar ReturnMessage Resultatet for metode kaldet, se afsnit RecordChangeDateTime Se afsnit 4.4. (det er adgangsadressens RecordChangeDateTime). Leveres tilbage for at man kan arbejde videre på den Snitfladebeskrivelse Side 53 af 89

54 AddressPointDeleteResponseStructure Feltnavn i OIOXML navn Kommentar adgangs- pågældende adresse. Snitfladebeskrivelse Side 54 af 89

55 9. Metoder til søgningerne De 2 metoder til at fremsøge adresser hhv. adressesager er: AddressSearch AddressCaseSearch Metoderne er beskrevet i de 2 næste afsnit. Der kan søges med forskellige søgekriterier. Hvis flere søgekriterier er udfyldt, betyder det, at alle udfyldte søgekriterier skal være opfyldt AddressSearch Metoden AddressSearch benyttes til at fremsøge adgangsadresser og enhedsadresser med en række søgekriterier, som f.eks. kommunekode, vejkode, oprettelsesdato m.m. De i afsnit og viste tegninger viser metodens input og output struktur. Søgekriterierne leveres i en struktur kaldt AddressSearchRequestStructure og adresserne som opfylder søgekriterierne leveres tilbage i en struktur med navn AddressSearchResponseStructure. For hver adgangsadresse hhv. enhedsadresse leveres der adressens ID samt andre relevante datafelter. En enhedsadresse, som opfylder søgekriteriet leveres altid sammen med den tilhørende adgangsadresse. En adgangsadresse, som opfylder søgekriteriet leveres altid sammen med de underliggende enhedsadresser. Søger man på en enhedsadresse vil den overliggende adgangsadresse således bliver leveret med alle dens underliggende enhedsadresser ikke kun dem som opfylder søgekriterierne. Resultatet for metode kaldet leveres i en struktur kaldt ReturnMessage, som også genbruges i de andre strukturer. Derfor er den beskrevet som en fælles struktur i kapitel 10. Hvis der ikke findes adresser med de angivne søgekriterier returneres returnidentifier 0 og reasonidentifier 10. Snitfladebeskrivelse Side 55 af 89

56 AddressSearchRequestStructure Snitfladebeskrivelse Side 56 af 89

57 AddressSearchRequestStructure Feltnavn i OIOXML navn Kommentar Kommunekode MunicipalityCode Feltet skal udfyldes med 4 cifret kommunekode, f.eks Feltet er krævet. Ejendomsnummer Matrikelnummer MunicipalRealPropertyIdentifier Der kan søges med et ejendomsnummer. Hvis feltet er udfyldt, leveres kun adresser med det ejendomsnummer, hvis feltet ikke er udfyldt, søges på alle ejendomsnumre. landparcelidentidystructure Der kan søges på matrikelnummeret. Hvis feltet er udfyldt, leveres kun adresser med det angivne matrikelnummer. Hvis feltet ikke er udfyldt, søges på alle matriklenumre. Se også afsnit Vejkode StreetCode Der kan søges på vejkode. Hvis feltet er udfyldt med en vejkode, leveres kun adresser med den vejkode, hvis ikke udfyldt leveres alle vejkoder Vejnavn StreetName Der kan søges på vejnavn. Hvis feltet er udfyldt leveres adresser med det angivne vejnavn. Hvis feltet ikke er udfyldt leveres alle vejnavne. Husnummer og husbogstav fra Husnummer og husbogstav til StreetBuidlingFromIdentifier StreetBuildingToIdentifier Der kan søges fra et husnummer/husbogstav til et andet. Hvis ikke feltet sendes med, søges på alle husnumre. Hvis feltet udfyldes med en tom string søges på alle adresser uden husnummer. Det er ikke muligt at søge på alle vejnavne uden husnummer idet kernekomponenten ikke tillader værdien 0 som input. Hvis kun fra felt er udfyldt, søges fra dette nummer og opefter, hvis kun til feltet er udfyldt søges fra 0 til det angivne husnummer. Landsejerlav CadastralDistrictIdentifier Der kan søges på landsejerlavskode. Hvis feltet er udfyldt leveres kun adresser med det landsejerlav, hvis ikke feltet er udfyldt, søges med alle Snitfladebeskrivelse Side 57 af 89

58 AddressSearchRequestStructure Feltnavn i OIOXML navn Kommentar landsejerlav Etage FloorIdentifier Der kan søges på etagebetegnelse. Side/dørnummer SuiteIdentifier Der kan søges på side/dørnummer. Status/Objektttype statuscode Der kan søges med statuskoden. Hvis feltet er udfyldt, leveres kun adresser med den angivne statuskode. Bynavn Postnummer PostCodeIdentifier Der kan søges på postnummer. DistrictSubdivisionIdentifier Der kan søges på bynavn. Postdistrikt DistrictName Der kan søges på postdistrikt. Journalnummer FileNumberIdentifier Der kan søges på journalnummer. ESDH reference ESDHreferenceIdentifier Der kan søges på ESDH referencen. Oprettelsesdato for adgangsadressen (fra-dato) Oprettelsesdato for adgangsadressen (til-dato) Seneste ændring for adgangsadressen (fra-dato) Seneste ændring for adgangsadressen (til-dato) AddressAccessCreateFromDate AddressAccessCreateTo- Date AddressAccessChangeFromDate AddressAccessChangeTo- Date Udfyldes felterne, leveres kun adresser med oprettelsesdatoen i perioden fra til. Hvis kun fra-datoen angives, sættes til-datoen til dagsdato. Hvis kun tildatoen angives, leveres alle adresser med oprettelsesdato mindre eller lige med til-datoen. Udfyldes felterne, leveres kun adresser med senesteændringsdatoen i perioden fra til. Hvis kun fra-datoen angives, sættes til-datoen til dagsdato. Hvis kun tildatoen angives, leveres alle adresser med seneste ændringsdato mindre eller lige med til-datoen. Sagsnummer AddressCaseFileReference Der fremsøges adresser som hører til den angivne adressesag. Sagsbehandler CaseWorkerReference Der fremsøges adresser som ligger i adressesager for den angivne sagsbehandler. Oprettelsesdato for adressesagen (fra-dato) Oprettelsesdato for adresse- AddressCaseCreateFrom- Date AddressCaseCreateToDate Udfyldes felterne, leveres kun adresser med oprettelsesdatoen i perioden fra til. Snitfladebeskrivelse Side 58 af 89

59 AddressSearchRequestStructure Feltnavn i OIOXML navn Kommentar sagen (til-dato) Nøjagtighedsklasse Hvis kun fra-datoen angives, sættes til-datoen til dagsdato. Hvis kun tildatoen angives, leveres alle adresser med oprettelsesdato mindre eller lige med til-datoen. AddressCoordinateQualityClassCode Udfyldes feltet leveres kun adresser som har den angivne nøjagtighedsklasse. Koder: A: Absolutte adressekoordinater stedfæstelsen bør pege på det rigtige objekt, jf. specifik f. teknisk kort B: Beregnet koordinatsæt, foreløbig, omtrentlig stedfæstelse U: Adresse uden koordinater stedfæstelse ukendt Revisionsdato fra Revisionsdato til Kode for teknisk standard AddressCoordinateRevisionFromDate AddressCoordinateRevisionToDate AddressCoordinateTechnicalStandardCode Udfyldes felterne, leveres kun adresser hvor geometriens revisionsdatoe er i perioden fra til. Hvis kun fra-datoen angives, sættes til-datoen til dagsdato. Hvis kun tildatoen angives, leveres alle adresser med revisionsdato mindre eller lige med til-datoen. Der kan søges med kode for teknisk standard for geometridata. Koder: TD: Husnummer placeres 3 meter inde i bygningen ved det sted hvor indgangsdør e.l. skønnes placeret, med en retningsvinkel der er orienteret i forhold til den adressegivende vejs vejmidte TK: Udtrykkelig TKstandard: 3 meter inde i bygning, midt for længste side mod vej og roteret TN: Alm. teknisk standard: bygningstyngdepunkt eller blot i bygning og roteret UF: Uspecificeret/foreløbig; ikke nød- Snitfladebeskrivelse Side 59 af 89

60 AddressSearchRequestStructure Feltnavn i OIOXML navn Kommentar Kilde til adresse geometri AddressGeometrySource- Code vendigvis placeret i bygning, ikke nødvendigvis roteret Der kan søges med kode for kilde til geometridata. Koder: 1: Oprettet maskinelt på baggrund af teknisk kort 2: Oprettet maskinelt på baggrund af matrikelnummer tyngdepunkt 3: Eksternt indberettet af konsulent på vegne af kommunen 4: Eksternt indberettet af kommunes kortkontor o.l. 5: Oprettet af teknisk forvaltning AddressSearchResponseStructure AddressSearchResponseStructure Feltnavn i OIOXML navn Kommentar AddressAccessResponseStructure En eller flere adgangsadresser med underliggende enhedsadresser, Snitfladebeskrivelse Side 60 af 89

61 AddressSearchResponseStructure Feltnavn i OIOXML navn Kommentar som opfylder søgekriteriet, se afsnit Enhedsadresser leveres altid med tilhørende adgangsadresse, derfor kan AddressAccessResponseStrcuture benyttes. ReturnMessage Resultatet for metode kaldet, se afsnit AddressCaseSearch Metoden AddressCaseSearch benyttes til at fremsøge adressesager med en række søgekriterier, som f.eks. sagsnummer, sagsbehandler, oprettelsesdato m.m. De i afsnit og viste tegninger viser metodens input og output struktur. Alle adressesager, som opfylder de angivne kriterier, leveres tilbage. Søgekriterierne leveres i en struktur kaldt AddressCaseSearchRequestStructure og adressesagerne, som opfylder søgekriterierne leveres tilbage i en struktur med navn AddressCaseSearchResponseStructure. For hver adressesag leveres der sagens ID samt andre relevante datafelter. Adressesagerne leveres tilbage med de tilhørende sagsentiteter, som kan være enhedsadresser eller adgangsadresser. Resultatet for metode kaldet leveres i en struktur kaldt ReturnMessage, som også genbruges i de andre strukturer. Derfor er den beskrevet som en fælles struktur i kapitel 10. Hvis der ikke findes adressesager med de angivne søgekriterier returneres returnidetifier 0 og reasonidentifier AddressCaseSearchRequestStructure Snitfladebeskrivelse Side 61 af 89

62 AddressCaseSearchRequestStructure Feltnavn i OIOXML navn Kommentar Kommunekode MunicipalityCode Feltet skal altid udfyldes med 4 cifret kommunekode, f.eks Oprettelsesdato for adressesagen (fra-dato) Oprettelsesdato for adressesagen (til-dato) AddressCaseCreateFrom- Date AddressCaseCreateToDate Disse to søgefelter kan benyttes til at søge efter sager, som er blevet oprettet i en bestemt tidsperiode. Sagsbehandler CaseWorkerReference Udfyldes feltet, leveres kun adressesager for denne sagsbehandler Sagsnummer AddressCaseFileReference Udfyldes feltet, leveres kun adressesager med denne sagsnummer AddressCaseSearchResponseStructure AddressCaseSearchResponseStructure Feltnavn i OIOXML navn Kommentar AddressCaseResponseStructure Adressesager, som opfylder de angivne søgekriterier, se afsnit Snitfladebeskrivelse Side 62 af 89

63 AddressCaseSearchResponseStructure Feltnavn i OIOXML navn Kommentar ReturnMessage Resultatet for metode kaldet, se afsnit Snitfladebeskrivelse Side 63 af 89

64 10. Fælles strukturer AddressAccessRequestStructure Strukturen AddressAccessRequestStructure benyttes når en adgangsadresse bliver leveret som input til en metode. Dette gælder f.eks. når en adgangsadresse skal oprettes eller opdateres. AddressAccessRequestStructure Feltnavn i OIOXML navn Kommentar AddressAccessUserKeys Adgangsadressens brugervendte nøgle, se afsnit Matrikeloplysninger, afsnit se landparcelidentitystructure AddressCaseAddressAccessRequestKeys AddressAccessRequestDates Hvis adgangsadressen har status 3 og leveres id en for den adressesag, som denne adgangsadresse hører til. Hvis det er en sagsadresse, leveres yderligere id for den adgangsadresse, som denne sagsadresse er en ændring til. Se også afsnit Datoer relevant for adgangsadressen i den situation hvor den bliver leveret som input. Se også afsnit Kommunespecifikke felter MunicipalityFields Kommunespecifikke felter, se afsnit ExternalReferences Journalnummer og ESDH reference for adgangsadressen, se afsnit Snitfladebeskrivelse Side 64 af 89

65 AddressAccessRequestStructure Feltnavn i OIOXML navn Kommentar Kilde til adgangsadresse AddressAccessSourceCode Kode, der klassificerer kilden til adressen. Koder: 1 - Oprettet af kommunen iht. adressecirkulæret 2 - Oplysning fra ejer 3 - Oplysning fra teknisk kort 4 - Oplysning fra KRR Manuel 5 - Oplysning fra KRR Administrativ 6 - Oplysning fra ESR 7 - Oplysning fra CPR 8 - Oplysning fra CVR 9 - Oplysning fra post 10 - Oplysning fra 112 o.l Oplysning fra anden kilde Strukturen "landparcelidentitystructure" er frivillig, men det vil i praksis altid skulle udfyldes med enten et KMS matrikelnummer eller med en ESR matrikeloplysning, som beskrevet i afsnit 3.8. Når strukturen medtages, skal strukturen "MATRLandParcelIdentificationStructure" forekomme, dvs. netop en landsejerlavskode og et matrikelnummer skal angives. Ejendomsnummer, artskode og delnumre mv. er derimod under alle omstændigheder frivillige. I tilfælde af, at disse frivillige felter ikke er angivet, vil Nyt sytemet automatisk finde frem til det rigtige KMS matrikelnummer herunder om det har artskode 00 eller 01. Det samme gælder ejendomsnummeret. Hvis det ikke angives, vil Nyt systemet automatisk finde frem til ejendomsnummeret ud fra de angivne parametre. Ejendomsnummer skal dog angives hvis det ikke er et KMS matrikelnummer og det er med til at identificere en ESR matrikeloplysning entydigt. I de tilfælde hvor ejendomsnummeret angives vil det blive valideret og metodekaldet fejler hvis det angivne ejendomsnummer ikke er korrekt AddressAccessResponseStructure Strukturen AddressAccessResponseStructure benyttes når en adgangsadresse bliver leveret som en del af et svar. Dette gælder f.eks. når en adgangsadresse leveres efter en Get eller GetById metode eller når en adgangsadresse leveres tilbage efter en Update eler Create metode. Yderligere benyttes strukturen når adgangsadressen leveres som søgeresultat. Strukturen er også en delstruktur i AddressCaseResponseStructure, idet en adressesag leveres sammen med de underliggende sagsentiteter. Snitfladebeskrivelse Side 65 af 89

66 I nedenstående tabel er de enkelte felter beskrevet i detaljer. AddressAccessResponseStructure Feltnavn i NYT OIOXML navn Kommentar AdgangsadresseID AddressAccessIdentifier Feltet er udfyldt med adgangsadressens id. AddressAccessUserKeys Adgangsadressens brugervendte nøgle, se afsnit AddressAccessInformation Supplerende oplysninger om adgangsadressen, se afsnit landparcelidentitystructure Matrikeloplysninger, afsnit se addresspoint Adgangsadressens adressepunkt, se afsnit AddressCaseAddressAccessResponseKeys Hvis adgangsadressen ikke har geometri (som svarer til at nøjagtighedsklassen er U og adressepunktid en null), vil der ikke blive leveret et addresspoint objekt tilbage. Hvis adgangsadressen har status 3 leveres oplysninger om den adressesag, som denne adgangs- Snitfladebeskrivelse Side 66 af 89

67 AddressAccessResponseStructure Feltnavn i NYT OIOXML navn Kommentar adresse hører til. For sagsadresser leveres yderligere id for den adgangsadresse, som denne sagsadresse er en ændring til. Se også afsnit AddressAccessResponse- Dates AddressSpecificResponseStructure AddressAccessCaseRespon se Datoer relevant for adgangsadressen i den situation hvor den bliver leveret som et svar. Se også afsnit Strukturen indeholder de enhedsadresser, som hører til adgangsadressen. Se også afsnit Hvis adgangsadressen har status 1 vil denne liste indeholde eventuelle sagsadresser, dvs. adgangsadresser, som retter den gældende adgangsadresse. Se også afsnit Kommunespecifikke felter MunicipalityFields Kommunespecifikke felter, se afsnit ExternalReferences Journalnummer og ESDH reference for enhedsadressen, se afsnit Kilde til adgangsadresse AddressAccessSourceCode Kode, der klassificerer kilden til adressen. Koder: 1 - Oprettet af kommunen iht. adressecirkulæret 2 - Oplysning fra ejer 3 - Oplysning fra teknisk kort 4 - Oplysning fra KRR Manuel 5 - Oplysning fra KRR Administrativ 6 - Oplysning fra ESR 7 - Oplysning fra CPR 8 - Oplysning fra CVR 9 - Oplysning fra post 10 - Oplysning fra 112 o.l Oplysning fra anden kilde Status (objekttype) for adgangsadressen statuscode Statuskoden er 1 for gældende adresser og 3 for nye foreløbige adresser og sagsadresser. Se også afsnit 3.9. Snitfladebeskrivelse Side 67 af 89

68 AddressAccessResponseStructure Feltnavn i NYT OIOXML navn Kommentar RecordChangeDateTime Se afsnit AddressAccessUserKeys Strukturen beskriver en brugervendt nøgle til en eller også flere adgangsadresser. Som beskrevet i kapitel 5.2, kan to adgangsadresser have samme brugervendte nøgle, dvs. samme kombination af kommunekode, vejkode og husnummer. AddressAccessUserKeys Feltnavn i NYT OIOXML navn Kommentar Kommunekode MunicipalityCode Feltet er altid udfyldt med 4 cifret kommunekode, f.eks Vejkode StreetCode Feltet er udfyldt med vejkode, hvis adressen har en vejkode. Husnummer og husbogstav StreetBuidlingIdentifier Feltet er udfyldt med husnummer/husbogstav, hvis adressen har et husnummer/husbogstav AddressAccessInformation Strukturen beskriver supplerende oplysninger for en adgangsadresse. Snitfladebeskrivelse Side 68 af 89

69 AddressAccessInformation Feltnavn i NYT OIOXML navn Kommentar Vejnavn Lokalitet Bynavn Postnummer Postdistrikt StreetName MailDeliverySublocationIdentifier DistrictSubdivisionIdentifier PostCodeIdentifier DistrictName AddressAccessRequestDates Strukturen benyttes til at levere forskellige relevante datoer for en adgangsadresse når adgangsadressen leveres som input til en metode. Snitfladebeskrivelse Side 69 af 89

70 AddressAccessRequestDates Feltnavn i NYT OIOXML navn Kommentar Ikrafttrædelsesdato AddressAccessValidDate Dato for adressens ikrafttrædelse Dato for nedlæggelse AddressAccessExpireDate Dato for adressens nedlæggelse AddressAccessResponseDates Strukturen leverer oplysninger om forskellige relevante datoer for adgangsadressen, når adgangsadressen er en del af svaret. AddressAccessResponseDates Feltnavn i NYT OIOXML navn Kommentar Oprettelsesdato AddressAccessCreateDate Dato for adressens oprettelse i Ikrafttrædelsesdato AddressAccessValidDate Dato for adressens ikrafttrædelse Dato for seneste ændring AddressAccessChangeDate Dato for adressens seneste ændring Dato for nedlæggelse AddressAccessExpireDate Dato for adressens nedlæggelse AddressAccessCaseResponse Strukturen leverer sagsadresser hørende til en given adgangsadresse. Her benyttes igen strukturen AddressAccessResponseStructure for at beskrive sags-adgangsadresserne. Der er dog ingen risiko for cirkulære referencer, idet strukturen AddressAccessCaseResponse kun er udfyldt for adgangsadresser med status 1 og i selve strukturen findes der kun adgangsadresser med sagstype 3. Snitfladebeskrivelse Side 70 af 89

71 AddressAccessCaseResponse Feltnavn i NYT OIOXML navn Kommentar AddressAccessResponseStructure Sekvens af sagadgangsadresser som hører til en adgangsadresse, se afsnit AddressSpecificRequestStructure Strukturen AddressSpecificRequestStructure benyttes når en enhedsadresse bliver leveret som input til en metode. Dette gælder f.eks. når en enhedsadresse skal oprettes eller opdateres. AddressSpecificRequestStructure Snitfladebeskrivelse Side 71 af 89

72 Feltnavn i OIOXML navn Kommentar Kommunespecifikke felter AddressSpecificUserKeys AddressCaseAddressSpecificRequestKeys AddressSpecificRequest- Dates MunicipalityFields Enhedsadressens brugervendte nøgle, se afsnit Hvis enhedssadressen har status 3 og leveres id en for den adressesag, som denne enhedsadresse hører til. Hvis det er en sagsadresse, leveres yderligere id for den enhedsadresse, som denne sagsadresse er en ændring til. Se også afsnit Datoer relevant for enhedsadressen i den situation hvor den bliver leveret som input. Se også afsnit Kommunespecifikke felter, se afsnit ExternalReferences Journalnummer og ESDH reference for enhedsadressen, se afsnit Kilde til enhedsadresse AddressSpecificSource- Code Kode, der klassificerer kilden til adressen. Koder: 1 - Oprettet af kommunen iht. adressecirkulæret 2 - Oplysning fra ejer 3 - Oplysning fra teknisk kort 4 - Oplysning fra KRR Manuel 5 - Oplysning fra KRR Administrativ 6 - Oplysning fra ESR 7 - Oplysning fra CPR 8 - Oplysning fra CVR 9 - Oplysning fra post 10 - Oplysning fra 112 o.l Oplysning fra anden kilde AddressSpecificResponseStructure Strukturen AddressSpecificResponseStructure benyttes når en enhedsadresse bliver leveret som en del af et svar. Dette gælder f.eks. når en enheds- Snitfladebeskrivelse Side 72 af 89

73 adresse leveres efter en Get eller GetById metode eller når en enhedsadresse leveres tilbage efter en Update eler Create metode. Strukturen er også en delstruktur i AddressCaseResponseStructure, idet en adressesag leveres sammen med de underliggende sagsentiteter. AddressSpecificResponseStructure Feltnavn i NYT OIOXML navn Kommentar EnhedsadresseID AddressSpecificIdentifier Feltet er udfyldt med enhedsadressens id. AddressSpecificUserKeys AddressSpecificInformation AddressCaseAddressSpecificResponseKeys AddressSpecificResponse- Dates AddressSpecificCase- Response Enhedsadressens brugervendte nøgle, se afsnit Supplerende oplysninger om enhedsadressen, se afsnit Hvis enhedsadressen har status 3 leveres oplysninger om den adressesag, som denne enhedsadresse hører til. For sagsadresser leveres yderligere id for den enhedsadresse, som denne sagsadresse er en ændring til. Se også afsnit Datoer relevant for enhedsadressen i den situation hvor den bliver leveret som et svar. Se også afsnit Hvis enhedsadressen har status 1 vil denne liste indeholde eventuelle sagsadresser, dvs. enhedsadresser, som retter Snitfladebeskrivelse Side 73 af 89

74 AddressSpecificResponseStructure Feltnavn i NYT OIOXML navn Kommentar den gældende enhedsadresse. Se også afsnit Kommunespecifikke felter MunicipalityFields Kommunespecifikke felter, se afsnit Kilde til adgangsadresse Status (objekttype) for adgangsadressen ExternalReferences AddressSpecificSourceCode statuscode Journalnummer og ESDH reference for enhedsadressen, se afsnit Kode, der klassificerer kilden til adressen. Koder: 1 - Oprettet af kommunen iht. adressecirkulæret 2 - Oplysning fra ejer 3 - Oplysning fra teknisk kort 4 - Oplysning fra KRR Manuel 5 - Oplysning fra KRR Administrativ 6 - Oplysning fra ESR 7 - Oplysning fra CPR 8 - Oplysning fra CVR 9 - Oplysning fra post 10 - Oplysning fra 112 o.l Oplysning fra anden kilde Statuskoden er 1 for gældende adresser og 3 for nye foreløbige adresser og sagsadresser. Se også afsnit 3.9. RecordChangeDateTime Se afsnit AddressSpecificUserKeys Strukturen beskriver en brugervendt nøgle til en enhedsadresse. Snitfladebeskrivelse Side 74 af 89

75 AddressSpecificUserKeys Feltnavn i NYT OIOXML navn Kommentar Kommunekode MunicipalityCode Feltet er altid udfyldt med 4 cifret kommunekode, f.eks Adgangsadresse ID AddressAccessIdentifier Adgangsadressens ID leveres med når enhedsadressen leveres som en del af et svar, men er optionel når enhedsadressen sendes som input. Den skal angives når en enhedsadresse oprettes, men er optionen når enhedsadressen opdateres. Etage Side/dørnummer FloorIdentifier SuiteIdentifier AddressSpecificInformation Strukturen beskriver supplerende oplysninger for en enhedsadresse. Snitfladebeskrivelse Side 75 af 89

76 AddressSpecificInformation Feltnavn i NYT OIOXML navn Kommentar Vejnavn Vejkode Husnummer og husbogstav til StreetName StreetCode StreetBuildingToIdentifier AddressSpecificRequestDates Strukturen benyttes til at levere forskellige relevante datoer for en enhedsadresse når enhedsadressen leveres som input til en metode. AddressSpecificRequestDates Feltnavn i NYT OIOXML navn Kommentar Ikrafttrædelsesdato AddressSpecificValidDate Dato for adressens ikrafttrædelse Dato for nedlæggelse AddressSpecificExpireDate Dato for adressens nedlæggelse Snitfladebeskrivelse Side 76 af 89

77 AddressSpecificResponseDates Strukturen leverer oplysninger om forskellige relevante datoer for enhedsadressen, når enhedsadressen er en del af svaret. AddressSpecificResponseDates Feltnavn i NYT OIOXML navn Kommentar Oprettelsesdato AddressSpecificCreateDate Dato for adressens oprettelse i Dato for seneste ændring Ikrafttrædelsesdato AddressSpecificValidDate Dato for adressens ikrafttrædelse AddressSpecificChangeDate Dato for adressens seneste ændring Dato for nedlæggelse AddressSpecificExpireDate Dato for adressens nedlæggelse AddressSpecificCaseResponse Strukturen leverer sagsadresser hørende til en given enhedsadresse. Her benyttes igen strukturen AddressSpecificResponseStructure for at beskrive sags-enhedsadresserne. Der er dog ingen risiko for cirkulære referencer, idet strukturen AddressSpecificCaseResponse kun er udfyldt for enhedsadresser med status 1 og i selve strukturen findes der kun enhedsadresser med sagstype 3. Snitfladebeskrivelse Side 77 af 89

78 AddressSpecificCaseResponse Feltnavn i NYT OIOXML navn Kommentar AddressSpecificResponseStructure Sekvens af sagenhedsadresser som hører til en enhedsadresse, se afsnit AddressCaseRequestStructure Strukturen AddressCaseRequestStructure benyttes når en adressesag bliver leveret som input til en metode. Dette gælder f.eks. når en adressesag skal oprettes eller opdateres. AddressCaseRequestStructure Feltnavn i OIOXML navn Kommentar Snitfladebeskrivelse Side 78 af 89

79 AddressCaseRequestStructure Feltnavn i OIOXML navn Kommentar Kommunekode Sagsnummer Dato for godkendelse Initialer på sagsbehandler MunicipalityCode AddressCaseFileReference AddressCaseApprovalDate Når datoen angives, afsluttes adressesagen. Datoen må ikke angives i en opret situation. CaseWorkerReference RecordChangeDateTime Se afsnit AddressCaseResponseStructure Strukturen AddressCaseResponseStructure benyttes når en adressesag bliver leveret som en del af et svar. Dette gælder f.eks. når en adressesag leveres efter en Get eller GetById metode eller når en adressesag leveres tilbage efter en Update eler Create metode. Yderligere benyttes strukturen når en adressesag leveres som søgeresultat. AddressCaseResponseStructure Feltnavn i NYT OIOXML navn Kommentar Adressesag ID AddressCaseIdentifier Kommunekode MunicipalityCode Feltet skal altid udfyldes med 4 cifret kommuneko- Snitfladebeskrivelse Side 79 af 89

80 AddressCaseResponseStructure Feltnavn i NYT OIOXML navn Kommentar de, f.eks Sagsnummer AddressCaseFileReference Dato for godkendelse AddressCaseApprovalDate Når datoen angives, afsluttes adressesagen. Oprettelsesdato Initialer på sagsbehandler AddresscaseCreateDate CaseWorkerReference AddressAccessResponseStructure AddressSpecificResponseStructure Adgangsadresser hørende til adressesagen Enhedsadresser hørende til adressesagen RecordChangeDateTime Se afsnit AddressCaseAddressAccessRequestKeys Hvis der leveres en adgangsadresse med status 3 (dvs. en sagsadresse eller en ny foreløbig adresse jf. afsnit 3.3) som input til en metode, skal strukturen AddressCaseAddressAccessRequestKeys udfyldes med id for den adressesag, som denne sagsentitet hører til. Hvis det er en sagsadresse (dvs. en ændring til en gældende adresse), skal der yderligere leveres id for den stamadresse, som denne sagsadresse peger på. AddressCaseAddressSpecificRequestKeys Feltnavn i NYT OIOXML navn Kommentar Adressesag ID AddressCaseIdentifier Id for den adressesag, som adressen hører til. Stam-adgangsadresse ID AddressAccessParentIdentifier Id for den stamadgangsadresse, som sagsadressen er en ændring til (udfyldt hvis det er en sagsadresse) AddressCaseAddressSpecificRequestKeys Hvis der leveres en adresse med status 3 (dvs. en sagsadresse eller en ny foreløbig adresse jf. afsnit 3.3) som input til en metode, skal strukturen AddressCaseAddressSpecificRequestKeys udfyldes med id for den adressesag, som denne sagsentitet hører til. Hvis det er en sagsadresse (dvs. en ændring til en gældende adresse), skal der yderligere leveres id for den stam-adresse, som denne sagsadresse peger på. Snitfladebeskrivelse Side 80 af 89

81 Når man opdaterer en ny foreløbig enhedsadresse (en (N)EAD, status 3) er det tilstrækkeligt at angive id en for den enhedsadresse man ønsker at opdatere. AddressCaseAddressSpecificRequestKeys Feltnavn i NYT OIOXML navn Kommentar Adressesag ID AddressCaseIdentifier Id for den adressesag, som adressen hører til. Stam-adgangsadresse ID AddressSpecificParentIdentifier Id for den stamenhedsadresse, som sagsadressen er en ændring til (udfyldt hvis det er en sagsadresse) AddressCaseAddressAccessResponseKeys Hvis der leveres en adgangsadresse med status 3 (dvs. en sagsadresse eller en ny foreløbig adresse jf. afsnit 3.3), er strukturen AddressCaseAddressAccessResponseKeys udfyldt. Den leverer oplysninger (id og sagsnummer) for den adressesag, som denne sagsentitet hører til. Hvis det er en sagsadresse (dvs. en ændring til en gældende adresse), leveres yderligere id en for den stam-adresse, som denne sagsadresse peger på. AddressCaseAddressAccessResponseKeys Feltnavn i NYT OIOXML navn Kommentar Adressesag ID AddressCaseIdentifier Id for den adressesag, som adressen hører til. Sagsnummer AddressCaseFileReference Sagsnummer for den adressesag, som denne adresse hører til. Stam-adgangsadresse ID AddressAccessParentIdentifier Id for den stamadgangsadresse, som sagsadressen er en ændring til (udfyldt hvis det er en sagsadresse) AddressCaseAddressSpecificResponseKeys Hvis der leveres en enhedsadresse med status 3 (dvs. en sagsadresse eller en ny foreløbig adresse jf. afsnit 3.3), er strukturen AddressCaseAddressSpeci- Snitfladebeskrivelse Side 81 af 89

82 ficresponsekeys udfyldt. Den leverer oplysninger (id og sagsnummer) for den adressesag, som denne sagsentitet hører til. Hvis det er en sagsadresse (dvs. en ændring til en gældende adresse), leveres yderligere id en for den stam-adresse, som denne sagsadresse peger på. AddressCaseAddressSpecificResponseKeys Feltnavn i NYT OIOXML navn Kommentar Adressesag ID AddressCaseIdentifier Id for den adressesag, som adressen hører til. Sagsnummer AddressCaseFileReference Sagsnummer for den adressesag, som denne adresse hører til. Stam-adgangsadresse ID AddressSpecificParentIdentifier Id for den stamadgangsadresse/enhedsadresse, som sagsadressen er en ændring til (udfyldt hvis det er en sagsadresse) ExternalReferences Strukturen indeholder felter som beskriver referencer til eksterne systemer. ExternalReferences Feltnavn i NYT OIOXML navn Kommentar Journalnummer ESDH reference FileNUmberIdentifier ESDHreferenceIdentifier BBBlandParcelIdentityStructure Strukturen leverer matrikeloplysninger til en adgangsadresse. En adgangsadresse har 0 eller 1 matrikel tilknyttet. Snitfladebeskrivelse Side 82 af 89

83 landparcelidentitystructure Navn i OIOXML navn Kommentar Matrikeloplysninger Matriklens delnummer Matriklens opdelingsnummer Matriklens artskode Ejendomsnummer MATRLandParcelIdentification SubLandParcelIdentifier LandParcelTypeCode Matrikeloplysninger (kernekomponent fra namespace KMS), indeholder matrikelnummer, matrikelbogstav, landsejerlav samt e-ref, den fælles ejendomsreference. AlternateSubLandParcelIdentifier MunicipalRealPropertyIdentifier addresspoint Strukturen addresspoint beskriver adgangsadressens adressepunkt. Strukturen addresspoint består af kernekomponenten AddressPoint med felterne revisionsdato, nøjagtighedsklasse og x- og y- koordinat samt nogle ekstra felter såsom retningsvinkel, tekstplacering, kilde til geometri og koordinatsystem. Kerneskemaet AddressPoint indeholder også elementer, som ikke benyttes i denne sammenhæng. Dette er felterne GeographicHeightMeasure og AddressPointValidStartDateTime og AddressPointValidStartEndTime. Disse felter sendes med frem og tilbage med ignoreres hvis de er udfyldt ved en opdatering eller oprettelse. Når en adgangsadresse har nøjagtighedsklasse U (som betyder uden koordinater), vil adressepunktet ikke leveres med. Snitfladebeskrivelse Side 83 af 89

84 addresspoint Feltnavn i NYT OIOXML navn Kommentar Nøjagtighedsklasse AddressCoordinateQualityClassCode Feltet er krævet. Når der ikke medsendes adressepunkt ved oprettelse af adgangsadressen, sættes nøjagtighedsklasse til U. Nøjagtighedsklasse for adressens koordinater. Koder: A: Absolutte adressekoordinater stedfæstelsen bør pege på det rigtige objekt, jf. specifik f. teknisk kort B: Beregnet koordinatsæt, foreløbig, omtrentlig stedfæstelse U: Adresse uden koordinater stedfæstelse ukendt Revisionsdato AddressCoordinateRevisionDate Feltet er krævet (fordi der gøres brug af kernekomponenten AddressPoint, som definerer feltet som krævet). Man kan dog udfylde feltet med nulværdien T00:00:00 og så vil systemet indsætte dagsdato som revisionsdato. Easting koordinat GeographicEastingMeasure x-koordinat i UTM ETRS89 Zone 32 Snitfladebeskrivelse Side 84 af 89

85 addresspoint Feltnavn i NYT OIOXML navn Kommentar Ved opdatering er feltet er krævet. Northing koordinat GeographicNorthingMeasure y-koordinat i UTM ETRS89 Zone 32 Ved opdatering er feltet er krævet. Retningsvinkel AddressTextAngleMeasure Retningsvinkel for tekst i Kode for teknisk standard Tekstplacering for husnummer AddressTextJustification- Code AddressCoordinateTechnicalStandardCode gon, jf. TK-standard: Ved opdatering er feltet ikke krævet. Hvis vinklen ikke angives sættes den til 200. Placeringskode (tekstjustering) af husnr.; kodesæt 1-9, jf. DSFL Ved opdatering er feltet ikke krævet. Hvis placering ikke angives, sættes den til 5. Ved opdatering er feltet er krævet. Kode for teknisk standard for geometridata. Kilde til adresse geometri AddressGeometrySource- Code Koder: TD: Husnummer placeres 3 meter inde i bygningen ved det sted hvor indgangsdør e.l. skønnes placeret, med en retningsvinkel der er orienteret i forhold til den adressegivende vejs vejmidte TK: Udtrykkelig TKstandard: 3 meter inde i bygning, midt for længste side mod vej og roteret TN: Alm. teknisk standard: bygningstyngdepunkt eller blot i bygning og roteret UF: Uspecificeret/foreløbig; ikke nødvendigvis placeret i bygning, ikke nødvendigvis roteret Kode for kilde til geometridata. Feltet er krævet. Koder: 1: Oprettet maskinelt på Snitfladebeskrivelse Side 85 af 89

86 addresspoint Feltnavn i NYT OIOXML navn Kommentar baggrund af teknisk kort 2: Oprettet maskinelt på baggrund af matrikelnummer tyngdepunkt 3: Eksternt indberettet af konsulent på vegne af kommunen 4: Eksternt indberettet af kommunes kortkontor o.l. 5: Oprettet af teknisk forvaltning MunicipalityFields Strukturen beskriver kommunespecifikke felter ReturnMessage Hvis der opstår en fejl er ResponseReturnIdentifier lig med 10 of der returneres kun én ReturnMessage. Hvis kaldet gik godt er ResponseReturnIdentifier lig med 0 og der returneres kun én ReturnMessage. Hvis kaldet returnerer et antal sandsynlighedsbeskeder er ResponseReturnIdentifier lig med 20 og der returneres en ReturnMessage pr. sandsynlighedsbesked. Hvis kaldet returnerer sandsynlighedsbeskeder betyder det, at kaldet kan blive gennemført når man vælger at ignorere advarsler ved hjælp af Ignore- WarningIndicator. Snitfladebeskrivelse Side 86 af 89

87 For hver besked sendes der følgende værdier tilbage: ReturnMessage Feltnavn i NYT OIOXML navn Kommentar Kommentar ResponseReturnIdentifier ResponseReasonIdentifier ResponseReasonText Beskriver hvilken type besked det drejer sig om. Koder: 0: OK 10: Fejl 20: Sandsynlighedsvalidering Nærmere detaljer for den returnerede besked. Hvis ReturnIdentifier er 0 forekommer følgende koder: 0: OK, kald udført 10: Søgning gav ingen resultat Hvis ReturnIdentifier er 10 eller 20 kan mange koder forekomme, idet der findes en kode for hver fejlbesked hhv sandsynlighedsbesked i Nyt. En beskrivelse af fejlen hhv. sandsynlighedsbeskeden. Snitfladebeskrivelse Side 87 af 89

88 11. Adgang til snitfladen Sikkerhed Sikkerheden i webservicen er baseret OIO-anbefalingen OWSA model T. Kort fortalt benytter denne sikkerhedsmekanisme HTTPS til sikker transport mellem to sikkerhedsdomæner og OCES-certifikater som autentifikation af Service Aftager. For at benytte webservicen skal Service Aftager : være autoriseret i (se afsnit 11.2) og have tilknyttet et gyldigt OCES virksomheds- eller medarbejdercertifikat til autorisationen medsende ovennævnte certifikat ved alle webservicekald have installeret OCES-rodcertifikat I øvrigt henvises til IT- og Telestyrelsens beskrivelse af OWSA model T. Derudover henvises til DanIDs hjemmeside ( for beskrivelse af hvordan man kan få det krævede certifikat og hvordan det installeres korrekt Autorisation For at kunne benytte snitfladen skal man kontakte en given kommune og bede om autorisation. Kommunen skal oprette jer som bruger og tildele jer den eller de passende roller. Der findes en kommunale rolle pr. metode i denne webservice: (hvad med fremsøgning af alle adresser?) OIOAddressServiceAddressAccessGet OIOAddressServiceAddressAccessGetById OIOAddressServiceAddressAccessCreate OIOAddressServiceAddressAccessUpdate OIOAddressServiceAddressAccessDelete OIOAddressServiceAddressSpecificGet OIOAddressServiceAddressSpecificGetById OIOAddressServiceAddressSpecificCreate OIOAddressServiceAddressSpecificUpdate OIOAddressServiceAddressSpecificDelete OIOAddressServiceAddressCaseGet OIOAddressServiceAddressCaseGetById OIOAddressServiceAddressCaseCreate OIOAddressServiceAddressCaseUpdate OIOAddressServiceAddressCaseDelete OIOAddressServiceAddressPointCreate OIOAddressServiceAddressPointDelete OIOAddressServiceAddressPointUpdate OIOAddressServiceAddressSearch OIOAddressServiceAddressCaseSearch Testmiljø For at kunne teste snitfladen kan man benytte webservicen i s demomiljø. Du kan finde webservicen til test her: Snitfladebeskrivelse Side 88 af 89

89 I modsætning til produktionsmiljøet benyttes ingen sikkerhed eller certifikater i testmiljøet. Vær opmærksom på, at der skal anvendes kommunekode 881 når webservicen kaldes i demo miljøet. Snitfladebeskrivelse Side 89 af 89