Page tree
Skip to end of metadata
Go to start of metadata





Siden beskriver de REST tjenester, der udstilles på Datafordeleren fra DAR.

Få en introduktion til REST på Datafordeleren, hvis du har brug for en introduktion til og vejledning i, hvordan man kan anvende webservices, som udstilles på Datafordeleren.

Få en guide til helt konkrete anvisninger til at bruge en webservice fra Datafordeleren i Guide til REST på Selvbetjeningen.

Under kodelister på Danmarksadresser.dk, kan du finde de værdier forretningsproces, forretningsområde og forretningshændelse kan tage.






Generelt for DAR webservices

Registernavn i SelvbetjeningenDAR
FormatXML/JSON
DLS version2.3.4
PagingAnvender paging.
Default paging-størrelse: 100 
Dato- og tidsformat

Datoformat følger ISO 8601 Date and time format.

Alle datoer skrives med andre ord i formatet yyyy-mm-ddTHH:MM:SS.ssssss, hvor tidsangivelsen kan udelades.

Tidszonen kan angives enten ved (2019-02-05T07:50:14.687580+01:00 (for normaltid/vintertid)), (2019-07-05T07:50:14.687580+02:00 (for sommertid)) eller ved at benytte Z (2019-07-05T07:50:14.687580Z).





REST - DAR



Generelt

Sikkerhedszone

0 – Indeholder ikke fortrolige eller følsomme data 

Adgangsniveau

Fri adgang

Adgangsbegrænsning

Ingen adgangsbegrænsning

Anvendt udstillingsmodelDanmarks Adresseregister (DAR), Danmarks Administrative Grænser (DAGI), Matriklen (Matrikel) 
SLA

Se registrets tilgængelighed på Datafordeler.dk









Url opbygning for REST

Url for de enkelte services er opbygget af et endpoint efterfulgt af registernavn, servicenavn, versionen af servicen, servicetype (REST eller WFS etc.) samt metodenavn for services. Efter ”?” tilføjes parametre i kaldet, der kan indeholde generelle kaldeparametre for REST services og metodespecifikke parametre.   

Endpointet indeholder værtsnavnet, med et præfiks for miljøet hvis det ikke er produktionsmiljøet der tilgås.  Hvis der er tale om fortrolige eller følsomme data, følger S5 -  se miljøbeskrivelser.

Læs mere om sammensætning af url'er på siden REST på Datafordeleren eller se eksempler på, at parametre bliver tilføjet til url'er på Datafordeleren - eks. på anvendelse af bitemporalitet eller User stories.




Url-struktur for REST services <endpoint>/register/service/version/servicetype/metode?
Eksempel på url https://services.datafordeler.dk/DAR/DAR/1/rest/adresse?
Eksempel på url med certifikathttps://certservices.datafordeler.dk/DAR/DAR/1/rest/adresse?











Metodeoversigt

Metodenavn Kompleksitet Tværgående tjeneste 
adresse Kompleks Ja, også DAGI data 
adresseTilHusnummerSimpel Nej 
husnummer Kompleks Ja, også DAGI data 

husnummerTilAdresse 

Simpel Nej 
husnummerTilJordstykke Kompleks Ja, også Matrikel data 
navngivenvej Kompleks Nej 

navngivenvejKommunedel 

Kompleks Nej 
postnummer Kompleks Nej 
supplerendebynavn

Normal 

Nej 







Metode - adresse 


Beskrivelse

Metoden udstiller Adresse(r) og tilknytningerne til NavngivenVej, Husnummer og postnummer. Alle attributter for Husnummer udstilles inklusiv de tilknytninger det aktuelle Husnummer har samt tilknytninger og ikke geografiske data fra Danmarks Administrative Geografiske Inddelinger (DAGI) (SupplerendeBynavn, Postnummer, Afstemningsområde, Sogneinddeling, Kommuneinddeling og MRAfstemningsområde).















Inputparametre

Metoden returnerer objekter der matcher inputparametrene. Underliggende relaterede objekter for hovedobjektet har enten ID'er eller ID'er og fulde objekter med afhængig af hvad parameteren MedDybde er sat til. Hvis virknings- eller registreringstid ikke er sat, så findes data for dags dato. Hvis flere inputparametre gives, så returneres resultater der opfylder samtlige af de angivne parametre. 

Hvis MedDybde er TRUE (eller NULL) så udfyldes JSON objektet med alt data, også nestede objekter; det vil sige data fra hovedobjektet samt relaterede objekters data. Hvis MedDybde er FALSE så indeholder JSON kun data som findes i hovedobjektet samt ID’er for hovedobjektets relaterede data. Det betyder at nestede objekter med følgende struktur kun skal specificerer ”id” attributten, og ikke "[NAVN]", når MedDybde er FALSE. Default værdi for MedDybde er TRUE.

"type": "object", 

"properties": { 

"id": {…}, 

"[NAVN]": {…} 

NavnTypeBeskrivelseDefault værdiUUID fra udstillingsmodel
Id UUID

Identifikation af adresseelementet igennem hele dets livscyklus.

Anvender du Id som input returneres den specifikke adresse.

NULL 

EAID_D273E3D8_A3F4_41bc_AF9C_E67B4A29C008EAID_9AB90AE0_9F85_4164_9B25_8EB2139D65A5
StatusString

Adresseelementets status i den pågældende version, dvs. elementets tilstand i den samlede livscyklus.

Mulige værdier: 

  • 2 - foreløbige adresser
  • - gældende adresser
  • 4 - nedlagte adresser
  • 5 - henlagte adresser

Parameteren benytter du, hvis du kun ønsker en specifik status. Det er ikke muligt med parameteren at inkludere flere forskellige statusser.

Læs mere om status på: https://danmarksadresser.dk/adressedata/kodelister/livscyklus/

NULLEAID_22AF1E6A_73A8_4c89_96EB_C307235DFD19
Husnummer 

UUID 

Angiver det DAR husnummer (adgangsadresse), som adressen er tilknyttet.

Bruger du dette inputparameteren finder du alle adresser for det pågældende husnummer.

NULLEAID_src6919CB_1734_44ef_BE5B_C115B637B2CD
Bygning UUID 

BBR bygning er relateret til husnummer og ikke til adressen, der er derfor ikke bagvedliggende data for denne parameter, og anvendelsen af parameteren vil ikke give noget resultat.

NULLEAID_src4A2C09_8035_4ca8_8AA0_CBAAB89AF135
NavngivenVej UUID 

DAR NavngivenVej ID kan du anvende, hvis du ønsker alle adresser på en navngivenvej.

NULL

NavngivenVejKommunedel 

UUID 

DAR NavngivenVejKommunedel ID. 

Parameteren finder adresser inden for en specifik kommune og vejkode. Hvis den navngivne vej breder sig over flere kommuner kan denne finde adresserne for den enkelte kommunedel.

NULL
Kommunekode 

String 

Med kommunekode kan du finde alle adresser for en kommune.

Konkrete værdier kan findes via https://danmarksadresser.dk/adressedata/kodelister/kommunekodeliste/

Angives med 4 cifre (inkl. foranstillet 0)

NULL
Vejkode 

String 

Vejkoden er en firecifret kode (inklusiv evt. foranstillede nuller), der kan finde alle adresser for en vejkode. Vejkode er unik inden for en kommune. Benyttes derfor sammen med parameteren kommunekode.

NULL
Nord Double 

Nordlig koordinat afgrænsning.

Koordinater skal være i ETRS89 /UTM zone 32N formatet. 

Med anvendelsen af nord, syd, oest og vest parameterne kan du finde adresser inden for et område.

NULL
Syd Double 

Sydlig koordinat afgrænsning.

Koordinater skal være i ETRS89 /UTM zone 32N formatet. 

Med anvendelsen af nord, syd, oest og vest parameterne kan du finde adresser inden for et område.

NULL
Oest Double 

Østlig koordinat afgrænsning. 

Koordinater skal være i ETRS89 /UTM zone 32N formatet. 

Med anvendelsen af nord, syd, oest og vest parameterne kan du finde adresserinden for et område.

NULL
Vest Double 

Vestlig koordinat afgrænsning. 

Koordinater skal være i ETRS89 /UTM zone 32N formatet. 

Med anvendelsen af nord, syd, oest og vest parameterne kan du finde adresser inden for et område.

NULL
VirkningFra DateTime

Tidspunktet hvorfra den pågældende version af adresseelementet har virkning.

En nem måde at få hele virkningshistorikken er angive datoen 0001-01-01. Anvender du denne parameterværdi får du alle virkningsversioner af objektet.

NOW() 

EAID_AB768062_FD24_4960_8AA1_C6BFF90C00C5
VirkningTil DateTime

Tidspunktet hvor virkningen af den pågældende version af adresseelementet ophører.

Parameteren kan bruges i kombination med VirkningFra, hvis du skal finde virkningshistorikken for et bestemt tidsrum.

NOW() EAID_3058C5FD_9824_48ba_B62C_C24587BF6537
RegistreringFraDateTime 

Tidspunktet hvor registreringen af den pågældende version af adresseelementet er foretaget.

En nem måde at få hele registreringshistorikken er ved at angive datoen 0001-01-01.

NOW() EAID_96862BAA_95CA_46aa_A6A0_757327A10BF7
RegistreringTilDateTime

Tidspunktet hvor en ny registrering på adresseelementet er foretaget, og hvor denne version således ikke længere er den seneste. 

Parameteren kan bruges i kombination med RegistreringFra, hvis du ønsker at finde registreringshistorikken for et bestemt tidsrum.

NOW() EAID_301BF58F_26E7_4d1f_B7B6_3881F8C1B0A5
DAFTimestampFraDateTime

Fra Datafordeler opdateringstidspunkt.

Benytter du denne parameter returneres data, der er registreret i Datafordeleren efter den angivne dato.

NULL

DAFTimestampTil

DateTime 

Til Datafordeler opdateringstidspunkt.

Benytter du denne parameter returneres data, der er registreret i Datafordeleren før den angivne dato.

NULL
Virkningsaktoer 

String 

Den aktør der har afstedkommet virkningsegenskaberne for den pågældende version af adresseelementet f.eks.: AjourføreAdresserEnheder.

Mulige værdier: https://danmarksadresser.dk/adressedata/kodelister/virkningsaktoer/

NULL EAID_8E60197F_D857_47c6_8611_75B63D0940FD

Registreringsaktoer

String 

Den aktør der har foretaget registreringen af den pågældende version af adresseelementet.

Værdien vil altid være DAR. 

NULLEAID_9F724D2B_7763_4997_8C85_580610BABC1F
ForretningsprocesString 

Den forretningsproces, som afstedkom opdateringen af adresseelementet til den pågældende version f.eks.: 0.

Mulige værdier: https://danmarksadresser.dk/adressedata/kodelister/forretningsproces/

NULLEAID_A9A40479_E58D_4c7a_A0EA_F8EC4829ECAC

Forretningsomraade

String 

Det forretningsområde som har opdateret adresseelementet til den pågældende version f.eks.: 54.15.10.08.

Mulige værdier: https://danmarksadresser.dk/adressedata/kodelister/forretningsomraade/

NULLEAID_C955CFEC_E2A0_47da_9F76_6452FCC9E4E2
Forretningshaendelse

String 

Den forretningshændelse, som afstedkom opdateringen af adresseelementet til den pågældende version f.eks.: 2

Mulige værdier: https://danmarksadresser.dk/adressedata/kodelister/forretningshaendelse/

NULLEAID_1CE948DD_FC3D_4638_8913_A2D35A00F64D
MedDybdeBoolean Angiver om resultatet skal indeholde nested data fra joins eller kun ID'er. TRUE











Eksempler på brug af metoden 













Alle adresser for et geografisk område (eksemplet tæller antal aktuelle adresser på Christiansø. Ønsker du kun antal gældende adresser skal status=3 tilføjes):











Outputparametre

MetodeSkema
Den inkluderede fil ”DAR_2.3.4_Adresse.schema.json” indeholder output som JSON-schema  

Skema - filudtræk og webservices (DAR)








Metode - adresseTilHusnummer 


Beskrivelse

Metoden adresseTilHusnummer er en simpel metode, der returner Husnummerid, når adresseid bruges som input.












Inputparametre

Parameteret adresseId er obligatorisk.  

NavnTypeBeskrivelseDefault værdiUUID fra udstillingsmodel

adresseId 

string 

Identifikation af adresseelementet igennem hele dets livscyklus

NULL

EAID_D273E3D8_A3F4_41bc_AF9C_E67B4A29C008








Eksempel på brug af metoden 


Kaldet finder husnummeret 0a3f507a-e179-32b8-e044-0003ba298018, som adresseid 0a3f50a0-4664-32b8-e044-0003ba298018 tilhører:







Outputparametre

MetodeSkema
Den inkluderede fil ”DAR_2.3.4_AdresseTilHusnummer.schema.json” indeholder output som JSON-schema   

Skema - filudtræk og webservices (DAR)





Metode - Husnummer 


Beskrivelse

Metoden udstiller husnummer inklusiv Adgangspunkt (repræsenteret ved Husnummer), Vejpunkt (repræsenteret ved Husnummer) samt tilknytninger til NavngivenVej. NavngivenVej har tilknyttet en eller flere NavngivenVejKommunedel, som også udstiller med denne. 

Alle attributter for Husnummer udstilles inklusiv de tilknytninger det aktuelle Husnummer har samt tilknytninger og ikke geografiske data fra Danmarks Administrative Geografiske Inddelinger (DAGI) (SupplerendeBynavn, Postnummer, Afstemningsområde, Sogneinddeling, Kommuneinddeling og MRAfstemningsområde).





















Inputparametre

Metoden returnerer objekter der matcher inputparametrene. Underliggende relaterede objekter for hovedobjektet har enten ID'er eller ID'er og fulde objekter med afhængig af hvad parameteren MedDybde er sat til. Hvis virknings- og registreringstid ikke er sat, så findes data for dags dato. Hvis flere inputparametre gives, så returneres resultater der opfylder samtlige af de angivne parametre. 

Hvis MedDybde er TRUE (eller NULL) så udfyldes JSON objektet med alt data, også nestede objekter; det vil sige data fra hovedobjektet samt relaterede objekters data. Hvis MedDybde er FALSE så indeholder JSON kun data som findes i hovedobjektet samt ID’er for hovedobjektets relaterede data. Det betyder at nestede objekter med følgende struktur kun skal specificerer ”id” attributten, og ikke "[NAVN]", når MedDybde er FALSE. Meddybde sættes automatisk til TRUE, hvis parameteren ikke er anvendt.

"type": "object", 

"properties": { 

"id": {…}, 

"[NAVN]": {…} 

NavnTypeBeskrivelseDefault værdiUUID fra udstillingsmodel
Id UUID

Identifikation af adresseelementet igennem hele dets livscyklus.

Anvender du Id som input returneres det specifikke husnummer.

NULL 

EAID_D273E3D8_A3F4_41bc_AF9C_E67B4A29C008.EAID_9AB90AE0_9F85_4164_9B25_8EB2139D65A5
StatusString

Adresseelementets status i den pågældende version, dvs. elementets tilstand i den samlede livscyklus.

Mulige værdier: 

  • 2 - foreløbige husnumre
  • 3 - gældende husnumre
  • 4 - nedlagte husnumre
  • 5 - henlagte husnumre

Parameteren benytter du, hvis du kun ønsker en specifik status. Det er ikke muligt med parameteren at inkludere flere forskellige statusser.

Læs mere om status på: https://danmarksadresser.dk/adressedata/kodelister/livscyklus/

NULLEAID_22AF1E6A_73A8_4c89_96EB_C307235DFD19
AdgangTilBygning 

UUID 

Den BBR bygning som husnummeret identificerer adgangen til.

Anvender du inputparameteren returneres alle husnumre, der er tilknyttet BBRbygningen.

NULLEAID_dst3E4349_6115_4191_AF4F_243CCE561C41
GeoDanmarkBygning 

Integer 

GeoDK Bygning ID. 

Anvender du inputparameteren returneres alle husnumre, der er tilknyttet  GeoDanmarkbygningen.

NULL
AdgangTilTekniskAnlaeg UUID 

Det BBR tekniske anlæg som husnummeret angiver adgangsvejen til.

Anvender du inputparameteren returneres alle husnumre, der er tilknyttet dette BBR teknisk anlæg.

NULLEAID_dst79A4C1_23B2_4c0c_85CC_60C6E2EA5AE0
Jordstykke 

Integer 

MU Jordstykke ID.

Anvender du inputparameteren returneres alle husnumre, der er tilknyttet jordstykket.

NULL

Adresse 

UUID 

Angiver det husnummer som den specifikke adresseID er tilknyttet.

NULL
 NavngivenVej UUID 

Angiver alle aktuelle husnumre tilknyttet denne navngivenvej UUID.

NULLEAID_dst74C4B5_0F0F_4a51_B317_BA74938B605F
Vejkode String 

Vejkode. 4 cifre inkl foranstillede 0’er.

Anvender du parameteren vejkode, returneres alle husnumre beliggende på en vej med vejkoden, men da vejkoden alene er unik inden for en kommune, bør den bruges sammen med parameteren KommuneInddeling.

NULL
Vejmidte 

Integer 

Feltet består af kommunekode-vejkode, og kan anvendes, når du ønsker alle husnumre for en vejkode i en specifik kommune f.eks.: 0740-1781.

NULL
NavngivenVejKommunedel UUID 

DAR NavngivenVejKommunedel ID.

Parameteren finder husnumrene inden for en specifik kommune og vejkode. Hvis den navngivne vej breder sig over flere kommuner kan denne finde husnumrene for den enkelte kommunedel.

NULL
Postnr 

String 

Anvender du, hvis resultatet skal være alle husnumre inden for et postnummer. Værdien er det firecifrede postnummer, der anvendes i Danmark f.eks.: 8600.

NULL
Postnummer UUID 

DAR Postnummer ID.

Parameteren angiver alle husnumre inden for dette postnummerID f.eks.: 39cb998e-19a7-4479-a0df-17b8ac2a4330.

Den konkrete værdi finder du via metoden Postnummer.

NULL

Postnummerinddeling 

Integer 

DAGI Postnummerinddeling ID. 

Parameteren angiver alle husnumre inden for denne postnummerinddeling f.eks.: 198600.

Den konkrete værdi kan findes via metoden Postnummer.

NULL
SupplerendeBynavnDAR 

UUID 

DAR SupplerendeBynavn ID.

Anvender du, hvis du ønsker alle husnumre i et supplerende bynavn f.eks.: 568f3d96-b829-46f4-8e0c-a818afeb67e2.

De konkrete værdier finder du via metoden SupplerendeBynavn.

NULL
SupplerendeBynavnDAGI 

Integer 

DAGI SupplerendeBynavn ID.

Anvender du, hvis du ønsker alle husnumre i et supplerende bynavn f.eks.: 681990.

Den konkrete værdi kan findes via metoden SupplerendeBynavn.

NULL
Afstemningsomraade 

Integer 

DAGI Afstemningsområde ID.

Anvender du, hvis du ønsker alle husnumre for et afstemningsområde f.eks: 704742.

Den konkrete værdi kan findes via DAGI’s metode DAGI eller ved at slå et husnummer op på anden vis via Husnummermetoden.

NULL
Sogneinddeling 

Integer 

DAGI Sogneinddeling ID. 

Anvender du, hvis du ønsker alle husnumre for et sogn f.eks: 107308.

Den konkrete værdi kan du finde via DAGI’s metode DAGI eller ved at slå et husnummer op på anden vis via metoden Husnummer.

NULL
Kommuneinddeling 

Integer 

DAGI Kommuneinddeling ID. 

Anvender du, hvis du ønsker alle husnumre i en kommune f.eks: 389164.

Den konkrete værdi kan du finde via DAGI’s metode DAGI eller ved at slå et husnummer op på anden vis via metoden Husnummer. 

NULL

Menighedsraadsafstemningsomraade 

Integer 

DAGI Menighedsrådsafstemingsområde ID.

Anvender du, hvis du øsnker alle husnumre for et menighedsrådsafstemningsområde f.eks.: 576843.

Den konkrete værdi kan du finde via DAGI’s metode DAGI eller ved at slå et husnummer op på anden vis via metoden Husnummer.

NULL

Nord 

Double 

Nordlig koordinat afgrænsning. 

Koordinater skal være i ETRS89 /UTM zone 32N formatet. 

Med anvendelsen af nord, syd, oest og vest parameterne kan du finde husnumre inden for et område.

NULL
Syd Double 

Sydlig koordinat afgrænsning.

Koordinater skal være i ETRS89 /UTM zone 32N formatet. 

Med anvendelsen af nord, syd, oest og vest parameterne kan du finde husnumre inden for et område.

NULL

Oest 

Double 

Østlig koordinat afgrænsning.

Koordinater skal være i ETRS89 /UTM zone 32N formatet. 

Med anvendelsen af nord, syd, oest og vest parameterne kan du finde husnumre inden for et område.

NULL
Vest Double 

Vestlig koordinat afgrænsning.

Koordinater skal være i ETRS89 /UTM zone 32N formatet. 

Med anvendelsen af nord, syd, oest og vest parameterne kan du finde husnumre inden for et område.

NULL
VirkningFra DateTime

Tidspunktet hvorfra den pågældende version af adresseelementet har virkning.

En nem måde at få hele virkningshistorikken er angive datoen 0001-01-01. Anvender du denne parameterværdi får du alle virkningsversioner af objektet.

NOW() 

EAID_AB768062_FD24_4960_8AA1_C6BFF90C00C5
VirkningTil DateTime

Tidspunktet hvor virkningen af den pågældende version af adresseelementet ophører.

Parameteren kan bruges i kombination med VirkningFra, hvis du skal finde virkningshistorikken for et bestemt tidsrum.

NOW() EAID_3058C5FD_9824_48ba_B62C_C24587BF6537
RegistreringFraDateTime 

Tidspunktet hvor registreringen af den pågældende version af adresseelementet er foretaget.

En nem måde at få hele registreringshistorikken er ved at angive datoen 0001-01-01. 

NOW() EAID_96862BAA_95CA_46aa_A6A0_757327A10BF7
RegistreringTilDateTime

Tidspunktet hvor en ny registrering på adresseelementet er foretaget, og hvor denne version således ikke længere er den seneste. 

Parameteren kan bruges i kombination med RegistreringFra, hvis du skal finde virkningshistorikken for et bestemt tidsrum.

NOW() EAID_301BF58F_26E7_4d1f_B7B6_3881F8C1B0A5
DAFTimestampFraDateTime

Fra Datafordeler opdateringstidspunkt.

Benytter du denne parameter returneres data, der er registreret i Datafordeleren efter den angivne dato.

NULL

DAFTimestampTil

DateTime 

Til Datafordeler opdateringstidspunkt.

Benytter du denne parameter returneres data, der er registreret i Datafordeleren før den angivne dato.

NULL
Virkningsaktoer 

String 

Den aktør der har afstedkommet virkningsegenskaberne for den pågældende version af adresseelementet f.eks.: AjourføreDarSystem

Mulige værdier: https://danmarksadresser.dk/adressedata/kodelister/virkningsaktoer/

NULL EAID_8E60197F_D857_47c6_8611_75B63D0940FD

Registreringsaktoer

String 

Den aktør der har foretaget registreringen af den pågældende version af adresseelementet.

Værdien vil altid være DAR.

NULLEAID_9F724D2B_7763_4997_8C85_580610BABC1F
ForretningsprocesString 

Den forretningsproces, som afstedkom opdateringen af adresseelementet til den pågældende version f.eks.: 0.

Mulige værdier: https://danmarksadresser.dk/adressedata/kodelister/forretningsproces/

NULLEAID_A9A40479_E58D_4c7a_A0EA_F8EC4829ECAC

Forretningsomraade

String 

Det forretningsområde som har opdateret adresseelementet til den pågældende version f.eks.: 54.15.10.07.

Mulige værdier: https://danmarksadresser.dk/adressedata/kodelister/forretningsomraade/

NULLEAID_C955CFEC_E2A0_47da_9F76_6452FCC9E4E2
Forretningshaendelse

String 

Den forretningshændelse, som afstedkom opdateringen af adresseelementet til den pågældende version f.eks.: 3.

Mulige værdier: https://danmarksadresser.dk/adressedata/kodelister/forretningshaendelse/

NULLEAID_1CE948DD_FC3D_4638_8913_A2D35A00F64D
MedDybdeBoolean Angiver om resultatet skal indeholde nested data fra joins eller kun ID'er. TRUE











Eksempler på brug af metoden





Tre eksempler, der finder husnumre på den navngivenvej Tågerupvej, der er beliggende i Kolding og Haderslev Kommune. 






Alle husnumre tilknyttet Tågerupvej på den del af den navngivnevej der er beliggende i Kolding kommune:




Alle husnumre tilknyttet Tågerupvej, på den del af den navngivenvej med kommunekode=0621 og vejkode=0985:
















Alle husnumre inden for et supplerende bynavn ud fra DAGI (nøgle):









Outputparametre

MetodeSkema
Den inkluderede fil ”DAR_2.3.4_Husnummer.schema.json” indeholder output som JSON-schema  

Skema - filudtræk og webservices (DAR)









Metode - husnummerTilAdresse  



Beskrivelse

Metoden HusnummerTiladresse en simpel metode, der returner Adresseid, når Husnummerid bruges som input.


















Inputparametre

Parameteret husnummerId er obligatorisk.  

NavnTypeBeskrivelseDefault værdiUUID fra udstillingsmodel

husnummerId 

string 

DAR Husnummer ID 

NULL 

EAID_D273E3D8_A3F4_41bc_AF9C_E67B4A29C008











Eksempel på brug af metoden




Alle adresse’ider for husnummer 0a3f507a-e179-32b8-e044-0003ba298018 (Rentemestervej 8, 2400 København NV):









Outputparametre

MetodeSkema
Den inkluderede fil ”DAR_2.3.4_HusnummerTilAdresse.schema.json” indeholder output som JSON-schema   

Skema - filudtræk og webservices (DAR)





Metode - husnummerTilJordstykke 


Beskrivelse

Metoden HusnummerTilJordstykke en simpel metode, der returner jordstykkeid og jordstykkets BFE nummer, når Husnummerid bruges som input.

















Inputparametre

Parameteret husnummerId er obligatorisk. 

NavnTypeBeskrivelseDefault værdiUUID fra udstillingsmodel

husnummerId 

string 

DAR Husnummer ID 

NULL 

EAID_D273E3D8_A3F4_41bc_AF9C_E67B4A29C008








Eksempel på brug af metoden




Jordstykkeid og BFE nummer for husnummer 0a3f507a-e179-32b8-e044-0003ba298018 (Rentemestervej 8, 2400 København NV):







Outputparametre

MetodeSkema
Den inkluderede fil ”DAR_2.3.4_HusnummerTilJordstykke.schema.json” indeholder output som JSON-schema   

Skema - filudtræk og webservices (DAR)





Metode - Navngivenvej



Beskrivelse

Metoden Navngivenvej returnerer den navngivne vejs geografiske udbredelse i tagget vejnavnebeliggenhed_vejnavnelinje, tilknytning til kommune(r) med en eller flere forekomster af NavngivenVejKommunedel i segmentet NavngivenvejKommunedelList, tilknytningen til samtlige postnumre for den navngivne vej samt tilknytningen til supplerende bynavn(e), hvis dette findes.


















Inputparametre

Metoden returnerer objekter der matcher inputparametrene. Underliggende relaterede objekter for hovedobjektet har enten ID'er eller ID'er og fulde objekter med afhængig af hvad parameteren MedDybde er sat til. Hvis virknings- og registreringstid ikke er sat, så findes data for dags dato. Hvis flere inputparametre gives, så returneres resultater der opfylder samtlige af de angivne parametre. 

Hvis MedDybde er TRUE (eller NULL) så udfyldes JSON objektet med alt data, også nestede objekter; det vil sige data fra hovedobjektet samt relaterede objekters data. Hvis MedDybde er FALSE så indeholder JSON kun data som findes i hovedobjektet samt ID’er for hovedobjektets relaterede data. Det betyder at nestede objekter med følgende struktur kun skal specificerer ”id” attributten, og ikke "[NAVN]", når MedDybde er FALSE.  Meddybde sættes automatisk til TRUE, hvis parameteren ikke er anvendt.

"type": "object", 

"properties": { 

"id": {…}, 

"[NAVN]": {…} 

NavnTypeBeskrivelseDefault værdiUUID fra udstillingsmodel

Id 

UUID 

Identifikation af adresseelementet igennem hele dets livscyklus.

Anvender du Id returneres den aktuelle version af den specifikke navngivne vej 

NULL 

EAID_D273E3D8_A3F4_41bc_AF9C_E67B4A29C008.EAID_9AB90AE0_9F85_4164_9B25_8EB2139D65A5

Status 

String 

Adresseelementets status i den pågældende version, dvs. elementets tilstand i den samlede livscyklus.

Mulige værdier: 

  • 2 - foreløbige navngivne veje
  • 3 - gældende navngivne veje
  • 4 - nedlagte navngivne veje
  • 5 - henlagte navngivne veje

Parameteren benytter, hvis du ønsker en specifik status. Det er ikke muligt med parameteren at inkludere flere forskellige statusser.

Læs mere om status på: https://danmarksadresser.dk/adressedata/kodelister/livscyklus/

NULL 

EAID_22AF1E6A_73A8_4c89_96EB_C307235DFD19

Husnummer 

UUID 

DAR Husnummer ID kan du anvende, hvis du ønsker oplysninger om den navngivne vej for et konkret husnummer.

NULL 


Adresse 

UUID 

DAR Adresse ID kan du anvende, hvis du ønsker oplysninger om den navngivne vej for en konkret adresse.

NULL 


Kommunekode 

String 

Kommunekode angiver navngivneveje som berører den valgte kommune og navngivneveje hvor et tilknyttet husnummer er beliggende i den angiven kommune.

Konkrete værdier kan findes via https://danmarksadresser.dk/adressedata/kodelister/kommunekodeliste/

Angives med 4 cifre (inkl. foranstillet 0)

NULL 


Vejkode 

String 

Vejkoden er en firecifret kode (inkl. evt. foranstillede nuller), der kan finde de navngivenveje for en vejkode. Vejkode er unik inden for en kommune. Benyttes derfor sammen med parameteren kommunekode, hvis en specifik navngivenvej ønskes.

NULL 


SupplerendeBynavnDAR 

UUID 

DAR SupplerendeBynavn ID anvender du, hvis alle navngivne veje der berører et supplerende bynavn skal være resultatet f.eks.: d58f8e08-8c10-4bfa-9096-6d2eff1782dc. 

De konkrete værdier kan findes vha. metoden SupplerendeBynavn.

I enkelte tilfælde er der flere områder, der har det samme supplerende bynavn dog aldrig inden for samme kommune. Det anbefales derfor at inkludere kommunekode som parameter. Resultatet fra SupplerendeBynavn for f.eks. Kongstrup er tre UUID’er, inkluderes kommunekoden for den ønskede Kongstrup kan du via NavngivenVej metoden finde de  navngivneveje du ønsker.

NULL 


SupplerendeBynavnDAGI 

Integer 

DAGI SupplerendeBynavn ID anvender du, hvis alle navngivne veje der berører et supplerende bynavn skal være resultatet f.eks.: 679395.

De konkrete værdier kan findes vha. metoden SupplerendeBynavn.

I enkelte tilfælde er der flere områder, der har det samme supplerende bynavn dog aldrig inden for samme kommune. Det anbefales derfor at inkludere også kommunekode som parameter. Resultatet fra SupplerendeBynavn for f.eks. Kongstrup er tre UUId’er, inkluderes kommunekoden for den ønskede Kongstrup kan du via NavngivenVej metoden finde de  navngivneveje du ønsker.

NULL 


Postnummer 

UUID 

DAR Postnummer ID angiver alle navngivenveje der berører dette postnummer og navngivenveje, hvor de tilknyttede husnummer placeret i dette postnummer f.eks.: 39cb998e-19a7-4479-a0df-17b8ac2a4330.

Den konkrete værdi kan du finde via metoden Postnummer.

NULL 


Postnummerinddeling 

Integer 

DAGI Postnummerinddeling ID angiver alle navngivenveje, der berører dette postnummer og navngivenveje, hvor de tilknyttede husnummer placeret i dette postnummer. F.eks.: 198600

Den konkrete værdi kan du finde via metoden Postnummer.

NULL 


VirkningFra 

DateTime 

Tidspunktet hvorfra den pågældende version af adresseelementet har virkning.

En nem måde at få hele virkningshistorikken er angive datoen 0001-01-01. Anvender du denne parameterværdi får du alle virkningsversioner af objektet.

NOW() 

EAID_AB768062_FD24_4960_8AA1_C6BFF90C00C5

VirkningTil 

DateTime 

Tidspunktet hvor virkningen af den pågældende version af adresseelementet ophører.

Parameteren kan bruges i kombination med VirkningFra, hvis du skal finde virkningshistorikken for et bestemt tidsrum.

NOW() 

EAID_3058C5FD_9824_48ba_B62C_C24587BF6537

RegistreringFra 

DateTime 

Tidspunktet hvor registreringen af den pågældende version af adresseelementet er foretaget. 

En nem måde at få hele registreringhistorikken er ved at angive datoen 0001-01-01.

NOW() 

EAID_96862BAA_95CA_46aa_A6A0_757327A10BF7

RegistreringTil 

DateTime 

Tidspunktet hvor en ny registrering på adresseelementet er foretaget, og hvor denne version således ikke længere er den seneste. 

Parameteren kan bruges i kombination med RegistreringFra, hvis registreringshistorikken for et bestemt tidsrum skal findes 

NOW() 

EAID_301BF58F_26E7_4d1f_B7B6_3881F8C1B0A5

DAFTimestampFra 

DateTime 

Fra Datafordeler opdateringstidspunkt.

Benytter du denne parameter returneres data, der er registreret i Datafordeleren efter den angivne dato.

NULL 


DAFTimestampTil 

DateTime 

Til Datafordeler opdateringstidspunkt.

Benytter du denne parameter returneres data, der er registreret i Datafordeleren før den angivne dato.

NULL 


Virkningsaktoer 

String 

Den aktør der har afstedkommet virkningsegenskaberne for den pågældende version af adresseelementet f.eks.: AjourføreGeoDKTilknytning.

Mulige værdier: https://danmarksadresser.dk/adressedata/kodelister/virkningsaktoer/

NULL 

EAID_8E60197F_D857_47c6_8611_75B63D0940FD

Registreringsaktoer 

String 

Den aktør der har foretaget registreringen af den pågældende version af adresseelementet.

Værdien vil altid være DAR.

NULL 

EAID_9F724D2B_7763_4997_8C85_580610BABC1F

Forretningsproces 

String 

Den forretningsproces, som afstedkom opdateringen af adresseelementet til den pågældende version f.eks.: 0.

Mulige værdier: https://danmarksadresser.dk/adressedata/kodelister/forretningsproces/

NULL 

EAID_A9A40479_E58D_4c7a_A0EA_F8EC4829ECAC

Forretningsomraade 

String 

Det forretningsområde som har opdateret adresseelementet til den pågældende version f.eks.: 54.15.10.25.

Mulige værdier: https://danmarksadresser.dk/adressedata/kodelister/forretningsomraade/

NULL 

EAID_C955CFEC_E2A0_47da_9F76_6452FCC9E4E2

Forretningshaendelse 

String 

Den forretningshændelse, som afstedkom opdateringen af adresseelementet til den pågældende version f.eks.: 20.

Mulige værdier: https://danmarksadresser.dk/adressedata/kodelister/forretningshaendelse/

NULL 

EAID_1CE948DD_FC3D_4638_8913_A2D35A00F64D

MedDybde 

Boolean 

Angiver om resultatet skal indeholde nested data fra joins eller kun ID'er. 

TRUE 








Eksempler på brug af metoden



Navngivenvej ud fra kommunedelen (kommunekode, vejkode), her Vallensbæk kommunedel af Holbækmotorvejen:









Outputparametre

MetodeSkema
Den inkluderede fil ”DAR_2.3.4_NavngivenVej.schema.json” indeholder output som JSON-schema   

Skema - filudtræk og webservices (DAR)





Metode - NavngivenvejKommunedel


Beskrivelse

DAR tjenesten indeholder metoden Navngiven vej med kommunekoder og vejkoder.  












Inputparametre

Metoden returnerer objekter der matcher inputparametrene. Underliggende relaterede objekter for hovedobjektet har enten ID'er eller ID'er og fulde objekter med afhængig af hvad parameteren MedDybde er sat til. Hvis virknings- og registreringstid ikke er sat, så findes data for dags dato. Hvis flere inputparametre gives, så returneres resultater der opfylder samtlige af de angivne parametre. 

Hvis MedDybde er TRUE (eller NULL) så udfyldes JSON objektet med alt data, også nestede objekter; det vil sige data fra hovedobjektet samt relaterede objekters data. Hvis MedDybde er FALSE så indeholder JSON kun data som findes i hovedobjektet samt ID’er for hovedobjektets relaterede data. Det betyder at nestede objekter med følgende struktur kun skal specificerer ”id” attributten, og ikke "[NAVN]", når MedDybde er FALSE. Meddybde sættes automatisk til TRUE, hvis parameteren ikke er anvendt.

"type": "object", 

"properties": { 

"id": {…}, 

"[NAVN]": {…} 

Navn

Type

Beskrivelse

Default værdi

UUID fra udstillingsmodel

Id 

UUID 

Identifikation af adresseelementet igennem hele dets livscyklus.

Anvender du Id returneres den specifikke aktuelle navngivne vejkommunedel.

NULL 

EAID_D273E3D8_A3F4_41bc_AF9C_E67B4A29C008.EAID_9AB90AE0_9F85_4164_9B25_8EB2139D65A5

Status 

String 

Adresseelementets status i den pågældende version, dvs. elementets tilstand i den samlede livscyklus.

Statussen angiver hvorvidt relationen mellem den navngivnevej og kommunedelen (kommunekode, vejkode) er hhv. gældende eller nedlagt.

Mulige værdier: 

  • 3 - gældende relation

  • 4 - nedlagte relation

Det er ikke muligt at inkludere flere forskellige statusser. Læs mere om status på: https://danmarksadresser.dk/adressedata/kodelister/livscyklus/

NULL 

EAID_22AF1E6A_73A8_4c89_96EB_C307235DFD19

NavngivenVej 

UUID 

DAR NavngivenVej ID returnerer oplysninger for de navngivenvejKommunedele for en specifik navngivenvej.

NULL 


Vejkode 

String 

Vejkoden er en firecifret kode (inkl. evt. foranstillede nuller), der kan finde de navngivenvejkommunedele for en vejkode. Vejkode er unik inden for en kommune. Benyttes derfor sammen med parameteren kommunekode, hvis du ønsker en specifik navngivenvejkommunedel.

NULL 


Kommunekode 

String 

Med kommunekode kan du finde alle NavngivenvejKommunedel veje for en kommune.

Konkrete værdier kan findes via https://danmarksadresser.dk/adressedata/kodelister/kommunekodeliste/

Angives med 4 cifre (inkl. foranstillet 0)

NULL 


Husnummer 

UUID 

DAR Husnummer ID kan du anvende, hvis du ønsker NavngivenvejKommunedel for et specifikt husnummer.

NULL 


Adresse 

UUID 

DAR Adresse ID kan du anvende, hvis du ønsker NavngivenvejKommunedel for en specifikt adresse.

NULL 


SupplerendeBynavnDAR 

Integer 

DAR SupplerendeBynavn ID 

Anvender du, hvis du ønsker alle nanvgivnevejekommunedele der berører et supplerende bynavn f.eks.: f7d4fe8b-733c-49de-9b86-5a224fe4d98f

De konkrete værdier kan du finde vha. metoden SupplerendeBynavn.

NULL 


SupplerendeBynavnDAGI 

Integer 

DAGI SupplerendeBynavn ID anvender du, hvis du ønsker alle nanvgivnevejekommunedele, der berører et supplerende bynavn skal være resultatet. f.eks.: 674604.

De konkrete værdier kan du finde vha. metoden SupplerendeBynavn.

NULL 


Postnummer 

UUID 

DAR Postnummer ID angiver alle navngivenvejekommunedele der berører dette postnummer og navngivenveje med hvor de tilknyttede husnummer placeret i dette postnummer f.eks.: 39cb998e-19a7-4479-a0df-17b8ac2a4330.

Den konkrete værdi kan du finde via metoden Postnummer.

NULL 


Postnummerinddeling 

Integer 

DAGI Postnummerinddeling ID angiver alle navngivenveje der berører dette postnummer og navngivenveje med hvor de tilknyttede husnummer placeret i dette postnummer f.eks.: 198600.

Den konkrete værdi kan findes via metoden Postnummer.

NULL 


VirkningFra

DateTime 

Tidspunktet hvorfra den pågældende version af adresseelementet har virkning.

En nem måde at få hele virkningshistorikken er angive datoen 0001-01-01. Anvender du denne parameterværdi får du alle virkningsversioner af objektet.

NOW() 

EAID_AB768062_FD24_4960_8AA1_C6BFF90C00C5

VirkningTil 

DateTime 

Tidspunktet hvor virkningen af den pågældende version af adresseelementet ophører.

Parameteren kan bruges i kombination med VirkningFra, hvis du skal finde virkningshistorikken for et bestemt tidsrum.

NOW() 

EAID_3058C5FD_9824_48ba_B62C_C24587BF6537

RegistreringFra 

DateTime 

Tidspunktet hvor registreringen af den pågældende version af adresseelementet er foretaget.

Hvis outputtet både skal vise historisk og aktuelt data, kan VirkningFra eller RegistreringFra benyttes. De to parametre må ikke benyttes samtidigt.

En nem måde at få hele historikken er ved at angive datoen 0001-01-01. Hvis parameteren anvendes fås alle versioner af objektet.

NOW() 

EAID_96862BAA_95CA_46aa_A6A0_757327A10BF7

RegistreringTil 

DateTime 

Tidspunktet hvor en ny registrering på adresseelementet er foretaget, og hvor denne version således ikke længere er den seneste. 

Parameteren kan bruges i kombination med RegistreringFra, hvis du skal finde registreringshistorikken for et bestemt tidsrum.

NOW() 

EAID_301BF58F_26E7_4d1f_B7B6_3881F8C1B0A5

DAFTimestampFra 

DateTime 

Fra Datafordeler opdateringstidspunkt.

Benytter du denne parameter returneres data, der er registreret i Datafordeleren efter datoen.

NULL 


DAFTimestampTil 

DateTime 

Til Datafordeler opdateringstidspunkt.

Benytter du denne parameter returneres data, der er registreret i Datafordeleren før datoen.

NULL 


Virkningsaktoer 

String 

Den aktør der har afstedkommet virkningsegenskaberne for den pågældende version af adresseelementet f.eks.: AjourføreGeoDKTilknytning.

Mulige værdier: https://danmarksadresser.dk/adressedata/kodelister/virkningsaktoer/

NULL 

EAID_8E60197F_D857_47c6_8611_75B63D0940FD

Registreringsaktoer 

String 

Den aktør der har foretaget registreringen af den pågældende version af adresseelementet. 

Værdien vil altid være DAR.

NULL 

EAID_9F724D2B_7763_4997_8C85_580610BABC1F

Forretningsproces 

String 

Den forretningsproces, som afstedkom opdateringen af adresseelementet til den pågældende version f.eks.: 0.

Mulige værdier: https://danmarksadresser.dk/adressedata/kodelister/forretningsproces/

NULL 

EAID_A9A40479_E58D_4c7a_A0EA_F8EC4829ECAC

Forretningsomraade 

String 

Det forretningsområde som har opdateret adresseelementet til den pågældende version f.eks.: 54.15.10.06.

Mulige værdier: https://danmarksadresser.dk/adressedata/kodelister/forretningsomraade/

NULL 

EAID_C955CFEC_E2A0_47da_9F76_6452FCC9E4E2

Forretningshaendelse 

String 

Den forretningshændelse, som afstedkom opdateringen af adresseelementet til den pågældende version f.eks.: 20.

Mulige værdier: https://danmarksadresser.dk/adressedata/kodelister/forretningshaendelse/

NULL 

EAID_1CE948DD_FC3D_4638_8913_A2D35A00F64D

MedDybde 

Boolean 

Angiver om resultatet skal indeholde nested data fra joins eller kun ID'er. 

TRUE 











Eksempler på brug af metoden



Alle navngivenvejkommunedel for det supplerende bynavn Nygård i Helsingør kommune:



















Outputparametre

MetodeSkema
Den inkluderede fil ”DAR_2.3.4_NavngivenVejKommunedel.schema.json” indeholder output som JSON-schema 

Skema - filudtræk og webservices (DAR)








Metode - Postnummer 


Beskrivelse

Metoden postnummer kan med en af inputparametrene finde postnummer UUID’en eller DAGI’s seks cifrede værdi for et postnummer. Disse værdier kan benyttes som inputparametre i metoderne husnummer, adresse, navngivenvej og navngivenvejkommunedel.













Inputparametre

Metoden returnerer objekter der matcher inputparametrene. Hvis virknings- og registreringstid ikke er sat, så findes data for dags dato. Hvis flere inputparametre gives, så returneres resultater der opfylder samtlige af de angivne parametre. 

NavnTypeBeskrivelseDefault værdiUUID fra udstillingsmodel

Id 

UUID 

Identifikation af adresseelementet igennem hele dets livscyklus.

Anvender du Id returneres den specifikke aktuelle postnummer.

NULL 

EAID_D273E3D8_A3F4_41bc_AF9C_E67B4A29C008

Status 

String 

Adresseelementets status i den pågældende version, dvs. elementets tilstand i den samlede livscyklus.

Statussen angiver hvorvidt postnummeret er hhv. gældende eller nedlagt.

Mulige værdier: 

  • 3 - gældende postnummer
  • 4 - nedlagte postnummer

Læs mere om status på: https://danmarksadresser.dk/adressedata/kodelister/livscyklus/

NULL 

EAID_22AF1E6A_73A8_4c89_96EB_C307235DFD19

Postnummerinddeling 

UUID 

DAGI Postnummerinddeling ID 

NULL 


Postnr 

String 

Værdien er det firecifrede postnummer, der anvendes i Danmark f.eks 8000.

NULL 


Navn 

String 

Postnummer navn, der er tilknyttet et postnummer kan benyttes som input. Outputtet er alle de postnumre, der er tilknyttet dette postnummernavnnavnet. Bemærk at parameteren er case-sensitiv f.eks Aarhus C.

NULL 


VirkningFra 

DateTime 

Tidspunktet hvorfra den pågældende version af adresseelementet har virkning.

En nem måde at få hele virkningshistorikken er ved at angive datoen 0001-01-01. Anvender du denne parameterværdi får du alle virkningsversioner af objektet.

NOW() 

EAID_AB768062_FD24_4960_8AA1_C6BFF90C00C5

VirkningTil 

DateTime 

Tidspunktet hvor virkningen af den pågældende version af adresseelementet ophører.

Parameteren kan bruges i kombination med VirkningFra, hvis du skal finde virkningshistorikken for et bestemt tidsrum.

NOW() 

EAID_3058C5FD_9824_48ba_B62C_C24587BF6537

RegistreringFra 

DateTime 

Tidspunktet hvor registreringen af den pågældende version af adresseelementet er foretaget.

En nem måde at få hele registreringshistorikken er ved at angive datoen 0001-01-01. 

NOW() 

EAID_96862BAA_95CA_46aa_A6A0_757327A10BF7

RegistreringTil 

DateTime 

Tidspunktet hvor en ny registrering på adresseelementet er foretaget, og hvor denne version således ikke længere er den seneste. 

Parameteren kan bruges i kombination med RegistreringFra, hvis registreringshistorikken for et bestemt tidsrum skal findes.

NOW() 

EAID_301BF58F_26E7_4d1f_B7B6_3881F8C1B0A5

DAFTimestampFra 

DateTime 

Fra Datafordeler opdateringstidspunkt.

Benytter du denne parameter returneres data, der er registreret i Datafordeleren efter datoen.

NULL 


DAFTimestampTil 

DateTime 

Til Datafordeler opdateringstidspunkt.

Benytter du denne parameter returneres data, der er registreret i Datafordeleren før datoen.

NULL 


Virkningsaktoer 

String 

Den aktør der har afstedkommet virkningsegenskaberne for den pågældende version af adresseelementet f.eks.: AjourføreDagiTilknytning.

De fleste postnummer har virkningsaktør= Konvertering2017

Mulige værdier: https://danmarksadresser.dk/adressedata/kodelister/virkningsaktoer/

NULL 

EAID_8E60197F_D857_47c6_8611_75B63D0940FD

Registreringsaktoer 

String 

Den aktør der har foretaget registreringen af den pågældende version af adresseelementet.

Alle postnumre vil have værdien DAR.

NULL 

EAID_9F724D2B_7763_4997_8C85_580610BABC1F

Forretningsproces 

String 

Den forretningsproces, som afstedkom opdateringen af adresseelementet til den pågældende version f.eks.: 0.

Mulige værdier: https://danmarksadresser.dk/adressedata/kodelister/forretningsproces/

NULL 

EAID_A9A40479_E58D_4c7a_A0EA_F8EC4829ECAC

Forretningsomraade 

String 

Det forretningsområde som har opdateret adresseelementet til den pågældende version f.eks.: 54.15.10.25.

Mulige værdier: https://danmarksadresser.dk/adressedata/kodelister/forretningsomraade/

NULL 

EAID_C955CFEC_E2A0_47da_9F76_6452FCC9E4E2

Forretningshaendelse 

String 

Den forretningshændelse, som afstedkom opdateringen af adresseelementet til den pågældende version f.eks.: 4.

Mulige værdier: https://danmarksadresser.dk/adressedata/kodelister/forretningshaendelse/

NULL 

EAID_1CE948DD_FC3D_4638_8913_A2D35A00F64D











Eksempler på brug af metoden





Postnumre for et postnummer navn (postdistrikt) her ”København K”:











Outputparametre

MetodeSkema
Den inkluderede fil ”DAR_2.3.4_Postnummer.schema.json” indeholder output som JSON-schema   

Skema - filudtræk og webservices (DAR)








Metode - Supplerendebynavn


Beskrivelse

Metoden Supplerendebynavn kan med en af inputparametrene finde Supplerendebynavn UUID’en eller DAGI’s seks cifrede værdi for et Supplerendebynavn. Disse værdier kan benyttes som inputparametre i metoderne husnummer, adresse, navngivenvej og navngivenvejkommunedel.













Inputparametre

Metoden returnerer objekter der matcher inputparametrene. Hvis virknings- og registreringstid ikke er sat, så findes data for dags dato. Hvis flere inputparametre gives, så returneres resultater der opfylder samtlige af de angivne parametre. 

NavnTypeBeskrivelseDefault værdiUUID fra udstillingsmodel

Id 

UUID 

Identifikation af adresseelementet igennem hele dets livscyklus.

Anvender du Id returneres den specifikke aktuelle supplerendeBynavn.

NULL 

EAID_D273E3D8_A3F4_41bc_AF9C_E67B4A29C008.EAID_9AB90AE0_9F85_4164_9B25_8EB2139D65A5

Status 

String 

Adresseelementets status i den pågældende version, dvs. elementets tilstand i den samlede livscyklus.

Statussen angiver hvorvidt supplerendeBynavn er hhv. gældende eller nedlagt.

Mulige værdier: 

  • 3 - gældende supplerende bynavn 
  • 4 - nedlagte supplerende bynavn 

Læs mere om status på: https://danmarksadresser.dk/adressedata/kodelister/livscyklus/

NULL 

EAID_22AF1E6A_73A8_4c89_96EB_C307235DFD19

SupplerendeBynavnDAGI 

Integer 

DAGI SupplerendeBynavn ID f.eks 667150.

NULL 


Navn 

String 

SupplerendeBynavn navn.

Parameteren navn er casesensitiv, dvs. kongstrup giver ikke samme resultat Kongstrup.

Metoden returnerer ikke kommunekode. Det bør man særligt være opmærksom på i de tilfælde, hvor der er mere end et sted med det samme supplerende bynavn.

NULL 


VirkningFra 

DateTime 

Tidspunktet hvorfra den pågældende version af adresseelementet har virkning.

En nem måde at få hele virkningshistorikken er ved at angive datoen 0001-01-01. Anvender du denne parameterværdi får du alle virkningsversioner af objektet.

NOW() 

EAID_AB768062_FD24_4960_8AA1_C6BFF90C00C5

VirkningTil 

DateTime 

Tidspunktet hvor virkningen af den pågældende version af adresseelementet ophører.

Parameteren kan bruges i kombination med VirkningFra, hvis du skal finde virkningshistorikken for et bestemt tidsrum.

NOW() 

EAID_3058C5FD_9824_48ba_B62C_C24587BF6537

RegistreringFra 

DateTime 

Tidspunktet hvor registreringen af den pågældende version af adresseelementet er foretaget.

En nem måde at få hele registreringshistorikken er ved at angive datoen 0001-01-01. Anvender du denne parameterværdi får du alle registreringsversioner af objektet.

NOW() 

EAID_96862BAA_95CA_46aa_A6A0_757327A10BF7

RegistreringTil 

DateTime 

Tidspunktet hvor en ny registrering på adresseelementet er foretaget, og hvor denne version således ikke længere er den seneste. 

Parameteren kan bruges i kombination med RegistreringFra, hvis du skal finde registreringshistorikken for et bestemt tidsrum.

NOW() 

EAID_301BF58F_26E7_4d1f_B7B6_3881F8C1B0A5

DAFTimestampFra 

DateTime 

Fra Datafordeler opdateringstidspunkt 

Fra Datafordeler opdateringstidspunkt 

Benytter du denne parameter returneres data, der er registreret i Datafordeleren efter datoen.

NULL 


DAFTimestampTil 

DateTime 

Til Datafordeler opdateringstidspunkt

Benytter du denne parameter returneres data, der er registreret i Datafordeleren før datoen.

NULL 


Virkningsaktoer 

String 

Den aktør der har afstedkommet virkningsegenskaberne for den pågældende version af adresseelementet f.eks.: AjourføreDagiTilknytning.

De fleste supplerendeBynavn har virkningsaktør= Konvertering2017

Mulige værdier: https://danmarksadresser.dk/adressedata/kodelister/virkningsaktoer/ 

NULL 

EAID_8E60197F_D857_47c6_8611_75B63D0940FD

Registreringsaktoer 

String 

Den aktør der har foretaget registreringen af den pågældende version af adresseelementet.

Værdien vil altid være DAR. 

NULL 

EAID_9F724D2B_7763_4997_8C85_580610BABC1F

Forretningsproces 

String 

Den forretningsproces, som afstedkom opdateringen af adresseelementet til den pågældende version f.eks.: 0.

Mulige værdier: https://danmarksadresser.dk/adressedata/kodelister/forretningsproces/

NULL 

EAID_A9A40479_E58D_4c7a_A0EA_F8EC4829ECAC

Forretningsomraade 

String 

Det forretningsområde som har opdateret adresseelementet til den pågældende version f.eks.: 54.15.10.25.

Mulige værdier: https://danmarksadresser.dk/adressedata/kodelister/forretningsomraade/

NULL 

EAID_C955CFEC_E2A0_47da_9F76_6452FCC9E4E2

Forretningshaendelse 

String 

Den forretningshændelse, som afstedkom opdateringen af adresseelementet til den pågældende version f.eks.: 15.

Mulige værdier: https://danmarksadresser.dk/adressedata/kodelister/forretningshaendelse/

NULL 

EAID_1CE948DD_FC3D_4638_8913_A2D35A00F64D











Eksempler på brug af metoden





SupplerendeBynavn, hvor det supplerendeBynavn’s navn er Kongstrup:











Outputparametre

MetodeSkema
Den inkluderede fil ”DAR_2.3.4_SupplerendeBynavn.schema.json” indeholder output som JSON-schema   

Skema - filudtræk og webservices (DAR)








REST - DAR_BFE_Public



Beskrivelse

Metoden adresseTilEnhedBfe anvendes når man ved hjælp af en adresse vil finde BFE-nummeret for en eventuel ejerlejlighed som er knyttet adressen i BBR. Er der ikke knyttet en ejerlejlighed til adressen returneres intet svar - i så fald kan metoden husnummerTilBygningBfe eventuelt anvendes.

Metoden husnummerTilBygningBfe anvendes når man ved hjælp af et husnummer som er knyttet til en bygning, ønsker at finde BFE-nummeret for den ejendom som bygningen i følge BBR indgår i. Indgår bygningen i en bygning på fremmed grund returneres både BFE-nummer for denne og for den samlede faste ejendom som bygningen ligger på. Er husnummeret ikke knyttet til en bygning (fx. en ubebygget grund) returneres intet svar.

Metoden husnummerTilTekniskanlægBfe anvendes på samme måde som husnummerTilBygningBfe for husnumre som er knyttet til et teknisk anlæg i BBR.

Hvis man ønsker at finde BFE-nummeret for en adresse eller et husnummer som ikke er knyttet til en bygning eller et tekniske anlæg - fx. adresser til ubebyggede grunde, kan DAR BFE metoderne ikke benyttes. I stedet kan man med jordstykke ID som input benytte Matriklens metode Samletfastejendom til at finde BFE nr. for ubebyggede grunde. Jordstykke ID findes vha. metoden Husnummer.









Generelt

Sikkerhedszone

0 – Indeholder ikke fortrolige eller følsomme data

Adgangsniveau

Kendt bruger 

Adgangsbegrænsning

Ingen adgangsbegrænsning

Anvendt udstillingsmodelDanmarks Adresseregister (DAR), Danmarks Administrative Grænser (DAGI), Matriklen (Matrikel) 
SLA

Se registrets tilgængelighed på Datafordeler.dk










Url opbygning for REST

Url for de enkelte services er opbygget af et endpoint efterfulgt af registernavn, servicenavn, versionen af servicen, servicetype (REST eller WFS etc.) samt metodenavn for services. Efter ”?” tilføjes parametre i kaldet, der kan indeholde generelle kaldeparametre for REST services og metodespecifikke parametre.   

Endpointet indeholder værtsnavnet, med et præfiks for miljøet hvis det ikke er produktionsmiljøet der tilgås.  Hvis der er tale om fortrolige eller følsomme data, følger S5 -  se miljøbeskrivelser.



Url-struktur for REST services <endpoint>/register/service/version/servicetype/metode?
Eksempel på url med brugernavn/adgangskodehttps://services.datafordeler.dk/DAR/DAR_BFE_Public/1/rest/adresseTilEnhedBfe?username=xxx&password=yyy&adresseId=xxxyxyxx-yyxx-xxxx-xxyy-yxxxyxyyxxyy 
Eksempel på url med certifikathttps://certservices.datafordeler.dk/DAR/DAR_BFE_Public/1/rest/adresseTilEnhedBfe?adresseId=xxxyxyxx-yyxx-xxxx-xxyy-yxxxyxyyxxyy











Metodeoversigt

Metodenavn Kompleksitet Tværgående tjeneste 
adresseTilEnhedBfeKompleks 

Ja, også BBR

husnummerTilBygningBfe

Kompleks Ja, også BBR og Matrikel
husnummerTilTekniskAnlægBfeKompleks Ja, også BBR og Matrikel





Metode - adresseTilEnhedBfe


Beskrivelse

Metoden adresseTilEnhedBfe anvendes når man ved hjælp af en adresse vil finde BFE-nummeret for en eventuel ejerlejlighed som er knyttet adressen i BBR. Er der ikke knyttet en ejerlejlighed til adressen returneres intet svar - i så fald kan metoden husnummerTilBygningBfe eventuelt anvendes.













Inputparametre

Parameteret adresseid er obligatorisk.

NavnTypeBeskrivelseDefault værdiUUID fra udstillingsmodel

adresseId 

string 

Identifikation af adresseelementet igennem hele dets livscyklus 

NULL

EAID_D273E3D8_A3F4_41bc_AF9C_E67B4A29C008











Outputparametre

MetodeSkema

Den inkluderede fil ”DAR_2.3.4_AdresseTilEnhedBfe.schema.json” indeholder output som JSON-schema. 

Skema - filudtræk og webservices (DAR)





Metode - husnummerTilBygningBfe


Beskrivelse

Metoden returnerer Samletfastejendom (BFE nummer) og jordstykkeid.

Metoden anvendes når man ved hjælp af et husnummer som er knyttet til en bygning, ønsker at finde BFE-nummeret for den ejendom som bygningen i følge BBR indgår i.

Indgår bygningen i en bygning på fremmed grund returneres både BFE-nummer for denne og for den samlede faste ejendom som bygningen ligger på. Er husnummeret ikke knyttet til en bygning (fx. en ubebygget grund) returneres intet svar.












Inputparametre

Parameteret husnummerId er obligatorisk.

NavnTypeBeskrivelseDefault værdiUUID fra udstillingsmodel

husnummerId 

string 

DAR Husnummer ID 

NULL 

EAID_D273E3D8_A3F4_41bc_AF9C_E67B4A29C008








Eksempler på brug af metoden



I det sidste tilfælde returneres også indhold i bygningPaaFremmedGrundList.







Outputparametre

MetodeSkema

Den inkluderede fil ”DAR_2.3.4_HusnummerTilBygningTekniskAnlægBfe.schema.json” indeholder output som JSON-schema   

Skema - filudtræk og webservices (DAR)





Metode - husnummerTilTekniskAnlægBfe


Beskrivelse

Metoden returnerer Samletfastejendom (BFE nummer) og jordstykkeid.

Metoden anvendes når man ved hjælp af et husnummer, som er knyttet til et teknisk anlæg, ønsker at finde BFE-nummeret for det tekniske anlæg.













Inputparametre

Parameteret husnummerId er obligatorisk.

NavnTypeBeskrivelseDefault værdiUUID fra udstillingsmodel

husnummerId 

string 

DAR Husnummer ID 

NULL 

EAID_D273E3D8_A3F4_41bc_AF9C_E67B4A29C008








Eksempel på brug af metoden



BFE nummer og jordstykke id for det tekniske anlæg med husnummerid = f353faca-4d79-4798-9af3-69f289582083 (Logistikvej 3, 7400 Herning):








Outputparametre

MetodeSkema
Den inkluderede fil ”DAR_2.3.4_HusnummerTilBygningTekniskAnlægBfe.schema.json” indeholder output som JSON-schema   

Skema - filudtræk og webservices (DAR)