- Created by Maria Klostermann Tapdrup, last modified on Aug 23, 2019
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 5 Next »
Siden beskriver de tjenester, der udstilles på Datafordeleren fra DAR.
Få en introduktion til Webservice på Datafordeleren (REST), 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 webservice på Selvbetjeningen (REST).
Generelt for DAR webservices
| Format | XML/JSON |
|---|---|
| DLS version | 2.3.4 |
| 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. UTC kan angives enten ved +HH:MM (2019-07-05T07:50:14.687580+01:00) eller ved at benytte Z (2019-07-05T07:50:14.687580Z) |
REST - DAR
| Sikkerhedszone | 0 – Indeholder ikke fortrolige eller følsomme data |
|---|---|
| Adgangsniveau | Fri adgang |
| Adgangsbegrænsning | Ingen adgangsbegrænsning |
| Anvendt udstillingsmodel | Danmarks Adresseregister (DAR), Danmarks Administrative Grænser (DAGI), Matriklen (Matrikel) |
| REST-regler | Default paging-størrelse: 100 |
| 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 | https://services.datafordeler.dk/DAR/DAR/1/REST/Adresse? |
Metodeoversigt
| Metodenavn | Kompleksitet | Tværgående tjeneste |
|---|---|---|
| adresse | Kompleks | Ja, også DAGI data |
| adresseTilHusnummer | Simpel | 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).
Url
| <endpoint> /DAR/DAR/1/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- 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]": {…}
}
| Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
|---|---|---|---|---|
| Id | UUID | Identifikation af adresseelementet igennem hele dets livscyklus | NULL | EAID_D273E3D8_A3F4_41bc_AF9C_E67B4A29C008.EAID_9AB90AE0_9F85_4164_9B25_8EB2139D65A5 |
| VirkningFra | DateTime | Tidspunktet hvorfra den pågældende version af adresseelementet har virkning | NOW() | EAID_AB768062_FD24_4960_8AA1_C6BFF90C00C5 |
| VirkningTil | DateTime | Tidspunktet hvor virkningen af den pågældende version af adresseelementet ophører | NOW() | EAID_3058C5FD_9824_48ba_B62C_C24587BF6537 |
| Virkningsaktoer | String | Den aktør der har afstedkommet virkningsegenskaberne for den pågældende version af adresseelementet | NULL | EAID_8E60197F_D857_47c6_8611_75B63D0940FD |
| RegistreringFra | DateTime | Tidspunktet hvor registreringen af den pågældende version af adresseelementet er foretaget | 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. | NOW() | EAID_301BF58F_26E7_4d1f_B7B6_3881F8C1B0A5 |
Registreringsaktoer | String | Den aktør der har foretaget registreringen af den pågældende version af adresseelementet | NULL | EAID_9F724D2B_7763_4997_8C85_580610BABC1F |
| Status | String | Adresseelementets status i den pågældende version, dvs. elementets tilstand i den samlede livscyklus | NULL | EAID_22AF1E6A_73A8_4c89_96EB_C307235DFD19 |
| Forretningsproces | String | Den forretningsproces, som afstedkom opdateringen af adresseelementet til den pågældende version | NULL | EAID_A9A40479_E58D_4c7a_A0EA_F8EC4829ECAC |
Forretningsomraade | String | Det forretningsområde som har opdateret adresseelementet til den pågældende version | NULL | EAID_C955CFEC_E2A0_47da_9F76_6452FCC9E4E2 |
| Forretningshaendelse | String | Den forretningshændelse, som afstedkom opdateringen af adresseelementet til den pågældende version | NULL | EAID_1CE948DD_FC3D_4638_8913_A2D35A00F64D |
| MedDybde | Boolean | Angiver om resultatet skal indeholde nested data fra joins eller kun ID'er. | SAND | |
| DAFTimestampFra | DateTime | Fra Datafordeler opdateringstidspunkt | NULL | |
DAFTimestampTil | DateTime | Til Datafordeler opdateringstidspunkt | NULL | |
| Husnummer | UUID | Angiver det DAR husnummer, der indgår i adressen | NULL | EAID_src6919CB_1734_44ef_BE5B_C115B637B2CD |
| Bygning | UUID | Angiver den BBR bygning som adressen ligger i | NULL | EAID_src4A2C09_8035_4ca8_8AA0_CBAAB89AF135 |
| NavngivenVej | UUID | DAR NavngivenVej ID | NULL | |
NavngivenVejKommunedel | UUID | DAR NavngivenVejKommunedel ID | NULL | |
| Kommunekode | String | Kommunekode | NULL | |
| Vejkode | String | Vejkode | NULL | |
| Nord | Double | Nordlig koordinat afgrænsning | NULL | |
| Syd | Double | Sydlig koordinat afgrænsning | NULL | |
| Oest | Double | Østlig koordinat afgrænsning | NULL | |
| Vest | Double | Vestlig koordinat afgrænsning | NULL |
Outputparametre
| Metode | Skema |
|---|---|
| Den inkluderede fil ”Adresse.schema.json” indeholder output som JSON-schema |
Metode - adresseTilHusnummere
Url
<endpoint>/DAR/DAR/1/rest/adresseTilHusnummer? |
Inputparametre
Parameteret adresseId er obligatorisk.
| Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
|---|---|---|---|---|
adresseId | string | DAR Husnummer ID | NULL | EAID_D273E3D8_A3F4_41bc_AF9C_E67B4A29C008 |
Outputparametre
| Metode | Skema |
|---|---|
| Den inkluderede fil ”AdresseTilHusnummer.schema.json” indeholder output som JSON-schema |
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
| <endpoint>/DAR/DAR/1/rest/husnummer? |
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]": {…}
}
| Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
|---|---|---|---|---|
| Id | UUID | Identifikation af adresseelementet igennem hele dets livscyklus | NULL | EAID_D273E3D8_A3F4_41bc_AF9C_E67B4A29C008.EAID_9AB90AE0_9F85_4164_9B25_8EB2139D65A5 |
| VirkningFra | DateTime | Tidspunktet hvorfra den pågældende version af adresseelementet har virkning | NOW() | EAID_AB768062_FD24_4960_8AA1_C6BFF90C00C5 |
| VirkningTil | DateTime | Tidspunktet hvor virkningen af den pågældende version af adresseelementet ophører | NOW() | EAID_3058C5FD_9824_48ba_B62C_C24587BF6537 |
| Virkningsaktoer | String | Den aktør der har afstedkommet virkningsegenskaberne for den pågældende version af adresseelementet | NULL | EAID_8E60197F_D857_47c6_8611_75B63D0940FD |
| RegistreringFra | DateTime | Tidspunktet hvor registreringen af den pågældende version af adresseelementet er foretaget | 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. | NOW() | EAID_301BF58F_26E7_4d1f_B7B6_3881F8C1B0A5 |
Registreringsaktoer | String | Den aktør der har foretaget registreringen af den pågældende version af adresseelementet | NULL | EAID_9F724D2B_7763_4997_8C85_580610BABC1F |
| Status | String | Adresseelementets status i den pågældende version, dvs. elementets tilstand i den samlede livscyklus | NULL | EAID_22AF1E6A_73A8_4c89_96EB_C307235DFD19 |
| Forretningsproces | String | Den forretningsproces, som afstedkom opdateringen af adresseelementet til den pågældende version | NULL | EAID_A9A40479_E58D_4c7a_A0EA_F8EC4829ECAC |
Forretningsomraade | String | Det forretningsområde som har opdateret adresseelementet til den pågældende version | NULL | EAID_C955CFEC_E2A0_47da_9F76_6452FCC9E4E2 |
| Forretningshaendelse | String | Den forretningshændelse, som afstedkom opdateringen af adresseelementet til den pågældende version | NULL | EAID_1CE948DD_FC3D_4638_8913_A2D35A00F64D |
| MedDybde | Boolean | Angiver om resultatet skal indeholde nested data fra joins eller kun ID'er. | TRUE | |
| DAFTimestampFra | DateTime | Fra Datafordeler opdateringstidspunkt | NULL | |
DAFTimestampTil | DateTime | Til Datafordeler opdateringstidspunkt | NULL | |
| AdgangTilBygning | UUID | Den BBR bygning som husnummeret identificerer adgangen til | NULL | EAID_dst3E4349_6115_4191_AF4F_243CCE561C41 |
| AdgangTilTekniskAnlaeg | UUID | Det BBR tekniske anlæg som husnummeret angiver adgangsvejen til | NULL | EAID_dst79A4C1_23B2_4c0c_85CC_60C6E2EA5AE0 |
| NavngivenVej | UUID | Angiver den DAR navngivne vej som husnummeret er knyttet til | NULL | EAID_dst74C4B5_0F0F_4a51_B317_BA74938B605F |
Adresse | UUID | Angiver de DAR adresser, der anvender husnummeret | NULL | |
| Postnr | String | Postnummer | NULL | |
| NavngivenVejKommunedel | UUID | DAR NavngivenVejKommunedel ID | NULL | |
| Jordstykke | Integer | MU Jordstykke ID | NULL | |
| Vejkode | String | Vejkode | NULL | |
| SupplerendeBynavnDAR | UUID | DAR SupplerendeBynavn ID | NULL | |
| SupplerendeBynavnDAGI | Integer | DAGI SupplerendeBynavn ID | NULL | |
| Postnummer | UUID | DAR Postnummer ID | NULL | |
Postnummerinddeling | Integer | DAGI Postnummerinddeling ID | NULL | |
| Afstemningsomraade | Integer | DAGI Afstemningsområde ID | NULL | |
| Sogneinddeling | Integer | DAGI Sogneinddeling ID | NULL | |
| Kommuneinddeling | Integer | DAGI Kommuneinddeling ID | NULL | |
Menighedsraadsafstemningsomraade | Integer | DAGI Menighedsrådsafstemingsområde ID | NULL | |
| Vejmidte | Integer | GeoDK Vejmidte ID | NULL | |
| GeoDanmarkBygning | Integer | GeoDK Bygning ID | NULL | |
Nord | Double | Nordlig koordinat afgrænsning | NULL | |
| Syd | Double | Sydlig koordinat afgrænsning | NULL | |
Oest | Double | Østlig koordinat afgrænsning | NULL | |
| Vest | Double | Vestlig koordinat afgrænsning | NULL |
Outputparametre
| Metode | Skema |
|---|---|
| Den inkluderede fil ”Husnummer.schema.json” indeholder output som JSON-schema |
Metode - husnummerTilAdresse
Url
| <endpoint>/DAR/DAR/1/rest/husnummerTilAdresse? |
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 ”HusnummerTilAdresse.schema.json” indeholder output som JSON-schema |
Metode - husnummerTilJordstykke
Url
| <endpoint>/DAR/DAR/1/rest/husnummerTilJordstykke? |
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 ”HusnummerTilJordstykke.schema.json” indeholder output som JSON-schema |
Metode - Navngivenvej
Url
| <endpoint>/DAR/DAR/1/rest/navngivenvej? |
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]": {…}
}
| Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
|---|---|---|---|---|
Id | UUID | Identifikation af adresseelementet igennem hele dets livscyklus | NULL | EAID_D273E3D8_A3F4_41bc_AF9C_E67B4A29C008.EAID_9AB90AE0_9F85_4164_9B25_8EB2139D65A5 |
VirkningFra | DateTime | Tidspunktet hvorfra den pågældende version af adresselementet har virkning | NOW() | EAID_AB768062_FD24_4960_8AA1_C6BFF90C00C5 |
VirkningTil | DateTime | Tidspunktet hvor virkningen af den pågældende version af adresselementet ophører | NOW() | EAID_3058C5FD_9824_48ba_B62C_C24587BF6537 |
Virkningsaktoer | String | Den aktør der har afstedkommet virkningsegenskaberne for den pågældende version af adresselementet | NULL | EAID_8E60197F_D857_47c6_8611_75B63D0940FD |
RegistreringFra | DateTime | Tidspunktet hvor registreringen af den pågældendeversion af adresselementet er foretaget | NOW() | EAID_96862BAA_95CA_46aa_A6A0_757327A10BF7 |
RegistreringTil | DateTime | Tidspunktet hvor en ny registrering på adresselementet er foretaget, og hvor denne version således ikke længere er den seneste. | NOW() | EAID_301BF58F_26E7_4d1f_B7B6_3881F8C1B0A5 |
Registreringsaktoer | String | Den aktør der har foretaget registreringen af den pågældende version af adresselementet | NULL | EAID_9F724D2B_7763_4997_8C85_580610BABC1F |
Status | String | Adresseelementets status i den pågældende version, dvs. elementets tilstand i den samlede livscyklus | NULL | EAID_22AF1E6A_73A8_4c89_96EB_C307235DFD19 |
Forretningsproces | String | Den forretningsproces, som afstedkom opdateringen af adresselementet til den pågældende version | NULL | EAID_A9A40479_E58D_4c7a_A0EA_F8EC4829ECAC |
Forretningsomraade | String | Det forretningsområde som har opdateret adresseelementet til den pågældende version | NULL | EAID_C955CFEC_E2A0_47da_9F76_6452FCC9E4E2 |
Forretningshaendelse | String | Den forretningshændelse, som afstedkom opdateringen af adresseelementet til den pågældende version | NULL | EAID_1CE948DD_FC3D_4638_8913_A2D35A00F64D |
MedDybde | Boolean | Angiver om resultatet skal indeholde nested data fra joins eller kun ID'er. | TRUE | |
DAFTimestampFra | DateTime | Fra Datafordeler opdateringstidspunkt | NULL | |
DAFTimestampTil | DateTime | Til Datafordeler opdateringstidspunkt | NULL | |
Kommunekode | String | Kommunekode | NULL | |
Vejkode | String | Vejkode | NULL | |
Husnummer | UUID | DAR Husnummer ID | NULL | |
SupplerendeBynavnDAR | UUID | 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 | Skema |
|---|---|
| Den inkluderede fil ”NavngivenVej.schema.json” indeholder output som JSON-schema |
Metode - NavngivenvejKommunedel
Beskrivelse
Metoden udstiller alle NavngivenVejKommunedel informationer.
Url
<endpoint>/DAR/DAR/1/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.
"type": "object",
"properties": {
"id": {…},
"[NAVN]": {…}
}
| Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
|---|---|---|---|---|
Id | UUID | Identifikation af adresseelementet igennem hele dets livscyklus | NULL | EAID_D273E3D8_A3F4_41bc_AF9C_E67B4A29C008.EAID_9AB90AE0_9F85_4164_9B25_8EB2139D65A5 |
VirkningFra | DateTime | Tidspunktet hvorfra den pågældende version af adresseelementet har virkning | NOW() | EAID_AB768062_FD24_4960_8AA1_C6BFF90C00C5 |
VirkningTil | DateTime | Tidspunktet hvor virkningen af den pågældende version af adresseelementet ophører | NOW() | EAID_3058C5FD_9824_48ba_B62C_C24587BF6537 |
Virkningsaktoer | String | Den aktør der har afstedkommet virkningsegenskaberne for den pågældende version af adresseelementet | NULL | EAID_8E60197F_D857_47c6_8611_75B63D0940FD |
RegistreringFra | DateTime | Tidspunktet hvor registreringen af den pågældende version af adresseelementet er foretaget | 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. | NOW() | EAID_301BF58F_26E7_4d1f_B7B6_3881F8C1B0A5 |
Registreringsaktoer | String | Den aktør der har foretaget registreringen af den pågældende version af adresseelementet | NULL | EAID_9F724D2B_7763_4997_8C85_580610BABC1F |
Status | String | Adresseelementets status i den pågældende version, dvs. elementets tilstand i den samlede livscyklus | NULL | EAID_22AF1E6A_73A8_4c89_96EB_C307235DFD19 |
Forretningsproces | String | Den forretningsproces, som afstedkom opdateringen af adresseelementet til den pågældende version | NULL | EAID_A9A40479_E58D_4c7a_A0EA_F8EC4829ECAC |
Forretningsomraade | String | Det forretningsområde som har opdateret adresseelementet til den pågældende version | NULL | EAID_C955CFEC_E2A0_47da_9F76_6452FCC9E4E2 |
Forretningshaendelse | String | Den forretningshændelse, som afstedkom opdateringen af adresseelementet til den pågældende version | NULL | EAID_1CE948DD_FC3D_4638_8913_A2D35A00F64D |
MedDybde | Boolean | Angiver om resultatet skal indeholde nested data fra joins eller kun ID'er. | TRUE | |
DAFTimestampFra | DateTime | Fra Datafordeler opdateringstidspunkt | NULL | |
DAFTimestampTil | DateTime | Til Datafordeler opdateringstidspunkt | 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 | Skema |
|---|---|
| Den inkluderede fil ”NavngivenVejKommunedel.schema.json” indeholder output som JSON-schema |
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.
| Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
|---|---|---|---|---|
Id | UUID | Identifikation af adresseelementet igennem hele dets livscyklus | NULL | EAID_D273E3D8_A3F4_41bc_AF9C_E67B4A29C008 |
VirkningFra | DateTime | Tidspunktet hvorfra den pågældende version af adresseelementet har virkning | NOW() | EAID_AB768062_FD24_4960_8AA1_C6BFF90C00C5 |
VirkningTil | DateTime | Tidspunktet hvor virkningen af den pågældende version af adresseelementet ophører | NOW() | EAID_3058C5FD_9824_48ba_B62C_C24587BF6537 |
Virkningsaktoer | String | Den aktør der har afstedkommet virkningsegenskaberne for den pågældende version af adresseelementet | NULL | EAID_8E60197F_D857_47c6_8611_75B63D0940FD |
RegistreringFra | DateTime | Tidspunktet hvor registreringen af den pågældende version af adresseelementet er foretaget | 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. | NOW() | EAID_301BF58F_26E7_4d1f_B7B6_3881F8C1B0A5 |
Registreringsaktoer | String | Den aktør der har foretaget registreringen af den pågældende version af adresseelementet | NULL | EAID_9F724D2B_7763_4997_8C85_580610BABC1F |
Status | String | Adresseelementets status i den pågældende version, dvs. elementets tilstand i den samlede livscyklus | NULL | EAID_22AF1E6A_73A8_4c89_96EB_C307235DFD19 |
Forretningsproces | String | Den forretningsproces, som afstedkom opdateringen af adresseelementet til den pågældende version | NULL | EAID_A9A40479_E58D_4c7a_A0EA_F8EC4829ECAC |
Forretningsomraade | String | Det forretningsområde som har opdateret adresseelementet til den pågældende version | NULL | EAID_C955CFEC_E2A0_47da_9F76_6452FCC9E4E2 |
Forretningshaendelse | String | Den forretningshændelse, som afstedkom opdateringen af adresseelementet til den pågældende version | NULL | EAID_1CE948DD_FC3D_4638_8913_A2D35A00F64D |
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 | Skema |
|---|---|
| Den inkluderede fil ”Postnummer.schema.json” indeholder output som JSON-schema |
Metode - Supplerendebynavn
Beskrivelse
Metoden udstiller alle data for Supplerendebynavn.
Url
| <endpoint>/DAR/DAR/1/rest/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 | NULL | EAID_D273E3D8_A3F4_41bc_AF9C_E67B4A29C008.EAID_9AB90AE0_9F85_4164_9B25_8EB2139D65A5 |
VirkningFra | DateTime | Tidspunktet hvorfra den pågældende version af adresseelementet har virkning | NOW() | EAID_AB768062_FD24_4960_8AA1_C6BFF90C00C5 |
VirkningTil | DateTime | Tidspunktet hvor virkningen af den pågældende version af adresseelementet ophører | NOW() | EAID_3058C5FD_9824_48ba_B62C_C24587BF6537 |
Virkningsaktoer | String | Den aktør der har afstedkommet virkningsegenskaberne for den pågældende version af adresseelementet | NULL | EAID_8E60197F_D857_47c6_8611_75B63D0940FD |
RegistreringFra | DateTime | Tidspunktet hvor registreringen af den pågældende version af adresseelementet er foretaget | 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. | NOW() | EAID_301BF58F_26E7_4d1f_B7B6_3881F8C1B0A5 |
Registreringsaktoer | String | Den aktør der har foretaget registreringen af den pågældende version af adresseelementet | NULL | EAID_9F724D2B_7763_4997_8C85_580610BABC1F |
Status | String | Adresseelementets status i den pågældende version, dvs. elementets tilstand i den samlede livscyklus | NULL | EAID_22AF1E6A_73A8_4c89_96EB_C307235DFD19 |
Forretningsproces | String | Den forretningsproces, som afstedkom opdateringen af adresseelementet til den pågældende version | NULL | EAID_A9A40479_E58D_4c7a_A0EA_F8EC4829ECAC |
Forretningsomraade | String | Det forretningsområde som har opdateret adresseelementet til den pågældende version | NULL | EAID_C955CFEC_E2A0_47da_9F76_6452FCC9E4E2 |
Forretningshaendelse | String | Den forretningshændelse, som afstedkom opdateringen af adresseelementet til den pågældende version | NULL | EAID_1CE948DD_FC3D_4638_8913_A2D35A00F64D |
DAFTimestampFra | DateTime | Fra Datafordeler opdateringstidspunkt | NULL | |
DAFTimestampTil | DateTime | Til Datafordeler opdateringstidspunkt | NULL | |
SupplerendeBynavnDAGI | Integer | DAGI SupplerendeBynavn ID | NULL | |
Navn | String | SupplerendeBynavn navn | NULL |
Outputparametre
| Metode | Skema |
|---|---|
| Den inkluderede fil ”SupplerendeBynavn.schema.json” indeholder output som JSON-schema |
REST - DAR_BFE
| Sikkerhedszone | 5 - Indeholder fortrolige eller følsomme data |
|---|---|
| Adgangsniveau | Kendt bruger |
| Adgangsbegrænsning | Alle brugere skal IP-whitelistes for at få adgang til tjenesten |
| Anvendt udstillingsmodel | Danmarks Adresseregister (DAR), Danmarks Administrative Grænser (DAGI), Matriklen (Matrikel) |
| REST-regler | Default paging-størrelse: 100 |
| 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 til produktion | https://s5-certservices.datafordeler.dk/DAR/DAR_BFE/1/rest/adresseTilEnhedBfe? |
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 |
Metode - adresseTilEnhedBfe
Url
<endpoint>/DAR/DAR_BFE/1/rest/adresseTilEnhedBfe? |
Inputparametre
| 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 |
Outputparametre
| Metode | Skema |
|---|---|
Den inkluderede fil ”AdresseTilEnhedBfe.schema.json” indeholder output som JSON-schema. |
Metode - husnummerTilBygningBfe
Url
<endpoint>/DAR/DAR_BFE/1/rest/husnummerTilBygningBfe? |
Inputparametre
| 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 ”HusnummerTilBygningTekniskAnlægBfe.schema.json” indeholder output som JSON-schema |
Metode - husnummerTilTekniskAnlægBfe
Url
<endpoint>/DAR/DAR_BFE/1/rest/husnummerTilTekniskAnlægBfe? |
Inputparametre
| 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 ”HusnummerTilBygningTekniskAnlægBfe.schema.json” indeholder output som JSON-schema |
- No labels