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



Siden beskriver de REST tjenester der udstilles på Datafordeleren fra Ejendomsbeliggenhedsregistret (EBR).

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.







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 REST services. Efter ? tilføjes parametre i kaldet, der kan indeholde generelle kaldeparametre for REST services og metode specifikke 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 og at servicen skal kaldes med certifikat derfor certservices - 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 med brugernavn/adgangskode

https://services.datafordeler.dk/EBR/Ejendomsbeliggenhed/1/rest/BFEnrAdresse?Adresseid=xyxxxyxx-yxxx-xxxx-yxxx-xxxxyyxxxxxx&username=xxx&password=yyy 

Eksempel på url med certifikathttps://certservices.datafordeler.dk/EBR /Ejendomsbeliggenhed/1/rest/BFEnrAdresse?Adresseid=xyxxxyxx-yxxx-xxxx-yxxx-xxxxyyxxxxxx




Generelt for EBR webservices

I nedenstående afsnit beskrives de tjenester på Datafordeleren der udstiller Ejendomsbeliggenhed. Ejendomsbeliggenhed er i hovedreglen en reference mellem ejendommen og den adresse der skal anvendes som beliggenhedsadresse. I tilfælde hvor der ikke eksisterer en adresse for en ejendom er der i Ejendomsbeliggenhed en beliggenhedsbetegnelse til anvendelse i stedet for en faktisk adresse. Beliggenhedsbetegnelsen er en tekst dannet på baggrund af bl.a. informationer i Danmarks Administrative og Geografiske Inddelinger. I Ejendomsbeliggenhed er der desuden information om hvilken kommune der har det administrative ansvar for informationen i Ejendomsbeliggenhed.


Registernavn i SelvbetjeningenEBR
FormatXML/JSON
DLS version2.9.1
Sikkerhedszone0 – Indeholder ikke fortrolige eller følsomme data
Adgangsniveau

Alle kendte brugere må tilgå tjenesten

AdgangsbegrænsningIngen adgangsbegrænsning
Anvendt udstillingsmodelEjendomsbeliggenhed, Matrikel, DanmarksAdresseRegister, DAGI
PagingAnvender paging.
Default paging-størrelse: 20
SLASe registrets tilgængelighed på Datafordeler.dk
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 - Ejendomsbeliggenhed


Metodeoversigt

Metodenavn

SLA kategori

Tværgående tjeneste

BFEnrAdresse

Kompleks

Ja

Ejendomsbeliggenhed

Kompleks

Ja

EjendomsbeliggenhedSimpel

Kompleks

Nej


SLA kategorier i produktion- maksimal svartid i sekunder:

  • Simpel: 0.09
  • Normal: 1.0
  • Kompleks: 2.5




Metode - BFEnrAdresse

Beskrivelse

Henter Ejendomsbeliggenhed (herunder BFEnr) for en eller flere DAR adresser, som er registreret i Ejendomsbeliggenhedsregisteret (objekttype Ejendomsbeliggenhed).


Eksempel på url med brugernavn/adgangskode

https://services.datafordeler.dk/EBR/Ejendomsbeliggenhed/1/rest/BFEnrAdresse?Adresseid=xyxxxyxx-yxxx-xxxx-yxxx-xxxxyyxxxxxx&username=xxx&password=yyy 


Eksempel på url med certifikat

https://certservices.datafordeler.dk/EBR /Ejendomsbeliggenhed/1/rest/BFEnrAdresse?Adresseid=xyxxxyxx-yxxx-xxxx-yxxx-xxxxyyxxxxxx


Inputparametre

Følgende parameter er obligatorisk: AdresseId (som enkelt eller liste) ELLER HusnummerId (som enkelt eller liste) Øvrige parametre er valgfri.

NavnTypeBeskrivelseDefault værdiUUID fra udstillingsmodel

AdresseId

String (List)

Liste af lokalId UUID for DAR Adresse

NULL

EAID_dstD4A261_DC16_404d_BC3C_7FA91424ACD3

HusnummerId

String (List)

Liste af lokalId UUID for DAR Husnummer

NULL

EAID_dst83583C_B905_471b_9DDE_D2E75E34CB37

Registreringstid

DateTime

Dato som falder indenfor en registreringstidsperiode. Anvendes fx 2015-09-02 vil de instanser med en gældende registreringstid på denne dato udvælges

NOW()

EAID_DFA31DDB_671D_41d3_B174_4129A6500F08
EAID_A19BB6FA_289E_4c0b_B11C_39F12A4F3105

Virkningstid

DateTime

Dato som falder indenfor en virkningstidsperiode. Anvendes fx 2015-09-02 vil de instanser med en gældende virkningstid på denne dato udvælges

NOW()

EAID_586C3BB8_D2B2_410f_9DA6_DBD9A66BE76E
EAID_AF4B2D78_EDED_4816_BA07_9C96D4876D17

Status

String

Status jf. modellens udfaldsrum

NULL

EAID_0309F182_1A14_4098_B718_11034C06F679


Outputparametre

Metode

Skema

Den inkluderede fil ” EBR_2.9.1_BFEnrAdresse.json” indeholder output som JSON-schema

EBR_2.9.1_BFEnrAdresse.json

Skema - filudtræk og webservices (EBR)




Metode - Ejendomsbeliggenhed

Beskrivelse

Henter Ejendomsbeliggenhed (herunder beliggenhedsadressen samt oplysning om administrativ ansvarlig kommune) tilknyttet en Bestemt Fast Ejendom.

Genereres på baggrund af Ejendomsbeliggenhedsregisteret på Datafordeleren.


Eksempel på url med brugernavn/adgangskode

https://services.datafordeler.dk/EBR/Ejendomsbeliggenhed/1/rest/Ejendomsbeliggenhed?EBId=xyyyxxxx-yxxy-xyxx-yxxx-yyxyxxxxxyxx&username=xxx&password=yyy 


Eksempel på url med certifikat

https://certservices.datafordeler.dk/EBR/Ejendomsbeliggenhed/1/rest/Ejendomsbeliggenhed?EBId=xyyyxxxx-yxxy-xyxx-yxxx-yyxyxxxxxyxx


Inputparametre

Følgende parametre er obligatoriske: EBId (som enkelt eller liste) ELLER BFEnr (som enkelt eller liste). Øvrige parametre er valgfri.

Listen må maksimalt indeholde 200 BFEnumre.

NavnTypeBeskrivelseDefault værdiUUID fra udstillingsmodel

EBId

String (List)

Liste af Id for ejendomsbeliggenhed

NULL

EAID_033C3051_F5C6_435a_95BB_4168879EAAB4
EAID_9AB90AE0_9F85_4164_9B25_8EB2139D65A5

BFEnr

Integer (List)

Liste af Bestemt Fast Ejendom numre

NULL

EAID_0FD7270E_53D6_445d_9572_2D0AF6D9A83A
EAID_3828326A_2F94_4e83_A24D_F0BBB5D9EC28
EAID_A2B9B2EF_86F2_4f1d_87C0_1804A7071486
EAID_3828326A_2F94_4e83_A24D_F0BBB5D9EC28
EAID_1C0A5E2D_83CC_43d5_A7D7_C5B4FABF6109
EAID_3828326A_2F94_4e83_A24D_F0BBB5D9EC28
EAID_9C1A6CF4_25D6_4e28_949F_D45BA79F9EF1
EAID_3828326A_2F94_4e83_A24D_F0BBB5D9EC28

Registreringstid

DateTime

Dato som falder indenfor en registreringstidsperiode. Anvendes fx 2015-09-02 vil de instanser med en gældende registreringstid på denne dato udvælges

NOW()

EAID_DFA31DDB_671D_41d3_B174_4129A6500F08
EAID_A19BB6FA_289E_4c0b_B11C_39F12A4F3105

Virkningstid

DateTime

Dato som falder indenfor en virkningstidsperiode. Anvendes fx 2015-09-02 vil de instanser med en gældende virkningstid på denne dato udvælges

NOW()

EAID_586C3BB8_D2B2_410f_9DA6_DBD9A66BE76E
EAID_AF4B2D78_EDED_4816_BA07_9C96D4876D17

Status

String

Status jf. modellens udfaldsrum

NULL

EAID_0309F182_1A14_4098_B718_11034C06F679


Outputparametre

Metode

Skema

Den inkluderede fil ”EBR_2.9.1_Ejendomsbeliggenhed.json” indeholder output som JSON-schema

EBR_2.9.1_Ejendomsbeliggenhed.json

Skema - filudtræk og webservices (EBR)




Metode - EjendomsbeliggenhedSimpel

Beskrivelse

Henter Beliggenhedsadressen tilknyttet en Bestemt Fast Ejendom performanceeffektivt, dvs. uden joins til andre registre.


Eksempel på url med brugernavn/adgangskode

https://services.datafordeler.dk/EBR/Ejendomsbeliggenhed/1/rest/EjendomsbeliggenhedSimpel?EBId=xyyyxxxx-yxxy-xyxx-yxxx-yyxyxxxxxyxx&username=xxx&password=yyy 


Eksempel på url med certifikat

https://certservices.datafordeler.dk/EBR/Ejendomsbeliggenhed/1/rest/EjendomsbeliggenhedSimpel?EBId=xyyyxxxx-yxxy-xyxx-yxxx-yyxyxxxxxyxx


Inputparametre

Følgende parametre er obligatoriske: EBId (som enkelt eller liste) ELLER BFEnr (som enkelt eller liste). Øvrige parametre er valgfri.

Listen må maksimalt indeholde 200 BFEnumre.

NavnTypeBeskrivelseDefault værdiUUID fra udstillingsmodel

EBId

String (List)

Liste af Id for ejendomsbeliggenhed

NULL

EAID_033C3051_F5C6_435a_95BB_4168879EAAB4
EAID_9AB90AE0_9F85_4164_9B25_8EB2139D65A5

BFEnr

Integer (List)

Liste af Bestemt Fast Ejendom numre

NULL

EAID_0FD7270E_53D6_445d_9572_2D0AF6D9A83AEAID_3828326A_2F94_4e83_A24D_F0BBB5D9EC28
EAID_A2B9B2EF_86F2_4f1d_87C0_1804A7071486
EAID_3828326A_2F94_4e83_A24D_F0BBB5D9EC28
EAID_1C0A5E2D_83CC_43d5_A7D7_C5B4FABF6109EAID_3828326A_2F94_4e83_A24D_F0BBB5D9EC28
EAID_9C1A6CF4_25D6_4e28_949F_D45BA79F9EF1
EAID_3828326A_2F94_4e83_A24D_F0BBB5D9EC28

RegistreringstidFra

DateTime

Dato som angiver starten af en periodesøgning på registreringstid. Medtager alle elementer der er afregistreret efter dette tidspunkt.

NULL

EAID_DFA31DDB_671D_41d3_B174_4129A6500F08

RegistreringstidTil

DateTime

Dato som angiver slutningen af en periodesøgning på registreringstid. Medtager alle elementer der er registreret før dette tidspunkt.

NULL

EAID_A19BB6FA_289E_4c0b_B11C_39F12A4F3105

VirkningstidFra

DateTime

Dato som angiver starten af en periodesøgning på virkningsstid. Medtager alle elementer hvis effekt ophørte efter dette tidspunkt.

NULL

EAID_586C3BB8_D2B2_410f_9DA6_DBD9A66BE76E

VirkningstidTil

DateTime

Dato som angiver slutningen af en periodesøgning på virkningsstid. Medtager alle elementer der kom i effekt efter eller på dette tidspunkt.

NULL

EAID_AF4B2D78_EDED_4816_BA07_9C96D4876D17

Registreringstid

DateTime

Dato som falder indenfor en registreringstidsperiode. Anvendes fx 2015-09-02 vil de instanser med en gældende registreringstid på denne dato udvælges

NOW()

EAID_DFA31DDB_671D_41d3_B174_4129A6500F08
EAID_A19BB6FA_289E_4c0b_B11C_39F12A4F3105

Virkningstid

DateTime

Dato som falder indenfor en virkningstidsperiode. Anvendes fx 2015-09-02 vil de instanser med en gældende virkningstid på denne dato udvælges

NOW()

EAID_586C3BB8_D2B2_410f_9DA6_DBD9A66BE76E
EAID_AF4B2D78_EDED_4816_BA07_9C96D4876D17

Status

String

Status jf. modellens udfaldsrum

NULL

EAID_0309F182_1A14_4098_B718_11034C06F679


Outputparametre

Metode

Skema

Den inkluderede fil ”EBR_2.9.1_EjendomsbeliggenhedSimpel.json” indeholder output som JSON-schema

EBR_2.9.1_EjendomsbeliggenhedSimpel.json

Skema - filudtræk og webservices (EBR)