Anchor | ||||
---|---|---|---|---|
|
Table of Contents |
---|
Table of Contents |
---|
Info |
---|
Ny version af REST-tjenesten DAR Den 24. april 2024 kan du kalde en ny version af REST-tjenesten DAR. Samtidigt kan alle REST-metoder kaldes i version 3.0.0. Læs mere på Datafordelerens ændringsmeddelelser. Ændringen omfatter ikke DAR BFE og de dertilhørende metoder. |
Eksempel på url
https://services.datafordeler.dk/DAR/DAR/3.0. |
0/rest/adresse? |
Eksempel på url med certifikat
https://certservices.datafordeler.dk |
Url
<endpoint>/DAR/DAR/ |
3.0.0/rest/adresse? |
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]": {…}
}
Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
---|---|---|---|---|
Id | UUID (liste) | Identifikation af adresseelementet igennem hele dets |
livscyklus. Anvender du Id som input returneres den specifikke adresse. Brug | som separator, hvis mere end et Id ønskes som parameter. | NULL | EAID_D273E3D8_A3F4_41bc_AF9C_ |
E67B4A29C008EAID_9AB90AE0_9F85_4164_9B25_8EB2139D65A5 |
Status |
String | Adresseelementets status i den pågældende version |
NOW()
String
Registreringsaktoer
Forretningsomraade
Det forretningsområde som har opdateret adresseelementet til den pågældende version
String
DAFTimestampTil
UUID
, dvs. elementets tilstand i den samlede livscyklus. Mulige værdier:
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/ | NULL | EAID_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. | NULL | EAID_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. | NULL | EAID_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. Kun gældende relationer (status = 3) vil returnere data. | 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. | NULL | 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 du ønsker at finde registreringshistorikken for et bestemt tidsrum. | NULL | 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ø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. | 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.08. 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.: 2 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 |
Beskrivelse
Metoden adresseTilHusnummer er en simpel metode, der returner Husnummerid, når adresseid bruges som input.
Eksempel på url
https://services.datafordeler.dk/DAR/DAR/3.0.0/rest/adresseTilHusnummer?adresseId=xxxyxyxx-yyxx-xxxx-xxyy-yxxxyxyyxxyy |
Eksempel på url med certifikat
https://certservices.datafordeler.dk/DAR/DAR/3.0.0/rest/adresseTilHusnummer?adresseId=xxxyxyxx-yyxx-xxxx-xxyy-yxxxyxyyxxyy |
Inputparametre
Parameteret adresseId er obligatorisk.
Navn | Type | Beskrivelse | Default værdi | UUID 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:
https://services.datafordeler.dk/DAR/DAR/3.0.0/rest/adressetilhusnummer?&adresseid=0a3f50a0-4664-32b8-e044-0003ba298018&format=json |
Outputparametre
Metode | Skema |
---|---|
Den inkluderede fil ”DAR_2.3.4_AdresseTilHusnummer.schema.json” indeholder output som JSON-schema |
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 (liste) | Identifikation af adresseelementet igennem hele dets livscyklus. Anvender du Id som input returneres det specifikke husnummer. Brug | som separator, hvis mere end et Id ønskes som parameter. | 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:
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/ | NULL | EAID_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. | NULL | EAID_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. | NULL | EAID_dst79A4C1_23B2_4c0c_85CC_60C6E2EA5AE0 |
Jordstykke | Integer | MU Jordstykke ID. Anvender du inputparameteren returneres alle husnumre, der er tilknyttet jordstykket. | NULL | |
ForeloebigtJordstykke | Integer | MU foreløbig jordstykke ID. Anvender du inputparameteren returneres alle husnumre, der er tilknyttet det foreløbige jordstykke. | NULL | |
Adresse | UUID | Angiver det husnummer som den specifikke adresseID er tilknyttet. | NULL | |
NavngivenVej | UUID | Angiver alle aktuelle husnumre tilknyttet denne navngivenvej UUID. | NULL | EAID_dst74C4B5_0F0F_4a51_B317_BA74938B605F |
Kommunekode | String | Med kommunekode kan du finde alle husnumre 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 | 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. Kun gældende relationer (status = 3) vil returnere data. | 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. | NULL | 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 du skal finde virkningshistorikken for et bestemt tidsrum. | NULL | 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ø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. | 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.07. 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.: 3. 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 |
Inputparametre
Parameteret husnummerId er obligatorisk.
Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
---|---|---|---|---|
husnummerId | string | DAR Husnummer ID | NULL | EAID_D273E3D8_A3F4_41bc_AF9C_E67B4A29C008 |
Outputparametre
Metode | Skema |
---|---|
Den inkluderede fil ”DAR_2.3.4_HusnummerTilAdresse.schema.json” indeholder output som JSON-schema |
Inputparametre
Parameteret husnummerId er obligatorisk.
Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
---|---|---|---|---|
husnummerId | string | DAR Husnummer ID | NULL | EAID_D273E3D8_A3F4_41bc_AF9C_E67B4A29C008 |
Jordstykkeid og BFE nummer for husnummer 0a3f507a-e179-32b8-e044-0003ba298018 (Rentemestervej 8, 2400 København NV):
https://services.datafordeler.dk/DAR/DAR/3.0.0/rest/husnummertiljordstykke?husnummerid=0a3f507a-e179-32b8-e044-0003ba298018&format=json |
Outputparametre
Metode | Skema |
---|---|
Den inkluderede fil ”DAR_2.3.9_HusnummerTilJordstykke.schema.json” indeholder output som JSON-schema |
Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
---|---|---|---|---|
Id | UUID (liste) | Identifikation af adresseelementet igennem hele dets livscyklus. Anvender du Id returneres den aktuelle version af den specifikke navngivne vej. Brug | som separator, hvis mere end et Id ønskes som parameter. | 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:
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. Kun gældende relationer (status = 3) vil returnere data. | 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. Kun gældende relationer (status = 3) vil returnere data. | 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. Kun gældende relationer (status = 3) vil returnere data. | 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. Kun gældende relationer (status = 3) vil returnere data. | 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. | NULL | 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 | NULL | 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 |
En specifik navngiven vej (Holbækmotorvejen):
https://services.datafordeler.dk/DAR/DAR/3.0.0/rest/navngivenvej?format=json&id=c0f08a1a-b9a4-465b-8372-d12babe7fbd6 |
Navngivenvej ud fra kommunedelen (kommunekode, vejkode), her Vallensbæk kommunedel af Holbækmotorvejen:
https://services.datafordeler.dk/DAR/DAR/3.0.0/rest/navngivenvej?kommunekode=0187&vejkode=2300&format=json |
Antallet af aktuelle navngivne veje i et supplerende bynavn (Venø):
https://services.datafordeler.dk/DAR/DAR/3.0.0/rest/navngivenvej?SupplerendeBynavnDAR=627f9ed8-e42a-44e8-b869-0a1f64e695b6&format=json&count=true |
https://services.datafordeler.dk/DAR/DAR/3.0.0/rest/navngivenvej?SupplerendeBynavnDAGI=690110&format=json&count=true |
Alle navngivne aktuelle veje for postnummeret 1218:
https://services.datafordeler.dk/DAR/DAR/3.0.0/rest/navngivenvej?Postnummer=9cc9db44-5599-4f4e-bebe-1e2ad684052a&format=json |
https://services.datafordeler.dk/DAR/DAR/3.0.0/rest/navngivenvej?Postnummerinddeling=191218&format=json |
Outputparametre
Metode | Skema |
---|---|
Den inkluderede fil ”DAR_2.3.4_NavngivenVej.schema.json” indeholder output som JSON-schema |
Beskrivelse
DAR tjenesten indeholder metodenNavgivenvejKommunedel som er kommunekoder og vejkoder for den navngivne vej.
Eksempel på url
https://services.datafordeler.dk/DAR/DAR/3.0.0/rest/navngivenvejkommunedel? |
Eksempel på url med certifikat
https://certservices.datafordeler.dk/DAR/DAR/3.0.0/rest/navngivenvejkommunedel? |
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:
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. Kun gældende relationer (status = 3) vil returnere data. | NULL | |
Adresse | UUID | DAR Adresse ID kan du anvende, hvis du ønsker NavngivenvejKommunedel for en specifikt adresse. Kun gældende relationer (status = 3) vil returnere data. | 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. | NULL | 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. | NULL | 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 |
Eksempel på url
https://services.datafordeler.dk/DAR/DAR/3.0.0/rest/postnummer? |
Eksempel på url med certifikat
https://certservices.datafordeler.dk/DAR/DAR/3.0.0/rest/postnummer? |
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
NavngivenVejKommunedel
DAR NavngivenVejKommunedel ID
String
String
Outputparametre
Metode - adresseTilHusnummere
Url
<endpoint>/DAR/DAR/1/rest/adresseTilHusnummer?
Inputparametre
Parameteret adresseId er obligatorisk.
adresseId
string
DAR Husnummer ID
NULL
Outputparametre
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.
Url
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.
"type": "object",
"properties": {
"id": {…},
"[NAVN]": {…}
}
NULL
NOW()
String
Registreringsaktoer
Forretningsomraade
Det forretningsområde som har opdateret adresseelementet til den pågældende version
String
DAFTimestampTil
UUID
Det BBR tekniske anlæg som husnummeret angiver adgangsvejen til
Angiver den DAR navngivne vej som husnummeret er knyttet til
Adresse
Angiver de DAR adresser, der anvender husnummeret
String
Integer
UUID
Integer
DAR Postnummer ID
Postnummerinddeling
Integer
DAGI Afstemningsområde ID
Integer
Integer
DAGI Kommuneinddeling ID
Menighedsraadsafstemningsomraade
Integer
Integer
Integer
Nord
Oest
Outputparametre
Metode - husnummerTilAdresse
Url
Inputparametre
Parameteret husnummerId er obligatorisk.
husnummerId
string
DAR Husnummer ID
NULL
Outputparametre
Metode - husnummerTilJordstykke
Url
Inputparametre
Parameteret husnummerId er obligatorisk.
Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
---|---|---|---|---|
Id |
husnummerId
string
UUID | Identifikation af adresseelementet igennem hele dets livscyklus. Anvender du Id returneres den specifikke aktuelle postnummer. |
NULL | EAID_D273E3D8_A3F4_41bc_AF9C_E67B4A29C008 |
Status |
Metode - Navngivenvej
Url
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.
"type": "object",
"properties": {
"id": {…},
"[NAVN]": {…}
}
Id
UUID
Identifikation af adresseelementet igennem hele dets livscyklus
NULL
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:
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. |
VirkningFra
DateTime
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. | NULL |
EAID_3058C5FD_9824_48ba_B62C_C24587BF6537 |
Virkningsaktoer
String
Den aktør der har afstedkommet virkningsegenskaberne for den pågældende version af adresselementet
NULL
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. | NULL |
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 |
Eksempel på url
https://services.datafordeler.dk/DAR/DAR/3.0.0/rest/supplerendebynavn? |
Eksempel på url med certifikat
https://certservices.datafordeler.dk/DAR/DAR/ |
3.0.0/rest/ |
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.
"type": "object",
"properties": {
"id": {…},
"[NAVN]": {…}
supplerendebynavn? |
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.
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 supplerendeBynavn. | NULL | EAID_D273E3D8_A3F4_41bc_AF9C_E67B4A29C008.EAID_9AB90AE0 |
VirkningFra
DateTime
Tidspunktet hvorfra den pågældende version af adresseelementet har virkning
NOW()
VirkningTil
DateTime
Tidspunktet hvor virkningen af den pågældende version af adresseelementet ophører
NOW()
Virkningsaktoer
String
Den aktør der har afstedkommet virkningsegenskaberne for den pågældende version af adresseelementet
NULL
RegistreringFra
DateTime
Tidspunktet hvor registreringen af den pågældende version af adresseelementet er foretaget
NOW()
RegistreringTil
DateTime
Tidspunktet hvor en ny registrering på adresseelementet er foretaget, og hvor denne version således ikke længere er den seneste.
NOW()
Registreringsaktoer
String
Den aktør der har foretaget registreringen af den pågældende version af adresseelementet
NULL
Status
String
Adresseelementets status i den pågældende version, dvs. elementets tilstand i den samlede livscyklus
NULL
Forretningsproces
String
Den forretningsproces, som afstedkom opdateringen af adresseelementet til den pågældende version
NULL
Forretningsomraade
String
Det forretningsområde som har opdateret adresseelementet til den pågældende version
NULL
Forretningshaendelse
String
Den forretningshændelse, som afstedkom opdateringen af adresseelementet til den pågældende version
NULL
_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:
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. | NULL | 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. | NULL | 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. |
MedDybde
Boolean
Angiver om resultatet skal indeholde nested data fra joins eller kun ID'er.
TRUE
DAFTimestampFra
DateTime
NULL | ||
DAFTimestampTil | DateTime | Til Datafordeler |
NULL
Kommunekode
String
Kommunekode
NULL
NavngivenVej
UUID
DAR NavngivenVej ID
NULL
Vejkode
String
Vejkode
NULL
Husnummer
UUID
DAR Husnummer ID
NULL
SupplerendeBynavnDAR
Integer
DAR SupplerendeBynavn ID
NULL
SupplerendeBynavnDAGI
Integer
DAGI SupplerendeBynavn ID
NULL
Postnummer
UUID
DAR Postnummer ID
NULL
Postnummerinddeling
Integer
DAGI Postnummerinddeling ID
NULL
Adresse
UUID
DAR Adresse ID
NULL
Outputparametre
Metode - Postnummer
Url
<endpoint>/DAR/DAR/1/rest/postnummer?
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.
Id
UUID
Identifikation af adresseelementet igennem hele dets livscyklus
NULL
VirkningFra
DateTime
Tidspunktet hvorfra den pågældende version af adresseelementet har virkning
NOW()
VirkningTil
DateTime
Tidspunktet hvor virkningen af den pågældende version af adresseelementet ophører
NOW()
Virkningsaktoer
String
Den aktør der har afstedkommet virkningsegenskaberne for den pågældende version af adresseelementet
NULL
RegistreringFra
DateTime
Tidspunktet hvor registreringen af den pågældende version af adresseelementet er foretaget
NOW()
RegistreringTil
DateTime
Tidspunktet hvor en ny registrering på adresseelementet er foretaget, og hvor denne version således ikke længere er den seneste.
NOW()
Registreringsaktoer
String
Den aktør der har foretaget registreringen af den pågældende version af adresseelementet
NULL
Status
String
Adresseelementets status i den pågældende version, dvs. elementets tilstand i den samlede livscyklus
NULL
Forretningsproces
String
Den forretningsproces, som afstedkom opdateringen af adresseelementet til den pågældende version
NULL
Forretningsomraade
String
Det forretningsområde som har opdateret adresseelementet til den pågældende version
NULL
Forretningshaendelse
String
Den forretningshændelse, som afstedkom opdateringen af adresseelementet til den pågældende version
NULL
DAFTimestampFra
DateTime
Fra Datafordeler opdateringstidspunkt
NULL
DAFTimestampTil
DateTime
Til Datafordeler opdateringstidspunkt
NULL
Postnummerinddeling
UUID
DAGI Postnummerinddeling ID
NULL
Postnr
String
Postnummer
NULL
Navn
String
Postnummer navn
NULL
Outputparametre
Metode - Supplerendebynavn
Beskrivelse
Metoden udstiller alle data for Supplerendebynavn.
Url
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.
Id
UUID
Identifikation af adresseelementet igennem hele dets livscyklus
NULL
VirkningFra
DateTime
Tidspunktet hvorfra den pågældende version af adresseelementet har virkning
NOW()
VirkningTil
DateTime
Tidspunktet hvor virkningen af den pågældende version af adresseelementet ophører
NOW()
Virkningsaktoer
String
Den aktør der har afstedkommet virkningsegenskaberne for den pågældende version af adresseelementet
NULL
RegistreringFra
DateTime
Tidspunktet hvor registreringen af den pågældende version af adresseelementet er foretaget
NOW()
RegistreringTil
DateTime
Tidspunktet hvor en ny registrering på adresseelementet er foretaget, og hvor denne version således ikke længere er den seneste.
NOW()
Registreringsaktoer
String
Den aktør der har foretaget registreringen af den pågældende version af adresseelementet
NULL
Status
String
Adresseelementets status i den pågældende version, dvs. elementets tilstand i den samlede livscyklus
NULL
Forretningsproces
String
Den forretningsproces, som afstedkom opdateringen af adresseelementet til den pågældende version
NULL
Forretningsomraade
String
Det forretningsområde som har opdateret adresseelementet til den pågældende version
NULL
Forretningshaendelse
String
Den forretningshændelse, som afstedkom opdateringen af adresseelementet til den pågældende version
NULL
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 |
Outputparametre
Metode | Skema |
---|---|
Den inkluderede fil ”DAR_2.3.4_SupplerendeBynavn.schema.json” indeholder output som JSON-schema |
Generelt
Sikkerhedszone | 0 – Indeholder ikke fortrolige eller følsomme data |
---|---|
Adgangsniveau | Kendt bruger |
Adgangsbegrænsning | Ingen adgangsbegrænsning |
Anvendt udstillingsmodel | Danmarks Adresseregister (DAR), Danmarks Administrative Grænser (DAGI), Matriklen (Matrikel) |
SLA | Se registrets tilgængelighed på Datafordeler.dk |
Url-struktur for REST services | <endpoint>/register/service/version/servicetype/metode? |
---|---|
Eksempel på url med brugernavn/adgangskode | https://services.datafordeler.dk/DAR/DAR_BFE_Public/1/rest/adresseTilEnhedBfe?username=xxx&password=yyy&adresseId=xxxyxyxx-yyxx-xxxx-xxyy-yxxxyxyyxxyy |
Eksempel på url med certifikat | https://certservices.datafordeler.dk/DAR/DAR_BFE_Public/1/rest/adresseTilEnhedBfe?adresseId=xxxyxyxx-yyxx-xxxx-xxyy-yxxxyxyyxxyy |
Metodeoversigt
Metodenavn | Kompleksitet | Tværgående tjeneste |
---|---|---|
adresseTilEnhedBfe | Kompleks | Ja, også BBR |
husnummerTilBygningBfe | Kompleks | Ja, også BBR og Matrikel |
husnummerTilTekniskAnlægBfe | Kompleks | Ja, også BBR og Matrikel |
Eksempel på url med brugernavn/adgangskode
https://services.datafordeler.dk/DAR/DAR_BFE_Public/1/rest/adresseTilEnhedBfe?adresseId=xxxyxyxx-yyxx-xxxx-xxyy-yxxxyxyyxxyy&username=xxx&password=yyy |
Eksempel på url med certifikat
https://certservices.datafordeler.dk/DAR/DAR_BFE_Public/1/rest/adresseTilEnhedBfe?adresseId=xxxyxyxx-yyxx-xxxx-xxyy-yxxxyxyyxxyy |
Inputparametre
Parameteret adresseid er obligatorisk.
Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
---|---|---|---|---|
adresseId | string | Identifikation af adresseelementet igennem hele dets livscyklus | NULL | EAID_D273E3D8_A3F4_41bc_AF9C_E67B4A29C008 |
DAFTimestampFra
DateTime
Fra Datafordeler opdateringstidspunkt
NULL
DAFTimestampTil
DateTime
Til Datafordeler opdateringstidspunkt
NULL
SupplerendeBynavnDAGI
Integer
DAGI SupplerendeBynavn ID
NULL
Navn
String
SupplerendeBynavn navn
Outputparametre
Metode | Skema |
---|---|
Den inkluderede fil |
”DAR_2.3.4_AdresseTilEnhedBfe.schema. |
json” indeholder output som JSON- |
Eksempel på url med brugernavn/adgangskode
https://services.datafordeler.dk/DAR/DAR_BFE_Public/1/rest/ |
Metodeoversigt
husnummerTilBygningBfe?HusnummerId=xxyxxxyx-yxxy-xxyx-xxxx-yyyyxyxxyxyx&username=xxx&password=yyy |
Eksempel på url med certifikat
https://certservices.datafordeler.dk |
Ja, også BBR
husnummerTilBygningBfe
Metode - adresseTilEnhedBfe
Url
<endpoint>/DAR/DAR_BFE_Public/1/rest/ |
husnummerTilBygningBfe?HusnummerId=xxyxxxyx-yxxy-xxyx-xxxx-yyyyxyxxyxyx |
Inputparametre
Parameteret husnummerId er obligatorisk.
Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
---|
husnummerId | string |
Identifikation af adresseelementet igennem hele dets livscyklus
DAR Husnummer ID | NULL |
EAID_D273E3D8_A3F4_41bc_AF9C_E67B4A29C008 |
Outputparametre
Den inkluderede fil ”AdresseTilEnhedBfe.schema.json” indeholder output som JSON-schema.
Rentemestervej 8, København:
https://certservices.datafordeler.dk/DAR/DAR_BFE_Public/1/REST/husnummerTilBygningBfe?husnummerid=0a3f507a-e179-32b8-e044-0003ba298018&format=json |
Bygning på fremmedgrund (kolonihaven Lupinstien 7, Herning):
https://certservices.datafordeler.dk |
Metode - husnummerTilBygningBfe
Url
<endpoint>/DAR/DAR_BFE_Public/1/ |
REST/husnummerTilBygningBfe? |
Inputparametre
husnummerId
string
DAR Husnummer ID
NULL
husnummerid=b7363daf-9cb9-4a27-bc9e-3ab1c08e9c20&format=json |
I det sidste tilfælde returneres også indhold i bygningPaaFremmedGrundList.
Outputparametre
Metode | Skema |
---|---|
Den inkluderede fil ”DAR_2.3.6_HusnummerTilBygningTekniskAnlægBfe.schema.json” indeholder output som JSON-schema |
Eksempel på url med brugernavn/adgangskode
https://services.datafordeler.dk/DAR/DAR_BFE_Public/1/rest/husnummerTilTekniskAnlægBfe?HusnummerId=xxyxxxyx-yxxy-xxyx-xxxx-yyyyxyxxyxyx&username=xxx&password=yyy |
Eksempel på url med certifikat
https://certservices.datafordeler.dk |
Outputparametre
Den inkluderede fil ”HusnummerTilBygningTekniskAnlægBfe.schema.json” indeholder output som JSON-schema
Metode - husnummerTilTekniskAnlægBfe
Url
<endpoint>/DAR/DAR_BFE_Public/1/rest/husnummerTilTekniskAnlægBfe? |
HusnummerId=xxyxxxyx-yxxy-xxyx-xxxx-yyyyxyxxyxyx |
Inputparametre
Parameteret husnummerId er obligatorisk.
Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
---|---|---|---|---|
husnummerId | string | DAR Husnummer ID | NULL | EAID_D273E3D8_A3F4_41bc_AF9C_E67B4A29C008 |
Outputparametre
Metode | Skema |
---|---|
Den inkluderede fil |
”DAR_2.3.6_HusnummerTilBygningTekniskAnlægBfe.schema.json” indeholder output som JSON-schema |