OIOXML Vejledning til OIOXML snitflade for Bygninger og boliger BuildingDwelling.wsdl Tillæg til BuildingDwellingV4 / Ændringer i BuildingDwellingV5 En vejledning rettet mod 3. part.
Indholdsfortegnelse 1. Introduktion... 3 2. Adgang til historiske data i BuildingDwellingV5... 4 3. Ændring af regelsættet for nedarving af sikkerhedsklassifikation... 5 3.1. Håndtering af sikkerhedsklassifikation ved oprettelse af entiteter... 5 3.2. Håndtering af sikkerhedsklassifikation ved opdatering af entiteter... 5 4. Ændrede felter i BuildingDwellingV5... 5 4.1. Ændret kodeliste til felt Byggeskadeforsikringsselskab for bygning... 5 4.2. Ændret kodeliste til felt Sløjfning for teknisk anlæg... 6 4.3. Ændret kodeliste til felt Klassifikation for teknisk anlæg... 7 5. Nye felter i BuildingDwelling 5... 8 5.1. Nye felter til vindmøller for teknisk anlæg... 8 5.2. Nyt areal felt Udvendig efterisolering for bygning... 8 5.3. Ny understruktur DispensationHeatSupply for bygning og grund... 8 Snitfladebeskrivelse Side 2 af 9
1. Introduktion Dette tillæg henvender sig til brugere af OIO XML snitfladen BuildingDwelling. OIO BuildingDwelling snitfladen har eksisteret/eksisterer i 4 versioner. BuildingDwellingV1 er blevet udfaset den 20.06.2011 i forbindelse med at Nyt release 1.3 er blevet sat i drift. BuildingDwellingV2 er blevet udfaset den 09.02.2012 i forbindelse med at Nyt release 1.4 er blevet sat i drift. BuildingDwellingV3 udfases den 09.04.2013 i forbindelse med at Nyt release 1.5 sættes i drift. BuildingDwellingV4 har været i drift siden 9. 02. 2012, og denne version fortsætter med at eksistere, indtil der kommer en version 6 af snitfladen. BuildingDwellingV5 er pr. 9.4.2013 den nyeste version af snitfladen. Denne vejledning henvender sig til alle brugere af snitfladen: Brugere af version 1, version 2 og version 3 af snitfladen skal overgå til en nyere version, hvis dette ikke allerede er sket. Denne vejledning giver dem et godt overblik over ændringer i version 5. Tilsvarende findes der dokumenter, som beskriver ændringer i version 2, 3 og 4. Disse tillæg/dokumenter findes på http://demo.bbrkommune.dk/services/. Brugere af version 4 af snitfladen kan fortsætte med at benytte version 4, dog skal brugerne være opmærksomme på de i denne vejledning beskrevne uhensigtsmæssigheder, som er forbundet med dette. Brugerne af version 4 skal være opmærksomme på, at snitfladen udgår, når version 6 af snitfladen sættes i drift, og de opfordres derfor til at gå over til version 5 ved førstkommende mulighed. Denne vejledning giver dem et godt overblik over ændringer i version 5. Brugere af version 5 af snitfladen kan benytte denne vejledning for at få et hurtigt overblik over ændringer i version 5 i forhold til version 4. Snitfladebeskrivelse Side 3 af 9
I produktionsmiljø findes snitfladernes endpoint her: https://bbr-kommune.dk/services/servicegateway/buildingdwellingservicev4.svc https://bbr-kommune.dk/services/servicegateway/buildingdwellingservicev5.svc Snitfladernes dokumentation, snitfladernes wsdl-dokumenter for både produktions- og demoversionen vil man kunne finde på 's demoserver: http://demo.bbr-kommune.dk/services/ 2. Adgang til historiske data i BuildingDwellingV5 Som noget nyt giver version 5 af snitfladen adgang til historiske data, dvs. entiteter, der er udgået og har fået et ophørstimestamp. Det betyder, at entiteter med objekttype 2, dvs. slettede stamentiteter, kan fremsøges eller hentes via snitfladen. I den forbindelse er der blevet tilføjet en ny inputparameter IncludeHistoricIndicator til følgende metoder: Søge-metoder SiteSearch BuildingSearch EntranceSearch FloorSearch TechnicalInstallationSearch BuildingUnitSearch RoomSearch UseUnitSearch Hent-metoder SiteGetById SiteGetByIds BuildingGetById BuildingGetByIds BuildingGetBySiteId EntranceGetById EntranceGetByIds EntranceGetByBuildingId FloorGetById FloorGetByIds FloorGetByBuildingId TechnicalInstallationGetById TechnicalInstallationGetByIds TechnicalInstallationGetBySiteId TechnicalInstallationGetByBuildingId BuildingUnitGetById BuildingUnitGetByIds BuildingUnitGetByFloorId BuildingUnitGetByEntranceId RoomGetById RoomGetByIds RoomByFloorId RoomByBuildingUnitId UseUnitGetById Snitfladebeskrivelse Side 4 af 9
UseUnitGetByIds UseUnitByBuildingId Læs mere om denne nye funktionalitet i vejledningen for BuildingDwelling5. Ændringen behøver ikke at blive håndteret. Man skal bare være opmærksom på, at funktionen ikke er til rådighed i version 4. 3. Ændring af regelsættet for nedarving af sikkerhedsklassifikation 3.1. Håndtering af sikkerhedsklassifikation ved oprettelse af entiteter Når man opretter en entitet og ikke angiver sikkerhedsklassifikation (dvs. hverken angiver true eller false), vil den oprettede entitet får den samme sikkerhedsklassifikation som den overliggende entitet. 3.2. Håndtering af sikkerhedsklassifikation ved opdatering af entiteter Når man opdaterer en entitet er feltet sikkerhedsklassifikation et krævet felt. Ændringen behøves ikke at blive håndteret. Man skal bare være opmærksom på ændringen når man skifter til version 5 af snitfladen. 4. Ændrede felter i BuildingDwellingV5 4.1. Ændret kodeliste til felt Byggeskadeforsikringsselskab for bygning Feltet Byggeskadeforsikringsselskab (BuildingDamageInsuranceCompanyCode), som findes i strukturen BuildingInsurance på bygning har ændret kodeliste fra version 4 til version 5. Der er blevet tilføjet kode 99. Kodeliste i BuildingDwellingV4: 00 - Ingen byggeskadeforsikring 01 - Tryg 02 - Topdanmark 04 - Codan 05 - If forsikring 06 - Alm. Brand 07 - Danske Forsikring 08 - Caplloyd A/S 09 Midtjysk Forsikring 10 Købstædernes Forsikring 11 ALKA 12 Frida Forsikring Agentur 13 NemForsikring Kodeliste i BuildingDwellingV5: Snitfladebeskrivelse Side 5 af 9
00 - Ingen byggeskadeforsikring 01 - Tryg 02 - Topdanmark 04 - Codan 05 - If forsikring 06 - Alm. Brand 07 - Danske Forsikring 08 Caplloyd A/S 09 Midtjysk Forsikring 10 Købstædernes Forsikring 11 ALKA 12 Frida Forsikring Agentur 13 NemForsikring 99 Ingen forsikring på grund af dispensation Da betydningen af koderne ikke har ændret sig, returneres feltet gennem BuildingDwellingV4 snitfladen og feltet kan indberettes så længe man ikke prøver at overskrive en eksisterende kode 99. Dette betyder i detaljer: Get metoderne og søgemetoderne leverer kun de gamle koder. Hvis en bygning har kode 99, returneres feltet ikke, men der returneres null i stedet for. Hvis man opretter eller opdaterer en bygning og sender BuildingInsurance strukturen med hvor indholdet for feltet BuildingDamageInsuranceCompanyCode er forskelligt fra det eksisterende feltindhold, gives der en sandsynlighedsbesked (ResponseReasonIdentifier=5000). Det gælder både, hvis man opdaterer feltet med en værdi og når man ikke angiver feltet, dvs. prøver at nullstille feltet. Sandsynlighedsbeskeden advarer om, at feltet har fået en ny kodeliste i version 5 af snitfladen. Hvis man gennemtvinger oprettelsen/opdateringen, bliver feltet oprettet/opdateret med den angivne værdi hhv. nulstillet dog med undtagelse af en situation: Når man ikke angiver feltet (nulstiller feltet) og den eksisterende værdi er kode 99, vil feltet ikke blive nulstillet. Hvis man opretter eller opdaterer en bygning og ikke sender BuildingInsurance strukturen med, betyder det, at man ikke ønsker at ajourføre alle felter i strukturen. I givet fald gives der heller ikke nogen advarsel. 4.2. Ændret kodeliste til felt Sløjfning for teknisk anlæg Feltet Sløjfning (TechnicalInstallationAbolishedCode), som findes i strukturen TechnicalInstallationInformation på teknisk anlæg har ændret kodeliste fra version 4 til version 5. Kodelisten som i dag kun benyttes for tanke, udvides, så den også dækker sløjfning af jordvarmeanlæg. Der er blevet tilføjet kodeværdi 10 (Jordvarmeslangerne er sløjfet/taget ud af drift ). Snitfladebeskrivelse Side 6 af 9
Da betydningen af koderne ikke har ændret sig, returneres feltet gennem BuildingDwellingV4 snitfladen og feltet kan indberettes så længe man ikke prøver at overskrive en eksisterende kode 10. Dette betyder i detaljer: Get metoderne og søgemetoderne leverer kun de gamle koder. Hvis et teknsik anlæg har kode 1265, returneres feltet ikke, men der returneres null i stedet for. Hvis man opretter eller opdaterer et teknisk anlæg og sender TechnicalInstallationInformation strukturen med hvor indholdet for TechnicalInstallationAbolishedCode er forskelligt fra det eksisterende feltindhold, gives der en en sandsynlighedsbesked (ResponseReasonIdentifier=5000). Det gælder både, hvis man opdaterer feltet med en værdi og når man ikke angiver feltet, dvs. prøver at nulstille feltet. Sandsynlighedsbeskeden advarer om, at feltet har fået en ny kodeliste i version 5 af snitfladen. Hvis man gennemtvinger oprettelsen/opdateringen, bliver feltet oprettet/opdateret med den angivne værdi hhv. nulstillet dog med undtagelse af en situation: Når man ikke angiver feltet (nulstiller feltet) og den eksisterende værdi er kode 1265, vil feltet ikke blive nulstillet. Hvis man opretter eller opdaterer et teknisk anlæg og ikke sender TechnicalInstallationInformation strukturen med, betyder det, at man ikke ønsker at ajourføre alle felter i strukturen. I givet fald gives der heller ikke nogen advarsel. 4.3. Ændret kodeliste til felt Klassifikation for teknisk anlæg Feltet Klassifikation (TechnicalInstallationClassificationCode), som findes i strukturen TechnicalInstallationKeys på teknisk anlæg har ændret kodeliste fra version 4 til version 5. Der er blevet tilføjet kode 1265 (Naturgasfyr). Da betydningen af koderne ikke har ændret sig, returneres feltet gennem BuildingDwellingV4 snitfladen og feltet kan indberettes så længe man ikke prøver at overskrive en eksisterende kode 1265. Dette betyder i detaljer: Get metoderne og søgemetoderne leverer kun de gamle koder. Hvis et teknsik anlæg har kode 1265, returneres feltet ikke, men der returneres null i stedet for. Hvis man opretter eller opdaterer et teknisk anlæg og sender TechnicalInstallationKeys strukturen med hvor indholdet for TechnicalInstallationClassificationCode er forskelligt fra det eksisterende feltindhold, gives der en sandsynlighedsbesked (ResponseReasonIdentifier=5000). Det gælder både, hvis man opdaterer feltet med en værdi og når man ikke angiver feltet, dvs. prøver at nulstille feltet. Sandsynlighedsbeskeden advarer om, at feltet har Snitfladebeskrivelse Side 7 af 9
fået en ny kodeliste i version 5 af snitfladen. Hvis man gennemtvinger oprettelsen/opdateringen, bliver feltet oprettet/opdateret med den angivne værdi hhv. nulstillet dog med undtagelse af en situation: Når man ikke angiver feltet (nulstiller feltet) og den eksisterende værdi er kode 1265, vil feltet ikke blive nulstillet. Hvis man opretter eller opdaterer et teknisk anlæg og ikke sender TechnicalInstallationKeys strukturen med, betyder det, at man ikke ønsker at ajourføre alle felter i strukturen. I givet fald gives der heller ikke nogen advarsel. 5. Nye felter i BuildingDwelling 5 5.1. Nye felter til vindmøller for teknisk anlæg Der er blevet tilføjet 3 nye felter til vindmøller i strukturen TechnicalInstallationInformation på teknisk anlæg niveau. Nye felter i TechnicalInstallationInformation Feltnavn i OIOXML navn Kommentar Narvhøjde Vindmøllenummer Rotordiameter TechnicalInstallationHub- HeightMeasure TechnicalInstallationWind- TurbineNumberIndicator Vindmøllens nummer i Energistyrelsens vindmølleregister. TechnicalInstallationRotor- DiameterMeasure Vindmøllens højde målt til narvet. Ændringen behøves ikke at blive håndteret. Man skal bare være opmærksom på, at felterne ikke leveres som en del af TechnicalInstallationInformation strukturen i version 4. 5.2. Nyt areal felt Udvendig efterisolering for bygning I Kommune er der i forbindelse med Nyt release 1.4.1 blevet implementeret et nyt areal felt til udvendig efterisolering i Kommune. Feltet ligger på bygningsniveau og er blevet en del af BuildingArea strukturen. Ændringen behøves ikke at blive håndteret. Man skal bare være opmærksom på, at feltet ikke leveres som en del af BuildingArea strukturen i version 4. 5.3. Ny understruktur DispensationHeatSupply for bygning og grund Strukturen for bygning BuildingStructure og grund SiteStructure har fået en yderligere understruktur DispensationHeatSupply. Felterne benyttes til at registrere, om Snitfladebeskrivelse Side 8 af 9
en grund hhv. bygning er omfattet af dispensation/fritagelse ift. kollektivvarmeforsyning. DispensationHeatSupply Feltnavn i OIOXML navn Kommentar Dispensation/fritagelse ift kollektiv varmeforsyning DispensationHeatSupplyCode For bygniger/ubebyggede grunde, hvor der ifølge feltet Dato for dispensation/fritagelse er oplyst en dato, angives det om den er tidsbegrænset. Koder: 1 - Dispensation er tidsbegrænset 2 - Dispensationen er ikke tidsbegrænset Dato for dispensation/ fritagelse ift kollektiv varmeforsyning DispensationHeatSupplyDate For bygniger/ubebyggede grunde, hvor der ifølge feltet Dispensation/fritagelse er udstedt dispensation eller fritagelse, angives dato for dispensation eller fritagelsen. Ændringen behøves ikke at blive håndteret. Man skal bare være opmærksom på ændringen når man skifter til version 5 af snitfladen. Snitfladebeskrivelse Side 9 af 9