Webservices (BBR) Siden beskriver de tjenester, der udstilles på Datafordeleren fra Bygnings- og Boligregistret, BBR.

Transkript

1 Websvices (BBR) Siden beskriv de tjenest, d udstilles på Datafordelen fra Bygnings- og Boligregistret, BBR. Få en introduktion til Websvice på Datafordelen (REST), hvis du har brug for en introduktion til og vejledning i, hvordan man kan anvende websvices, som udstilles på Datafordelen. Få en guide til helt konkrete anvisning til at bruge en websvice fra Datafordelen i Guide til websvice på Selvbetjeningen (REST). Genelt for BBR websvices REST - BBR Metode - bbrsag Metode - bygning Metode - ejendomsrelation Metode - enhed Metode - grund Metode - tekniskanlaeg Url opbygning for REST Url for de enkelte svices opbygget af et endpoint eftfulgt af registnavn, svicenavn, vsionen af svicen, svicetype (REST ell WFS etc.) samt metodenavn for REST svices. Eft? tilføjes parametre i kaldet, d kan indeholde genelle kaldeparametre for REST svices og metode specifikke parametre. Endpointet indehold værtsnavnet, med et præfiks for miljøet hvis det ikke produktionsmiljøet d tilgås. Hvis d tale om fortrolige ell følsomme data, følg S5 og at svicen skal kaldes med ctifikat dfor ctsvices - se miljøbeskrivels. Url-struktur for REST svices Eksempel til produktion <endpoint>/regist/svice/vsion/svicetype/metode? Genelt om intvalopslag For REST svicene foretages d joins med andre tabell, hvis data returnes som nestede objekt. Input D kan laves intvalopslag på en tidsdimension ad gangen og altid sammen med et ID for det ønskede objekt. Dette betyd for eksempel, at når d modtages en hændelse om at et objekt ændret, giv et intvalopslag mulighed for at hente hvordan objektet s ud i alle dets nye virkningspiod ud fra dets ID og et regingstidspunkt. Input skal for intvalopslag således altid indeholde: Et ID på hovedentitet d spørges på: Bygning Grund Enhed TekniskAnlæg

2 BBRSag Ejendomsrelation Et intval for enten regingstid (ngfra og ngtil), virkningstid (ingfra og ingtil) ell opdatingstid (pfra og ptil). D må kun angives et intval for én af tidsdimensionne i et intvalopslag. For tidsdimension, d ikke angivet et intval for, kan d specifices et tidspunkt ved at sætte fra- og til-tidspunkt til samme værdi. Fx hvis d eftspurgt et virkningsintval, så kan ngfra og ngtil sættes til et tidspunkt, hvor d som standard ells ville blive brugt NOW( ). Output Resultatet af et intvalopslag består af samtlige konfiguration som den returnede objektstruktur har haft i det forespurgte intval. Dette simpelt for et objekt, d ingen nestede objekt har da d således blot returnes de vsion af objektet d har eksistet inden for det forespurgte intval. Genelt for BBR websvices Format XML/JSON DLS vsion Sikkhedszone Adgangsbegrænsning Paging 5 Indehold fortrolige ell følsomme data. Alle bruge skal IP-whitelistes for at få adgang til tjenesten Anvend paging. Default paging-størrelse: 100 Dato- og tidsformat Datoformat følg ISO 8601 and time format. Alle dato skrives med andre ord i formatet yyyy-mm-ddthh:mm: SS.ssssss, hvor tidsangivelsen kan udelades. UTC kan angives enten ved +HH:MM ( T07:50: :00) ell ved at benytte Z ( T07:50: Z) REST - BBR Anvendt udstillingsmodel SLA BBR Se registrets tilgængelighed på Datafordel.dk Metodeovsigt Metodenavn SLA kategori Tværgående tjeneste bbrsag Kompleks Nej bygning Normal Nej ejendomsrelation Normal Nej enhed Normal Nej grund Normal Nej tekniskanlaeg Kompleks Nej

3 SLA kategori i produktion- maksimal svartid i sekund: Simpel: 0.09 Normal: 1.0 Kompleks: 2.5 Metode - bbrsag Beskrivelse Denne metode hent udstillede information om BBR sag, d baset på data fra BBR. Url <endpoint>/bbr/bbr/1/rest/ bbrsag? Inputparametre Navn Type Beskrivelse Default værdi D fra udstillingsmodel Id Identifikation af bygværkselementet igennem hele dets livscyklus EAID_F8196C58_7115 _48a6_9A1D_B49BC0F 6289A. EAID_9AB90AE0_9F85 _4164_9B25_8EB2139 D65A5 ingfra Tidspunktet hvorfra den pågældende vsion af bygværkselement har virkning EAID_A351A366_2F30 _4c3f_B086_7FAA5933 9C5D ingtil Tidspunktet hvor virkningen af den bygværkselementet ophør EAID_47628A51_6589 _4f1e_A19F_E9943A13 6AEC ingsa Den aktør d har afstedkommet virkningsegenskabne for den bygværkselementet EAID_59A458B1_5844 _4fe3_95B1_C38AD3A AFAF4 ngfra Tidspunktet hvor regingen af den pågældendevsion af bygværkselementet foretaget EAID_7A7F26D9_D5A E_4158_A7FF_3E6EF0 B228D8 ngtil Tidspunktet hvor en ny reging på bygværkselementet foretaget, og hvor denne vsion således ikke længe den seneste. EAID_E718B937_950A _4ea1_BFA0_2AE9DB 8C43AD ngsa Den aktør d har foretaget regingen af den pågældende vsion af bygværkselementet EAID_B3CCBA6B_52B 2_4ddc_A751_ABEA39 D6EE6B Status Strin g> Bygværkselementets status i den pågældende vsion, dvs. elementets tilstand i den samlede livscyklus EAID_6FAA8A1A_5BC F_4950_B220_F4AFCA 7F35E3 sproc es Den forresproces, som afstedkom opdatingen af bygværkselementet til den pågældende vsion EAID_E _7923 _4533_8529_5E8D8C somr aade Det forresområde som har opdatet bygværkselementet til den pågældende vsion EAID_C91552B7_18C0 _4e28_8B06_F60332A 8776B

4 shae ndelse Den forreshændelse, som afstedkom opdatingen af bygværkselementet til den pågældende vsion EAID_50066AF4_06D9 _4f3a_BAC2_5F83ABF 0E335 Kom mun ekode Den kommune som bygværkselementet ligg i EAID_C95C717A_752C _4b17_B647_ CAC Med Dybde Angiv om resultatet skal indeholde nested data fra joins ell kun ID'. SAND pfra Fra Datafordel opdatingstidspunkt ptil Til Datafordel opdatingstidspunkt Bygn ing D Enhed D Etage D Grund D Opga ng D Tekni skanl aeg D gfra Tidspunkt hvor pioden med æg begynd. Kan kun benyttes i kombination med gtil. gtil Tidspunkt hvor pioden med æg slutt. Kan kun benyttes i kombination med gfra. Kun Nyes teipe riode Angives hvis man kun vil have de nye vsion af dataobjektne. Kan kun benyttes i kombination med gfra og gtil. FALSK Outputparametre Metode Den inkludede fil BBRSag.schema.json indehold output som JSON-schema Skema Skema - filudtræk og websvices (BBR) Metode - bygning Beskrivelse Denne metode hent udstillede information om bygning, d baset på data fra BBR. Url <endpoint>/bbr/bbr/1/rest/ bygning?

5 Inputparametre Navn Type Beskrivelse Default værdi D fra udstillingsmodel Id Identifikation af bygværkselementet igennem hele dets livscyklus EAID_F8196C58_7115 _48a6_9A1D_B49BC0F 6289A. EAID_9AB90AE0_9F85 _4164_9B25_8EB2139 D65A5 ingfra Tidspunktet hvorfra den pågældende vsion af bygværkselement har virkning EAID_A351A366_2F30 _4c3f_B086_7FAA5933 9C5D ingtil Tidspunktet hvor virkningen af den bygværkselementet ophør EAID_47628A51_6589 _4f1e_A19F_E9943A13 6AEC ingsa Den aktør d har afstedkommet virkningsegenskabne for den bygværkselementet EAID_59A458B1_5844 _4fe3_95B1_C38AD3A AFAF4 ngfra Tidspunktet hvor regingen af den pågældendevsion af bygværkselementet foretaget EAID_7A7F26D9_D5A E_4158_A7FF_3E6EF0 B228D8 ngtil Tidspunktet hvor en ny reging på bygværkselementet foretaget, og hvor denne vsion således ikke længe den seneste. EAID_E718B937_950A _4ea1_BFA0_2AE9DB 8C43AD ngsa Den aktør d har foretaget regingen af den pågældende vsion af bygværkselementet EAID_B3CCBA6B_52B 2_4ddc_A751_ABEA39 D6EE6B Status Strin g> Bygværkselementets status i den pågældende vsion, dvs. elementets tilstand i den samlede livscyklus EAID_6FAA8A1A_5BC F_4950_B220_F4AFCA 7F35E3 sproc es Den forresproces, som afstedkom opdatingen af bygværkselementet til den pågældende vsion EAID_E _7923 _4533_8529_5E8D8C somr aade Det forresområde som har opdatet bygværkselementet til den pågældende vsion EAID_C91552B7_18C0 _4e28_8B06_F60332A 8776B shae ndelse Den forreshændelse, som afstedkom opdatingen af bygværkselementet til den pågældende vsion EAID_50066AF4_06D9 _4f3a_BAC2_5F83ABF 0E335 Kom mun ekode Den kommune som bygværkselementet ligg i EAID_C95C717A_752C _4b17_B647_ CAC Med Dybde Angiv om resultatet skal indeholde nested data fra joins ell kun ID'. SAND pfra Fra Datafordel opdatingstidspunkt ptil Til Datafordel opdatingstidspunkt Etage BBR Etage ID

6 Ford eling sare al D BBR Fordelingsareal ID Opga ng BBR Opgang ID Tekni skanl aeg D BBR TekniskAnlæg ID Grund D BBR Grund ID Jords tykke MU Jordstykke ID Ejen doms relati on Husn umm D BBR Ejendomsrelation ID D DAR Husnumm ID BFE Num m BFE-numm Nord Nordlig koordinat afgrænsning Syd Sydlig koordinat afgrænsning Oest Østlig koordinat afgrænsning Vest Vestlig koordinat afgrænsning gfra Tidspunkt hvor pioden med æg begynd. Kan kun benyttes i kombination med gtil. gtil Tidspunkt hvor pioden med æg slutt. Kan kun benyttes i kombination med gfra. Kun Nyes teipe riode Angives hvis man kun vil have de nye vsion af dataobjektne. Kan kun benyttes i kombination med gfra og gtil. FALSK Outputparametre Metode Den inkludede fil Bygning.schema.json indehold output som JSON-schema Skema Skema - filudtræk og websvices (BBR) Metode - ejendomsrelation Beskrivelse Denne metode hent udstillede information om ejendomsrelation, d baset på data fra BBR.

7 Url <endpoint>/bbr/bbr/1/rest/ ejendomsrelation? Inputparametre Navn Type Beskrivelse Default værdi D fra udstillingsmodel Id Identifikation af bygværkselementet igennem hele dets livscyklus EAID_F8196C58_7115 _48a6_9A1D_B49BC0 F6289A. EAID_9AB90AE0_9F8 5_4164_9B25_8EB213 9D65A5 in gfra Tidspunktet hvorfra den pågældende vsion af bygværkselement har virkning EAID_A351A366_2F30 _4c3f_B086_7FAA593 39C5D in gtil Tidspunktet hvor virkningen af den bygværkselementet ophør EAID_47628A51_6589 _4f1e_A19F_E9943A1 36AEC in gsakto Den aktør d har afstedkommet virkningsegenskabne for den bygværkselementet EAID_59A458B1_5844 _4fe3_95B1_C38AD3A AFAF4 st ring Fra Tidspunktet hvor regingen af den pågældendevsion af bygværkselementet foretaget EAID_7A7F26D9_D5A E_4158_A7FF_3E6EF 0B228D8 st ring Til Tidspunktet hvor en ny reging på bygværkselementet foretaget, og hvor denne vsion således ikke længe den seneste. EAID_E718B937_950 A_4ea1_BFA0_2AE9D B8C43AD st rings a Den aktør d har foretaget regingen af den pågældende vsion af bygværkselementet EAID_B3CCBA6B_52B 2_4ddc_A751_ABEA3 9D6EE6B Status Strin g> Bygværkselementets status i den pågældende vsion, dvs. elementets tilstand i den samlede livscyklus EAID_6FAA8A1A_5BC F_4950_B220_F4AFC A7F35E3 t ningsp roces Den forresproces, som afstedkom opdatingen af bygværkselementet til den pågældende vsion EAID_E _7923 _4533_8529_5E8D8C t ningso mraade Det forresområde som har opdatet bygværkselementet til den pågældende vsion EAID_C91552B7_18C 0_4e28_8B06_F60332 A8776B t ningsh aendel se Den forreshændelse, som afstedkom opdatingen af bygværkselementet til den pågældende vsion EAID_50066AF4_06D9 _4f3a_BAC2_5F83ABF 0E335 Komm uneko de Den kommune som bygværkselementet ligg i EAID_C95C717A_752 C_4b17_B647_ CAC MedD ybde Angiv om resultatet skal indeholde nested data fra joins ell kun ID'. SAND Ti mesta mpfra Fra Datafordel opdatingstidspunkt Ti mesta mptil Til Datafordel opdatingstidspunkt BFEN umm BFE-numm

8 BPFG MU BygningPåFremmedGrund ID Ejfor holdsk ode Ejforholdskode Ejlejl ighed MU Ejlejlighed ID Ejend omsnu mm Ejendomsnumm Samlet FastEj endom MU SamletFastEjendom ID Vurd ingsej endom snum m Vurdingsejendomsnumm d eaend ringfra Tidspunkt hvor pioden med æg begynd. Kan kun benyttes i kombination med gtil. d eaend ringtil Tidspunkt hvor pioden med æg slutt. Kan kun benyttes i kombination med gfra. KunNy esteip iode Angives hvis man kun vil have de nye vsion af dataobjektne. Kan kun benyttes i kombination med gfra og gtil. FALSK Outputparametre Metode Den inkludede fil Ejendomsrelation.schema.json indehold output som JSON-schema Skema Skema - filudtræk og websvices (BBR) Metode - enhed Beskrivelse Denne metode hent udstillede information om enhed, d baset på data fra BBR. Url <endpoint>/bbr/bbr/1/rest/ enhed? Inputparametre Navn Type Beskrivelse Default værdi D fra udstillingsmodel Id Identifikation af bygværkselementet igennem hele dets livscyklus EAID_F8196C58_7115 _48a6_9A1D_B49BC0F 6289A. EAID_9AB90AE0_9F85 _4164_9B25_8EB2139 D65A5

9 ingfra Tidspunktet hvorfra den pågældende vsion af bygværkselement har virkning EAID_A351A366_2F30 _4c3f_B086_7FAA5933 9C5D ingtil Tidspunktet hvor virkningen af den bygværkselementet ophør EAID_47628A51_6589 _4f1e_A19F_E9943A13 6AEC ingsa Den aktør d har afstedkommet virkningsegenskabne for den bygværkselementet EAID_59A458B1_5844 _4fe3_95B1_C38AD3A AFAF4 ngfra Tidspunktet hvor regingen af den pågældendevsion af bygværkselementet foretaget EAID_7A7F26D9_D5A E_4158_A7FF_3E6EF0 B228D8 ngtil Tidspunktet hvor en ny reging på bygværkselementet foretaget, og hvor denne vsion således ikke længe den seneste. EAID_E718B937_950A _4ea1_BFA0_2AE9DB 8C43AD ngsa Den aktør d har foretaget regingen af den pågældende vsion af bygværkselementet EAID_B3CCBA6B_52B 2_4ddc_A751_ABEA39 D6EE6B Status Strin g> Bygværkselementets status i den pågældende vsion, dvs. elementets tilstand i den samlede livscyklus EAID_6FAA8A1A_5BC F_4950_B220_F4AFCA 7F35E3 sproc es Den forresproces, som afstedkom opdatingen af bygværkselementet til den pågældende vsion EAID_E _7923 _4533_8529_5E8D8C somr aade Det forresområde som har opdatet bygværkselementet til den pågældende vsion EAID_C91552B7_18C0 _4e28_8B06_F60332A 8776B shae ndelse Den forreshændelse, som afstedkom opdatingen af bygværkselementet til den pågældende vsion EAID_50066AF4_06D9 _4f3a_BAC2_5F83ABF 0E335 Kom mun ekode Den kommune som bygværkselementet ligg i EAID_C95C717A_752C _4b17_B647_ CAC Med Dybde Angiv om resultatet skal indeholde nested data fra joins ell kun ID'. SAND pfra Fra Datafordel opdatingstidspunkt ptil Til Datafordel opdatingstidspunkt BFE Num m BFE-numm Etage BBR Etage ID Ford eling sare al D BBR Fordelingsareal ID Opga ng BBR Opgang ID

10 Tekni skanl aeg BBR TekniskAnlæg ID Ejen doms relati on Adre sseid entifi c D BBR Ejendomsrelation ID D DAR Adresse ID Bygn ing BBR Bygning ID gfra Tidspunkt hvor pioden med æg begynd. Kan kun benyttes i kombination med gtil. gtil Tidspunkt hvor pioden med æg slutt. Kan kun benyttes i kombination med gfra. Kun Nyes teipe riode Angives hvis man kun vil have de nye vsion af dataobjektne. Kan kun benyttes i kombination med gfra og gtil. FALSK Outputparametre Metode Den inkludede fil Enhed.schema.json indehold output som JSON-schema Skema Skema - filudtræk og websvices (BBR) Metode - grund Beskrivelse Denne metode hent udstillede information om grunde, d baset på data fra BBR. Url <endpoint>/bbr/bbr/1/rest/grund? Inputparametre Navn Type Beskrivelse Default værdi D fra udstillingsmodel Id Identifikation af bygværkselementet igennem hele dets livscyklus EAID_F8196C58_7115 _48a6_9A1D_B49BC0F 6289A. EAID_9AB90AE0_9F85 _4164_9B25_8EB2139 D65A5 ingfra Tidspunktet hvorfra den pågældende vsion af bygværkselement har virkning EAID_A351A366_2F30 _4c3f_B086_7FAA5933 9C5D

11 ingtil Tidspunktet hvor virkningen af den bygværkselementet ophør EAID_47628A51_6589 _4f1e_A19F_E9943A13 6AEC ingsa Den aktør d har afstedkommet virkningsegenskabne for den bygværkselementet EAID_59A458B1_5844 _4fe3_95B1_C38AD3A AFAF4 ngfra Tidspunktet hvor regingen af den pågældendevsion af bygværkselementet foretaget EAID_7A7F26D9_D5A E_4158_A7FF_3E6EF0 B228D8 ngtil Tidspunktet hvor en ny reging på bygværkselementet foretaget, og hvor denne vsion således ikke længe den seneste. EAID_E718B937_950A _4ea1_BFA0_2AE9DB 8C43AD ngsa Den aktør d har foretaget regingen af den pågældende vsion af bygværkselementet EAID_B3CCBA6B_52B 2_4ddc_A751_ABEA39 D6EE6B Status Strin g> Bygværkselementets status i den pågældende vsion, dvs. elementets tilstand i den samlede livscyklus EAID_6FAA8A1A_5BC F_4950_B220_F4AFCA 7F35E3 sproc es Den forresproces, som afstedkom opdatingen af bygværkselementet til den pågældende vsion EAID_E _7923 _4533_8529_5E8D8C somr aade Det forresområde som har opdatet bygværkselementet til den pågældende vsion EAID_C91552B7_18C0 _4e28_8B06_F60332A 8776B shae ndelse Den forreshændelse, som afstedkom opdatingen af bygværkselementet til den pågældende vsion EAID_50066AF4_06D9 _4f3a_BAC2_5F83ABF 0E335 Kom mun ekode Den kommune som bygværkselementet ligg i EAID_C95C717A_752C _4b17_B647_ CAC Med Dybde Angiv om resultatet skal indeholde nested data fra joins ell kun ID'. SAND pfra Fra Datafordel opdatingstidspunkt ptil Til Datafordel opdatingstidspunkt BFE Num m BFE-numm Bygn ing Tekni skanl aeg Ejen doms relati on D BBR Bygning ID D BBR TekniskAnlæg ID D BBR Ejendomsrelation ID Jords tykke MU Jordstykke ID Husn umm DAR Husnumm ID

12 gfra Tidspunkt hvor pioden med æg begynd. Kan kun benyttes i kombination med gtil. gtil Tidspunkt hvor pioden med æg slutt. Kan kun benyttes i kombination med gfra. Kun Nyes teipe riode Angives hvis man kun vil have de nye vsion af dataobjektne. Kan kun benyttes i kombination med gfra og gtil. FALSK Outputparametre Metode Den inkludede fil grund indehold output som JSON-schema Skema Skema - filudtræk og websvices (BBR) Metode - tekniskanlaeg Beskrivelse Denne metode hent udstillede information om tekniske anlæg, d baset på data fra BBR. Url <endpoint>/bbr/bbr/1/rest/ tekniskanlaeg? Inputparametre Navn Type Beskrivelse Default værdi D fra udstillingsmodel Id Identifikation af bygværkselementet igennem hele dets livscyklus EAID_F8196C58_7115 _48a6_9A1D_B49BC0F 6289A. EAID_9AB90AE0_9F85 _4164_9B25_8EB2139 D65A5 ingfra Tidspunktet hvorfra den pågældende vsion af bygværkselement har virkning EAID_A351A366_2F30 _4c3f_B086_7FAA5933 9C5D ingtil Tidspunktet hvor virkningen af den bygværkselementet ophør EAID_47628A51_6589 _4f1e_A19F_E9943A13 6AEC ingsa Den aktør d har afstedkommet virkningsegenskabne for den bygværkselementet EAID_59A458B1_5844 _4fe3_95B1_C38AD3A AFAF4 ngfra Tidspunktet hvor regingen af den pågældendevsion af bygværkselementet foretaget EAID_7A7F26D9_D5A E_4158_A7FF_3E6EF0 B228D8

13 ngtil Tidspunktet hvor en ny reging på bygværkselementet foretaget, og hvor denne vsion således ikke længe den seneste. EAID_E718B937_950A _4ea1_BFA0_2AE9DB 8C43AD ngsa Den aktør d har foretaget regingen af den pågældende vsion af bygværkselementet EAID_B3CCBA6B_52B 2_4ddc_A751_ABEA39 D6EE6B Status Strin g> Bygværkselementets status i den pågældende vsion, dvs. elementets tilstand i den samlede livscyklus EAID_6FAA8A1A_5BC F_4950_B220_F4AFCA 7F35E3 sproc es Den forresproces, som afstedkom opdatingen af bygværkselementet til den pågældende vsion EAID_E _7923 _4533_8529_5E8D8C somr aade Det forresområde som har opdatet bygværkselementet til den pågældende vsion EAID_C91552B7_18C0 _4e28_8B06_F60332A 8776B shae ndelse Den forreshændelse, som afstedkom opdatingen af bygværkselementet til den pågældende vsion EAID_50066AF4_06D9 _4f3a_BAC2_5F83ABF 0E335 Kom mun ekode Den kommune som bygværkselementet ligg i EAID_C95C717A_752C _4b17_B647_ CAC Med Dybde Angiv om resultatet skal indeholde nested data fra joins ell kun ID'. SAND pfra Fra Datafordel opdatingstidspunkt ptil Til Datafordel opdatingstidspunkt Jords tykke MU Jordstykke ID Ejen doms relati on Husn umm Bygn ing D BBR Ejendomsrelation ID D DAR Husnumm ID D BBR Bygning ID Enhed D BBR Enhed ID Grund D BBR Grund ID BFE Num m BFE-numm Nord Nordlig koordinat afgrænsning Syd Sydlig koordinat afgrænsning Oest Østlig koordinat afgrænsning Vest Vestlig koordinat afgrænsning

14 gfra Tidspunkt hvor pioden med æg begynd. Kan kun benyttes i kombination med gtil. gtil Tidspunkt hvor pioden med æg slutt. Kan kun benyttes i kombination med gfra. Kun Nyes teipe riode Angives hvis man kun vil have de nye vsion af dataobjektne. Kan kun benyttes i kombination med gfra og gtil. FALSK Outputparametre Metode Den inkludede fil TekniskAnlæg.schema.json indehold output som JSON-schema Skema Skema - filudtræk og websvices (BBR)