You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »


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




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? 
Eksempelhttps://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

FormatXML/JSON
Sikkerhedszone

0 – Indeholder ikke fortrolige eller følsomme data

Adgangsniveau

Alle kendte brugere må tilgå tjenesten

Adgangsbegrænsning

Ingen adgangsbegrænsning

Anvendt udstillingsmodelEjendomsbeliggenhed, Matrikel, DanmarksAdresseRegister, DAGI
REST-reglerAnvend paging. Default paging-størrelse: 20



Oversigt over metoder

Metodenavn

SLA kategori

Tværgående tjeneste

Ejendomsbeliggenhed

Kompleks

Ja

EjendomsbeliggenhedSimpel

Kompleks

Nej

BFEnrAdresse

Kompleks

Ja

SLA kategorier i produktion- maksimal svartid i sekunder:

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



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.

KompleksitetKompleks
Tværgående tjenesteJa
SLASe registrets tilgængelighed på Datafordeler.dk
Urlhttps://<endpoint>.datafordeler.dk/EBR/Ejendomsbeliggenhed/1/rest/Ejendomsbeliggenhed?


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

NavnTypeBeskrivelseDefault værdi

EBId

String (List)

Liste af Id for ejendomsbeliggenhed

NULL

BFEnr

Integer (List)

Liste af Bestemt Fast Ejendom numre

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 ”Ejendomsbeliggenhed.json” indeholder output som JSON-schema


Ejendomsbeliggenhed.json

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

Til toppen



Metode - EjendomsbeliggenhedSimpel

Beskrivelse

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

Returnerer altid den gældende beliggenhedsadresse pr. dags dato.

Der kan ikke hentes historiske oplysninger med denne metode.

KompleksitetKompleks
Tværgående tjenesteNej
SLASe registrets tilgængelighed på Datafordeler.dk
Urlhttps://<endpoint>.datafordeler.dk/EBR/Ejendomsbeliggenhed/1/rest/EjendomsbeliggenhedSimpel?


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

NavnTypeBeskrivelseDefault 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 ”EjendomsbeliggenhedSimpel.json” indeholder output som JSON-schema

EjendomsbeliggenhedSimpel.json

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


Til toppen



Metode - BFEnrAdresse

Beskrivelse

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


KompleksitetKompleks
Tværgående tjenesteJa
SLASe registrets tilgængelighed på Datafordeler.dk
Url

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


Inputparametre

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

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

NavnTypeBeskrivelseDefault værdi

AdresseId

String (List)

Liste af lokalId UUID for DAR Adresse

NULL

HusnummerId

String (List)

Liste af lokalId 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

Metode

Skema

Den inkluderede fil ” BFEnrAdresse.json” indeholder output som JSON-schema

BFEnrAdresse.json

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

Til toppen

  • No labels