- Created by Maria Klostermann Tapdrup, last modified by Martin Jensen on Mar 24, 2023
| Oprindelig kilde | WorkZone - 1442-0425 |
|---|---|
| Forfatter | Datafordeleren |
| Dato for oprettelse | May 07, 2019 |
| Version | 1.1 |
| Dato for seneste ændring - se beskrivelse i historik | Feb 02, 2023 |
Siden beskriver de REST tjenester, der udstilles på Datafordeleren fra Bygnings- og Boligregistret, BBR.
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.
Hent BBRs kodelister på Bygnings- og Boligregistret (BBR)s egen hjemmeside eller hent Kodelisten i Excel.
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/BBR/BBRPublic/1/rest/bbrsag?Bygning=xxxyxyxx-yyxx-xxxx-xxyy-yxxxyxyyxxyy&RegistreringFra=yyyy-mm-dd&RegistreringTil=yyyy-mm-dd&&username=xxx&password=yyy |
| Eksempel på url med certifikat | https://certservices.datafordeler.dk//BBR/BBRPublic/1/rest/bbrsag?Bygning=xxxyxyxx-yyxx-xxxx-xxyy-yxxxyxyyxxyy&RegistreringFra=yyyy-mm-dd&RegistreringTil=yyyy-mm-dd |
Generelt om intervalopslag
For REST servicene foretages der joins med andre tabeller, hvis data returneres som nestede objekter.
Input
Der kan foretages intervalopslag på tidsdimensionerne:
- RegistreringFra og RegistreringTil
- VirkningFra og VirkningTil
- DAFTimestampFra og DAFTimestampTil.
For tidsdimensioner, der ikke er angivet et interval for, kan der specificeres et tidspunkt ved at sætte fra- og til-tidspunkt til samme værdi.
Fx. hvis der er efterspurgt et virkningsinterval, så kan RegistreringFra og RegistreringTil sættes til et tidspunkt, hvor der som standard ellers ville blive brugt ”NOW( )”.
Se implementering af reglerne for intervalopslag under de enkelte REST metoder.
Output
Resultatet af et intervalopslag består af samtlige konfigurationer som den returnerede objektstruktur har haft i det forespurgte interval. Dette er simpelt for et objekt, der ingen nestede objekter har – da der således blot returneres de versioner af objektet der har eksisteret inden for det forespurgte interval.
Generelt for BBR webservices
| Registernavn i Selvbetjeningen | BBR |
|---|---|
| Format | XML/JSON |
| DLS version | 2.4.4 |
| Sikkerhedszone | 0 – Indeholder ikke fortrolige eller følsomme data |
| Adgangsbegrænsning | Ingen adgangsbegrænsning |
| Paging | Anvender paging. Default paging-størrelse: 100 |
| 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 - BBRPublic
| Anvendt udstillingsmodel | BBR |
|---|---|
| SLA | Se registrets tilgængelighed på Datafordeler.dk |
Metodeoversigt
Metodenavn | SLA kategorier | Tværgående tjeneste |
|---|---|---|
bbrsag | Kompleks | Nej |
bygning | Normal | Nej |
ejendomsrelation | Normal | Nej |
enhed | Normal | Nej |
grund | Normal | Nej |
tekniskanlaeg | Kompleks | Nej |
SLA kategorier i produktion- maksimal svartid i sekunder:
- Simpel: 0.09
- Normal: 1.0
- Kompleks: 2.5
Metode - bbrsag
Beskrivelse
Denne metode henter udstillede informationer om BBR sager, der er baseret på data fra BBR.
Eksempel på url med brugernavn/adgangskode
| https://services.datafordeler.dk/BBR/BBRPublic/1/rest/bbrsag?RegistreringFra=yyyy-mm-dd&RegistreringTil=yyyy-mm-dd&Id=xxxyxyxx-yyxx-xxxx-xxyy-yxxxyxyyxxyy&username=xxx&password=yyy |
Eksempel på url med certifikat
| https://certservices.datafordeler.dk//BBR/BBRPublic/1/rest/bbrsag?RegistreringFra=yyyy-mm-dd&RegistreringTil=yyyy-mm-dd&Id=xxxyxyxx-yyxx-xxxx-xxyy-yxxxyxyyxxyy |
Inputparametre
Ved intervalopslag er Id på BBRSag obligatorisk og et tidsinterval for enten registreringstid, virkningstid eller DAF opdateringstid.
Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
|---|---|---|---|---|
Id | List<UUID> | Identifikation af byggesagen igennem hele sin livscyklus | NULL | EAID_F8196C58_7115_48a6_9A1D_B49BC0F6289A.EAID_9AB90AE0_9F85_4164_9B25_8EB2139D65A5 |
VirkningFra | DateTime | Tidspunktet hvorfra den pågældende version af byggesagen har virkning | NOW() | EAID_A351A366_2F30_4c3f_B086_7FAA59339C5D |
VirkningTil | DateTime | Tidspunktet hvor virkningen af den pågældende version af byggesagen ophører | NOW() | EAID_47628A51_6589_4f1e_A19F_E9943A136AEC |
Virkningsaktoer | String | Den aktør der har afstedkommet virkningsegenskaberne for den pågældende version af byggesagen | NULL | EAID_59A458B1_5844_4fe3_95B1_C38AD3AAFAF4 |
RegistreringFra | DateTime | Tidspunktet hvor registreringen af den pågældendeversion af byggesagen er foretaget | NOW() | EAID_7A7F26D9_D5AE_4158_A7FF_3E6EF0B228D8 |
RegistreringTil | DateTime | Tidspunktet hvor en ny registrering på byggesagen er foretaget, og hvor denne version således ikke længere er den seneste. | NOW() | EAID_E718B937_950A_4ea1_BFA0_2AE9DB8C43AD |
Registreringsaktoer | String | Den aktør der har foretaget registreringen af den pågældende version af byggesagen | NULL | EAID_B3CCBA6B_52B2_4ddc_A751_ABEA39D6EE6B |
Status | List<String> | Byggesagens status i den pågældende version, dvs. byggesagens tilstand i den samlede livscyklus | NULL | EAID_6FAA8A1A_5BCF_4950_B220_F4AFCA7F35E3 |
Forretningsproces | String | Den forretningsproces, som afstedkom opdateringen af byggesagen til den pågældende version | NULL | EAID_E4132152_7923_4533_8529_5E8D8C937656 |
Forretningsomraade | String | Det forretningsområde som har opdateret byggesagen til den pågældende version | NULL | EAID_C91552B7_18C0_4e28_8B06_F60332A8776B |
Forretningshaendelse | String | Den forretningshændelse, som afstedkom opdateringen af byggesagen til den pågældende version | NULL | EAID_50066AF4_06D9_4f3a_BAC2_5F83ABF0E335 |
Kommunekode | String | Den kommune som byggesagen er registret i | NULL | EAID_C95C717A_752C_4b17_B647_850738975CAC |
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 | |
Bygning | UUID | NULL | ||
Enhed | UUID | NULL | ||
Etage | UUID | NULL | ||
Grund | UUID | NULL | ||
Opgang | UUID | NULL | ||
TekniskAnlaeg | UUID | NULL | ||
PeriodeaendringFra | DateTime | Tidspunkt hvor perioden med ændringer begynder. Kan kun benyttes i kombination med PeriodeaendringTil. | NULL | |
PeriodeaendringTil | DateTime | Tidspunkt hvor perioden med ændringer slutter. Kan kun benyttes i kombination med PeriodeaendringFra. | NULL | |
KunNyesteIPeriode | Boolean | Angives hvis man kun vil have de nye versioner af dataobjekterne. Kan kun benyttes i kombination med PeriodeaendringFra og PeriodeaendringTil. | FALSK |
Outputparametre
| Metode | Skema |
|---|---|
Den inkluderede fil ”BBR_2.4.4_BBRSag.schema.json” indeholder output som JSON-schema |
Metode - bygning
Beskrivelse
Denne metode henter udstillede informationer om bygninger, der er baseret på data fra BBR.
Eksempel på url med brugernavn/adgangskode
| https://services.datafordeler.dk/BBR/BBRPublic/1/rest/bygning?RegistreringFra=yyyy-mm-dd&RegistreringTil=yyyy-mm-dd&Id= xyxyxxxy-xxxy-xxxy-xxyx-xxxxxxyxxxxy&username=xxx&password=yyy |
Eksempel på url med certifikat
| https://certservices.datafordeler.dk//BBR/BBRPublic/1/rest/bygning?RegistreringFra=yyyy-mm-dd&RegistreringTil=yyyy-mm-dd&Id= xyxyxxxy-xxxy-xxxy-xxyx-xxxxxxyxxxxy |
Inputparametre
Ved intervalopslag er Id på Bygning obligatorisk og et tidsinterval for enten registreringstid, virkningstid eller DAF opdateringstid.
Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
|---|---|---|---|---|
Id | List<UUID> | Identifikation af bygværkselementet igennem hele dets livscyklus | NULL | EAID_F8196C58_7115_48a6_9A1D_B49BC0F6289A.EAID_9AB90AE0_9F85_4164_9B25_8EB2139D65A5 |
VirkningFra | DateTime | Tidspunktet hvorfra den pågældende version af bygværkselement har virkning | NOW() | EAID_A351A366_2F30_4c3f_B086_7FAA59339C5D |
VirkningTil | DateTime | Tidspunktet hvor virkningen af den pågældende version af bygværkselementet ophører | NOW() | EAID_47628A51_6589_4f1e_A19F_E9943A136AEC |
Virkningsaktoer | String | Den aktør der har afstedkommet virkningsegenskaberne for den pågældende version af bygværkselementet | NULL | EAID_59A458B1_5844_4fe3_95B1_C38AD3AAFAF4 |
RegistreringFra | DateTime | Tidspunktet hvor registreringen af den pågældendeversion af bygværkselementet er foretaget | NOW() | EAID_7A7F26D9_D5AE_4158_A7FF_3E6EF0B228D8 |
RegistreringTil | DateTime | Tidspunktet hvor en ny registrering på bygværkselementet er foretaget, og hvor denne version således ikke længere er den seneste. | NOW() | EAID_E718B937_950A_4ea1_BFA0_2AE9DB8C43AD |
Registreringsaktoer | String | Den aktør der har foretaget registreringen af den pågældende version af bygværkselementet | NULL | EAID_B3CCBA6B_52B2_4ddc_A751_ABEA39D6EE6B |
Status | List<String> | Bygværkselementets status i den pågældende version, dvs. elementets tilstand i den samlede livscyklus | NULL | EAID_6FAA8A1A_5BCF_4950_B220_F4AFCA7F35E3 |
Forretningsproces | String | Den forretningsproces, som afstedkom opdateringen af bygværkselementet til den pågældende version | NULL | EAID_E4132152_7923_4533_8529_5E8D8C937656 |
Forretningsomraade | String | Det forretningsområde som har opdateret bygværkselementet til den pågældende version | NULL | EAID_C91552B7_18C0_4e28_8B06_F60332A8776B |
Forretningshaendelse | String | Den forretningshændelse, som afstedkom opdateringen af bygværkselementet til den pågældende version | NULL | EAID_50066AF4_06D9_4f3a_BAC2_5F83ABF0E335 |
Kommunekode | String | Den kommune som bygværkselementet ligger i | NULL | EAID_C95C717A_752C_4b17_B647_850738975CAC |
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 | |
Etage | List<UUID> | BBR Etage ID | NULL | |
Fordelingsareal | UUID | BBR Fordelingsareal ID | NULL | |
Opgang | List<UUID> | BBR Opgang ID | NULL | |
TekniskAnlaeg | UUID | BBR TekniskAnlæg ID | NULL | |
Grund | UUID | BBR Grund ID | NULL | |
Jordstykke | Integer | MU Jordstykke ID | NULL | |
Ejendomsrelation | UUID | BBR Ejendomsrelation ID | NULL | |
Husnummer | UUID | DAR Husnummer ID | NULL | |
BFENummer | Integer | BFE-nummer Er bygningen af ejendomstypen Bygning På Fremmed Grund eller Ejerlejlighed kan BFE-nummer bruges som inputparameter. Er bygningen af ejendomstypen Samlet Fast Ejendom kan BFE-nummer ikke bruges som inputparameter. Det kun muligt at angive et BFE-nummer, som inputparameter, i forespørgslen. Det betyder, at du ikke kan forespørge på en liste af BFE-numre, hvor flere BFE-numre i listen adskilles af et ”|”-tegn (pipe karakter). | 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 | |
PeriodeaendringFra | DateTime | Tidspunkt hvor perioden med ændringer begynder. Kan kun benyttes i kombination med PeriodeaendringTil. | NULL | |
PeriodeaendringTil | DateTime | Tidspunkt hvor perioden med ændringer slutter. Kan kun benyttes i kombination med PeriodeaendringFra. | NULL | |
KunNyesteIPeriode | Boolean | Angives hvis man kun vil have de nye versioner af dataobjekterne. Kan kun benyttes i kombination med PeriodeaendringFra og PeriodeaendringTil. | FALSK |
Outputparametre
| Metode | Skema |
|---|---|
| Den inkluderede fil ”BBR_2.4.4_Bygning.schema.json” indeholder output som JSON-schema | Skema - filudtræk og webservices (BBR) |
Metode - ejendomsrelation
Beskrivelse
Denne metode henter udstillede informationer om ejendomsrelationer, der er baseret på data fra BBR.
Eksempel på url med brugernavn/adgangskode
| https://services.datafordeler.dk/BBR/BBRPublic/1/rest/ejendomsrelation?RegistreringFra=yyyy-mm-dd&RegistreringTil=yyyy-mm-dd&username=xxx&password=yyy |
Eksempel på url med certifikat
| https://certservices.datafordeler.dk//BBR/BBRPublic/1/rest/ejendomsrelation?RegistreringFra=yyyy-mm-dd&RegistreringTil=yyyy-mm-dd |
Inputparametre
Ved intervalopslag kan der søges på én eller flere tidsintervaller samtidig, registreringstid, virkningstid og DAF opdateringstid.
Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
|---|---|---|---|---|
Id | List<UUID> | Identifikation af ejendomsrelationen igennem hele sin livscyklus | NULL | EAID_F8196C58_7115_48a6_9A1D_B49BC0F6289A.EAID_9AB90AE0_9F85_4164_9B25_8EB2139D65A5 |
VirkningFra | DateTime | Tidspunktet hvorfra den pågældende version af ejendomsrelationen har virkning | NOW() | EAID_A351A366_2F30_4c3f_B086_7FAA59339C5D |
VirkningTil | DateTime | Tidspunktet hvor virkningen af den pågældende version af ejendomsrelationen ophører | NOW() | EAID_47628A51_6589_4f1e_A19F_E9943A136AEC |
Virkningsaktoer | String | Den aktør der har afstedkommet virkningsegenskaberne for den pågældende version af ejendomsrelationen | NULL | EAID_59A458B1_5844_4fe3_95B1_C38AD3AAFAF4 |
RegistreringFra | DateTime | Tidspunktet hvor registreringen af den pågældendeversion af ejendomsrelationen er foretaget | NOW() | EAID_7A7F26D9_D5AE_4158_A7FF_3E6EF0B228D8 |
RegistreringTil | DateTime | Tidspunktet hvor en ny registrering på ejendomsrelationen er foretaget, og hvor denne version således ikke længere er den seneste. | NOW() | EAID_E718B937_950A_4ea1_BFA0_2AE9DB8C43AD |
Registreringsaktoer | String | Den aktør der har foretaget registreringen af den pågældende version af ejendomsrelationen | NULL | EAID_B3CCBA6B_52B2_4ddc_A751_ABEA39D6EE6B |
Status | List<String> | Ejendomsrelationens status i den pågældende version, dvs. ejendomsrelationens tilstand i den samlede livscyklus | NULL | EAID_6FAA8A1A_5BCF_4950_B220_F4AFCA7F35E3 |
Forretningsproces | String | Den forretningsproces, som afstedkom opdateringen af ejendomsrelationen til den pågældende version | NULL | EAID_E4132152_7923_4533_8529_5E8D8C937656 |
Forretningsomraade | String | Det forretningsområde som har opdateret ejendomsrelationen til den pågældende version | NULL | EAID_C91552B7_18C0_4e28_8B06_F60332A8776B |
Forretningshaendelse | String | Den forretningshændelse, som afstedkom opdateringen af ejendomsrelationen til den pågældende version | NULL | EAID_50066AF4_06D9_4f3a_BAC2_5F83ABF0E335 |
Kommunekode | String | Den kommune som ejendomsrelationen er registreret i | NULL | EAID_C95C717A_752C_4b17_B647_850738975CAC |
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 | |
BFENummer | Integer | BFE-nummer er altid én af følgende tre ejendomstyper:
Et BFE-nummer kan altid kun være én ejendomstype, dvs SFE, BPFG eller Ejerlejlighed. Et BFE-nummer kan aldrig være fx både SFE og BPFG. Det kun muligt at angive et BFE-nummer, som inputparameter, i forespørgslen. Det betyder, at du ikke kan forespørge på en liste af BFE-numre, hvor flere BFE-numre i listen adskilles af et ”|”-tegn (pipe karakter). | NULL | |
BPFG | Integer | MU BygningPåFremmedGrund ID | NULL | |
Ejerforholdskode | String | Ejerforholdskode | NULL | |
Ejerlejlighed | Integer | MU Ejerlejlighed ID | NULL | |
Ejendomsnummer | Integer | Ejendomsnummer Ejendomsnummeret er en fortløbende nummerrække indenfor hver kommune. Dvs at et Ejendomsnummer kun er unikt på landsplan, når det kombineres med Kommunekode. | NULL | |
SamletFastEjendom | Integer | MU SamletFastEjendom ID | NULL | |
Vurderingsejendomsnummer | Integer | Vurderingsejendomsnummer | NULL | |
PeriodeaendringFra | DateTime | Tidspunkt hvor perioden med ændringer begynder. Kan kun benyttes i kombination med PeriodeaendringTil. | NULL | |
PeriodeaendringTil | DateTime | Tidspunkt hvor perioden med ændringer slutter. Kan kun benyttes i kombination med PeriodeaendringFra. | NULL | |
KunNyesteIPeriode | Boolean | Angives hvis man kun vil have de nye versioner af dataobjekterne. Kan kun benyttes i kombination med PeriodeaendringFra og PeriodeaendringTil. | FALSK |
Outputparametre
| Metode | Skema |
|---|---|
Den inkluderede fil ”BBR_2.4.4_Ejendomsrelation.schema.json” indeholder output som JSON-schema |
Metode - enhed
Beskrivelse
Denne metode henter udstillede informationer om enheder, der er baseret på data fra BBR.
Eksempel på url med brugernavn/adgangskode
| https://services.datafordeler.dk/BBR/BBRPublic/1/rest/enhed?RegistreringFra=yyyy-mm-dd&RegistreringTil=yyyy-mm-dd&username=xxx&password=yyy |
Eksempel på url med certifikat
| https://certservices.datafordeler.dk//BBR/BBRPublic/1/rest/enhed?RegistreringFra=yyyy-mm-dd&RegistreringTil=yyyy-mm-dd& |
Inputparametre
Ved intervalopslag kan der søges på én eller flere tidsintervaller samtidig, registreringstid, virkningstid og DAF opdateringstid.
Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
|---|---|---|---|---|
Id | List<UUID> | Identifikation af enheden igennem hele sin livscyklus | NULL | EAID_F8196C58_7115_48a6_9A1D_B49BC0F6289A.EAID_9AB90AE0_9F85_4164_9B25_8EB2139D65A5 |
VirkningFra | DateTime | Tidspunktet hvorfra den pågældende version af enheden har virkning | NOW() | EAID_A351A366_2F30_4c3f_B086_7FAA59339C5D |
VirkningTil | DateTime | Tidspunktet hvor virkningen af den pågældende version af enheden ophører | NOW() | EAID_47628A51_6589_4f1e_A19F_E9943A136AEC |
Virkningsaktoer | String | Den aktør der har afstedkommet virkningsegenskaberne for den pågældende version af enheden | NULL | EAID_59A458B1_5844_4fe3_95B1_C38AD3AAFAF4 |
RegistreringFra | DateTime | Tidspunktet hvor registreringen af den pågældendeversion af enheden er foretaget | NOW() | EAID_7A7F26D9_D5AE_4158_A7FF_3E6EF0B228D8 |
RegistreringTil | DateTime | Tidspunktet hvor en ny registrering på enheden er foretaget, og hvor denne version således ikke længere er den seneste. | NOW() | EAID_E718B937_950A_4ea1_BFA0_2AE9DB8C43AD |
Registreringsaktoer | String | Den aktør der har foretaget registreringen af den pågældende version af enheden | NULL | EAID_B3CCBA6B_52B2_4ddc_A751_ABEA39D6EE6B |
Status | List<String> | Enhedens status i den pågældende version, dvs. enhedens tilstand i den samlede livscyklus | NULL | EAID_6FAA8A1A_5BCF_4950_B220_F4AFCA7F35E3 |
Forretningsproces | String | Den forretningsproces, som afstedkom opdateringen af enheden til den pågældende version | NULL | EAID_E4132152_7923_4533_8529_5E8D8C937656 |
Forretningsomraade | String | Det forretningsområde som har opdateret enheden til den pågældende version | NULL | EAID_C91552B7_18C0_4e28_8B06_F60332A8776B |
Forretningshaendelse | String | Den forretningshændelse, som afstedkom opdateringen af enheden til den pågældende version | NULL | EAID_50066AF4_06D9_4f3a_BAC2_5F83ABF0E335 |
Kommunekode | String | Den kommune som enheden ligger i | NULL | EAID_C95C717A_752C_4b17_B647_850738975CAC |
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 | |
BFENummer | Integer | BFE-nummer Er enheden af ejendomstypen Ejerlejlighed kan BFE-nummer bruges som inputparameter. Er enheden af ejendomstypen Samlet Fast Ejendom eller Bygning På Fremmed Grund kan BFE-nummer ikke bruges som inputparameter. Det kun muligt at angive et BFE-nummer, som inputparameter, i forespørgslen. Det betyder, at du ikke kan forespørge på en liste af BFE-numre, hvor flere BFE-numre i listen adskilles af et ”|”-tegn (pipe karakter). | NULL | |
Etage | List<UUID> | BBR Etage ID | NULL | |
Fordelingsareal | UUID | BBR Fordelingsareal ID | NULL | |
Opgang | List<UUID> | BBR Opgang ID | NULL | |
TekniskAnlaeg | List<UUID> | BBR TekniskAnlæg ID | NULL | |
Ejendomsrelation | UUID | BBR Ejendomsrelation ID | NULL | |
AdresseIdentificerer | UUID | DAR Adresse ID | NULL | |
Bygning | List<UUID> | BBR Bygning ID | NULL | |
PeriodeaendringFra | DateTime | Tidspunkt hvor perioden med ændringer begynder. Kan kun benyttes i kombination med PeriodeaendringTil. | NULL | |
PeriodeaendringTil | DateTime | Tidspunkt hvor perioden med ændringer slutter. Kan kun benyttes i kombination med PeriodeaendringFra. | NULL | |
KunNyesteIPeriode | Boolean | Angives hvis man kun vil have de nye versioner af dataobjekterne. Kan kun benyttes i kombination med PeriodeaendringFra og PeriodeaendringTil. | FALSK |
Outputparametre
| Metode | Skema |
|---|---|
| Den inkluderede fil ”BBR_2.4.4_Enhed.schema.json” indeholder output som JSON-schema | Skema - filudtræk og webservices (BBR) |
Metode - grund
Beskrivelse
Denne metode henter udstillede informationer om grunde, der er baseret på data fra BBR.
Eksempel på url med brugernavn/adgangskode
| https://services.datafordeler.dk/BBR/BBRPublic/1/rest/grund?RegistreringFra=yyyy-mm-dd&RegistreringTil=yyyy-mm-dd&VirkningFra=yyyy-mm-dd&VirkningTil=yyyy-mm-dd&username=xxx&password=yyy |
Eksempel på url med certifikat
| https://certservices.datafordeler.dk//BBR/BBRPublic/1/rest/grund?RegistreringFra=yyyy-mm-dd&RegistreringTil=yyyy-mm-dd&VirkningFra=yyyy-mm-dd&VirkningTil=yyyy-mm-dd |
Inputparametre
Ved intervalopslag kan der søges på én eller flere tidsintervaller samtidig, registreringstid, virkningstid og DAF opdateringstid.
Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
|---|---|---|---|---|
Id | List<UUID> | Identifikation af grunden igennem hele sin livscyklus | NULL | EAID_F8196C58_7115_48a6_9A1D_B49BC0F6289A.EAID_9AB90AE0_9F85_4164_9B25_8EB2139D65A5 |
VirkningFra | DateTime | Tidspunktet hvorfra den pågældende version af grunden har virkning | NOW() | EAID_A351A366_2F30_4c3f_B086_7FAA59339C5D |
VirkningTil | DateTime | Tidspunktet hvor virkningen af den pågældende version af grunden ophører | NOW() | EAID_47628A51_6589_4f1e_A19F_E9943A136AEC |
Virkningsaktoer | String | Den aktør der har afstedkommet virkningsegenskaberne for den pågældende version af grunden | NULL | EAID_59A458B1_5844_4fe3_95B1_C38AD3AAFAF4 |
RegistreringFra | DateTime | Tidspunktet hvor registreringen af den pågældendeversion af grunden er foretaget | NOW() | EAID_7A7F26D9_D5AE_4158_A7FF_3E6EF0B228D8 |
RegistreringTil | DateTime | Tidspunktet hvor en ny registrering på grunden er foretaget, og hvor denne version således ikke længere er den seneste. | NOW() | EAID_E718B937_950A_4ea1_BFA0_2AE9DB8C43AD |
Registreringsaktoer | String | Den aktør der har foretaget registreringen af den pågældende version af grunden | NULL | EAID_B3CCBA6B_52B2_4ddc_A751_ABEA39D6EE6B |
Status | List<String> | Grundens status i den pågældende version, dvs. grundens tilstand i den samlede livscyklus | NULL | EAID_6FAA8A1A_5BCF_4950_B220_F4AFCA7F35E3 |
Forretningsproces | String | Den forretningsproces, som afstedkom opdateringen af grunden til den pågældende version | NULL | EAID_E4132152_7923_4533_8529_5E8D8C937656 |
Forretningsomraade | String | Det forretningsområde som har opdateret grunden til den pågældende version | NULL | EAID_C91552B7_18C0_4e28_8B06_F60332A8776B |
Forretningshaendelse | String | Den forretningshændelse, som afstedkom opdateringen af grunden til den pågældende version | NULL | EAID_50066AF4_06D9_4f3a_BAC2_5F83ABF0E335 |
Kommunekode | String | Den kommune som grunden er registret i | NULL | EAID_C95C717A_752C_4b17_B647_850738975CAC |
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 | |
BFENummer | Integer | BFE-nummer En grund er altid af ejendomstypen Samlet Fast Ejendom. Kun BFE-numre af ejendomstypen Samlet Fast Ejendom kan bruges som inputparameter. Det kun muligt at angive et BFE-nummer, som inputparameter, i forespørgslen. Det betyder, at du ikke kan forespørge på en liste af BFE-numre, hvor flere BFE-numre i listen adskilles af et ”|”-tegn (pipe karakter). | NULL | |
Bygning | UUID | BBR Bygning ID | NULL | |
TekniskAnlaeg | UUID | BBR TekniskAnlæg ID | NULL | |
Ejendomsrelation | UUID | BBR Ejendomsrelation ID | NULL | |
Jordstykke | Integer | MU Jordstykke ID | NULL | |
Husnummer | List<UUID> | DAR Husnummer ID | NULL | |
PeriodeaendringFra | DateTime | Tidspunkt hvor perioden med ændringer begynder. Kan kun benyttes i kombination med PeriodeaendringTil. | NULL | |
PeriodeaendringTil | DateTime | Tidspunkt hvor perioden med ændringer slutter. Kan kun benyttes i kombination med PeriodeaendringFra. | NULL | |
KunNyesteIPeriode | Boolean | Angives hvis man kun vil have de nye versioner af dataobjekterne. Kan kun benyttes i kombination med PeriodeaendringFra og PeriodeaendringTil. | FALSK |
Outputparametre
| Metode | Skema |
|---|---|
Den inkluderede fil ”BBR_2.4.4_Grund.schema.json” indeholder output som JSON-schema |
Metode - tekniskanlaeg
Beskrivelse
Denne metode henter udstillede informationer om tekniske anlæg, der er baseret på data fra BBR.
Eksempel på url med brugernavn/adgangskode
| https://services.datafordeler.dk/BBR/BBRPublic/1/rest/tekniskanlaeg?RegistreringFra=yyyy-mm-dd&RegistreringTil=yyyy-mm-dd&Bygning=xxxyxyxx-yyxx-xxxx-xxyy-yxxxyxyyxxyy&username=xxx&password=yyy |
Eksempel på url med certifikat
| https://certservices.datafordeler.dk//BBR/BBRPublic/1/rest/tekniskanlaeg?RegistreringFra=yyyy-mm-dd&RegistreringTil=yyyy-mm-dd&Bygning=xxxyxyxx-yyxx-xxxx-xxyy-yxxxyxyyxxyy |
Inputparametre
Ved intervalopslag kan der søges på én eller flere tidsintervaller samtidig, registreringstid, virkningstid og DAF opdateringstid.
Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
|---|---|---|---|---|
Id | List<UUID> | Identifikation af det tekniske anlæg igennem hele dets livscyklus | NULL | EAID_F8196C58_7115_48a6_9A1D_B49BC0F6289A.EAID_9AB90AE0_9F85_4164_9B25_8EB2139D65A5 |
VirkningFra | DateTime | Tidspunktet hvorfra den pågældende version af det tekniske anlæg har virkning | NOW() | EAID_A351A366_2F30_4c3f_B086_7FAA59339C5D |
VirkningTil | DateTime | Tidspunktet hvor virkningen af den pågældende version af det tekniske anlæg ophører | NOW() | EAID_47628A51_6589_4f1e_A19F_E9943A136AEC |
Virkningsaktoer | String | Den aktør der har afstedkommet virkningsegenskaberne for den pågældende version af det tekniske anlæg | NULL | EAID_59A458B1_5844_4fe3_95B1_C38AD3AAFAF4 |
RegistreringFra | DateTime | Tidspunktet hvor registreringen af den pågældende version af det tekniske anlæg er foretaget | NOW() | EAID_7A7F26D9_D5AE_4158_A7FF_3E6EF0B228D8 |
RegistreringTil | DateTime | Tidspunktet hvor en ny registrering på det tekniske anlæg er foretaget, og hvor denne version således ikke længere er den seneste. | NOW() | EAID_E718B937_950A_4ea1_BFA0_2AE9DB8C43AD |
Registreringsaktoer | String | Den aktør der har foretaget registreringen af den pågældende version af det tekniske anlæg | NULL | EAID_B3CCBA6B_52B2_4ddc_A751_ABEA39D6EE6B |
Status | List<String> | Det tekniske anlægs status i den pågældende version, dvs. det tekniske anlægs tilstand i den samlede livscyklus | NULL | EAID_6FAA8A1A_5BCF_4950_B220_F4AFCA7F35E3 |
Forretningsproces | String | Den forretningsproces, som afstedkom opdateringen af det tekniske anlæg til den pågældende version | NULL | EAID_E4132152_7923_4533_8529_5E8D8C937656 |
Forretningsomraade | String | Det forretningsområde som har opdateret det tekniske anlæg til den pågældende version | NULL | EAID_C91552B7_18C0_4e28_8B06_F60332A8776B |
Forretningshaendelse | String | Den forretningshændelse, som afstedkom opdateringen af det tekniske anlæg til den pågældende version | NULL | EAID_50066AF4_06D9_4f3a_BAC2_5F83ABF0E335 |
Kommunekode | String | Den kommune som det tekniske anlæg er registret i | NULL | EAID_C95C717A_752C_4b17_B647_850738975CAC |
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 | |
Jordstykke | Integer | MU Jordstykke ID | NULL | |
Ejendomsrelation | UUID | BBR Ejendomsrelation ID | NULL | |
Husnummer | UUID | DAR Husnummer ID | NULL | |
Bygning | UUID | BBR Bygning ID | NULL | |
Enhed | UUID | BBR Enhed ID | NULL | |
Grund | UUID | BBR Grund ID | NULL | |
BFENummer | Integer | BFE-nummer Er dit BFE-nummer af ejendomstypen Bygning På Fremmed Grund eller Ejerlejlighed og indeholder den teknisk anlæg kan BFE-nummer bruges som inputparameter. Er dit BFE-nummer af ejendomstypen Samlet Fast Ejendom kan BFE-nummer ikke bruges som inputparameter. Det kun muligt at angive et BFE-nummer, som inputparameter, i forespørgslen. Det betyder, at du ikke kan forespørge på en liste af BFE-numre, hvor flere BFE-numre i listen adskilles af et ”|”-tegn (pipe karakter). | 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 | |
PeriodeaendringFra | DateTime | Tidspunkt hvor perioden med ændringer begynder. Kan kun benyttes i kombination med PeriodeaendringTil. | NULL | |
PeriodeaendringTil | DateTime | Tidspunkt hvor perioden med ændringer slutter. Kan kun benyttes i kombination med PeriodeaendringFra. | NULL | |
KunNyesteIPeriode | Boolean | Angives hvis man kun vil have de nye versioner af dataobjekterne. Kan kun benyttes i kombination med PeriodeaendringFra og PeriodeaendringTil. | FALSK |
Outputparametre
| Metode | Skema |
|---|---|
| Den inkluderede fil ”BBR_2.4.4_TekniskAnlæg.schema.json” indeholder output som JSON-schema | Skema - filudtræk og webservices (BBR) |