OIOXML Vejledning til OIOXML snitflade for Bygninger og boliger BuildingDwelling.wsdl En vejledning rettet mod 3. part.
Ændringer i forhold til forrige versioner Version 1.0.0 Version 1.0.1 Version 1.0.2 Version 1.1.0 Version 2.0 Første version, 01. maj 2010 26. 05. 2010 juni 2010 Mange to be written steder er blevet skrevet. Implementering og beskrivelse af teknisk anlæg afventer (på grund af DIADEM felter) Nogle steder er markeret med to be written. Disse afsnit skrives snarest. Andre steder er markeret med gul farve. Disse skrives når implementeringen af snitfladerne er afsluttet idet disse steder kræver afklaring. metoderne er blevet beskrevet nærmere oprettelse og sletning af geometripunkter er beskrevet teknisk anlæg er blevet opdateret 29. juni 2010 1. produktionsversion (svarende til BuildingDwellingServiceV1.svc) Tegning vedr. repræsentative adresser tilknyttet Ændring af navn til BuildingDwelling.wsdl Alle strukturer og metoder er beskrevet færdigt Webservice version 2, BuildingDwellingServiceV2.svc 15. december 2010 ( Kommune version 1.2. lægges i produktion) Søgningen er begrænset til 100 resultater (tilføjet til vejledningen) Beskrivelse af hvordan man sletter et ejerskab tilføjet Opdatering af links i kapitel 1 Ny kapitel 4.13 Datatyper Ny kapitel 4.14 Udviklingsværktøjer Afsnit 16.2 (Kodeeksempel for kald af certifikat) tilføjet Opdatering af strukturer på grund af nye felter i Nyt version 1.2 eller andre ændringer/fejlrettelser o o o o o o o Pålæg fra stormområdet ny kodeliste Gyldighedsdato på 7 entiteter (flyttet fra update/create metoder til selve entitetsstrukturerne) Afløbsforhold nye kodeværdier og nye kodeoversættelser Nyt felt Omfattet af byggeskadeforsikring Forsikringsselskab ny kodeliste (kode 3 slettet, kode 8 tilføjet) En byggesag Et teknisk anlæg kan oprettes på en grund uden vandforsyning og afløbsforhold. Snitfladebeskrivelse Side 2 af 303
o Beskrivelsen vedr. midlertidig afslutning er udvidet med beskrivelse for afslutning af byggesager med teknisk anlæg o Felt FloorDeviationStatusIndicator hedder nu FloorDeviationStatusCode på grund af fejl i version 1. o o o o Felt DrainagePermissionCode er blevet opdateret på grund af fejl i version 1. Felt PublicSubsidyCode er blevet opdateret på grund af fejl i version 1. Felt WaterSupplyCode er blevet opdateret på grund af fejl i version 1 (kode 7 manglede). Kode 1 har fået ny kodeoversættelse. Felt LegalUseCode er blevet opdateret på grund af fejl i version 1 (kode I manglede og kode blank er blevet fjernet) o Felt TechnicalInstallationContentCode: Tekst oliebekendtgørelsens 6, stk. 1 nr. 11 rettet til oliebekendtgørelsens 6, stk. 1 nr. 13 Version 3.0 Version 1.0 af snitfladen udfases (BuildingDwellingServiceV1.svc) Webservice version 3, BuildingDwellingServiceV3.svc lægges i produktion den 21. juni 2011 ( Kommune version 1.3.) Bygning/Grunde Bygning 7 nye felter i strukturen WaterDrainage, som angiver yderligere spildevandsoplysninger. Ny kodeliste (ændrede kodeoversættelser og nye koder) til feltet DrainageCode (afløbsforhold) Ny kodeliste (ændrede kodeoversættelser og nye koder) til feltet DrainagePermissionCode (afløbsforholdtilladelse) Ny struktur på bygning, som angiver om bygningen er under flytning til en anden kommune (MunicipalityRelocation) Ny kodeliste for feltet Forsikringsselskab, BuildingDamageInsuranceCompanyCode i strukturen BuildingInsurance. Kode 09 er tilføjet. Ny version af feltet Pålæg fra Stormrådet (StormCouncilInstructionCode), idet feltet ændrer navn til Selvrisiko ved oversvømmelse jf. Stormrådet. Det engelske navn for xsd skemaet bibeholdes, men der tilføjes en ny metadatafil og der laves en ny version af strukturen. Teknisk anlæg Snitfladebeskrivelse Side 3 af 303
Ny xsd fil til TechnicalInstallationContentCode, idet xsd filen ved en fejl manglede kode 40. Nyt felt Sløjfningsår (TechnicalInstallationAbolishYearIdentifier) i strukturen TechnicalInstallationInformation Version 4.0 Version 2.0 af snitfladen udfases (BuildingDwellingServiceV2.svc) Webservice version 4, BuildingDwellingServiceV4.svc lægges i produktion den 9. februar 2012 ( Kommune version 1.4.) Identændringer Flere muligheder for identændringer for bygning, teknisk anlæg og opgang. Disse er beskrevet i afsnit 3.5.10, 5.2.1 og 5.3.1 og 5.6.1 Ny funktion på grundniveau, som flytter alle entiteter fra en matrikel til en anden (afsnit 5.1.1) Historiske data Nyt afsnit Historiske data, som beskriver at snitfalden ikke giver adgang til historiske data. (afsnit 3.7). Ny mulighed for at slette data fra historikken (afsnit 3.7). Dette indebærer en ny metode <Entitity>DeleteHistoric for hvert niveau. Grund Ny metode SiteMoveEntities som flytter alle entiteter fra en matrikel til en anden (afsnit 5.1.1) Enhed Ny kodeliste for feltet Boligtype (DwellingTypeCode) i strukturen BuildingUnitInformation. Det tidligere brugte xsd skema DwellingTypeCode fra namespacet http://rep.oio.dk/bbr.dk/xml/schemas/2006/04/25/ for feltet Boligtype indeholder desværre ikke værdien E. Det betyder at snitfladen i version 3.0 fejler, når man henter en enhed med boligtype E. Fejlen er rettet ved at definere et nyt skema i version 4.0. Ny kodeliste for feltet Offentlig Støtte (PublicSubsidy- Code) i strukturen BuildingUnitInformation. Det tidligere brugte skema mangler fejlagtigt kodeværdi 0. Bygning Nye muligheder for identændringer Ny kodeliste for feltet Forsikringsselskab, BuildingDamageInsuranceCompanyCode i strukturen BuildingInsu- Snitfladebeskrivelse Side 4 af 303
rance. Koderne 10, 11, 12 og 13 er tilføjet. Ny kodeliste for feltet Tagdækningsmateriale (Roofing- MaterialCode) og Supplerende Tagdækningsmateriale(RoofingSupplementaryMaterialCode) i strukturen BuildingMaterial. Kode 20 Grønne tage er tilføjet. Ny version af feltet Dato for pålæg fra Stormrådet (StormCouncilInstructionDate) i strukturen BuildingInsurance, idet feltet ændrer navn til Dato for skade hos Stormrådet. Det engelske navn for xsd skemaet bibeholdes, men der tilføjes en ny metadatafil og der laves en ny version af strukturen. Teknisk anlæg Nye muligheder for identændringer Opgang Nye muligheder for identændringer Byggesag Afsnit 3.5 er tilrettet i forbindelse med en revidering af byggesagskoderne. Diverse Feltet Sagstype i strukturen EntityBuildingCaseInformation hed fejlagtigt BuildingCaseFileTypeCode i vejledningen og er nu blevet rettet til BuildingCaseTypeCode, som er det rigtige navn. Snitfladebeskrivelse Side 5 af 303
Indholdsfortegnelse Indholdsfortegnelse... 6 1. Introduktion... 24 2. Formål og målgrupper... 26 3. Forretningsviden... 27 3.1. De forskellige entiteter i og deres sammenhæng... 27 3.2. Adressers tilknytning til niveauer i Bygninger og boliger... 29 3.3. Stamentiteter... 31 3.4. Sagsentiteter... 31 3.5. Byggesager... 32 3.5.1. Mulige byggesagskoder... 32 3.5.2. Afslutning af en byggesag... 32 3.5.3. Overførsel af data fra sag til stam... 33 3.5.4. Midlertidig afslutning af en byggesag... 33 3.5.5. Delvis afslutning af en byggesag... 34 3.5.6. Indflytning... 35 3.5.7. Henlæggelse... 35 3.5.8. Sletning af sagsentitet i en byggesag... 35 3.5.9. Sletning af byggesag... 35 3.5.10. Kopiering af byggesager... 35 3.6. Koordinater til bygning og teknisk anlæg... 38 3.6.1. Foreløbige koordinater... 39 3.6.2. Kontrol af koordinater... 39 3.7. Historiske data... 40 4. Overblik over webservices og metoderne... 41 4.1. Sandsynlighedskontroller (IgnoreWarningIndicator)... 42 4.2. Udskrivning af Meddelelser (printenableindicator)... 42 4.3. Gyldighedsdato (AssessmentChangedDate)... 43 4.4. Den implementerede opdateringsmekanisme... 43 4.5. Rettigheder... 44 4.6. Styring af opdateringer (RecordChangeDateTime)... 44 4.7. Sagstype (BuildingCaseTypeCode og updatereasoncode)... 44 4.8. Resultat for metodekald (ReturnMessage)... 45 4.9. Skemavalidering... 46 4.10. UniversalIdentifier og Reference... 47 4.11. Placeholder-problematik... 47 4.11.1. <Entity>GetById og <Entity>GetByIds metoder... 49 4.11.2. <Entity>GetByParentId metoder... 50 4.11.3. <Entity1>GetBy<Entity2>Id metoder... 50 4.11.4. BuildingCaseGetByEntityId metode... 51 4.11.5. Delete og update metoder... 51 4.12. Namespaces... 51 4.13. Datatyper... 52 4.14. Udviklingsværktøjer... 52 4.15. Rettigheder... 52 5. Strukturer til entiteter - <Entity>Structure... 53 5.1. SiteStructure... 54 5.1.1. Mulighed for identændringer... 55 5.1.2. SiteKeys... 56 Snitfladebeskrivelse Side 6 af 303
5.1.3. SiteInformation... 58 5.1.4. AddressComplete... 60 5.1.5. WaterDrainage... 60 5.1.6. EntityBuildingCaseInformation... 60 5.1.7. ExternalReferences... 60 5.1.8. MunicipalityFields... 60 5.1.9. NoteStructure... 60 5.2. BuildingStructure... 61 5.2.1. Mulighed for identændringer... 63 5.2.2. BuildingKeys... 65 5.2.3. BuildingInformation... 68 5.2.4. AddressComplete... 71 5.2.5. CondominiumStructure... 71 5.2.6. ConstructionPoint... 71 5.2.7. BuildingHeating... 72 5.2.8. BuildingArea... 73 5.2.9. BuildingArrangement... 76 5.2.10. BuildingMaterial... 77 5.2.11. WaterDrainage... 79 5.2.12. EntityBuildingCaseInformation... 79 5.2.13. BuildingInsurance... 79 5.2.14. ExternalReferences... 81 5.2.15. MunicipalityFields... 81 5.2.16. NoteStructure... 81 5.2.17. MunicipalityRelocation... 81 5.3. EntranceStructure... 83 5.3.1. Mulighed for identændringer... 84 5.3.2. EntranceKeys... 86 5.3.3. EntranceInformation... 88 5.3.4. AddressComplete... 90 5.3.5. EntityBuildingCaseInformation... 90 5.3.6. ExternalReferences... 90 5.3.7. MunicipalityFields... 90 5.3.8. NoteStructure... 90 5.4. FloorStructure... 91 5.4.1. Mulighed for identændringer... 92 5.4.2. FloorKeys... 93 5.4.3. FloorInformation... 95 5.4.4. FloorArea... 96 5.4.5. EntityBuildingCaseInformation... 97 5.4.6. ExternalReferences... 97 5.4.7. MunicipalityFields... 97 5.4.8. NoteStructure... 97 5.5. BuildingUnitStructure... 98 5.5.1. Mulighed for identændringer... 99 5.5.2. BuildingUnitKeys... 101 5.5.3. BuildingUnitInformation... 103 5.5.4. AddressComplete... 106 5.5.5. EntityBuildingCaseInformation... 106 5.5.6. CondominiumStructure... 107 5.5.7. BuildingUnitHeating... 107 5.5.8. BuildingUnitArea... 108 5.5.9. BuildingUnitInterior... 110 5.5.10. ExternalReferences... 111 5.5.11. MunicipalityFields... 111 Snitfladebeskrivelse Side 7 af 303
5.5.12. NoteStructure... 111 5.6. TechnicalInstallationStructure... 112 5.6.1. Mulighed for identændringer... 113 5.6.2. TechnicalInstallationKeys... 115 5.6.3. TechnicalInstallationInformation... 118 5.6.4. AddressComplete... 125 5.6.5. ConstructionPoint... 125 5.6.6. EntityBuildingCaseInformation... 125 5.6.7. CondominiumStructure... 126 5.6.8. ExternalReferences... 126 5.6.9. MunicipalityFields... 126 5.6.10. NoteStructure... 126 5.7. RoomStructure... 127 5.7.1. Mulighed for identændringer... 128 5.7.2. RoomKeys... 129 5.7.3. RoomInformation... 132 5.7.4. AddressComplete... 133 5.7.5. EntityBuildingCaseInformation... 133 5.7.6. ExternalReferences... 133 5.7.7. MunicipalityFields... 133 5.7.8. NoteStructure... 133 5.8. UseUnitStructure... 134 5.8.1. Mulighed for identændringer... 135 5.8.2. UseUnitKeys... 136 5.8.3. UseUnitInformation... 138 5.8.4. UseUnitArea... 139 5.8.5. AddressComplete... 140 5.8.6. EntityBuildingCaseInformation... 140 5.8.7. ExternalReferences... 140 5.8.8. MunicipalityFields... 140 5.8.9. NoteStructure... 140 5.9. BuildingCaseStructure... 141 5.9.1. BuildingCaseKeys... 142 5.9.2. BuildingCaseInformation... 143 5.9.3. BuildingCaseDates... 145 5.9.4. BuildingCaseInformationDates... 146 5.9.5. BuildingCaseCompletionDates... 147 5.10. Fælles strukturer... 148 5.10.1. landparcelidentitystructure... 148 5.10.2. AddressComplete... 148 5.10.3. ConstructionPoint... 149 5.10.4. WaterDrainage... 152 5.10.5. EntityBuildingCaseInformation... 157 5.10.6. ExternalReferences... 159 5.10.7. MunicipalityFields... 159 5.10.8. CondominiumStructure... 160 5.10.9. NoteStructure... 161 6. Metoder til entitet grund... 164 6.1. SiteGetById... 165 6.1.1. SiteGetByIdRequestStructure... 165 6.1.2. SiteGetByIdResponseStructure... 166 6.2. SiteGetByIds... 166 6.2.1. SiteGetByIdsRequestStructure... 166 6.2.2. SiteGetByIdsResponseStructure... 167 Snitfladebeskrivelse Side 8 af 303
6.3. SiteGet... 167 6.3.1. SiteGetRequestStructure... 168 6.3.2. SiteGetResponseStructure... 168 6.4. SiteGetByMunicipalRealPropertyId... 168 6.4.1. SiteGetByMunicipalRealPropertyIdRequestStructure... 169 6.4.2. SiteGetByMunicipalRealPropertyIdResponseStructure... 169 6.5. SiteGetByParentId... 169 6.5.1. SiteGetByParentIdRequestStructure... 170 6.5.2. SiteGetByParentIdResponseStructure... 170 6.6. SiteGetSubStructuresById... 170 6.6.1. SiteGetSubStructuresByIdRequestStructure... 171 6.6.2. SiteGetSubStructuresByIdResponseStructure... 171 6.7. SiteCreate... 173 6.7.1. SiteCreateRequestStructure... 174 6.7.2. SiteCreateResponseStructure... 174 6.8. SiteUpdate... 174 6.8.1. SiteUpdateRequestStructure... 175 6.8.2. SiteUpdateResponseStructure... 175 6.9. SiteDelete... 176 6.9.1. SiteDeleteRequestStructure... 176 6.9.2. SiteDeleteResponseStructure... 176 6.10. SiteMoveEntities... 177 6.10.1. SiteMoveEntitiesRequestStructure... 177 6.10.2. SiteMoveEntitiesResponseStructure... 178 7. Metoder til entitet bygning... 179 7.1. BuildingGetById... 180 7.1.1. BuildingGetByIdRequestStructure... 180 7.1.2. BuildingGetByIdResponseStructure... 181 7.2. BuildingGetByIds... 181 7.2.1. BuildingGetByIdsRequestStructure... 181 7.2.2. BuildingGetByIdsResponseStructure... 182 7.3. BuildingGet... 182 7.3.1. BuildingGetRequestStructure... 183 7.3.2. BuildingGetResponseStructure... 183 7.4. BuildingGetBySiteId... 184 7.4.1. BuildingGetBySiteIdRequestStructure... 184 7.4.2. BuildingGetBySiteIdResponseStructure... 184 7.5. BuildingGetByParentId... 185 7.5.1. BuildingGetByParentIdRequestStructure... 185 7.5.2. BuildingGetByParentIdResponseStructure... 186 7.6. BuildingCreate... 186 7.6.1. BuildingCreateRequestStructure... 186 7.6.2. BuildingCreateResponseStructure... 187 7.7. BuildingUpdate... 187 7.7.1. BuidlingUpdateRequestStructure... 188 7.7.2. BuildingUpdateResponseStructure... 188 7.8. BuildingDelete... 189 7.8.1. BuildingDeleteRequestStructure... 189 7.8.2. BuildingDeleteResponseStructure... 190 7.9. BuildingDeleteHistoric... 190 7.9.1. BuildingDeleteHistoricRequestStructure... 190 7.9.2. BuildingDeleteHistoricResponseStructure... 190 8. Metoder til entitet opgang/indgang... 192 Snitfladebeskrivelse Side 9 af 303
8.1. EntranceGetById... 192 8.1.1. EntranceGetByIdRequestStructure... 193 8.1.2. EntranceGetByIdResponseStructure... 193 8.2. EntranceGetByIds... 194 8.2.1. EntranceGetByIdsRequestStructure... 194 8.2.2. EntranceGetByIdsResponseStructure... 195 8.3. EntranceGet... 195 8.3.1. EntranceGetRequestStructure... 196 8.3.2. EntranceGetResponseStructure... 196 8.4. EntranceGetByBuildingId... 197 8.4.1. EntranceGetByBuildingIdRequestStructure... 197 8.4.2. EntranceGetByBuildingIdResponseStructure... 197 8.5. EntranceGetByParentId... 198 8.5.1. EntranceGetByParentIdRequestStructure... 198 8.5.2. EntranceGetByParentIdResponseStructure... 199 8.6. EntranceCreate... 199 8.6.1. EntranceCreateRequestStructure... 200 8.6.2. EntranceCreateResponseStructure... 200 8.7. EntranceUpdate... 200 8.7.1. EntranceUpdateRequestStructure... 201 8.7.2. EntranceUpdateResponseStructure... 201 8.8. EntranceDelete... 202 8.8.1. EntranceDeleteRequestStructure... 202 8.8.2. EntranceDeleteResponseStructure... 203 8.9. EntranceDeleteHistoric... 203 8.9.1. EntranceDeleteHistoricRequestStructure... 203 8.9.2. EntranceDeleteHistoricResponseStructure... 203 9. Metoder til entitet etage... 205 9.1. FloorGetById... 205 9.1.1. FloorGetByIdRequestStructure... 206 9.1.2. FloorGetByIdResponseStructure... 206 9.2. FloorGetByIds... 207 9.2.1. FloorGetByIdsRequestStructure... 207 9.2.2. FloorGetByIdsResponseStructure... 207 9.3. FloorGet... 208 9.3.1. FloorGetRequestStructure... 208 9.3.2. FloorGetResponseStructure... 209 9.4. FloorGetByBuildingId... 209 9.4.1. FloorGetByBuildingIdRequestStructure... 210 9.4.2. FloorGetByBuildingIdResponseStructure... 210 9.5. FloorGetByParentId... 210 9.5.1. FloorGetByParentIdRequestStructure... 211 9.5.2. FloorGetByParentIdResponseStructure... 211 9.6. FloorCreate... 211 9.6.1. FloorCreateRequestStructure... 212 9.6.2. FloorCreateResponseStructure... 212 9.7. FloorUpdate... 213 9.7.1. FloorUpdateRequestStructure... 213 9.7.2. FloorUpdateResponseStructure... 214 9.8. FloorDelete... 214 9.8.1. FloorDeleteRequestStructure... 214 9.8.2. FloorDeleteResponseStructure... 215 9.9. FloorDeleteHistoric... 215 9.9.1. FloorDeleteHistoricRequestStructure... 215 Snitfladebeskrivelse Side 10 af 303
9.9.2. FloorDeleteHistoricResponseStructure... 216 10. Metoder til entitet enhed... 217 10.1. BuildingUnitGetById... 218 10.1.1. BuildingUnitGetByIdRequestStructure... 218 10.1.2. BuildingUnitGetByIdResponseStructure... 218 10.2. BuildingUnitGetByIds... 219 10.2.1. BuildingUnitGetByIdsRequestStructure... 219 10.2.2. BuildingUnitGetByIdsResponseStructure... 220 10.3. BuildingUnitGet... 220 10.3.1. BuildingUnitGetRequestStructure... 221 10.3.2. BuildingUnitGetResponseStructure... 221 10.4. BuildingUnitGetByEntranceId... 222 10.4.1. BuildingUnitGetByEntranceIdRequestStructure... 222 10.4.2. BuildingUnitGetByEntranceIdResponseStructure... 223 10.5. BuildingUnitGetByFloorId... 223 10.5.1. BuildingUnitGetByFloorIdRequestStructure... 223 10.5.2. BuildingUnitGetByFloorIdResponseStructure... 224 10.6. BuildingUnitGetByParentId... 224 10.6.1. BuildingUnitGetByParentIdRequestStructure... 225 10.6.2. BuildingUnitGetByParentIdResponseStructure... 225 10.7. BuildingUnitCreate... 225 10.7.1. BuildingUnitCreateRequestStructure... 226 10.7.2. BuildingUnitCreateResponseStructure... 226 10.8. BuildingUnitUpdate... 227 10.8.1. BuildingUnitUpdateRequestStructure... 227 10.8.2. BuildingUnitUpdateResponseStructure... 228 10.9. BuildingUnitDelete... 228 10.9.1. BuildingUnitDeleteRequestStructure... 228 10.9.2. BuildingUnitDeleteResponseStructure... 229 10.10. BuildingUnitDeleteHistoric... 229 10.10.1. BuildingUnitDeleteHistoricRequestStructure... 230 10.10.2. BuildingUnitDeleteHistoricResponseStructure... 230 11. Metoder til entitet teknisk anlæg... 231 11.1. TechnicalInstallationGetById... 231 11.1.1. TechnicalInstallationGetByIdRequestStructure... 232 11.1.2. TechnicalInstallationGetByIdResponseStructure... 232 11.2. TechnicalInstallationGetByIds... 233 11.2.1. TechnicalInstallationGetByIdsRequestStructure... 233 11.2.2. TechnicalInstallationGetByIdsResponseStructure... 234 11.3. TechnicalInstallationGet... 234 11.3.1. TechnicalInstallationGetRequestStructure... 235 11.3.2. TechnicalInstallationGetResponseStructure... 235 11.4. TechnicalInstallationGetBySiteId... 235 11.4.1. TechnicalInstallationGetBySiteIdRequestStructure... 236 11.4.2. TechnicalInstallationGetBySiteIdResponseStructure... 236 11.5. TechnicalInstallationGetByBuildingId... 236 11.5.1. TechnicalInstallationGetByBuildingIdRequestStructure... 237 11.5.2. TechnicalInstallationGetByBuildingIdResponseStructure... 237 11.6. TechnicalInstallationGetByParentId... 237 11.6.1. TechnicalInstallationGetByParentIdRequestStructure... 238 11.6.2. TechnicalInstallationGetByParentIdResponseStructure... 238 11.7. TechnicalInstallationCreate... 239 11.7.1. TechnicalInstallationCreateRequestStructure... 239 Snitfladebeskrivelse Side 11 af 303
11.7.2. TechnicalInstallationCreateResponseStructure... 240 11.8. TechnicalInstallationUpdate... 240 11.8.1. TechnicalInstallationUpdateRequestStructure... 240 11.8.2. TechnicalInstallationUpdateResponseStructure... 241 11.9. TechnicalInstallationDelete... 241 11.9.1. TechnicalInstallationDeleteRequestStructure... 242 11.9.2. TechnicalInstallationDeleteResponseStructure... 242 11.10. TechnicalInstallationDeleteHistoric... 242 11.10.1. TechnicalInstallationDeleteHistoricRequestStructure... 243 11.10.2. TechnicalInstallationDeleteHistoricResponseStructure... 243 12. Metoder til entitet rum... 244 12.1. RoomGetById... 245 12.1.1. RoomGetByIdRequestStructure... 245 12.1.2. RoomGetByIdResponseStructure... 245 12.2. RoomGetByIds... 246 12.2.1. RoomGetByIdsRequestStructure... 246 12.2.2. RoomGetByIdsResponseStructure... 247 12.3. RoomGet... 247 12.3.1. RoomGetRequestStructure... 248 12.3.2. RoomGetResponseStructure... 248 12.4. RoomGetByFloorId... 248 12.4.1. RoomGetByFloorIdRequestStructure... 249 12.4.2. RoomGetByFloorIdResponseStructure... 249 12.5. RoomGetByBuildingUnitId... 249 12.5.1. RoomGetByBuildingUnitIdRequestStructure... 250 12.5.2. RoomGetByBuildingUnitIdResponseStructure... 250 12.6. RoomGetByParentId... 251 12.6.1. RoomGetByParentIdRequestStructure... 251 12.6.2. RoomGetByParentIdResponseStructure... 251 12.7. RoomCreate... 252 12.7.1. RoomCreateRequestStructure... 252 12.7.2. RoomCreateResponseStructure... 253 12.8. RoomUpdate... 253 12.8.1. RoomUpdateRequestStructure... 254 12.8.2. RoomUpdateResponseStructure... 254 12.9. RoomDelete... 254 12.9.1. RoomDeleteRequestStructure... 255 12.9.2. RoomDeleteResponseStructure... 255 12.10. RoomDeleteHistoric... 255 12.10.1. RoomDeleteHistoricRequestStructure... 256 12.10.2. RoomDeleteHistoricResponseStructure... 256 13. Metoder til entitet brugsenhed... 257 13.1. UseUnitGetById... 257 13.1.1. UseUnitGetByIdRequestStructure... 258 13.1.2. UseUnitGetByIdResponseStructure... 258 13.2. UseUnitGetByIds... 259 13.2.1. UseUnitGetByIdsRequestStructure... 259 13.2.2. UseUnitGetByIdsResponseStructure... 259 13.3. UseUnitGet... 260 13.3.1. UseUnitGetRequestStructure... 260 13.3.2. UseUnitGetResponseStructure... 261 13.4. UseUnitGetByBuildingId... 261 13.4.1. UseUnitGetByBuildingIdRequestStructure... 262 Snitfladebeskrivelse Side 12 af 303
13.4.2. UseUnitGetByBuildingIdResponseStructure... 262 13.5. UseUnitGetByParentId... 262 13.5.1. UseUnitGetByParentIdRequestStructure... 263 13.5.2. UseUnitGetByParentIdResponseStructure... 263 13.6. UseUnitCreate... 263 13.6.1. UseUnitCreateRequestStructure... 264 13.6.2. UseUnitCreateResponseStructure... 264 13.7. UseUnitUpdate... 265 13.7.1. UseUnitUpdateRequestStructure... 265 13.7.2. UseUnitUpdateResponseStructure... 266 13.8. UseUnitDelete... 266 13.8.1. UseUnitDeleteRequestStructure... 266 13.8.2. UseUnitDeleteResponseStructure... 267 13.9. UseUnitDeleteHistoric... 267 13.9.1. UseUnitDeleteHistoricRequestStructure... 268 13.9.2. UseUnitDeleteHistoricResponseStructure... 268 14. Metoder til entitet byggesag... 269 14.1. BuildingCaseGetById... 269 14.1.1. BuildingCaseGetByIdRequestStructure... 270 14.1.2. BuildingCaseGetByIdResponseStructure... 270 14.2. BuildingCaseGetByIds... 270 14.2.1. BuildingCaseGetByIdsRequestStructure... 271 14.2.2. BuildingCaseGetByIdsResponseStructure... 271 14.3. BuildingCaseGet... 272 14.3.1. BuildingCaseGetRequestStructure... 272 14.3.2. BuildingCaseGetResponseStructure... 272 14.4. BuildingCaseGetBySiteId... 273 14.4.1. BuildingCaseGetBySiteIdRequestStructure... 273 14.4.2. BuildingCaseGetBySiteIdResponseStructure... 273 14.5. BuildingCaseGetByEntityId... 274 14.5.1. BuildingCaseGetByEntityIdRequestStructure... 275 14.5.2. BuildingCaseGetByEntityIdResponseStructure... 276 14.6. BuildingCaseGetAllEntities... 276 14.6.1. BuildingCaseGetAllEntitiesRequestStructure... 276 14.6.2. BuildingCaseGetAllEntitiesResponseStructure... 277 14.7. BuildingCaseCreate... 278 14.7.1. BuildingCaseCreateRequestStructure... 278 14.7.2. BuildingCaseCreateResponseStructure... 279 14.8. BuildingCaseUpdate... 279 14.8.1. BuidlingCaseUpdateRequestStructure... 280 14.8.2. BuildingCaseUpdateResponseStructure... 280 14.9. BuildingCaseDelete... 280 14.9.1. BuildingCaseDeleteRequestStructure... 281 14.9.2. BuildingCaseDeleteResponseStructure... 281 15. Metoder til søgninger... 282 15.1. Søgekriterier... 283 15.1.1. AddressSearchRequestSubStructure... 284 15.1.2. SiteSearchRequestSubStructure... 285 15.1.3. BuildingSearchRequestSubStructure... 285 15.1.4. FloorSearchRequestSubStructure... 286 15.1.5. BuildingUnitSearchRequestSubStructure... 286 15.1.6. CondominiumSearchRequestSubStructure... 287 15.1.7. TechnicalInstallationSearchRequestSubStructure... 287 Snitfladebeskrivelse Side 13 af 303
15.1.8. RoomSearchRequestSubStructure... 288 15.1.9. UseUnitSearchRequestSubStructure... 288 15.1.10. BuildingCaseSearchRequestSubStructure... 288 15.2. Søgemetoder og søgeresultat... 289 15.3. Søgning på grunde... 291 15.3.1. SiteSearchRequestStructure... 291 15.3.2. SiteSearchResponseStructure... 291 15.4. Søgning på bygninger... 292 15.4.1. BuildingSearchRequestStructure... 292 15.4.2. BuildingSearchResponseStructure... 292 15.5. Søgning på opgange/indgange... 293 15.5.1. EntranceSearchRequestStructure... 293 15.5.2. EntranceSearchResponseStructure... 293 15.6. Søgning på etager... 294 15.6.1. FloorSearchRequestStructure... 294 15.6.2. FloorSearchResponseStructure... 295 15.7. Søgning på enheder... 296 15.7.1. BuildingUnitSearchRequestStructure... 296 15.7.2. BuildingUnitSearchResponseStructure... 297 15.8. Søgning på tekniske anlæg... 297 15.8.1. TechnicalInstallationSearchRequestStructure... 297 15.8.2. TechnicalInstallationSearchResponseStructure... 298 15.9. Søgning på rum... 298 15.9.1. RoomSearchRequestStructure... 298 15.9.2. RoomSearchResponseStructure... 299 15.10. Søgning på brugsenheder... 299 15.10.1. UseUnitSearchRequestStructure... 300 15.10.2. UseUnitSearchResponseStructure... 300 15.11. Søgning på byggesager... 300 15.11.1. BuildingCaseSearchRequestStructure... 301 15.11.2. BuildingCaseSearchResponseStructure... 301 16. Adgang til snitfladen... 302 16.1. Sikkerhed... 302 16.2. Kodeeksempel for kald af certifikat... 302 16.3. Autorisation... 302 16.4. Testmiljø... 303 Indholdsfortegnelse... 6 1. Introduktion... 15 2. Formål og målgrupper... 17 3. Forretningsviden... 18 3.1. De forskellige entiteter i og deres sammenhæng... 18 3.2. Adressers tilknytning til niveauer i Bygninger og boliger... 20 3.3. Stamentiteter... 22 3.4. Sagsentiteter... 22 3.5. Byggesager... 23 3.5.1. Mulige byggesagskoder... 23 3.5.2. Afslutning af en byggesag... 23 3.5.3. Overførsel af data fra sag til stam... 24 3.5.4. Midlertidig afslutning af en byggesag... 24 3.5.5. Delvis afslutning af en byggesag... 25 3.5.6. Indflytning... 26 Snitfladebeskrivelse Side 14 af 303
3.5.7. Henlæggelse... 26 3.5.8. Sletning af sagsentitet i en byggesag... 26 3.5.9. Sletning af byggesag... 26 3.5.10. Kopiering af byggesager... 26 3.6. Koordinater til bygning og teknisk anlæg... 29 3.6.1. Foreløbige koordinater... 30 3.6.2. Kontrol af koordinater... 30 3.7. Historiske data... 31 4. Overblik over webservices og metoderne... 32 4.1. Sandsynlighedskontroller (IgnoreWarningIndicator)... 33 4.2. Udskrivning af Meddelelser (printenableindicator)... 33 4.3. Gyldighedsdato (AssessmentChangedDate)... 34 4.4. Den implementerede opdateringsmekanisme... 34 4.5. Rettigheder... 35 4.6. Styring af opdateringer (RecordChangeDateTime)... 35 4.7. Sagstype (BuildingCaseTypeCode og updatereasoncode)... 35 4.8. Resultat for metodekald (ReturnMessage)... 36 4.9. Skemavalidering... 37 4.10. UniversalIdentifier og Reference... 38 4.11. Placeholder-problematik... 38 4.11.1. <Entity>GetById og <Entity>GetByIds metoder... 40 4.11.2. <Entity>GetByParentId metoder... 41 4.11.3. <Entity1>GetBy<Entity2>Id metoder... 41 4.11.4. BuildingCaseGetByEntityId metode... 42 4.11.5. Delete og update metoder... 42 4.12. Namespaces... 42 4.13. Datatyper... 43 4.14. Udviklingsværktøjer... 43 4.15. Rettigheder... 43 5. Strukturer til entiteter - <Entity>Structure... 44 5.1. SiteStructure... 45 5.1.1. Mulighed for identændringer... 46 5.1.2. SiteKeys... 47 5.1.3. SiteInformation... 49 5.1.4. AddressComplete... 51 5.1.5. WaterDrainage... 51 5.1.6. EntityBuildingCaseInformation... 51 5.1.7. ExternalReferences... 51 5.1.8. MunicipalityFields... 51 5.1.9. NoteStructure... 51 5.2. BuildingStructure... 52 5.2.1. Mulighed for identændringer... 54 5.2.2. BuildingKeys... 56 5.2.3. BuildingInformation... 59 5.2.4. AddressComplete... 62 5.2.5. CondominiumStructure... 62 5.2.6. ConstructionPoint... 62 5.2.7. BuildingHeating... 63 5.2.8. BuildingArea... 64 5.2.9. BuildingArrangement... 67 5.2.10. BuildingMaterial... 68 5.2.11. WaterDrainage... 70 5.2.12. EntityBuildingCaseInformation... 70 Snitfladebeskrivelse Side 15 af 303
5.2.13. BuildingInsurance... 70 5.2.14. ExternalReferences... 72 5.2.15. MunicipalityFields... 72 5.2.16. NoteStructure... 72 5.2.17. MunicipalityRelocation... 72 5.3. EntranceStructure... 74 5.3.1. Mulighed for identændringer... 75 5.3.2. EntranceKeys... 77 5.3.3. EntranceInformation... 79 5.3.4. AddressComplete... 81 5.3.5. EntityBuildingCaseInformation... 81 5.3.6. ExternalReferences... 81 5.3.7. MunicipalityFields... 81 5.3.8. NoteStructure... 81 5.4. FloorStructure... 82 5.4.1. Mulighed for identændringer... 83 5.4.2. FloorKeys... 84 5.4.3. FloorInformation... 86 5.4.4. FloorArea... 87 5.4.5. EntityBuildingCaseInformation... 88 5.4.6. ExternalReferences... 88 5.4.7. MunicipalityFields... 88 5.4.8. NoteStructure... 88 5.5. BuildingUnitStructure... 89 5.5.1. Mulighed for identændringer... 90 5.5.2. BuildingUnitKeys... 92 5.5.3. BuildingUnitInformation... 94 5.5.4. AddressComplete... 97 5.5.5. EntityBuildingCaseInformation... 97 5.5.6. CondominiumStructure... 98 5.5.7. BuildingUnitHeating... 98 5.5.8. BuildingUnitArea... 99 5.5.9. BuildingUnitInterior... 101 5.5.10. ExternalReferences... 102 5.5.11. MunicipalityFields... 102 5.5.12. NoteStructure... 102 5.6. TechnicalInstallationStructure... 103 5.6.1. Mulighed for identændringer... 104 5.6.2. TechnicalInstallationKeys... 106 5.6.3. TechnicalInstallationInformation... 109 5.6.4. AddressComplete... 116 5.6.5. ConstructionPoint... 116 5.6.6. EntityBuildingCaseInformation... 116 5.6.7. CondominiumStructure... 117 5.6.8. ExternalReferences... 117 5.6.9. MunicipalityFields... 117 5.6.10. NoteStructure... 117 5.7. RoomStructure... 118 5.7.1. Mulighed for identændringer... 119 5.7.2. RoomKeys... 120 5.7.3. RoomInformation... 123 5.7.4. AddressComplete... 124 5.7.5. EntityBuildingCaseInformation... 124 5.7.6. ExternalReferences... 124 5.7.7. MunicipalityFields... 124 Snitfladebeskrivelse Side 16 af 303
5.7.8. NoteStructure... 124 5.8. UseUnitStructure... 125 5.8.1. Mulighed for identændringer... 126 5.8.2. UseUnitKeys... 127 5.8.3. UseUnitInformation... 129 5.8.4. UseUnitArea... 130 5.8.5. AddressComplete... 131 5.8.6. EntityBuildingCaseInformation... 131 5.8.7. ExternalReferences... 131 5.8.8. MunicipalityFields... 131 5.8.9. NoteStructure... 131 5.9. BuildingCaseStructure... 132 5.9.1. BuildingCaseKeys... 133 5.9.2. BuildingCaseInformation... 134 5.9.3. BuildingCaseDates... 136 5.9.4. BuildingCaseInformationDates... 137 5.9.5. BuildingCaseCompletionDates... 138 5.10. Fælles strukturer... 139 5.10.1. landparcelidentitystructure... 139 5.10.2. AddressComplete... 139 5.10.3. ConstructionPoint... 140 5.10.4. WaterDrainage... 143 5.10.5. EntityBuildingCaseInformation... 148 5.10.6. ExternalReferences... 150 5.10.7. MunicipalityFields... 150 5.10.8. CondominiumStructure... 151 5.10.9. NoteStructure... 152 6. Metoder til entitet grund... 155 6.1. SiteGetById... 156 6.1.1. SiteGetByIdRequestStructure... 156 6.1.2. SiteGetByIdResponseStructure... 157 6.2. SiteGetByIds... 157 6.2.1. SiteGetByIdsRequestStructure... 157 6.2.2. SiteGetByIdsResponseStructure... 158 6.3. SiteGet... 158 6.3.1. SiteGetRequestStructure... 159 6.3.2. SiteGetResponseStructure... 159 6.4. SiteGetByMunicipalRealPropertyId... 159 6.4.1. SiteGetByMunicipalRealPropertyIdRequestStructure... 160 6.4.2. SiteGetByMunicipalRealPropertyIdResponseStructure... 160 6.5. SiteGetByParentId... 160 6.5.1. SiteGetByParentIdRequestStructure... 161 6.5.2. SiteGetByParentIdResponseStructure... 161 6.6. SiteGetSubStructuresById... 161 6.6.1. SiteGetSubStructuresByIdRequestStructure... 162 6.6.2. SiteGetSubStructuresByIdResponseStructure... 162 6.7. SiteCreate... 164 6.7.1. SiteCreateRequestStructure... 165 6.7.2. SiteCreateResponseStructure... 165 6.8. SiteUpdate... 165 6.8.1. SiteUpdateRequestStructure... 166 6.8.2. SiteUpdateResponseStructure... 166 6.9. SiteDelete... 167 6.9.1. SiteDeleteRequestStructure... 167 Snitfladebeskrivelse Side 17 af 303
6.9.2. SiteDeleteResponseStructure... 167 6.10. SiteMoveEntities... 168 6.10.1. SiteMoveEntitiesRequestStructure... 168 6.10.2. SiteMoveEntitiesResponseStructure... 169 7. Metoder til entitet bygning... 170 7.1. BuildingGetById... 171 7.1.1. BuildingGetByIdRequestStructure... 171 7.1.2. BuildingGetByIdResponseStructure... 172 7.2. BuildingGetByIds... 172 7.2.1. BuildingGetByIdsRequestStructure... 172 7.2.2. BuildingGetByIdsResponseStructure... 173 7.3. BuildingGet... 173 7.3.1. BuildingGetRequestStructure... 174 7.3.2. BuildingGetResponseStructure... 174 7.4. BuildingGetBySiteId... 175 7.4.1. BuildingGetBySiteIdRequestStructure... 175 7.4.2. BuildingGetBySiteIdResponseStructure... 175 7.5. BuildingGetByParentId... 176 7.5.1. BuildingGetByParentIdRequestStructure... 176 7.5.2. BuildingGetByParentIdResponseStructure... 177 7.6. BuildingCreate... 177 7.6.1. BuildingCreateRequestStructure... 177 7.6.2. BuildingCreateResponseStructure... 178 7.7. BuildingUpdate... 178 7.7.1. BuidlingUpdateRequestStructure... 179 7.7.2. BuildingUpdateResponseStructure... 179 7.8. BuildingDelete... 180 7.8.1. BuildingDeleteRequestStructure... 180 7.8.2. BuildingDeleteResponseStructure... 181 7.9. BuildingDeleteHistoric... 181 7.9.1. BuildingDeleteHistoricRequestStructure... 181 7.9.2. BuildingDeleteHistoricResponseStructure... 181 8. Metoder til entitet opgang/indgang... 183 8.1. EntranceGetById... 183 8.1.1. EntranceGetByIdRequestStructure... 184 8.1.2. EntranceGetByIdResponseStructure... 184 8.2. EntranceGetByIds... 185 8.2.1. EntranceGetByIdsRequestStructure... 185 8.2.2. EntranceGetByIdsResponseStructure... 186 8.3. EntranceGet... 186 8.3.1. EntranceGetRequestStructure... 187 8.3.2. EntranceGetResponseStructure... 187 8.4. EntranceGetByBuildingId... 188 8.4.1. EntranceGetByBuildingIdRequestStructure... 188 8.4.2. EntranceGetByBuildingIdResponseStructure... 188 8.5. EntranceGetByParentId... 189 8.5.1. EntranceGetByParentIdRequestStructure... 189 8.5.2. EntranceGetByParentIdResponseStructure... 190 8.6. EntranceCreate... 190 8.6.1. EntranceCreateRequestStructure... 191 8.6.2. EntranceCreateResponseStructure... 191 8.7. EntranceUpdate... 191 8.7.1. EntranceUpdateRequestStructure... 192 Snitfladebeskrivelse Side 18 af 303
8.7.2. EntranceUpdateResponseStructure... 192 8.8. EntranceDelete... 193 8.8.1. EntranceDeleteRequestStructure... 193 8.8.2. EntranceDeleteResponseStructure... 194 8.9. EntranceDeleteHistoric... 194 8.9.1. EntranceDeleteHistoricRequestStructure... 194 8.9.2. EntranceDeleteHistoricResponseStructure... 194 9. Metoder til entitet etage... 196 9.1. FloorGetById... 196 9.1.1. FloorGetByIdRequestStructure... 197 9.1.2. FloorGetByIdResponseStructure... 197 9.2. FloorGetByIds... 198 9.2.1. FloorGetByIdsRequestStructure... 198 9.2.2. FloorGetByIdsResponseStructure... 198 9.3. FloorGet... 199 9.3.1. FloorGetRequestStructure... 199 9.3.2. FloorGetResponseStructure... 200 9.4. FloorGetByBuildingId... 200 9.4.1. FloorGetByBuildingIdRequestStructure... 201 9.4.2. FloorGetByBuildingIdResponseStructure... 201 9.5. FloorGetByParentId... 201 9.5.1. FloorGetByParentIdRequestStructure... 202 9.5.2. FloorGetByParentIdResponseStructure... 202 9.6. FloorCreate... 202 9.6.1. FloorCreateRequestStructure... 203 9.6.2. FloorCreateResponseStructure... 203 9.7. FloorUpdate... 204 9.7.1. FloorUpdateRequestStructure... 204 9.7.2. FloorUpdateResponseStructure... 205 9.8. FloorDelete... 205 9.8.1. FloorDeleteRequestStructure... 205 9.8.2. FloorDeleteResponseStructure... 206 9.9. FloorDeleteHistoric... 206 9.9.1. FloorDeleteHistoricRequestStructure... 206 9.9.2. FloorDeleteHistoricResponseStructure... 207 10. Metoder til entitet enhed... 208 10.1. BuildingUnitGetById... 209 10.1.1. BuildingUnitGetByIdRequestStructure... 209 10.1.2. BuildingUnitGetByIdResponseStructure... 209 10.2. BuildingUnitGetByIds... 210 10.2.1. BuildingUnitGetByIdsRequestStructure... 210 10.2.2. BuildingUnitGetByIdsResponseStructure... 211 10.3. BuildingUnitGet... 211 10.3.1. BuildingUnitGetRequestStructure... 212 10.3.2. BuildingUnitGetResponseStructure... 212 10.4. BuildingUnitGetByEntranceId... 213 10.4.1. BuildingUnitGetByEntranceIdRequestStructure... 213 10.4.2. BuildingUnitGetByEntranceIdResponseStructure... 214 10.5. BuildingUnitGetByFloorId... 214 10.5.1. BuildingUnitGetByFloorIdRequestStructure... 214 10.5.2. BuildingUnitGetByFloorIdResponseStructure... 215 10.6. BuildingUnitGetByParentId... 215 10.6.1. BuildingUnitGetByParentIdRequestStructure... 216 Snitfladebeskrivelse Side 19 af 303
10.6.2. BuildingUnitGetByParentIdResponseStructure... 216 10.7. BuildingUnitCreate... 216 10.7.1. BuildingUnitCreateRequestStructure... 217 10.7.2. BuildingUnitCreateResponseStructure... 217 10.8. BuildingUnitUpdate... 218 10.8.1. BuildingUnitUpdateRequestStructure... 218 10.8.2. BuildingUnitUpdateResponseStructure... 219 10.9. BuildingUnitDelete... 219 10.9.1. BuildingUnitDeleteRequestStructure... 219 10.9.2. BuildingUnitDeleteResponseStructure... 220 10.10. BuildingUnitDeleteHistoric... 220 10.10.1. BuildingUnitDeleteHistoricRequestStructure... 221 10.10.2. BuildingUnitDeleteHistoricResponseStructure... 221 11. Metoder til entitet teknisk anlæg... 222 11.1. TechnicalInstallationGetById... 222 11.1.1. TechnicalInstallationGetByIdRequestStructure... 223 11.1.2. TechnicalInstallationGetByIdResponseStructure... 223 11.2. TechnicalInstallationGetByIds... 224 11.2.1. TechnicalInstallationGetByIdsRequestStructure... 224 11.2.2. TechnicalInstallationGetByIdsResponseStructure... 225 11.3. TechnicalInstallationGet... 225 11.3.1. TechnicalInstallationGetRequestStructure... 226 11.3.2. TechnicalInstallationGetResponseStructure... 226 11.4. TechnicalInstallationGetBySiteId... 226 11.4.1. TechnicalInstallationGetBySiteIdRequestStructure... 227 11.4.2. TechnicalInstallationGetBySiteIdResponseStructure... 227 11.5. TechnicalInstallationGetByBuildingId... 227 11.5.1. TechnicalInstallationGetByBuildingIdRequestStructure... 228 11.5.2. TechnicalInstallationGetByBuildingIdResponseStructure... 228 11.6. TechnicalInstallationGetByParentId... 228 11.6.1. TechnicalInstallationGetByParentIdRequestStructure... 229 11.6.2. TechnicalInstallationGetByParentIdResponseStructure... 229 11.7. TechnicalInstallationCreate... 230 11.7.1. TechnicalInstallationCreateRequestStructure... 230 11.7.2. TechnicalInstallationCreateResponseStructure... 231 11.8. TechnicalInstallationUpdate... 231 11.8.1. TechnicalInstallationUpdateRequestStructure... 231 11.8.2. TechnicalInstallationUpdateResponseStructure... 232 11.9. TechnicalInstallationDelete... 232 11.9.1. TechnicalInstallationDeleteRequestStructure... 233 11.9.2. TechnicalInstallationDeleteResponseStructure... 233 11.10. TechnicalInstallationDeleteHistoric... 233 11.10.1. TechnicalInstallationDeleteHistoricRequestStructure... 234 11.10.2. TechnicalInstallationDeleteHistoricResponseStructure... 234 12. Metoder til entitet rum... 235 12.1. RoomGetById... 236 12.1.1. RoomGetByIdRequestStructure... 236 12.1.2. RoomGetByIdResponseStructure... 236 12.2. RoomGetByIds... 237 12.2.1. RoomGetByIdsRequestStructure... 237 12.2.2. RoomGetByIdsResponseStructure... 238 12.3. RoomGet... 238 12.3.1. RoomGetRequestStructure... 239 Snitfladebeskrivelse Side 20 af 303
12.3.2. RoomGetResponseStructure... 239 12.4. RoomGetByFloorId... 239 12.4.1. RoomGetByFloorIdRequestStructure... 240 12.4.2. RoomGetByFloorIdResponseStructure... 240 12.5. RoomGetByBuildingUnitId... 240 12.5.1. RoomGetByBuildingUnitIdRequestStructure... 241 12.5.2. RoomGetByBuildingUnitIdResponseStructure... 241 12.6. RoomGetByParentId... 242 12.6.1. RoomGetByParentIdRequestStructure... 242 12.6.2. RoomGetByParentIdResponseStructure... 242 12.7. RoomCreate... 243 12.7.1. RoomCreateRequestStructure... 243 12.7.2. RoomCreateResponseStructure... 244 12.8. RoomUpdate... 244 12.8.1. RoomUpdateRequestStructure... 245 12.8.2. RoomUpdateResponseStructure... 245 12.9. RoomDelete... 245 12.9.1. RoomDeleteRequestStructure... 246 12.9.2. RoomDeleteResponseStructure... 246 12.10. RoomDeleteHistoric... 246 12.10.1. RoomDeleteHistoricRequestStructure... 247 12.10.2. RoomDeleteHistoricResponseStructure... 247 13. Metoder til entitet brugsenhed... 248 13.1. UseUnitGetById... 248 13.1.1. UseUnitGetByIdRequestStructure... 249 13.1.2. UseUnitGetByIdResponseStructure... 249 13.2. UseUnitGetByIds... 250 13.2.1. UseUnitGetByIdsRequestStructure... 250 13.2.2. UseUnitGetByIdsResponseStructure... 250 13.3. UseUnitGet... 251 13.3.1. UseUnitGetRequestStructure... 251 13.3.2. UseUnitGetResponseStructure... 252 13.4. UseUnitGetByBuildingId... 252 13.4.1. UseUnitGetByBuildingIdRequestStructure... 253 13.4.2. UseUnitGetByBuildingIdResponseStructure... 253 13.5. UseUnitGetByParentId... 253 13.5.1. UseUnitGetByParentIdRequestStructure... 254 13.5.2. UseUnitGetByParentIdResponseStructure... 254 13.6. UseUnitCreate... 254 13.6.1. UseUnitCreateRequestStructure... 255 13.6.2. UseUnitCreateResponseStructure... 255 13.7. UseUnitUpdate... 256 13.7.1. UseUnitUpdateRequestStructure... 256 13.7.2. UseUnitUpdateResponseStructure... 257 13.8. UseUnitDelete... 257 13.8.1. UseUnitDeleteRequestStructure... 257 13.8.2. UseUnitDeleteResponseStructure... 258 13.9. UseUnitDeleteHistoric... 258 13.9.1. UseUnitDeleteHistoricRequestStructure... 259 13.9.2. UseUnitDeleteHistoricResponseStructure... 259 14. Metoder til entitet byggesag... 260 14.1. BuildingCaseGetById... 260 14.1.1. BuildingCaseGetByIdRequestStructure... 261 Snitfladebeskrivelse Side 21 af 303
14.1.2. BuildingCaseGetByIdResponseStructure... 261 14.2. BuildingCaseGetByIds... 261 14.2.1. BuildingCaseGetByIdsRequestStructure... 262 14.2.2. BuildingCaseGetByIdsResponseStructure... 262 14.3. BuildingCaseGet... 263 14.3.1. BuildingCaseGetRequestStructure... 263 14.3.2. BuildingCaseGetResponseStructure... 263 14.4. BuildingCaseGetBySiteId... 264 14.4.1. BuildingCaseGetBySiteIdRequestStructure... 264 14.4.2. BuildingCaseGetBySiteIdResponseStructure... 264 14.5. BuildingCaseGetByEntityId... 265 14.5.1. BuildingCaseGetByEntityIdRequestStructure... 266 14.5.2. BuildingCaseGetByEntityIdResponseStructure... 267 14.6. BuildingCaseGetAllEntities... 267 14.6.1. BuildingCaseGetAllEntitiesRequestStructure... 267 14.6.2. BuildingCaseGetAllEntitiesResponseStructure... 268 14.7. BuildingCaseCreate... 269 14.7.1. BuildingCaseCreateRequestStructure... 269 14.7.2. BuildingCaseCreateResponseStructure... 270 14.8. BuildingCaseUpdate... 270 14.8.1. BuidlingCaseUpdateRequestStructure... 271 14.8.2. BuildingCaseUpdateResponseStructure... 271 14.9. BuildingCaseDelete... 271 14.9.1. BuildingCaseDeleteRequestStructure... 272 14.9.2. BuildingCaseDeleteResponseStructure... 272 15. Metoder til søgninger... 273 15.1. Søgekriterier... 274 15.1.1. AddressSearchRequestSubStructure... 275 15.1.2. SiteSearchRequestSubStructure... 276 15.1.3. BuildingSearchRequestSubStructure... 276 15.1.4. FloorSearchRequestSubStructure... 277 15.1.5. BuildingUnitSearchRequestSubStructure... 277 15.1.6. CondominiumSearchRequestSubStructure... 278 15.1.7. TechnicalInstallationSearchRequestSubStructure... 278 15.1.8. RoomSearchRequestSubStructure... 279 15.1.9. UseUnitSearchRequestSubStructure... 279 15.1.10. BuildingCaseSearchRequestSubStructure... 279 15.2. Søgemetoder og søgeresultat... 280 15.3. Søgning på grunde... 282 15.3.1. SiteSearchRequestStructure... 282 15.3.2. SiteSearchResponseStructure... 282 15.4. Søgning på bygninger... 283 15.4.1. BuildingSearchRequestStructure... 283 15.4.2. BuildingSearchResponseStructure... 283 15.5. Søgning på opgange/indgange... 284 15.5.1. EntranceSearchRequestStructure... 284 15.5.2. EntranceSearchResponseStructure... 284 15.6. Søgning på etager... 285 15.6.1. FloorSearchRequestStructure... 285 15.6.2. FloorSearchResponseStructure... 286 15.7. Søgning på enheder... 287 15.7.1. BuildingUnitSearchRequestStructure... 287 15.7.2. BuildingUnitSearchResponseStructure... 288 15.8. Søgning på tekniske anlæg... 288 Snitfladebeskrivelse Side 22 af 303
15.8.1. TechnicalInstallationSearchRequestStructure... 288 15.8.2. TechnicalInstallationSearchResponseStructure... 289 15.9. Søgning på rum... 289 15.9.1. RoomSearchRequestStructure... 289 15.9.2. RoomSearchResponseStructure... 290 15.10. Søgning på brugsenheder... 290 15.10.1. UseUnitSearchRequestStructure... 291 15.10.2. UseUnitSearchResponseStructure... 291 15.11. Søgning på byggesager... 291 15.11.1. BuildingCaseSearchRequestStructure... 292 15.11.2. BuildingCaseSearchResponseStructure... 292 16. Adgang til snitfladen... 293 16.1. Sikkerhed... 293 16.2. Kodeeksempel for kald af certifikat... 293 16.3. Autorisation... 293 16.4. Testmiljø... 294 Snitfladebeskrivelse Side 23 af 303
1. Introduktion Denne snitfladebeskrivelse beskriver en af de OIOXML snitflader BuildingDwelling, som systemet stiller til rådighed. Baggrunden for snitfladen er, at man ønsker at registrere og opdatere Bygninger og boliger -data i ved webservicebaseret overførsel fra et eksternt system i OIOXML format. Denne snitfladebeskrivelse svarer til følgende version af webservicen: BuildingDwellingServiceV4.svc. I produktionsmiljø findes snitfladens endpoint her: https://bbr-kommune.dk/services/servicegateway/buildingdwellingservicev4.svc Snitfladens dokumentation, snitfladens wsdl dokumenter for både produktions- og demoversionen vil man kunne finde på s demoserver, hvor den kan tilgåes uden certifikater. http://demo.bbr-kommune.dk/services/ Wsdl'en er ikke eksponeret i produktion. Man skal bruge den fra demomiljøet og erstatte endpointet når man vil køre op mod produktion. Snitfladebeskrivelsen giver kort sagt mulighed for fremsøgning samt opdatering af Bygninger og boliger -data i, herunder grunde, bygninger, opgange/indgange, etager, enheder, tekniske anlæg, rum, brugsenheder og ikke mindst byggesager. Kapitel 2 giver en mere detaljeret beskrivelse af snitfladens formål samt dens målgruppe. Kapitel 3 beskriver de grundlæggende begreber og definitioner for s bygnings- og boligoplysninger, herunder datasammenhængen. Kapitel 4 giver et overblik over webservicen BuildingDwelling og dens metoder, som udgør snitfladen. Kapitlet beskriver også nogle generelle forhold som gælder for alle metoder og strukturer hørende til webservicen. Kapitel 5 beskriver strukturerne, som benyttes til at beskrive de enkelte entiteter. Det er en og den samme struktur som benyttes for hver entitet, uafhængig af hvor den benyttes, dvs. i alle metoder som henter og opdaterer entiteterne samt i søgningerne. Kapitel 5 beskriver også nogle fælles strukturer, som benyttes på tværs af entiteterne. Kapitel 6 til 14 beskriver metoderne for hver entitet i detaljer. kapitel 6 beskriver metoderne hørende til entiteten grund kapitel 7 beskriver metoderne hørende til entiteten bygning kapitel 8 beskriver metoderne hørende til entiteten opgang/indgang kapitel 9 beskriver metoderne hørende til entiteten etage kapitel 10 beskriver metoderne hørende til entiteten enhed kapitel 11 beskriver metoderne hørende til entiteten teknisk anlæg kapitel 12 beskriver metoderne hørende til entiteten rum kapitel 13 beskriver metoderne hørende til entiteten brugsenhed kapitel 14 beskriver metoderne hørende til entiteten byggesag Kapitel 15 beskriver søgningerne. Snitfladebeskrivelse Side 24 af 303
Kapitel 16 beskriver de betingelser, som skal være opfyldt for at få adgang til snitfladen, deriblandt sikkerheden omkring snitfladen. Der gøres opmærksom på, at denne snitflade alene dækker data i 's Bygninger og boliger del. Ud over denne snitflade findes 4 andre snitflader, som er relevante, hvis man ønsker at udvikle applikationer til systemet. Snitfladen Address dækker over systemets adressedel og stiller metoder til hentning og opdatering af adgangs- og enhedsadresser til rådighed. Snitfladen Permission stiller funktionalitet til rådighed, som er relevant både når man benytter Address eller BuildingDwelling. Denne service tilbyder metoder til at få oplysninger om feltrettigheder i Nyt. Afhængig af hvilke roller man er tildelt i Nyt vil man have adgang til at læse, skrive eller læse/skrive til de enkelte felter. Snitfladen CodeList stiller funktionalitet til rådighed, som er relevant både når man benytter Address eller BuildingDwelling. Denne service tilbyder tre metoder til at få oplysninger om kodelister i Nyt. Snitfladen StreetName stiller funktionalitet til rådighed, som er relevant både når man benytter Address eller BuildingDwelling. Denne service tilbyder 2 metoder til at hente veje og adgangsadresser i. Vejledninger til snitfladerne kan finde her: http://demo.bbr-kommune.dk/services/ Snitfladebeskrivelse Side 25 af 303
2. Formål og målgrupper Snitfladen har til formål at gøre det muligt for kommunerne at fremsøge og ajourføre Bygninger og boliger -data i. Snitfladen er en tovejskommunikation mellem en leverandør/kommune og systemet. Den gør det muligt at hente data fra systemet og den gør det muligt at sende data til opdatering af. Når der skrives "Bygninger og boliger"-data dækker det over de allerede nævnte 9 entiteter: Grund Bygning Opgang/indgang Etage Enhed Teknisk anlæg Rum Brugsenhed Byggesag Snitfladens funktioner henvender sig hovedsaglig til private eller offentlige itvirksomheder som ønsker at udvikle it-løsninger eller andre komponenter, der ved hjælp af webservicebaseret overførsel kan anvendes til at registrere eller opdatere 's bygnings- og boligoplysninger. Snitfladebeskrivelse Side 26 af 303
3. Forretningsviden For at kunne forstå den efterfølgende vejledning og snitfladens metoder er det vigtigt at kende de enkelte entiteter samt deres datasammenhæng. Snitfladen indeholder metoder hørende til de i kapitel 2 nævnte 9 entiteter. De første 8 entiteter og deres sammenhæng er beskrevet i afsnit 3.1. Entiteten byggesag adskiller sig fra de andre 8 entiteter og bliver beskrevet i afsnit 3.5. Afsnit 3.2. beskriver sammenhængen mellem adresser og entiteter i Bygninger- og Boliger. Afsnit 3.3 og 3.4 beskriver forskellen mellem stamentiteter og sagsentiteter, som er vigtig at kende for at kunne forstå forretningslogikken omkring de 8 entiteter og entiteten byggesag. Afsnit 3.6 beskriver geometripunkter til tekniske anlæg og bygninger. 3.1. De forskellige entiteter i og deres sammenhæng Billedet på næste side viser sammenhængen mellem de 8 nævnte entiteter. Selv om matriklen vises som entitet på figuren, betragtes den ikke som en -entitet, idet matrikeloplysninger stammer fra KMS og ESR-systemerne og de kan således ikke oprettes, rettes eller slettes i. I snitfladen vil matrikeloplysninger altid blive leveret som en undertstruktur til de respektive entiteter. Entiteten byggesag er ikke med på tegningen idet den som nævnt adskiller sig fra de andre 8 entiteter. Som man kan se, er entiteterne knyttet til hinanden. En grund består altid af 1 til flere matrikler. Omvendt er en matrikel altid knyttet til præcis en grund. På en matrikel kan der være registeret 0 til flere bygninger og 0 til flere tekniske anlæg. Omvendt er en bygning altid knyttet til en matrikel og et teknisk anlæg er enten knyttet til en bygning eller direkte til en matrikel. Som noget nyt kan man oprette tekniske anlæg på ubebyggede grunde uden at der er indberettet kloak- og vandforhold på grunden. En bygning kan have tilknyttet 0 til flere opgange/indgange, 0 til flere etager, 0 til flere tekniske anlæg og 0 til flere brugsenheder. Omvendt er en opgang/indgang, en etage og en brugsenhed altid knyttet til en bygning. Et teknisk anlæg kan være knyttet til en bygning eller direkte til en matrikel. En opgang/indgang og en etage kan have 0 til flere tilknyttede enheder. Omvendt er en enhed altid knyttet til en opgang/indgang og til en etage i samme bygning. En etage eller en enhed kan have underliggende rum. Omvendt er et rum altid knyttet til en etage og et rum kan yderligere være knyttet til en enhed. Snitfladebeskrivelse Side 27 af 303
Brugsenheder, rum og tekniske anlæg har ikke nogen underliggende entiteter. I forbindelse med de enkelte metoder vil relationerne mellem entiteterne blive beskrevet endnu engang. Grund hedder på engelsk site og i servicen Site. Bygning hedder på engelsk building og i servicen Building. Opgang/indgang hedder på engelsk entrance og i servicen Entrance. Etage hedder på engelsk floor og i servicen Floor. Enhed hedder på engelsk unit og i servicen BuildingUnit for at markere at en enhed altid hører til en bygning. Teknisk anlæg hedder på engelsk technical installation og i servicen TechnicalInstallation. Snitfladebeskrivelse Side 28 af 303
Rum hedder på engelsk room og i servicen Room. Brugsenhed hedder på engelsk use unit og i servicen UseUnit. En byggesag er altid knyttet til en grund og de sagsentiteter som hører til byggesagen skal ligge under selv samme grund. Byggesag hedder på engelsk building case og i servicen BuildingCase. Ud over at entiteterne har deres indbyrdes sammenhæng, kan de have tilknyttet adresser. I denne webservice er denne tilknytning udtrykt via en reference til en adresse ident, hørende til en adgangs- eller enhedsadresse. Denne webservice giver mulighed for at oprette, ændre og slette referencer til adresser, men vil man oprette nye adresser, ændre eller slette adresser i s adressedel, skal man benytte sig af webservicen Address.wsdl. 3.2. Adressers tilknytning til niveauer i Bygninger og boliger En adresse kan bruges på flere niveauer i Bygninger og Boliger. I Bygninger og Boliger fungerer adressen som en simpel attribut, der beskriver beliggenheden af den pågældende entitet. Man kan også sige at Bygninger og Boliger anvender de adresser der er oprettet i Adresser. En adgangsadresse kan tilknyttes til følgende niveauer: Grund Bygning Teknisk anlæg Opgang En enhedsadresse kan tilknyttes til følgende niveauer: Enhed Brugsenhed Følgende niveauer har ingen adresse tilknyttet: Rum Etage Adressen er krævet for alle niveauer, som har en adresse, undtagen ubebyggede grunde, som ikke behøver at have en adresse. Der kan forekomme grunde uden adresse når grunde oprettes automatisk efter besked fra ESR/KMS. Når adresser tilknyttes til niveauer i Bygninger og Boliger kan følgende adresser benyttes: Gældende adgangsadresser og gældende enhedsadresser Nye foreløbige adgangsadresser med husnummer og tilhørende enhedsadresser Den samme adresse må gerne benyttes på flere niveauer i Bygninger og boliger. I tidligere versioner af Nyt har det ikke været muligt for to ejendomme at have den samme adresse. Denne begrænsning er fjernet. En adgangsadresse, som er knyttet til en bygning direkte kaldes også repræsentativ adgangsadresse. For de repræsentative bygningsadresser gælder det, at samme adgangsadresse kan benyttes for flere bygninger. På en Snitfladebeskrivelse Side 29 af 303
landbrugsejendom vil alle bygninger typisk have samme repræsentative adgangsadresse. For et enfamiliehus vil garagen typisk have samme repræsentative adgangsadresse som villaen. Adgangsadresser kan også knyttes til en bygning indirekte via bygningens opgang/indgange. Bygninger hvori der findes en eller flere opgange/indgange har tilknyttet en adgangsadresse for hver opgang eller indgang. En adgangsadresse kan i en bygning kun være tilknyttet til højst én opgang/indgang i bygningen. Hvis en bygning har mere end en opgang/indgang vil den have lige så mange adgangsadresser tilknyttet via opgangene/indgangene. Opgangsadresser skal være entydige i én bygning. To opgange i to forskellige bygninger på samme ejendom kan dog have den samme adresse. Dette imødekommer anneksproblematikken. Systemet vil dog give en advarsel i dette tilfælde. To opgange i forskellige ejendomme må ikke have den samme adresse. Disse regler skal også opretholdes, når man flytter en bygning til en anden matrikel. Der er sammenhæng mellem en opgangs adgangsadresse og de tilhørende enheders enhedsadresser. Enheder i en opgang har enhedsadresser, som ligger under den adgangsadresse, som opgangen har. Der gælder, at enhedsadresser og brugsenhedsadresser i to forskellige ejendomme ikke må være ens. Snitfladebeskrivelse Side 30 af 303