Page History

Anchor

	Toppen
	Toppen

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

Table of Contents

Url opbygning for REST

URL for de enkelte REST 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.

Til toppen

URL-struktur for REST services	<endpoint>/register/service/version/servicetype/metode?
Eksempel	https://services.datafordeler.dk/EBR/Ejendomsbeliggenhed/1/REST/Ejendomsbeliggenhed?

Ejendomsbeliggenhed (EBR)

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.

Til toppen

REST - Ejendomsbeliggenhed

Format	XML/JSON
Sikkerhedszone	0 – Indeholder ikke fortrolige eller følsomme data
Adgangsniveau	Alle kendte brugere må tilgå tjenesten
Adgangsbegrænsning	Ingen adgangsbegrænsning
Anvendt udstillingsmodel	Ejendomsbeliggenhed, Matrikel, DanmarksAdresseRegister, DAGI
REST-regler	Anvend paging. Default paging-størrelse: 20
SLA	Se registrets tilgængelighed på Datafordeler.dk

Oversigt over metoder

Ejendomsbeliggenhed

Metodenavn	SLA kategori	Tværgående tjeneste
BFEnrAdresse	Kompleks	Ja
EjendomsbeliggenhedSimpelEjendomsbeliggenhed	Kompleks	NejJa
BFEnrAdresseEjendomsbeliggenhedSimpel	Kompleks	JaNej

SLA kategorier i produktion- maksimal svartid i sekunder:

Simpel: 0.09
Normal: 1.0
Kompleks: 2.5

Metode -

Ejendomsbeliggenhed

BFEnrAdresse

Beskrivelse

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

Genereres på baggrund af Ejendomsbeliggenhedsregisteret på Datafordeleren.

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

Kompleksitet	Kompleks
Tværgående tjeneste	Ja
SLA	Se registrets tilgængelighed på Datafordeler.dk
Url	https://<endpoint>.datafordeler.dk/EBR /Ejendomsbeliggenhed/1/rest/ Ejendomsbeliggenhed BFEnrAdresse?

Inputparametre

Følgende parametre parameter er obligatoriskeobligatorisk: EBId AdresseId (som enkelt eller liste) ELLER BFEnr HusnummerId (som enkelt eller liste) . Øvrige parametre er valgfri.Listen må maksimalt indeholde 200 BFEnumre.

Datoformat følger ISO 8601 Date and time format.

Alle datoer skrives med andre ord i formatet yyyy-mm-ddTHH:MM:SS - eksempelvis 2018-06-26T17:23:00

Navn	Type	Beskrivelse	Default værdi
EBIdAdresseId	String (List)	Liste af Id lokalId UUID for ejendomsbeliggenhedDAR Adresse	NULL
BFEnrHusnummerId	Integer String (List)	Liste af Bestemt Fast Ejendom numrelokalId UUID for DAR Husnummer	NULL
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()
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()
Status	String	Status jf. modellens udfaldsrum	NULL

Outputparametre

”EBREjendomsbeliggenhedEjendomsbeliggenhedhttps://confluence.datafordeler.dk/pages/viewpage.action?pageId=13664914

Metode	Skema
Den inkluderede fil	” EBR_v2.8_	BFEnrAdresse.json” indeholder output som JSON-schema	EBR_v2.8_	BFEnrAdresse.json	Skema - filudtræk og webservices (EBR)

Til toppen

Metode -

EjendomsbeliggenhedSimpel

Ejendomsbeliggenhed

Beskrivelse

Henter Beliggenhedsadressen Ejendomsbeliggenhed (herunder beliggenhedsadressen samt oplysning om administrativ ansvarlig kommune) tilknyttet en Bestemt Fast Ejendom performanceeffektivt, dvs. uden joins til andre registre.

KompleksitetKompleksTværgående tjenesteNejSLASe registrets tilgængelighed på Datafordeler.dk

.

Genereres på baggrund af Ejendomsbeliggenhedsregisteret på Datafordeleren.

Url	https://<endpoint>.datafordeler.dk/EBR/Ejendomsbeliggenhed/1/rest/EjendomsbeliggenhedSimpelEjendomsbeliggenhed?

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.

Datoformat følger ISO 8601 Date and time format.

Alle datoer skrives med andre ord i formatet yyyy-mm-ddTHH:MM:SS - eksempelvis 2018-06-26T17:23:00

Navn	Type	Beskrivelse	Default værdi
EBId	String (List)	Liste af Id for ejendomsbeliggenhed	NULL
BFEnr	Integer (List)	Liste af Bestemt Fast Ejendom numre	NULL
RegistreringstidFra	DateTime	Dato som angiver starten af en periodesøgning på registreringstid. Medtager alle elementer der er afregistreret efter dette tidspunkt.	NULL
RegistreringstidTil	DateTime	Dato som angiver slutningen af en periodesøgning på registreringstid. Medtager alle elementer der er registreret før dette tidspunkt.	NULL
VirkningstidFra	DateTime	Dato som angiver starten af en periodesøgning på virkningsstid. Medtager alle elementer hvis effekt ophørte efter dette tidspunkt.	NULL
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
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()
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()
Status	String	Status jf. modellens udfaldsrum	NULL

Outputparametre

Metode

Skema

Den inkluderede fil ”EBR_v2.8_EjendomsbeliggenhedSimpelEjendomsbeliggenhed.json” indeholder output som JSON-schema

EBR_v2.8_EjendomsbeliggenhedSimpelEjendomsbeliggenhed.jsonhttps://confluence.datafordeler.dk/pages/viewpage.action?pageId=13664914

Skema - filudtræk og webservices (EBR)

Til toppen

Metode -

BFEnrAdresse

EjendomsbeliggenhedSimpel

Beskrivelse

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

KompleksitetKompleksTværgående tjenesteJaSLASe registrets tilgængelighed på Datafordeler.dk

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

Url	https://<endpoint>.datafordeler.dk/EBR/Ejendomsbeliggenhed/1/rest/BFEnrAdresseEjendomsbeliggenhedSimpel?

Inputparametre

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

Listen må maksimalt indeholde 200 BFEnumre.

Datoformat følger ISO 8601 Date and time format.

Alle datoer skrives med andre ord i formatet yyyy-mm-ddTHH:MM:SS - eksempelvis 2018-06-26T17:23:00

Navn	Type	Beskrivelse	Default værdi
AdresseIdEBId	String (List)	Liste af lokalId UUID Id for DAR Adresseejendomsbeliggenhed	NULL
HusnummerIdBFEnr	String Integer (List)	Liste af lokalId UUID for DAR HusnummerBestemt Fast Ejendom numre	NULL
RegistreringstidFra	DateTime	Dato som angiver starten af en periodesøgning på registreringstid. Medtager alle elementer der er afregistreret efter dette tidspunkt.	NULL
RegistreringstidTil	DateTime	Dato som angiver slutningen af en periodesøgning på registreringstid. Medtager alle elementer der er registreret før dette tidspunkt.	NULL
VirkningstidFra	DateTime	Dato som angiver starten af en periodesøgning på virkningsstid. Medtager alle elementer hvis effekt ophørte efter dette tidspunkt.	NULL
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
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()
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()
Status	String	Status jf. modellens udfaldsrum	NULL

Outputparametre

” EBRBFEnrAdresseBFEnrAdressehttps://confluence.datafordeler.dk/pages/viewpage.action?pageId=13664914

Metode

Skema

Den inkluderede fil

”EBR_v2.8_

EjendomsbeliggenhedSimpel.json” indeholder output som JSON-schema

EBR_v2.8_

EjendomsbeliggenhedSimpel.json

Skema - filudtræk og webservices (EBR)

Til toppen

Page tree

Versions Compared

Old Version 4

New Version 5

Key

Ejendomsbeliggenhed (EBR)

REST - Ejendomsbeliggenhed

Oversigt over metoder

Metode -

BFEnrAdresse

Metode -

Ejendomsbeliggenhed

Metode -

EjendomsbeliggenhedSimpel