Webservices (BBR)

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.

Til toppen

Url-struktur for REST services	<endpoint>/register/service/version/servicetype/metode?
Eksempel til produktion	https://s5-certservices.datafordeler.dk/BBR/BBR/1/REST/bygning?

Generelt om intervalopslag

For REST servicene foretages der joins med andre tabeller, hvis data returneres som nestede objekter.

Input

Der kan laves intervalopslag på en tidsdimension ad gangen og altid sammen med et ID for det ønskede objekt.

Dette betyder for eksempel, at når der modtages en hændelse om at et objekt er ændret, giver et intervalopslag mulighed for at hente hvordan objektet ser ud i alle dets nye virkningsperioder ud fra dets ID og et registreringstidspunkt.

Input skal for intervalopslag således altid indeholde:

Et ID på hovedentitet der spørges på:
- Bygning
- Grund
- Enhed
- TekniskAnlæg
- BBRSag
- Ejendomsrelation
Et interval for enten registreringstid (RegistreringFra og RegistreringTil), virkningstid (VirkningFra og VirkningTil) eller DAF opdateringstid (DAFTimestampFra og DAFTimestampTil).
- Der må kun angives et interval for én af tidsdimensionerne i et intervalopslag.
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( )”.

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.

Til toppen

Generelt for BBR webservices

Format	XML/JSON
Sikkerhedszone	5 – Indeholder fortrolige eller følsomme data.
Adgangsbegrænsning	Alle brugere skal IP-whitelistes for at få adgang til tjenesten
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)

Til toppen

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.

Url

<endpoint>/BBR/BBR/1/rest/ bbrsag?

Inputparametre

Navn	Type	Beskrivelse	Default værdi
Id	List<UUID>	Identifikation af bygværkselementet igennem hele dets livscyklus	NULL
VirkningFra	DateTime	Tidspunktet hvorfra den pågældende version af bygværkselement har virkning	NOW()
VirkningTil	DateTime	Tidspunktet hvor virkningen af den pågældende version af bygværkselementet ophører	NOW()
Virkningsaktoer	String	Den aktør der har afstedkommet virkningsegenskaberne for den pågældende version af bygværkselementet	NULL
RegistreringFra	DateTime	Tidspunktet hvor registreringen af den pågældendeversion af bygværkselementet er foretaget	NOW()
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()
Registreringsaktoer	String	Den aktør der har foretaget registreringen af den pågældende version af bygværkselementet	NULL
Status	List<String>	Bygværkselementets status i den pågældende version, dvs. elementets tilstand i den samlede livscyklus	NULL
Forretningsproces	String	Den forretningsproces, som afstedkom opdateringen af bygværkselementet til den pågældende version	NULL
Forretningsomraade	String	Det forretningsområde som har opdateret bygværkselementet til den pågældende version	NULL
Forretningshaendelse	String	Den forretningshændelse, som afstedkom opdateringen af bygværkselementet til den pågældende version	NULL
Kommunekode	String	Den kommune som bygværkselementet ligger i	NULL
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 ” BBRSag.schema.json” indeholder output som JSON-schema	Skema - filudtræk og webservices (BBR)

Til toppen

Metode - bygning

Beskrivelse

Denne metode henter udstillede informationer om bygninger, der er baseret på data fra BBR.

Url

<endpoint>/BBR/BBR/1/rest/ bygning?

Inputparametre

Navn	Type	Beskrivelse	Default værdi
Id	List<UUID>	Identifikation af bygværkselementet igennem hele dets livscyklus	NULL
VirkningFra	DateTime	Tidspunktet hvorfra den pågældende version af bygværkselement har virkning	NOW()
VirkningTil	DateTime	Tidspunktet hvor virkningen af den pågældende version af bygværkselementet ophører	NOW()
Virkningsaktoer	String	Den aktør der har afstedkommet virkningsegenskaberne for den pågældende version af bygværkselementet	NULL
RegistreringFra	DateTime	Tidspunktet hvor registreringen af den pågældendeversion af bygværkselementet er foretaget	NOW()
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()
Registreringsaktoer	String	Den aktør der har foretaget registreringen af den pågældende version af bygværkselementet	NULL
Status	List<String>	Bygværkselementets status i den pågældende version, dvs. elementets tilstand i den samlede livscyklus	NULL
Forretningsproces	String	Den forretningsproces, som afstedkom opdateringen af bygværkselementet til den pågældende version	NULL
Forretningsomraade	String	Det forretningsområde som har opdateret bygværkselementet til den pågældende version	NULL
Forretningshaendelse	String	Den forretningshændelse, som afstedkom opdateringen af bygværkselementet til den pågældende version	NULL
Kommunekode	String	Den kommune som bygværkselementet ligger i	NULL
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	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 ”Bygning.schema.json” indeholder output som JSON-schema	Skema - filudtræk og webservices (BBR)

Til toppen

Metode - ejendomsrelation

Beskrivelse

Denne metode henter udstillede informationer om ejendomsrelationer, der er baseret på data fra BBR.

Url

<endpoint>/BBR/BBR/1/rest/ ejendomsrelation?

Inputparametre

Navn	Type	Beskrivelse	Default værdi
Id	List<UUID>	Identifikation af bygværkselementet igennem hele dets livscyklus	NULL
VirkningFra	DateTime	Tidspunktet hvorfra den pågældende version af bygværkselement har virkning	NOW()
VirkningTil	DateTime	Tidspunktet hvor virkningen af den pågældende version af bygværkselementet ophører	NOW()
Virkningsaktoer	String	Den aktør der har afstedkommet virkningsegenskaberne for den pågældende version af bygværkselementet	NULL
RegistreringFra	DateTime	Tidspunktet hvor registreringen af den pågældendeversion af bygværkselementet er foretaget	NOW()
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()
Registreringsaktoer	String	Den aktør der har foretaget registreringen af den pågældende version af bygværkselementet	NULL
Status	List<String>	Bygværkselementets status i den pågældende version, dvs. elementets tilstand i den samlede livscyklus	NULL
Forretningsproces	String	Den forretningsproces, som afstedkom opdateringen af bygværkselementet til den pågældende version	NULL
Forretningsomraade	String	Det forretningsområde som har opdateret bygværkselementet til den pågældende version	NULL
Forretningshaendelse	String	Den forretningshændelse, som afstedkom opdateringen af bygværkselementet til den pågældende version	NULL
Kommunekode	String	Den kommune som bygværkselementet ligger i	NULL
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	NULL
BPFG	Integer	MU BygningPåFremmedGrund ID	NULL
Ejerforholdskode	String	Ejerforholdskode	NULL
Ejerlejlighed	Integer	MU Ejerlejlighed ID	NULL
Ejendomsnummer	Integer	Ejendomsnummer	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 ”Ejendomsrelation.schema.json” indeholder output som JSON-schema	Skema - filudtræk og webservices (BBR)

Til toppen

Metode - enhed

Beskrivelse

Denne metode henter udstillede informationer om enheder, der er baseret på data fra BBR.

Url

<endpoint>/BBR/BBR/1/rest/ enhed?

Inputparametre

Navn	Type	Beskrivelse	Default værdi
Id	List<UUID>	Identifikation af bygværkselementet igennem hele dets livscyklus	NULL
VirkningFra	DateTime	Tidspunktet hvorfra den pågældende version af bygværkselement har virkning	NOW()
VirkningTil	DateTime	Tidspunktet hvor virkningen af den pågældende version af bygværkselementet ophører	NOW()
Virkningsaktoer	String	Den aktør der har afstedkommet virkningsegenskaberne for den pågældende version af bygværkselementet	NULL
RegistreringFra	DateTime	Tidspunktet hvor registreringen af den pågældendeversion af bygværkselementet er foretaget	NOW()
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()
Registreringsaktoer	String	Den aktør der har foretaget registreringen af den pågældende version af bygværkselementet	NULL
Status	List<String>	Bygværkselementets status i den pågældende version, dvs. elementets tilstand i den samlede livscyklus	NULL
Forretningsproces	String	Den forretningsproces, som afstedkom opdateringen af bygværkselementet til den pågældende version	NULL
Forretningsomraade	String	Det forretningsområde som har opdateret bygværkselementet til den pågældende version	NULL
Forretningshaendelse	String	Den forretningshændelse, som afstedkom opdateringen af bygværkselementet til den pågældende version	NULL
Kommunekode	String	Den kommune som bygværkselementet ligger i	NULL
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	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 ” Enhed.schema.json” indeholder output som JSON-schema	Skema - filudtræk og webservices (BBR)

Til toppen

Metode - grund

Beskrivelse

Denne metode henter udstillede informationer om grunde, der er baseret på data fra BBR.

Url

<endpoint>/BBR/BBR/1/rest/grund?

Inputparametre

Navn	Type	Beskrivelse	Default værdi
Id	List<UUID>	Identifikation af bygværkselementet igennem hele dets livscyklus	NULL
VirkningFra	DateTime	Tidspunktet hvorfra den pågældende version af bygværkselement har virkning	NOW()
VirkningTil	DateTime	Tidspunktet hvor virkningen af den pågældende version af bygværkselementet ophører	NOW()
Virkningsaktoer	String	Den aktør der har afstedkommet virkningsegenskaberne for den pågældende version af bygværkselementet	NULL
RegistreringFra	DateTime	Tidspunktet hvor registreringen af den pågældendeversion af bygværkselementet er foretaget	NOW()
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()
Registreringsaktoer	String	Den aktør der har foretaget registreringen af den pågældende version af bygværkselementet	NULL
Status	List<String>	Bygværkselementets status i den pågældende version, dvs. elementets tilstand i den samlede livscyklus	NULL
Forretningsproces	String	Den forretningsproces, som afstedkom opdateringen af bygværkselementet til den pågældende version	NULL
Forretningsomraade	String	Det forretningsområde som har opdateret bygværkselementet til den pågældende version	NULL
Forretningshaendelse	String	Den forretningshændelse, som afstedkom opdateringen af bygværkselementet til den pågældende version	NULL
Kommunekode	String	Den kommune som bygværkselementet ligger i	NULL
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	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 ”grund” indeholder output som JSON-schema	Skema - filudtræk og webservices (BBR)

Til toppen

Metode - tekniskanlaeg

Beskrivelse

Denne metode henter udstillede informationer om tekniske anlæg, der er baseret på data fra BBR.

Url

<endpoint>/BBR/BBR/1/rest/ tekniskanlaeg?

Inputparametre

Navn	Type	Beskrivelse	Default værdi
Id	List<UUID>	Identifikation af bygværkselementet igennem hele dets livscyklus	NULL
VirkningFra	DateTime	Tidspunktet hvorfra den pågældende version af bygværkselement har virkning	NOW()
VirkningTil	DateTime	Tidspunktet hvor virkningen af den pågældende version af bygværkselementet ophører	NOW()
Virkningsaktoer	String	Den aktør der har afstedkommet virkningsegenskaberne for den pågældende version af bygværkselementet	NULL
RegistreringFra	DateTime	Tidspunktet hvor registreringen af den pågældendeversion af bygværkselementet er foretaget	NOW()
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()
Registreringsaktoer	String	Den aktør der har foretaget registreringen af den pågældende version af bygværkselementet	NULL
Status	List<String>	Bygværkselementets status i den pågældende version, dvs. elementets tilstand i den samlede livscyklus	NULL
Forretningsproces	String	Den forretningsproces, som afstedkom opdateringen af bygværkselementet til den pågældende version	NULL
Forretningsomraade	String	Det forretningsområde som har opdateret bygværkselementet til den pågældende version	NULL
Forretningshaendelse	String	Den forretningshændelse, som afstedkom opdateringen af bygværkselementet til den pågældende version	NULL
Kommunekode	String	Den kommune som bygværkselementet ligger i	NULL
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	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 ” TekniskAnlæg.schema.json” indeholder output som JSON-schema	Skema - filudtræk og webservices (BBR)

Til toppen

Anvendt udstillingsmodel	BBR
REST-regler	Anvend paging. Default paging-størrelse: 100
SLA	Se registrets tilgængelighed på Datafordeler.dk

Page tree

Generelt om intervalopslag

Generelt for BBR webservices

REST - BBR

Metode - bbrsag

Metode - bygning

Metode - ejendomsrelation

Metode - enhed

Metode - grund

Metode - tekniskanlaeg

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