BBR OIOXML. Vejledning til OIOXML snitflade for Bygninger og boliger BuildingDwelling.wsdl

Transkript

1 OIOXML Vejledning til OIOXML snitflade for Bygninger og boliger BuildingDwelling.wsdl En vejledning rettet mod 3. part.

2 Ændringer i forhold til forrige versioner Version Version Version Version Version 2.0 Første version, 01. maj 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 implementringen 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 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ænst 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 310

3 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 310

4 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 Webservice version 4, BuildingDwellingServiceV4.svc lægges i produktion den 9. februar 2012 ( Kommune version 1.4.) Version 2.0 af snitfladen udfases (BuildingDwellingServiceV2.svc) Identændringer Flere muligheder for identændringer for bygning, teknisk anlæg og opgang. Disse er beskrevet i afsnit , og og 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 snitfladen 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 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 310

5 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. Tilføjelse, at feltet byggeskadeforsikring kan indberettes på nybyggerier og stambygninger. 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. Sætningen For København og Frederiksberg gennemføres disse kald til GST ikke. (afsnit 3.6.1) er fjernet. Sætningen for Københavns og Frederiksberg dog fra den kommunale matrikel. (3.6.1.) er fjernet. Version 5.0 Webservice version 5, BuildingDwellingServiceV5.svc lægges i produktion den 9. april 2013 ( Kommune version 1.5.) Version 3.0 af snitfladen udfases (BuildingDwellingServiceV3.svc) Nyt funktionalitet/fejlrettelser Det er nu muligt at fremsøge og hente historiske entiteter. I den forbindelse er der blevet tilføjet en ny inputparameter IncludeHistoricIndicator (se afsnit 3.7.1) til søge- og hentmetoder. Ændring af regelsættet for nedarving af sikkerhedsklassifi- Snitfladebeskrivelse Side 5 af 310

6 kation (se afsnit 3.8) Skemaændringer/Metadata ændringer Nye felter til vindmøller i struktur TechnicalInstallationInformation for teknisk anlæg (se afsnit 5.6.3) Nyt areal felt Udvendig isolering i struktur BuildingArea for bygning (se afsnit 5.2.8) Ny understruktur DispensationHeatSupply for bygning og grund (se afsnit ) Ændret kodeliste til felt Byggeskadeforsikringsselskab for bygning (se afsnit ) Ændret kodeliste til felt Sløjfning for teknisk anlæg. Kodelisten som i dag kun benyttes for tanke, udvides, så den også dækker sløjfning af jordvarmeanlæg (se afsnit 5.6.3) Ændret kodeliste til felt Klassifikation for teknisk anlæg (se afsnit 5.6.2) Andre ændringer i vejledningen Version 6.0 Kommunekode 902 (og ikke som tidligere kommunekode 881) skal anvendes ved test af snitfladen i demomiljøet. Se afsnit Webservice version 6, BuildingDwellingServiceV6.svc lægges i produktion den 2. juli 2014 ( Kommune version 1.5.3) Version 4.0 af snitfladen udfases (BuildingDwellingServiceV4.svc) Skemaændringer/Metadata ændringer Nyt felt vedr. støjisolering i struktur BuildingUnitInformation for enhed (se afsnit 5.5.3) Nyt felt Supplerende oplysninger vedr. koordinatsæt i struktur ConstructionPoint for bygning og teknisk anlæg (se afsnit ) Ændret kodeliste til felt Byggeskadeforsikringsselskab for bygning (se afsnit ) Ændret kodeliste til felt Nøjagtighedsklasse i strukturen ConstructionPoint for bygning hhv. teknisk anlæg. Ændret kodeliste til felt Kilde til geometri i strukturen ConstructionPoint for bygning hhv. teknisk anlæg. Andre ændringer i vejledningen Betegnelsen KMS er blevet erstattet med GST (Geodatastyrelsen) og EBST med MBBL. Snitfladebeskrivelse Side 6 af 310

7 Version 6.1 Version 7 Opdatering af afnsit 3.5 Byggesager på grund af den nu ænderede håndtering af indflytning for byggesagskode 1. Opdatering af afsnit vedr. foreløbige koordinater Webservice version 7, BuildingDwellingServiceV7.svc lægges i produktion den 5. oktober 2015 (svarende til Kommune version 1.7.1) Skemaændringer/Metadata ændringer 2 nye felter vedr. flexboliger på i struktur BuildingUnitInformation for enhed Ændret kodeliste til felt Påbud om forbedret rensning for bygning Andre ændringer i vejledningen Hele vejledningen er tilrettet i forhold til at adresser nu ikke længere ligger i, men i DAR. Snitfladebeskrivelse Side 7 af 310

8 1. Introduktion Formål og målgrupper Forretningsviden De forskellige entiteter i og deres sammenhæng Adressers tilknytning til niveauer i Bygninger og boliger Stamentiteter Sagsentiteter Byggesager Mulige byggesagskoder Afslutning af en byggesag Overførsel af data fra sag til stam Midlertidig afslutning af en byggesag Indflytning Håndtering af eksisterende byggesager med byggesagskode 1, som er midlertidig afsluttet Delvis afslutning af en byggesag Afslutning af en delvis afsluttet byggesag Henlæggelse Sletning af sagsentitet i en byggesag Sletning af byggesag Kopiering af byggesager Koordinater til bygning og teknisk anlæg Foreløbige koordinater Kontrol af koordinater Historiske data Fremsøgning og hentning af historiske data IncludeHistoricIndicator Sletning af data fra historik Sikkerhedsklassifikation Håndtering af sikkerhedsklassifikation ved oprettelse af entiteter Håndtering af sikkerhedsklassifikation ved opdatering af entiteter Overblik over webservices og metoderne Sandsynlighedskontroller (IgnoreWarningIndicator) Udskrivning af Meddelelser (printenableindicator) Gyldighedsdato (AssessmentChangedDate) Den implementerede opdateringsmekanisme Rettigheder Styring af opdateringer (RecordChangeDateTime) Sagstype (BuildingCaseTypeCode og updatereasoncode) Resultat for metodekald (ReturnMessage) Skemavalidering UniversalIdentifier og Reference Placeholder-problematik <Entity>GetById og <Entity>GetByIds metoder <Entity>GetByParentId metoder <Entity1>GetBy<Entity2>Id metoder BuildingCaseGetByEntityId metode Delete og update metoder Namespaces Datatyper Udviklingsværktøjer Snitfladebeskrivelse Side 8 af 310

9 5. Strukturer til entiteter - <Entity>Structure SiteStructure Mulighed for identændringer SiteKeys SiteInformation AddressComplete WaterDrainage EntityBuildingCaseInformation ExternalReferences MunicipalityFields NoteStructure DispensationHeatSupply BuildingStructure Mulighed for identændringer BuildingKeys BuildingInformation AddressComplete CondominiumStructure ConstructionPoint BuildingHeating BuildingArea BuildingArrangement BuildingMaterial WaterDrainage EntityBuildingCaseInformation BuildingInsurance ExternalReferences MunicipalityFields NoteStructure MunicipalityRelocation DispensationHeatSupply EntranceStructure Mulighed for identændringer EntranceKeys EntranceInformation AddressComplete EntityBuildingCaseInformation ExternalReferences MunicipalityFields NoteStructure FloorStructure Mulighed for identændringer FloorKeys FloorInformation FloorArea EntityBuildingCaseInformation ExternalReferences MunicipalityFields NoteStructure BuildingUnitStructure Mulighed for identændringer BuildingUnitKeys BuildingUnitInformation AddressComplete Snitfladebeskrivelse Side 9 af 310

10 EntityBuildingCaseInformation CondominiumStructure BuildingUnitHeating BuildingUnitArea BuildingUnitInterior ExternalReferences MunicipalityFields NoteStructure TechnicalInstallationStructure Mulighed for identændringer TechnicalInstallationKeys TechnicalInstallationInformation AddressComplete ConstructionPoint EntityBuildingCaseInformation CondominiumStructure ExternalReferences MunicipalityFields NoteStructure RoomStructure Mulighed for identændringer RoomKeys RoomInformation AddressComplete EntityBuildingCaseInformation ExternalReferences MunicipalityFields NoteStructure UseUnitStructure Mulighed for identændringer UseUnitKeys UseUnitInformation UseUnitArea AddressComplete EntityBuildingCaseInformation ExternalReferences MunicipalityFields NoteStructure BuildingCaseStructure BuildingCaseKeys BuildingCaseInformation BuildingCaseDates BuildingCaseInformationDates BuildingCaseCompletionDates Fælles strukturer landparcelidentitystructure AddressComplete ConstructionPoint WaterDrainage EntityBuildingCaseInformation ExternalReferences MunicipalityFields CondominiumStructure NoteStructure DispensationHeatSupply Snitfladebeskrivelse Side 10 af 310

11 6. Metoder til entitet grund SiteGetById SiteGetByIdRequestStructure SiteGetByIdResponseStructure SiteGetByIds SiteGetByIdsRequestStructure SiteGetByIdsResponseStructure SiteGet SiteGetRequestStructure SiteGetResponseStructure SiteGetByMunicipalRealPropertyId SiteGetByMunicipalRealPropertyIdRequestStructure SiteGetByMunicipalRealPropertyIdResponseStructure SiteGetByParentId SiteGetByParentIdRequestStructure SiteGetByParentIdResponseStructure SiteGetSubStructuresById SiteGetSubStructuresByIdRequestStructure SiteGetSubStructuresByIdResponseStructure SiteCreate SiteCreateRequestStructure SiteCreateResponseStructure SiteUpdate SiteUpdateRequestStructure SiteUpdateResponseStructure SiteDelete SiteDeleteRequestStructure SiteDeleteResponseStructure SiteMoveEntities SiteMoveEntitiesRequestStructure SiteMoveEntitiesResponseStructure Metoder til entitet bygning BuildingGetById BuildingGetByIdRequestStructure BuildingGetByIdResponseStructure BuildingGetByIds BuildingGetByIdsRequestStructure BuildingGetByIdsResponseStructure BuildingGet BuildingGetRequestStructure BuildingGetResponseStructure BuildingGetBySiteId BuildingGetBySiteIdRequestStructure BuildingGetBySiteIdResponseStructure BuildingGetByParentId BuildingGetByParentIdRequestStructure BuildingGetByParentIdResponseStructure BuildingCreate BuildingCreateRequestStructure BuildingCreateResponseStructure BuildingUpdate BuidlingUpdateRequestStructure BuildingUpdateResponseStructure Snitfladebeskrivelse Side 11 af 310

12 7.8. BuildingDelete BuildingDeleteRequestStructure BuildingDeleteResponseStructure BuildingDeleteHistoric BuildingDeleteHistoricRequestStructure BuildingDeleteHistoricResponseStructure Metoder til entitet opgang/indgang EntranceGetById EntranceGetByIdRequestStructure EntranceGetByIdResponseStructure EntranceGetByIds EntranceGetByIdsRequestStructure EntranceGetByIdsResponseStructure EntranceGet EntranceGetRequestStructure EntranceGetResponseStructure EntranceGetByBuildingId EntranceGetByBuildingIdRequestStructure EntranceGetByBuildingIdResponseStructure EntranceGetByParentId EntranceGetByParentIdRequestStructure EntranceGetByParentIdResponseStructure EntranceCreate EntranceCreateRequestStructure EntranceCreateResponseStructure EntranceUpdate EntranceUpdateRequestStructure EntranceUpdateResponseStructure EntranceDelete EntranceDeleteRequestStructure EntranceDeleteResponseStructure EntranceDeleteHistoric EntranceDeleteHistoricRequestStructure EntranceDeleteHistoricResponseStructure Metoder til entitet etage FloorGetById FloorGetByIdRequestStructure FloorGetByIdResponseStructure FloorGetByIds FloorGetByIdsRequestStructure FloorGetByIdsResponseStructure FloorGet FloorGetRequestStructure FloorGetResponseStructure FloorGetByBuildingId FloorGetByBuildingIdRequestStructure FloorGetByBuildingIdResponseStructure FloorGetByParentId FloorGetByParentIdRequestStructure FloorGetByParentIdResponseStructure FloorCreate FloorCreateRequestStructure FloorCreateResponseStructure Snitfladebeskrivelse Side 12 af 310

13 9.7. FloorUpdate FloorUpdateRequestStructure FloorUpdateResponseStructure FloorDelete FloorDeleteRequestStructure FloorDeleteResponseStructure FloorDeleteHistoric FloorDeleteHistoricRequestStructure FloorDeleteHistoricResponseStructure Metoder til entitet enhed BuildingUnitGetById BuildingUnitGetByIdRequestStructure BuildingUnitGetByIdResponseStructure BuildingUnitGetByIds BuildingUnitGetByIdsRequestStructure BuildingUnitGetByIdsResponseStructure BuildingUnitGet BuildingUnitGetRequestStructure BuildingUnitGetResponseStructure BuildingUnitGetByEntranceId BuildingUnitGetByEntranceIdRequestStructure BuildingUnitGetByEntranceIdResponseStructure BuildingUnitGetByFloorId BuildingUnitGetByFloorIdRequestStructure BuildingUnitGetByFloorIdResponseStructure BuildingUnitGetByParentId BuildingUnitGetByParentIdRequestStructure BuildingUnitGetByParentIdResponseStructure BuildingUnitCreate BuildingUnitCreateRequestStructure BuildingUnitCreateResponseStructure BuildingUnitUpdate BuildingUnitUpdateRequestStructure BuildingUnitUpdateResponseStructure BuildingUnitDelete BuildingUnitDeleteRequestStructure BuildingUnitDeleteResponseStructure BuildingUnitDeleteHistoric BuildingUnitDeleteHistoricRequestStructure BuildingUnitDeleteHistoricResponseStructure Metoder til entitet teknisk anlæg TechnicalInstallationGetById TechnicalInstallationGetByIdRequestStructure TechnicalInstallationGetByIdResponseStructure TechnicalInstallationGetByIds TechnicalInstallationGetByIdsRequestStructure TechnicalInstallationGetByIdsResponseStructure TechnicalInstallationGet TechnicalInstallationGetRequestStructure TechnicalInstallationGetResponseStructure TechnicalInstallationGetBySiteId TechnicalInstallationGetBySiteIdRequestStructure TechnicalInstallationGetBySiteIdResponseStructure Snitfladebeskrivelse Side 13 af 310

14 11.5. TechnicalInstallationGetByBuildingId TechnicalInstallationGetByBuildingIdRequestStructure TechnicalInstallationGetByBuildingIdResponseStructure TechnicalInstallationGetByParentId TechnicalInstallationGetByParentIdRequestStructure TechnicalInstallationGetByParentIdResponseStructure TechnicalInstallationCreate TechnicalInstallationCreateRequestStructure TechnicalInstallationCreateResponseStructure TechnicalInstallationUpdate TechnicalInstallationUpdateRequestStructure TechnicalInstallationUpdateResponseStructure TechnicalInstallationDelete TechnicalInstallationDeleteRequestStructure TechnicalInstallationDeleteResponseStructure TechnicalInstallationDeleteHistoric TechnicalInstallationDeleteHistoricRequestStructure TechnicalInstallationDeleteHistoricResponseStructure Metoder til entitet rum RoomGetById RoomGetByIdRequestStructure RoomGetByIdResponseStructure RoomGetByIds RoomGetByIdsRequestStructure RoomGetByIdsResponseStructure RoomGet RoomGetRequestStructure RoomGetResponseStructure RoomGetByFloorId RoomGetByFloorIdRequestStructure RoomGetByFloorIdResponseStructure RoomGetByBuildingUnitId RoomGetByBuildingUnitIdRequestStructure RoomGetByBuildingUnitIdResponseStructure RoomGetByParentId RoomGetByParentIdRequestStructure RoomGetByParentIdResponseStructure RoomCreate RoomCreateRequestStructure RoomCreateResponseStructure RoomUpdate RoomUpdateRequestStructure RoomUpdateResponseStructure RoomDelete RoomDeleteRequestStructure RoomDeleteResponseStructure RoomDeleteHistoric RoomDeleteHistoricRequestStructure RoomDeleteHistoricResponseStructure Metoder til entitet brugsenhed UseUnitGetById UseUnitGetByIdRequestStructure UseUnitGetByIdResponseStructure Snitfladebeskrivelse Side 14 af 310

15 13.2. UseUnitGetByIds UseUnitGetByIdsRequestStructure UseUnitGetByIdsResponseStructure UseUnitGet UseUnitGetRequestStructure UseUnitGetResponseStructure UseUnitGetByBuildingId UseUnitGetByBuildingIdRequestStructure UseUnitGetByBuildingIdResponseStructure UseUnitGetByParentId UseUnitGetByParentIdRequestStructure UseUnitGetByParentIdResponseStructure UseUnitCreate UseUnitCreateRequestStructure UseUnitCreateResponseStructure UseUnitUpdate UseUnitUpdateRequestStructure UseUnitUpdateResponseStructure UseUnitDelete UseUnitDeleteRequestStructure UseUnitDeleteResponseStructure UseUnitDeleteHistoric UseUnitDeleteHistoricRequestStructure UseUnitDeleteHistoricResponseStructure Metoder til entitet byggesag BuildingCaseGetById BuildingCaseGetByIdRequestStructure BuildingCaseGetByIdResponseStructure BuildingCaseGetByIds BuildingCaseGetByIdsRequestStructure BuildingCaseGetByIdsResponseStructure BuildingCaseGet BuildingCaseGetRequestStructure BuildingCaseGetResponseStructure BuildingCaseGetBySiteId BuildingCaseGetBySiteIdRequestStructure BuildingCaseGetBySiteIdResponseStructure BuildingCaseGetByEntityId BuildingCaseGetByEntityIdRequestStructure BuildingCaseGetByEntityIdResponseStructure BuildingCaseGetAllEntities BuildingCaseGetAllEntitiesRequestStructure BuildingCaseGetAllEntitiesResponseStructure BuildingCaseCreate BuildingCaseCreateRequestStructure BuildingCaseCreateResponseStructure BuildingCaseUpdate BuidlingCaseUpdateRequestStructure BuildingCaseUpdateResponseStructure BuildingCaseDelete BuildingCaseDeleteRequestStructure BuildingCaseDeleteResponseStructure Metoder til søgninger Snitfladebeskrivelse Side 15 af 310

16 15.1. Søgekriterier AddressSearchRequestSubStructure SiteSearchRequestSubStructure BuildingSearchRequestSubStructure FloorSearchRequestSubStructure BuildingUnitSearchRequestSubStructure CondominiumSearchRequestSubStructure TechnicalInstallationSearchRequestSubStructure RoomSearchRequestSubStructure UseUnitSearchRequestSubStructure BuildingCaseSearchRequestSubStructure Søgemetoder og søgeresultat Søgning på grunde SiteSearchRequestStructure SiteSearchResponseStructure Søgning på bygninger BuildingSearchRequestStructure BuildingSearchResponseStructure Søgning på opgange/indgange EntranceSearchRequestStructure EntranceSearchResponseStructure Søgning på etager FloorSearchRequestStructure FloorSearchResponseStructure Søgning på enheder BuildingUnitSearchRequestStructure BuildingUnitSearchResponseStructure Søgning på tekniske anlæg TechnicalInstallationSearchRequestStructure TechnicalInstallationSearchResponseStructure Søgning på rum RoomSearchRequestStructure RoomSearchResponseStructure Søgning på brugsenheder UseUnitSearchRequestStructure UseUnitSearchResponseStructure Søgning på byggesager BuildingCaseSearchRequestStructure BuildingCaseSearchResponseStructure Adgang til snitfladen Sikkerhed Kodeeksempel for kald af certifikat Autorisation Testmiljø Snitfladebeskrivelse Side 16 af 310

17 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 OI- OXML format. Denne snitfladebeskrivelse svarer til følgende version af webservicen: BuildingDwellingServiceV7.svc. I produktionsmiljø findes snitfladens endpoint her: 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. 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. Snitfladen 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 17 af 310

18 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 AddressV1 dækker over adresser i DAR 0.9 og stiller metoder til hentning og opdatering af adgangspunkter/husnumre/adresser til rådighed. Snitfladen Permission 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 tilbyder tre metoder til at få oplysninger om kodelister i Nyt. Vejledninger til snitfladerne kan finde her: Snitfladebeskrivelse Side 18 af 310

19 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 19 af 310

20 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 entiter 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 koordinatsættet til tekniske anlæg og bygninger. Afsnit 3.7 beskriver hvordan historiske entiteter kan fremsøges hhv. hentes via snitfladen, samt hvordan data kan slettes fra historik. Afsnit 3.8 beskriver hvoran sikkerhedsklassifikation bliver hånteret af snitfladen 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 GST og ESRsystemerne og de kan således ikke oprettes, rettes eller slettes i. I snitfladen vil matrikeloplysninger altid blive leveret som en undertsruktur 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. Snitfladebeskrivelse Side 20 af 310

21 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. 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. Snitfladebeskrivelse Side 21 af 310

22 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. 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 et husnummer eller adresse i DAR 0.9. Denne webservice giver mulighed for at oprette, ændre og slette referencer til adresser, men vil man oprette nye adresser, ændre eller slette adresser i DAR, skal man benytte sig af webservicen AddressV1.wsdl 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 (et husnummer fra DAR) kan tilknyttes til følgende niveauer: Grund Bygning Teknisk anlæg Opgang En enhedsadresse (en adresse fra DAR) 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/GST. Alle adresser fra DAR med status gældende eller foreløbig som har en vejkode og husnummerbetegnelse kan tilknyttes til niveauer i Bygninger og Boliger. Snitfladebeskrivelse Side 22 af 310

23 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 (et husnummer fra DAR), som er knyttet til en bygning direkte kaldes også repræsentativ bygningsadresse. For de repræsentative bygningsadresser gælder det, at samme adgangsadresse/husnummer kan benyttes for flere bygninger. På en landbrugsejendom vil alle bygninger typisk have samme repræsentative adresse. For et enfamiliehus vil garagen typisk have samme repræsentative adresse som villaen. Adgangsadresser/Husnumre kan også knyttes til en bygning indirekte via bygningens opgang/indgange. Bygninger hvori der findes en eller flere opgange/indgange har tilknyttet en adgangsadresse/et husnummer for hver opgang eller indgang. En adgangsadresse/et husnummer 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/husnumre 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. Snitfladebeskrivelse Side 23 af 310

24 Der er sammenhæng mellem en opgangs adgangsadresse/husnummer og de tilhørende enheders adresser. Enheder i en opgang har adresser, som ligger under den adgangsadresse/det husnummer, som opgangen har. Der gælder, at enhedsadresser og brugsenhedsadresser i to forskellige ejendomme ikke må være ens Stamentiteter Der skelnes mellem stamentiteter med status 1 og sagsentiteter med status 3. Sagsentiteter er nybyggerier (N) eller rettelser til stamentiteter (S). Hvis du vil rette, oprette eller slette en stamentitet, kan dette gøres direkte i stamdelen eller via en byggesag, hvor ændringer først bliver gældende ved afslutning af byggesagen. Sidstnævnte mulighed er nærmere forklaret i afsnit 3.5. Når entiteter slettes i stamdelen får de et ophørstimestamp og deres status ændres til 2. Stamentiteter vil altid ligge under andre stamentiteter i det i afsnit 3.1 beskrevne hierarki. Dvs. man kan fx ikke have en stam-brugsenhed som ligger under en bygning, som er et nybyggeri. Eller en stam-enhed som ligger under en etage eller opgang, der er nybyggerier Sagsentiteter Der findes 3 slags sagsentiteter: Nybyggerier (N) Til/ombygninger (S) Nedrivninger (S) Nedrivninger og til-/ombygninger refererer til den stamentitet de hører til, dvs. den de er en ændring til. I nedenstående eksempel peger sagsentiteten 14 på stamentiteten 13. Nybyggerier peger også på en stamentitet, men her drejer det sig om en slags placeholder for den senere stamentitet. Placeholderen har den id, som entiteten får, når sagen afsluttes og nybyggeriet overføres til stam. I nedenstående eksempel peger nybyggeriet 12 på en placeholder 11 i stamdelen. I d: 11 Placeholder for nybyggeri (status 1) I d: 13 Stamentitet (status 1) <Ent i t y>par ent Ref er ence <Ent i t y>par ent Ref er ence I d: 12 Nybyggeri (status 3) I d: 14 Ændring til stamentitet (nedrivning eller til/ombygning) (status 3) Snitfladebeskrivelse Side 24 af 310

25 I nogle sjældne tilfælde kan man godt have en sag på et nybyggeri. I givet fald vil (S) entiteten pege på samme placeholder som (N) entiteten. Placeholdere er nærmere beskrevet i afsnit Når man opretter en sagsentitet (S), dvs. en ændring til en stamentitet, gøres det ved at angive stamentitetens id. Der vil automatisk blive kopieret nogle får oplysninger fra stamentiteten over til sagsentiteten Byggesager En sagsentitet er altid knyttet til en byggesag. En byggesag kan samle en eller flere sagentiteter. Når en byggesag afsluttes ved angivelse af en eller flere nødvendige datoer afsluttes de tilhørende sagsentiteter og overføres til stamdata. Der må ikke være to sagsentiteter hørende til samme stamentitet i den samme byggesag. I enhver byggesag skal der normalt være en bygning (en (S)BYG eller (N)BYG)). Undtaget er byggesager som alene indeholder entiteter som ikke ligger under en bygning, dvs. ændringer til grunde ((S)GRU entiteter) eller ændringer eller nyopførelser af tekniske anlæg som ikke knytter sig til en bygning ((N)TEK hhv. (S)TEK entiteter). Opretter man fx en ny enhed, (N)ENH, og byggesagen ikke indeholder en bygning, vil der blive oprettet en (S)BYG entitet i byggesagen. Denne sagsentitet er en ændring til den bygning, som den nye enhed ligger under. Baggrunden for denne implementering er, at synkronisering af Nyt til KMD, i mange tilfælde kræver, at der forefindes en bygning i byggesagen. Der må kun være én bygning i en byggesag. En byggesag er altid knyttet til en grund og de sagsentiteter som hører til byggesagen skal ligge under selv samme grund Mulige byggesagskoder En byggesag skal have en af de nedenstående byggesagskoder: 1 BR Tilladelsessag uden ibrugtagningstilladelse 2 BR Anmeldelsessag (garager, carporte, udhuse og nedrivning) 3 BR Tilladelsessag med ibrugtagningstilladelse 4 BR Tilladelsessag uden landbrugsbygning 5 BR Anmeldelsessag (øvrige) Afslutning af en byggesag Når en byggesag afsluttes overføres data fra de tilhørende sagsentiteter ((N) hhv. (S) entiteter) til data i stam. En byggesag afsluttes ved at der angives en eller flere relevante datoer: For byggesagskode 1,2,4,5: Fuldførelsesdato udfyldes og sagen gemmes. Snitfladebeskrivelse Side 25 af 310

26 For byggesagskode 3: Ibrugtagningsdato udfyldes og sagen gemmes (udfyldes der fuldførelsesdato uden indtastning af ibrugtagningsdato afsluttes sagen midlertidig, se afsnit 3.5.4). Ibrugtagningsdato indberettes kun ved byggesagskode 3. Mere nøjagtig sker der følgende ved afslutning af en byggesag: Data overføres fra sag til stam. Sagsentiteterne får status 4 og et ophørstimestamp. Byggesagen får et ophørstimestamp. Hvis byggesagen indeholder en nybyggeri bygning sættes opførelsesår. Hvis byggesagen indeholder et nybyggeri teknisk anlæg sættes etableringsår. For nedrivninger gælder det, at stamentiteten slettes i stamdelen, dvs. får et ophørstimestamp og status 2. Dette gælder naturligvis kun ved nedrivning af hele entiteten. For tilladelsessager med byggesagskode 3 kan man afslutte byggesagen midlertidig eller delvis. Disse to typer er beskrevet i det følgende Overførsel af data fra sag til stam Når en byggesag afsluttes overføres data fra de tilhørende sagsentiteter ((N) hhv. (S) entiteter) til data i stam. For nybyggerier overføres alle data, men for sagsentiteter (S) overføres ikke alle felter. Følgende felter opfattes som hørende til sagsniveauet og overføres ikke til stamentiteter ved afslutning af en (S) entitet: ESDH reference Journalnummer Oprettelsesdato (RecordCreatedDateTime) Seneste ændringsdato (RecordChangeDateTime) Ved til- og ombygninger samt nedrivininger kan der forekomme negative værdier i f.eks. arelafelter, som trækkes fra det i stamdelen registrerede areal Midlertidig afslutning af en byggesag En byggesag med byggesagskode 3 kan afsluttes midlertidigt. Dette sker når en byggesag fuldføres, men ikke ibrugtages (fuldførelsesdato forskellig fra null, ibrugtagningstilladelse = null). Tidligere har der været et krav om en bygning i byggesagen for at kunne afslutte denne midlertidig, men dette krav er nu fjernet hvis byggesagen indeholder alene et teknisk anlæg. En midlertidig afslutning betyder, at data overføres fra sag til stam for alle sagsentiteter, men at byggesagen ikke afsluttes endeligt. Byggesagen venter på, at der angives en ibrugtagningsdato. Alle entiteter undtagen bygninger og tekniske anlæg fjernes fra byggesagen, men bygninger og tekniske anlæg vil som sagsentiteter forblive i byggesagen indtil den afsluttes helt. De kan dog ikke længere rettes. Et forsøg på at opdatere de forblivne sagsentiteter i byggesagen eller et forsøg på at rette selve byggesagen vil blive afvist. Det eneste der kan Snitfladebeskrivelse Side 26 af 310

27 inddateres i byggesagen er ibrugtagningstilladelse. Alle andre data skal rettes i stam. Mere teknisk udtrykt sker der følgende ved en midlertidig afslutning af en byggesag: Data overføres fra sag til stam for alle sagsentiteter. Sagsentiteterne - undtagen bygninger og tekniske anlæg - får status 4 og et ophørstimestamp. Hvis det er nybyggerier, sættes deres opførelsestimstamp. Data for bygninger/tekniske anlæg overføres fra sag til stam men sagsentiteterne forbliver i byggesagen med status 3 og får ingen ophørstimestamp. Byggesagen får ikke et ophørstimestamp. Sagentiterne i byggesagen må ikke rettes, men der kan foretages rettelser i stamentiteterne. Midlertidigstatus på stambygning sættes til 2 hvis nybyggeri og 4 hvis om/tilbygning. Først når der efterfølgende indtastes en ibrugtagningsdato på byggesagen vil sagsentiterne få status 4 og et ophørstimestamp, men der sker ingen overførsel af data fra sagsdata til stam. Stambygningens felt Midlertidig status resettes. (Dvs. det undersøges, om der er andre midlertidig afsluttede byggesager på samme bygning. I dette tilfælde sættes midlertidig status til 2 eller 4 alt efter nybyggeri eller ej. Hvis der ikke er andre midlertidigt afsluttede byggesager på bygningen sættes feltet til 0.) Indflytning På en byggesag med byggesagskode 1 eller 3 kan man på en sagsenhed indtaste en indflytningsdato. Det vil afslutte denne enhed og overføre den til stam. Hvis det er en byggesagskode 1 blev der før 1.6 (10. december 2014) foretaget en midlertidig afslutning af byggesagen, dvs. alle sagsdata (ikke kun den ene enhed) blev flyttet til stam og byggesagen ventede kun på fuldførelse. Dette var ikke specielt hensigtsmæssigt og har givet kun mening for parcelhuse med én enhed. Hvis det er en byggesagskode 3 blev der før 1.6 (10. december 2014) simuleret en delvis ibrugtagningstilladelse. Enheden blev opdateret med Delvis ibrugtagning sat lig indflytningsdato. Byggesagen blev opdateret med Delvis ibrugtagningstilladelse sat til dags dato og byggesagens FærdigtBygningsareal sat lig med enhedens areal. Dette var ikke specielt hensigtsmæssigt. I forbindelse med 1.6 er funktionaliteten blevet ændret på følgende måde: En byggesag med byggesagskode 1 afsluttes delvis og ikke længere midlertidig i forbindelse med at der ske indflytning på en sagsenhed. Dette gælder også indflytning i en enhed i en bygning med kun én enhed. Felterne Delvis ibrugtagning på enhed og Delvis ibrugtagningstilladelse på byggesag bliver ikke længere udfyldt og indflytning ligestilles således ikke med en delvis ibrugtagning. Snitfladebeskrivelse Side 27 af 310

28 Indflytning på en enhed fungerer fra 1.6 således på samme måde for byggesagskode 1 og 3. Lidt mere teknisk sker der følgende: Enhedens samlede areal og adderes til feltet Foreløbig Færdiggjort bygningsareal i alt på byggesagen. Felterne Foreløbig færdiggjort antal lejligheder og Foreløbig færdiggjort antal lejligheder uden køkken på byggesagen beregnes. Enheden, som har fået en indflytningsdato, afsluttes. Hvis der er tale om nybyggeri afsluttes enhedens opgang og etage ligeledes. Hvis bygningen i byggesagen er et nybyggeri og det er den første enhed som afsluttes, opdateres stambygningen med indeværende år som opførelsesår. Stambygningen opdateres med status for delvis/midlertidig afslutning (kode 1 for nybyggeri og kode 3 for til/ombygning). Bygningens sagsdata overføres ellers ikke til stamdata og det er forsat sagsbygningen og ikke stambygningen som vises og opdateres i klienten Håndtering af eksisterende byggesager med byggesagskode 1, som er midlertidig afsluttet Selv om byggesager med byggesagskode 1 ikke længere ved indflytning afsluttes midlertidig vil der være nogle byggesager tilbage i systemet, som har byggesagskode 1 og som er midlertidig afsluttet og venter på fuldførelse. Disse kan afsluttes ved at man giver dem en fuldførelsesdato Delvis afslutning af en byggesag Byggesager med byggesagskode 3 og som indeholder enheder kan også delvis afsluttes ved at der gives ibrugtagningstilladelse. Dette sker normalt når nogle enheder ibrugtages, mens andre endnu ikke er færdiggjort. Som det første skridt opdateres den (eller de) enhed(er) der skal afsluttes, med en dato i feltet Delvis ibrugtagning. Som det andet skridt indtastes dato for Delvis ibrugtagningstilladelse på byggesagen og i feltet Færdiggjort bygningsareal indtastes et areal. Grunden til at det ikke bare kan beregnes ud fra enheden(erne) er, at der godt kan være noget fællesareal der også er færdiggjort. Når byggesagen gemmes sker der følgende: Færdiggjort bygningsareal vil blive adderet til feltet Foreløbig Færdiggjort bygningsareal i alt. Felterne Foreløbig færdiggjort antal lejligheder og Foreløbig færdiggjort antal lejligheder uden køkken beregnes. De enheder der har en dato i feltet Delvis ibrugtagning afsluttes. Hvis der er tale om nybyggeri afsluttes enhedens opgang og etage ligeledes. Hvis bygningen i byggesagen er et nybyggeri og det er den(de) første enhed(er) som afsluttes, opdateres stambygningen med år for delvis ibrugtagningstilladelse som opførelsesår. Stambygningen opdateres med status for delvis/midlertidig afslutning (kode 1 for nybyggeri og kode 3 for til/ombygning). Bygningens sagsdata overføres ellers ikke til stamdata og det er forsat sagsbygningen og ikke stambygningen som vises og opdateres i klienten. Det er også muligt at angive en delvis ibrugtagningstilladelsesdato på en byggesag uden at der samtidig afsluttes enheder. I princippet kan man også an- Snitfladebeskrivelse Side 28 af 310

29 give datoen på en byggesag som ikke har enheder som entiteter. Dette vil resultere i følgende: Færdiggjort bygningsareal vil blive adderet til feltet Foreløbig Færdiggjort bygningsareal i alt. Hvis bygningen i byggesagen er et nybyggeri og det er første gang der byggesagen gemmes med delvis ibrugtagningstilladelse, opdateres stambygningen med år for delvis ibrugtagningstilladelse som opførelsesår. Stambygningen opdateres desuden med status for delvis/midlertidig afslutning (kode 1 for nybyggeri og kode 3 for til/ombygning). Bygningens sagsdata overføres ellers ikke til stamdata og det er forsat sagsbygningen og ikke stambygningen som vises og opdateres i klienten. Vær opmærksom på, at datoen for delvis ibrugtagningstilladelse kan slettes igen på byggesagen hvis der ikke er afsluttede enheder. Hvis man gør det, vil også stambygningens status for delvis afslutning blive genberegnet. Desuden vil opførelsesår på stambygningen blev nulstillet hvis det drejer sig om et nybyggeri og der ikke er andre delvis/midlertidig afsluttede byggesager på stambygningen. En delvis afsluttet byggesag ibrugtages/afsluttes ved at indtaste dato for ibrugtagningstilladelse. Alle entiteter i byggesagen (inkl. bygningen) afsluttes og sagsdata overføres til stam på almindeligvis. Bygningens felt Midlertidig status resettes. (Dvs. det undersøges, om der er andre midlertidig afsluttede byggesager på samme bygning. I dette til sættes midlertidig status til 2 eller 4 alt efter nybyggeri eller ej. Hvis der ikke er andre midlertidigt afsluttede byggesager på bygningen sættes feltet til 0.) Afslutning af en delvis afsluttet byggesag Ved en byggesagskode 1 afsluttes en delvis afsluttet byggesag ved at der indtastes dato for fuldførelse. Alle entiteter i byggesagen (inkl. bygningen), som endnu ikke er afsluttet, afsluttes og sagsdata overføres til stam på almindeligvis. Ved en byggesagskode 3 afsluttes en delvis afsluttet byggesag ved at indtaste dato for ibrugtagningstilladelse. Alle entiteter i byggesagen (inkl. bygningen), som endnu ikke er afsluttet, afsluttes og sagsdata overføres til stam på almindeligvis. Der er muligt efter en delvis afslutning af byggesagen med byggesagskode 3 at foretage en fuldførelse af byggeriet før ibrugtagningstilladelse. I dette tilfælde afsluttes byggesagen midlertidig og venter på ibrugtagning. Når en delvis afsluttet byggesag afsluttes, genberegnes stambygningens status for delvis/midlertidig afslutning Henlæggelse Man henlægger en byggesag ved at udfylde henlæggelsesdatoen og gemme byggesagen. Byggesagen får et ophørstimestamp. Når en byggesag henlægges, henlægges også de underliggende sagentiteter, dvs. ophørstimestampet sættes og status ændres til Sletning af sagsentitet i en byggesag Man sletter en sagsentitet ved at benytte Slet entitet (Delete) metoden. Når en sagsentitet slettes, bliver ophørstimestampet sat, og status forbliver 3. En sletning af en sagsentitet tolkes som om entiteten aldrig burde have været oprettet. Snitfladebeskrivelse Side 29 af 310

30 Sletning af byggesag Man sletter en byggesag ved at benytte Slet byggesag (Delete) delete metoden på byggesagen. Byggesagen får et ophørstimestamp. Når en byggesag slettes, slettes også de underliggende sagsentiteter Kopiering af byggesager En byggesag er altid relateret til én grund, og sagsentiteter i en byggesag må kun høre til højst én bygning, dvs. må ikke høre til to forskellige bygninger. Disse regler bliver der taget højde for, når man identændrer entiteter og flytter dem til nye bygninger, ejendomme og grunde. I forbindelse med flytning af entiteter, kan byggesager blive involveret på forskellige måder: - Der flyttes et nybyggeri. - Der flyttes en stam-entitet, som har en tilhørende sagsentitet. - Der flyttes en entitet, som har en eller flere byggesager på et underliggende niveau. Når byggesager er involveret i forbindelse med en identændring, bliver følgende regel anvendt: Hvis det er muligt, flyttes en byggesag sammen med alle dens sagsentiteter til den nye grund. Dette er dog kun muligt, hvis alle sagsentiteter i byggesagen kan flyttes med. Hvis byggesagen indeholder entiteter, som ikke kan flyttes med, vil byggesagen blive kopieret. Den kopierede byggesag vil have de samme attributter (dvs. byggesagsnummer, sagsbehandler mm.), som den byggesag, man kopierer. Hvis flere sagsentiteter i en byggesag flyttes umiddelbart efter hinanden, vil de efter flytningen igen komme til at ligge i samme byggesag, idet der ved flytningen af en sagsentitet bliver taget hensyn til, om der på den nye grund ligger en byggesag, som er en tidligere kopi af den byggesag, som sagsentiteten hører til. Den beskrevne regel gælder dog ikke for en nybyggeri-opgang, som flytter til en ny nybyggeri-bygning. Her flytter opgangen altid i samme byggesag, som nybyggeri-bygningen ligger i. Dette gælder også, hvis opgangen ikke samtidig flyttes til en anden grund. Hvis en nybyggeri-opgang flyttes under en nybyggeri-bygning, vil også alle andre sagsentiteter, som ligger i samme byggesag som opgangen, og som kan flyttes med, blive flyttet i samme sag. Eksempel 1 En (N)BYG entitet og en (N)TEK entitet ligger i den samme byggesag, og man ønsker at flytte dem til en ny grund en ad gangen. GRU 1 SAG MAT 1 (N)BYG Snitfladebeskrivelse Side 30 af 310

31 (N)TEK Den første flytning af (N)TEK resulterer i, at byggesagen kopieres: GRU 1 SAG MAT 1 GRU 2 (N)BYG SAG (Kopi) MAT 2 (N)TEK Den efterfølgende flytning af (N)BYG resulterer i, at (N)TEK og (N)BYG igen kommer til at ligge i samme byggesag som før, dog på den nye grund. GRU 2 SAG MAT 2 (N)BYG (N)TEK Byggesagen på den oprindelige grund vil blive slettet med mindre der ligger andre sagsentiteter i den, som ikke kunne flyttes med. Bemærk, at det tekniske anlæg og bygningen kun kommer til at ligge i samme byggesag, hvis byggesagen ikke ændres imellem flytningerne, og hvis de ikke vedrører 2 forskellige bygninger. Eksempel 2 En nybyggeri-bygning og en nybyggeri-opgang ligger i den samme byggesag, og man ønsker at flytte nybyggeri-opgangen til en ny bygning på en anden grund. GRU 1 SAG 1 MAT 1 (N)BYG 1 Snitfladebeskrivelse Side 31 af 310

32 (N)OPG (N)ENH GRU 2 SAG 2 MAT 2 (N)BYG 2 Når nybyggeri-opgangen flyttes til nybyggeri-bygningen på GRU2, flytter nybyggeri-opgangen ind i byggesagen for nybyggeri-bygningen på GRU2, dvs. SAG 2. GRU 1 SAG 1 MAT 1 (N)BYG 1 GRU 2 SAG 2 MAT 2 (N)BYG 2 (N)OPG (N)ENH Hvis nybygger-opgangen havde været den eneste entitet i SAG 1, ville denne blive tom. Systemet ville i givet fald give en advarsel om dette Koordinater til bygning og teknisk anlæg Bygninger og tekniske anlæg har i Nyt mulighed for at få tilknyttet et koordinatsæt. Koordinatsæt knyttes til bygninger hhv. tekniske anlæg i forbindelse med oprettelse eller opdatering af entiteten. Dette gøres ved at man udfylder strukturen ConstructionPoint (se afsnit ). Hvilke felter denne struktur har og hvilke af disse felter der er krævede ved indberetning er beskrevet i afsnit Snitfladebeskrivelse Side 32 af 310

33 Koordinater kan kun tilknyttes til stamentiteter eller nybyggerier, men ikke til sager, som er ændringer til stamentiteter ((S) entiteter). Når man indberetter koordinater skal man tage højde for følgende valideringsregler: Felterne x-koordinat, y-koordinat, kilde til koordinatsæt og kvalitet af koordinatsæt er krævede felter Revisionsdato skal være større eller lig med den eksisterende revisionsdato, og den skal være mindre eller lig med dagsdato. x- og y koordinaten skal være i det geografiske rektangel, som hører til landsdelen. Der skelnes mellem 4 landsdele: Jylland (incl. Læsø og Anholt) (kommunenumre større end 500) Fyn (incl Sprogø) (kommunenumre 410, og ellers større end 411 og mindre end 500) Sjælland (kommunenumre større end 100 og mindre end 400) Bornholm og Christiansø (kommunenumre 400 og 411) Foreløbige koordinater Koordinatsæt til bygninger og teknisk anlæg kan indberettes af kommunen eller eksterne parter, men i de tilfælde hvor de ikke indberettes, hentes foreløbige koordinater fra GST. Det bliver gjort i forbindelse med opdatering og oprettelse af bygninger og tekniske anlæg i følgende situationer: Ved oprettelse af en bygning eller et teknisk anlæg i stamdelen eller ved oprettelse af et nybyggeri, hvor der ikke sendes et koordinatsæt med. Ved opdatering af en bygning eller teknisk anlæg i stamdelen (enten ved direkte opdatering eller ved afslutning af en byggesag) eller ved opdatering af et nybyggeri. Det er kun muligt at hente foreløbige koordinater når bygningen hhv. det teknisk anlæg har tilknyttet et GST matrikelnummer. Med GST matrikelnummer menes ejerlav og matrikelnummer fra GST' matrikel og tilhørende matrikelkort. Disse matrikelbetegnelser svarer til en ESR matrikeloplysning og ejendomsnummer med artskode 00 eller 01. Der hentes kun koordinater fra GST hvis de ikke er blevet opdateret igennem OIOXML snitfladen af en bedre kilde end fra GST. Det betyder i detaljer: Koordinater hentes når - Kilde til koordinatsæt" er lig med M og - Kvalitet af koordinatsæt er lig med 3 og - Matriklen, som bygningen hhv. det tekniske anlæg ligger på, ændres til en anden matrikel eller de eksisterende koordinater er 0 (dvs. der endnu ikke er blevet hentet koordinater) Kontrol af koordinater Når en stamentitet (bygning hhv. teknisk anlæg) eller et nybyggeri har et koordinatsæt, som er bedre end GST (dvs. kilde er forskelligt fra M eller kvalitet er forskelligt fra 3), bliver der kontrolleret, om koordinaterne ligger på samme Snitfladebeskrivelse Side 33 af 310

34 matrikel som bygningen hhv. det tekniske anlæg. Ligesom ovenfor gennemføres denne kontrol kun hvis entiteten er knyttet til et GST matrikelnummer Denne kontrol bliver gennemført i følgende situationer: Ved oprettelse af en bygning eller et teknisk anlæg i stamdelen eller ved oprettelse af et nybyggeri, hvor der sendes et koordinatsæt med. Ved opdatering af en bygning eller teknisk anlæg i stamdelen (enten ved direkte opdatering eller ved afslutning af en byggesag) eller ved opdatering af et nybyggeri. Hvis dette ikke er tilfælde returneres sandsynlighedsbeskeden Matriklen er ikke i overensstemmelse med entitetens matrikel fra GST (<GST matrikel>). For København og Frederiksberg gennemføres disse kald til GST ikke Historiske data Fremsøgning og hentning af historiske data Som noget nyt giver version 5 af snitfladen BuildingDwelling adgang til historiske data, dvs. entiteter, der er udgået og har fået et ophørstimestamp. Det betyder i detaljer, at følgende historiske data kan fremsøges eller hentes via snitfladen: Stamentiteter med objekttype 2 (se også afsnit 3.3) Det gælder dog stadig, at der ikke er adgang til udgåede sagsentiteter og følgende entiteter kan således ikke fremsøges eller hentes: Afsluttede sagsentiteter med objekttype 4 (se også afsnit 3.5), dvs. sagsentiteter som er overført til stam. Sagsentiteter med objekttype 3, som har fået et ophørstimestamp, dvs. sagsentiteter som er blevet slettet. Byggesager, som er blevet afsluttet eller slettet. I den forbindelse er der blevet tilføjet en ny inputparameter IncludeHistoricIndicator til relevante søge- og hent metoder. Ved hjælp af feltet IncludeHistoricIndicator angiver man, om man ønsker, at foretage en historisk søgning hhv. hentning. Det gøres ved at sætte feltet IncludeHistoricIndicator til true. Feltet findes på følgende metoder: <Entity>Search <Entity>GetById <Entity>GetByIds <Entity1>GetBy<Entity2>Id Når indikatoren er lig med true, betyder det, at man ønsker at medtage historiske data i resultatet. Se næste afsnit IncludeHistoricIndicator <Entity>GetById og <Entity>GetByIds Når man ønsker at hente udgåede stamentiteter ved GetById eller GetByIds metoderne, sættes indikatoren til true. Snitfladebeskrivelse Side 34 af 310

35 <Entity1>GetBy<Entity2>Id Hvis man sætter indikatoren til true, vil metoden - ud over at returnere gældende stamentiteter og eventuelle underliggende nybyggeri entiteter også levere udgåede stamentiteter. <Entity>Search Når feltet er sat til true, vil metoderne <Entity>Search fremsøge både udgåede og gældende entiteter dog ikke sagsentiteter, hverken gældende eller udgåede Sletning af data fra historik Snitfladen giver mulighed for at slette historiske data. For at slette en entitet fra historikken benyttes <Entity>DeleteHistoric metoden, som kaldes med id en for den udgåede entitet, som man ønsker at slette fra historik. Det er kun udgåede stamentiteter som kan fjernes fra de historiske data. Når en entitet slettes fra historik, slettes også underliggende data fra historik. Slettes der f.eks. en bygning fra historikken, slettes der også eventuelle underliggende opgange, enheder, tekniske anlæg samt sagsentiteter fra historikken. Snitfladebeskrivelse Side 35 af 310

36 3.8. Sikkerhedsklassifikation 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 Håndtering af sikkerhedsklassifikation ved opdatering af entiteter Når man opdaterer en entitet er feltet sikkerhedsklassifikation et krævet felt. Snitfladebeskrivelse Side 36 af 310

37 4. Overblik over webservices og metoderne Metoderne i servicen (WSDL en) kan inddeles i 10 grupper: metoderne hørende til entiteten grund metoderne hørende til entiteten bygning metoderne hørende til entiteten opgang/indgang metoderne hørende til entiteten etage metoderne hørende til entiteten enhed metoderne hørende til entiteten teknisk anlæg metoderne hørende til entiteten rum metoderne hørende til entiteten brugsenhed metoderne hørende til entiteten byggesag søgemetoderne For hver entitet findes der metoder til at hente, opdatere, oprette og slette entiteten: <Entitet>GetById/GetByIds <Entitet>Get <Entitet>Create <Entitet>Update <Entitet>Delete <Entitet>DeleteHistoric Derudover findes der for hver af de 8 førstnævnte entiteter en metode til at hente sagsentiteter hørende til en stamentitet: <Entitet>GetByParentId Hver entitet leveres med referencer til overliggende entiteter. For at hente underliggende entiteter stilles yderligere metoder til rådighed. Der findes for hver entitet med underliggende entiteter en metode til at hente disse underliggende entiteter: <Entitet1>GetBy<Entitet2>Id Derudover findes der for hver entitet en søgemetode: <Entitet>Search Til sidst kan der nævnes at metoden SiteGetSubStructuresById henter alle underliggende entiteter til en grund. Denne metode kan benyttes på alle niveauer til at hente alle underliggende entiteter. Ønsker man fx at hente alle underliggende entiteter til en bygning, kalder man metoden med id en for den grund som bygningen hører til. Alle metoder har en inputstruktur, som hedder <metodenavn>requeststructure og en outputstruktur, som hedder <metodenavn>responsestructure. Fx hedder strukturerne til GetById metoden for bygningen BuildingGetByIdRequestStructure og BuildingGet- ByIdResponseStructure. For hver entitet findes der en struktur, som beskriver entiteten både når den benyttes som input og som output til en metode. Dette gælder også for søgemetoderne, som returnerer en entitet i samme struktur som en hent metode til entiteten. Strukturen hedder: Snitfladebeskrivelse Side 37 af 310

38 <Entitet>Structure Fordelen ved denne implementering er, at man kan genbruge strukturen fra en søgning eller et læsekald, når man skal opdatere entiteten efterfølgende. Ulempen kan være, at man ikke altid ud fra strukturen kan se, hvilke felter der er krævede eller optionelle i hvilke situationer. Vejledningen vil dog tage hensyn til dette og de fleste steder er der beskrevet i hvilke situationer et felt er krævet og i hvilke det ikke er. De forskellige entitetsstrukturer er beskrevet i kapitel 5 idet de danner grundlag for stort set alle metoder i webservicen. Metoderne er beskrevet i kapitel 6 til 15, hvor hvert kapitel svarer til en af de ovenstående 10 grupper af metoder. Beskrivelsen er underbygget med billeder af strukturerne for at anskueliggøre beskrivelsen. Bl.a. kan man se, hvilke felter der er obligatoriske, dvs. skal udfyldes, når metoderne bliver kaldt. Derudover kan man se alle felter/understrukturer som hører til en struktur og deres kardinalitet. Før entitetsstrukturerne og metoderne beskrives, vil afsnit 4.1 til 4.11 beskrive nogle generelle forhold, som er fælles for de fleste metoder og som med fordel kan beskrives samlet Sandsynlighedskontroller (IgnoreWarningIndicator) De fleste opdateringer i systemet (opdater, opret og slet metoder) har en indikator, som angiver, om man ønsker at ignorere advarsler. Med advarsler menes der de i systemet implementerede sandsynlighedskontroller. Hvis indikatoren er true, ignoreres advarsler og opdateringen udføres hvis der ikke er fejl. Hvis indikatoren er false, udføres opdateringen kun hvis der ikke findes advarsler. Man vil typisk først kalde metoden med indikatoren sæt til false. De leverede advarsler tjekkes og hvis man ønsker at opdatere på trods af disse advarsler kaldes metoden med indikatoren sæt til true. Advarslerne leveres tilbage i samme struktur som fejl og andre returbeskeder. Læs mere om dette i afsnit Udskrivning af Meddelelser (printenableindicator) Man kan benytte en indikator for at angive, om der skal udskrives en Meddelelse i forbindelse med den rettelse man foretager. Indikatoren findes kun i de metoder hvor den giver mening, dvs. fx ikke i hent eller søgemetoderne, men i opret, ret og slet metoder. Hvis man sætter indikatoren til at være true, resulterer den respektive opdatering i en bestilling af en automatisk Meddelelse for en ejendom/ejerlejlighed vel at mærke hvis det giver mening. Der bestilles fx ingen Meddelelser ved ændringer af sagsentiteter. Kun en afslutning af en byggesag kan resultere i en Meddelelse for den involverede ejendom (de involverede ejendomme). Årsagskoden afhænger af den respektive ændring. For en beskrivelse af mulige årsagskoder henvises til brugervejledning for systemets Meddelelse funktionalitet. Snitfladebeskrivelse Side 38 af 310

39 4.3. Gyldighedsdato (AssessmentChangedDate) Feltet gyldighedsdato er et felt på følgende entiteter: Grund Bygning Opgang/indgang Etage Enhed Teknisk anlæg Byggesag Feltet sendes videre til KMD og derfra til Vurdering systemet, når man opdaterer, opretter eller sletter en entitet. Feltet gør det muligt for SKAT at opretholde den funktionalitet de i dag har u Vurderingssystemet, hvor man benytter gyldighedsdato fra KMD til at danne varslinger og årskopier. Feltet hører til en enkel opdatering og feltet leveres derfor ikke med i metode svar. For entiteterne brugsenhed og rum findes feltet ikke på entiteten i, men feltet sendes alene videre til KMD. Feltnavn i NYT OIOXML navn Kommentar Kommentar Gyldighedsdato AssessmentChangedDate Feltet benyttes af KMD /Vurdering systemet til at angive fra hvilken dato en rettelse i systemet har været gyldig og dermed har haft indflydelse for vurderingen Den implementerede opdateringsmekanisme Den her beskrevne opdateringsmekanisme er valgt for at gøre det muligt at nulstille alle felter på entiteterne. Kort sagt skal der ved opdatering af en entitet kun sendes de understrukturer for entiteten med, som indeholder felter, der skal opdateres eller nulstilles. En undtagelse for denne regel er strukturen <Entitet>Keys, som identificerer entiteten og derfor altid skal sendes med. Felterne i strukturen <Entitet>Keys behandles således specielt i opdateringssituationen og dette er nærmere forklaret i forbindelse med de enkelte update-metoder. En anden undtagelse er opdateringen af notater. Kun de medsendte notater opdateres. Dette er nærmere forklaret i afsnit Denne opdateringsmekanisme betyder således følgende: Undlader man at sende en understruktur med, betyder det, at man ikke vil opdatere felterne i denne understruktur. Sendes understrukturen med, betyder det, at alle felter i understrukturen bliver opdateret. Derfor skal alle felter udfyldes, også dem man ikke ønsker at opdatere. Udfyldes et felt i en understruktur ikke, eller mangler feltet når strukturen sendes, betragtes det som en nulstilling af feltet. Snitfladebeskrivelse Side 39 af 310

40 Denne mekanisme betyder, at man kan slette et felt ved at opdatere det med en null værdi eller ved ikke at udfylde feltet. Førstnævnte mulighed gælder kun for nogle få felter, mens sidstnævnte virker for alle felter. Stringfelter, som f.eks. ESDH reference, kan f.eks. nulstilles ved at sende en tom string som input. For andre felter, som fx mange kodefelter er denne mulighed ikke givet. Et eksempel er feltet kilde til materiale, som kan have kodeværdier 1 til 5. Vil man slette koden kan man ikke sende koden 0 eller blank med, skemavalideringen vil afvise dette. For at nulstille feltet skal man således lad være med at sende feltet med i opdateringen. Hvis ikke andet er nævnt kan felterne på de enkelte entiteter opdateres igennem snitfladen. Når felter er beregnede eller hvis de af andre grunde ikke må opdateres er dette eksplicit nævnt under feltbeskrivelsen Rettigheder Generelt gælder det, at man kun kan læse og opdatere de felter, som man har rettigheder til. Sender man en struktur som input i forbindelse med en update/create metode, som man ikke har lov til at opdatere, vil strukturen blive ignoreret. Denne regel - sammen med den ovenstående opdateringsmekanisme - betyder, at man altid skal kunne læse et felt når man har opdateringsrettigheder til feltet. Der kan være to årsag til, at et felt ikke er udfyldt når det leveres som del af et svar: Du har ikke rettigheder til at læse feltet. Feltet er ikke udfyldt i databasen. Du kan benytte den i kapitel 1 nævnte webservice Permission til at hente oplysninger om de rettigheder du har. Snitfladebeskrivelse Side 40 af 310

41 4.6. Styring af opdateringer (RecordChangeDateTime) Feltet RecordChangeDateTime benyttes til at styre opdateringer. Når man henter en entitet, får man en RecordChangeDateTime med retur. Når man foretager en opdatering, skal denne sendes med tilbage. Servicen benytter dette felt til at kontrollere, om andre har opdateret entiteten i mellemtiden. Hvis den medsendte RecordChangeDateTime ikke er den nyeste, dvs. entiteten er blevet opdateret fra et andet sted siden man læste den, vil systemet returnere en fejl og opdateringen (update eller delete handlingen) afvises Sagstype (BuildingCaseTypeCode og updatereasoncode) Der skelnes mellem 2 forskellige slags sagstyper, en som benyttes for sagsentiteter og en som benyttes for stamentiteter. Sagsentiteter har en sagstype, som angiver hvilken slags sag det drejer sig om. Sagstypen angiver ved sagens oprettelse og kan efterfølgende ikke rettes. Feltet hedder BuildingCaseTypeCode. Følgende 3 koder er mulige for sagsentiteter: Koder i byggesagsdata: 1 - Nybyggeri 2 - Til/ombygning 3 - Nedrivning (hel eller delvis) Stamentiteter har en sagstype, som angiver hvorfor man opretter eller retter en entitet i stamdelen. Sagstypen angives ved hver oprettelse eller rettelse. Feltet hedder updatereasoncode. Stamentiteternes sagstype kan have følgende 4 koder: Koder i stamdata: 4 - Fejlrettelse af faktiske fejlregistreringer og udeladelser) 5 - Faktisk udført ændring uden byggesagsbehandling 6 - Opdeling i enheder 7 - Sammenlægning af enheder Kode 6 og 7 vil ikke kunne benyttes for alle entiteter da de omhandler opdeling og sammenlægning af enheder Resultat for metodekald (ReturnMessage) Resultatet for alle metode kald leveres tilbage i en struktur kaldet Return- Message. Snitfladebeskrivelse Side 41 af 310

42 Der skelnes mellem tre forskellige slags svartyper: 1. Metodekaldet blev udført uden fejl. 2. Metodekaldet blev ikke udført på grund af fejl. 3. Metodekaldet blev ikke udført på grund af en advarsel. I første tilfælde, hvis kaldet går godt, er ResponseReturnIdentifier lig med 0 og der returneres kun én ReturnMessage. I det andet tilfælde, hvis der opstår en fejl, er ResponseReturnIdentifier lig med 10 og der returneres kun én ReturnMessage. I det tredje tilfælde, hvis kaldet returnerer en eller flere advarsler, er ResponseReturnIdentifier lig med 20 og der returneres en ReturnMessage pr. sandsynlighedsbesked. Med sandsynlighedsbeskeder/advarsler menes der følgende: systemet kan ud fra diverse valideringsregler afgør, at den sendte opdatering/oprettelse/sletning indeholder data, som kunne være forkerte. Det er dog muligt at ignorere disse advarsler og gennemføre kaldet ved at sætte den i afsnit 4.1. nævnte indikator IgnoreWarningIndicator til true. Nedenstående tabel beskriver felterne i strukturen ReturnMesasage samt deres mulige værdier. ReturnMessage Feltnavn i NYT OIOXML navn Kommentar Kommentar ResponseReturnIdentifier Beskriver hvilken type besked det drejer sig om. ResponseReasonIdentifier Koder: 0: OK 10: Fejl 20: Sandsynlighedsvalidering Nærmere detaljer for den returnerede besked. Hvis ReturnIdentifier er 0 kan følgende koder forekomme: 0: OK, kald udført 10: Metodekaldet (søgning eller en af de forskellige hent metoder) gav ingen resultat. 20: Metodekaldet (BuildingCaseUpdate) gik godt, Byggesagen er afsluttet. BuildingCase- Structure returneres ikke idet byggesagen er afsluttet. 40: Mere end 100 søgeresultater Hvis ReturnIdentifier er 10 kan følgende Snitfladebeskrivelse Side 42 af 310

43 ReturnMessage Feltnavn i NYT OIOXML navn Kommentar Kommentar koder forekomme: Der kan forekomme mange koder, idet der findes en kode for hver fejlbesked i Nyt. Kode 30 benyttes hvis den ved opdatering sendte RecordChangeDate- Time er forkert ResponseReasonText Hvis ReturnIdentifier er 20 kan følgende koder forekomme: Der kan forekomme mange koder, idet der findes en kode for hver sandsynlighedsbesked i Nyt. En beskrivelse af fejlen hhv. sandsynlighedsbeskeden Skemavalidering Der foretages skemavalidering af de indsendte data. Hvis requested ikke overholder skemaerne returneres en SOAP fejl med en beskrivelse af problemet. Et eksempel for sådan en fejlbesked kunne være: <?xml version="1.0" encoding="utf-16"?> <s:envelope xmlns:s=" <s:body> <s:fault> <faultcode xmlns:a="urn:oio:bbr:1.0.0">a:schemavalidationfault</faultcode> <faultstring xml:lang="en-us">the ' element is invalid - The value '461' is invalid according to its datatype ' - The Pattern constraint failed.</faultstring> </s:fault> </s:body> </s:envelope> Her har man sendt en 3-cifret kommunekode 461 i stedet for den 4-cifrede UniversalIdentifier og Reference Når et felt har et navn, hvor et entitetsnavn er efterfulgt af udtrykket UniversalIdentifier beskriver feltet den til entiteten hørende unikke identifier. Når der derimod benyttes et entitetsnavn efterfulgt af udtrykket Reference beskriver feltet en ekstern reference til en entitet og feltet indeholder den unikke idenfier for den entitet der refereres til (fremmed nøgle). En entitet kan kun have én UniversalIdentifier men kan have flere References idet en entitet kan referere til forskellige andre entiteter. Snitfladebeskrivelse Side 43 af 310

44 4.11. Placeholder-problematik Som beskrevet under 4.3, refererer nedrivninger og til/ombygninger altid til den stamentitet de hører til, dvs. de er en ændring til. I d: 13 Stamentitet (status 1) <Ent i t y>par ent Ref er ence I d: 14 Ændring til stamentitet (nedrivning eller til/ombygning) (status 3) Lige som nedrivninger og til/ombygninger peger også nybyggerier på en stamentitet, men her drejer det sig om en slags placeholder for den senere stamentitet. Placeholderen har den id, som entiteten får, når sagen afsluttes og nybyggeriet overføres til stam. I d: 11 Placeholder for nybyggeri (status 1) <Ent i t y>par ent Ref er ence I d: 12 Nybyggeri (status 3) Hvis nedrivningen hhv. til/ombygningen hører til et nybyggeri, vil både nybyggeriet og sagen (nedrivning hhv. til/ombygningen) pege på placeholderen for stamentiteten. I d: 11 Placeholder for nybyggeri (status 1) <Ent i t y>par ent Ref er ence <Ent i t y>par ent Ref er ence I d: 12 Nybyggeri (status 3) I d: 14 Ændring til stamentitet(nedrivning eller til/ombygning) (status 3) I entiteternes hierarki (se afsnit 3.1) peger underliggende entiteter altid på en eller flere overliggende entiteter. Dvs. en enhed peger f.eks. på en opgang/indgang og en etage. Alle disse references (se afsnit 4.10) peger på stamentiteter, enten gældende stamentiteter eller hvis den overliggende Snitfladebeskrivelse Side 44 af 310

45 entitet er et nybyggeri den til nybyggeriet hørende placeholder. Dette er forsøgt illustreret i nedenstående billede. I d: 11 Placeholder for nybyggeri etage(status 1) I d: 14 Placeholder for nybyggeri enhed (status 1) Fl oor Par ent Ref er ence Fl oor Ref er ence Bui l di nguni t Par ent Ref er ence I d: 12 Nybyggeri etage (status 3) I d: 13 Nybyggeri enhed (status 3) I d: 15 Stamentitet (status 1) opgang/indgang Ent r anceref er ence Nybyggeri-enheden peger på en stam-opgang/indang og placeholderen for den nybyggede etage. Nybyggeri entiteter peger altid på deres placeholder i stamdelen via feltet EntityBuidlingCaseType.<Entity>ParentReference. Denne implementering er vigtig at kende i nogle af de i denne vejledning beskrevne metoder. Det giver fx ikke mening at hente eller levere en placeholder entitet og derfor skal man være opmærksom på, i hvilke situationer man benytter nybyggeri id en og i hvilke tilfælde man benytter placeholder id en. De næste 3 afsnit beskriver hvordan de forskellige metodekald håndterer kald med en placeholder id <Entity>GetById og <Entity>GetByIds metoder <Entity>GetById og <Entity>GetByIds metoderne henter en (eller flere) entitet(er) stamentiteter eller sagentiteter- ved angivelse af deres unikke identifier. Når man kalder en <Entity>GetById eller <Entity>GetByIds metode med en placeholder id for et nybyggeri vil man få en fejlbesked tilbage. Lad os se på nedenstående eksempel: Snitfladebeskrivelse Side 45 af 310

46 I d: 11 Placeholder for nybyggeri (status 1) I d: 13 Stambygning (status 1) I d: 15 Placeholder for nybyggeri (status 1) <Ent i t y>par ent Ref er ence <Ent i t y>par ent Ref er ence <Ent i t y>par ent Ref er ence I d: 12 Nybyggeri (status 3) I d: 14 Ændring til bygning (nedrivning eller til/ombygning) (status 3) I d: 16 Nybyggeri (status 3) <Ent i t y>par ent Ref er ence I d: 17 Ændring til nybyggeri (nedrivning eller til/ombygning) (status 3) I den viste situation vil der gælde følgende: Kald af <Entity>GetById med id 12 leverer nybyggeri-entiteten med id 12 hvor EntityBuidlingCaseType.<Entity>ParentReference refererer til placeholderen i stamdelen, som har id 11. Kald af <Entity>GetById med id 11 eller id 15 (dvs. kald med placeholder id) giver en fejl. Kald af <Entity>GetById med id 13 leverer stamentiteten med id 13 uden en EntityBuidlingCaseType struktur. Kald af <Entity>GetById med id 14 leverer sagsentiteten med id 14 hvor EntityBuidlingCaseType.<Entity>ParentReference refererer til stamentiteten med id 13. Kald af <Entity>GetById med id 16 leverer nybyggeriet med id 16 hvor EntityBuidlingCaseType.<Entity>ParentReference refererer til placeholderen i stamdelen, som har id 15. Kald af <Entity>GetById med id 17 leverer sagsentiteten med id 17 hvor EntityBuidlingCaseType.<Entity>ParentReference refererer til id 15, som er placeholderen i stamdelen for nybyggeriet. For midlertidig afsluttede byggesager kan man kalde GetById metoderne både med placeholder id en (som jo nu ikke længere er en rigtig placeholder) samt nybyggeri id en <Entity>GetByParentId metoder <Entity>GetByParentId metoderne henter sager (dvs. entiteter med status 3) hørende til en stamentitet. For at hente sager til en eksisterende stamentitet kalder man metoden med stamentitetens id. For at hente sager til et nybyggeri, skal man kalde metoden med nybyggerietes placeholder og ikke med nybyggeriets id. Når man kalder en EntityGetByParentId metoden med en placeholder id for et nybyggeri vil man få selve nybyggeriet (og eventuelle sager på selve ny- Snitfladebeskrivelse Side 46 af 310

47 byggeriet) leveret retur. Nybyggeriet er en sag hørende til dens placeholder i stamdelen. Det betyder således at et kald af <Entity>GetByParentId metode med en nybyggeri id vil resultere i en fejl. I den ovenfor viste situation vil der gælde følgende: Kald af <Entity>GetByParentId med id 12, 14, 16 eller 17 leverer ingen sagsentiteter tilbage, idet der ikke findes sager på disse entiteter. Kald af <Entity>GetByParentId med id 11 (placeholderen for nybyggeriet) leverer sagsentiteten (nybyggeriet) med id 12, hvor EntityBuidlingCaseType.<Entity>ParentReference refererer til id 11. Kald af <Entity>GetByParentId med id 13 leverer sagsentiteten (til/ombygning eller nedrivning) med id 14, hvor EntityBuidlingCaseType.<Entity>ParentReference refererer til id 13. Kald af <Entity>GetByParentId med id 15 leverer 2 sagsentiteter: Nybyggeriet med id 17 og Til/ombygning/nedrivning med id 16. For begge sagsentiteter gælder det, at EntityBuidlingCaseType.<Entity>Parent- Reference refererer til id <Entity1>GetBy<Entity2>Id metoder <Entity1>GetBy<Entity2>Id metoderne og SiteGetSubStructuresById metoden henter underliggende entiteter til en entitet. F.ek.s henter metoden BuildingGetBySiteId en eller flere bygninger hørende til en grund. <Entity1>GetBy<Entity2>Id samt SiteGetSubStructuresById metoderne returnerer stamentiteter og eventuelle nybyggerier, men ingen (S)entiteter, dvs. ingen til/ombygninger eller nedrivninger. For at hente underliggende entiteter til en eksisterende stamentitet kalder man metoden med stamentitetens id. For at hente underliggende entiteter til et nybyggeri, skal man kalde metoden med nybyggerietes placeholder og ikke med nybyggeriets id. Det betyder således at et kald af <Entity1>GetBy<Entity2>Id metoden med en nybyggeri id vil resultere i en fejl. Snitfladebeskrivelse Side 47 af 310

48 I d: 11 Placeholder for nybyggeri etage(status 1) I d: 14 Placeholder for nybyggeri enhed (status 1) Fl oor Par ent Ref er ence Fl oor Ref er ence Bui l di nguni t Par ent Ref er ence I d: 12 Nybyggeri etage (status 3) I d: 13 Nybyggeri enhed (status 3) I d: 15 Stamentitet (status 1) opgang/indgang Ent r anceref er ence I den viste situation vil der gælde følgende: Kald af BuildingUnitGetByFloorId med id 11 (placeholderen for nybyggeri etagen) leverer nybyggeri enheden med id 13, hvis FloorReference peger på id 11. Kald af BuildingUnitGetByFloorId med id 12 resulterer i en fejl. Kald af BuildingUnitGetByEntranceId med id 15 leverer nybyggeriet med id 13, hvis EntranceReference peger på id BuildingCaseGetByEntityId metode Metoden BuildingCaseGetByEntityId henter alle byggesager hørende til en stamentitet. For at hente byggesager til en eksisterende stamentitet kalder man metoden med stamentitetens id. For at hente byggesagen til et nybyggeri, skal man kalde metoden med nybyggerietes placeholder og ikke med nybyggeriets id. Når man kalder en EntityGetByParentId metoden med en placeholder id for et nybyggeri vil man få leveret byggesagen til selve nybyggeriet (og byggesager for eventuelle sager på selve nybyggeriet) retur. Nybyggeriet er en sag hørende til dens placeholder i stamdelen. Det betyder således at et kald af BuildingCaseGetByEntityId metoden med en id for et nybyggeri vil resultere i en fejl Delete og update metoder Delete og update metoderne følger de i afsnit beskrevne principper, dvs. en delete eller update metode kan ikke kaldes med en placeholder id Namespaces Der benyttes felter og strukturer fra andre namespaces i forbindelse med denne OIOXML snitflade. Nedenstående oversigt viser hvilke forkortelser der på tegningerne bliver brugt for hvilke namespaces. bbr urn:oio:bbr:1.0.0 Snitfladebeskrivelse Side 48 af 310

49 bbr200 bbr300 bbr400 bbr500 Bbr600 bbr1 bbr2 bbr3 kmd cpr dkcc esr bbr4 xkom svur dkcc2 dkcc3 urn:oio:bbr:2.0.0 urn:oio:bbr:3.0.0 urn:oio:bbr:4.0.0 urn:oio:bbr:5.0.0 urn:oio:bbr: Datatyper Webservicen benytter de datatyper, som er defineret på digitaliser.dk. Det er xsd filerne, som beskriver hvilket format de enkelte typer skal overholde Udviklingsværktøjer Mange udviklingsværktøjer kan generere et interface/proxy til webservicen. I.NET skal man i denne sammenhæng f.eks. være opmærksom på følgende: Optionelle felter resulterer i to felter i koden: Et felt hvor man angiver en værdi og et felt (feltnavn efterfulgt af Specified ), som angiver om feltet er angivet eller ej. Specified feltet skal sættes til true hvis værdien angives. Sættes Specified feltet til false, ignoreres en eventuel værdi som angives. En Integer type bliver til en string. Det betyder, at f.eks. feltererne WasteAreaMeasure, AccessAreaMeasure mm. skal angives med omkring værdien. Snitfladebeskrivelse Side 49 af 310

50 5. Strukturer til entiteter - <Entity>Structure For hver entitet er der lavet en struktur som beskriver entiteten i alle de situationer entiteten bliver brugt, dvs. når entiteten sendes som input til en metode, når den returneres som output for en metode og når den leveres som et resultat for en søgning. De 9 strukturer hedder: SiteStructure BuildingStructure EntranceStructure FloorStructure BuildingUnitStructure TechnicalInstallationStructure RoomStructure UseUnitStructure BuildingCaseStructure Disse strukturer er beskrevet i de efterfølgende 9 afsnit. Det sidste afsnit Fælles strukturer samler understrukturer som er fælles for nogle af de nævnte entitetsstrukturer. Generelt gælder det, at understrukturer i en entitetsstruktur kun leveres tilbage fra et metodekald, hvis et af felterne i understrukturen er udfyldt. Hvis alle felter i en understruktur er tomme, sendes understrukturen ikke med. <Entity>Keys strukturen er altid med, både i input og output til en metode, idet feltet kommunekode altid er udfyldt/skal udfyldes. Snitfladebeskrivelse Side 50 af 310

51 5.1. SiteStructure Strukturen SiteStructure beskriver en grund i alle situationer den bliver brugt. Både, når grunden sendes med som input til en metode og når grunden leveres som output til en metode. Dette gælder også søgningerne. SiteStructure Feltnavn i OIOXML navn Kommentar Tidsstempel RecordChangeDateTime Tidspunkt for seneste rettelse af grunden, se også afsnit 4.6. Feltet leveres altid når grunden er del af et svar, og den skal leveres ved update og delete metoderne. Når man opretter en grund, skal feltet ikke udfyldes. Nøgler til grunden SiteKeys Felter som er med til at identificere grunden, se også afsnit Strukturen er altid til stede idet den indeholder kommunekoden, som er et krævet felt, både ved input og output. Informationer om grunden SiteInformation Supplerende oplysninger om grunden, se også afsnit Adresseoplysninger AddressComplete Adresseoplysniger for den adgangsadresse som Snitfladebeskrivelse Side 51 af 310

52 SiteStructure Feltnavn i OIOXML navn Kommentar hører til grunden, se afsnit (I nuværende version af, er adressen et krævet felt på grunden. ) Vand- og afløbsforhold WaterDrainage Oplysninger om vand- og afløbsforhold, se afsnit Sagsoplysninger Jornalnummer og ESDH reference EntityBuildingCaseInformation ExternalReferences Hvis grunden har status 3 leveres oplysninger om den byggesag, som denne grund hører til. Der leveres yderligere id for den grund, som denne sag er en ændring til. Der findes ikke nybyggerier for grunde. Se også afsnit Journalnummer og ESDH reference, se afsnit Kommunespecifikke felter MunicipalityFields Kommunespecifikke felter, se afsnit Notater NoteStructure 0 til 99 notater som kan knyttes til grunden, se afsnit Gyldighedsdato AssessmentChangedDate Se afsnit 4.3. Dispensation ift. kollektiv varmeforforsyning DispensationHeatSupply Oplysninger vedr. dispensation/fritagelse ift. kollektivvarmeforsyning. Se afsnit For at se, om en grund med status 1 har sager tilknyttet, benyttes metoden SiteGetByParentId (se afsnit 6.5). For at hente bygninger og tekniske anlæg til en grund benyttes metoderne BuildingGetBySiteId (se afsnit 7.4) og TechnicalInstallationGetBySiteId (se afsnit 11.4) Mulighed for identændringer Oplysninger om grunde ajourføres via ESR og GST. Der findes således ingen nybyggeri-grunde i og gældende grunde må hverken slettes eller oprettes. Muligheden for identændringer er således begrænset. Følgende ident-felter må gerne rettes for en grund i stam: Adgangsadresse (AddressAccessReference), svarende til Husnummer ident en fra DAR En grund kan godt opdateres uden en adresse, så længe den ikke skal bebygges. Følgende felter kan ikke rettes for en grund i stam: Ejendomsnummer (MunicipalRealPropertyIdentifier) Tilhørende matrikler (landparcelidentitystructure) Ejerforholskode fra ESR (OwnershipCode) Snitfladebeskrivelse Side 52 af 310

53 Identændringer kan ikke laves for (S) entiteter, dv.s ændringer til eksisterende grunde. Følgende felter kopieres fra stamentiteten til sagsentiteten når man opretter en (S) entitet: Adgangsadresse (AddressAccessReference), svarende til Husnummer ident en fra DAR Ejendomsnummer (MunicipalRealPropertyIdentifier) Tilhørende matrikler (landparcelidentitystructure) Ejerforholskode fra ESR (OwnershipCode) Hvis felterne efterfølgende rettes i stam, slå ændringerne igennem til tilknyttede sager. Identændring: Flyt alt fra en matrikel til en anden For grunde eller mere præcist for matrikler, findes der en speciel identændringsfunktion, som gør det muligt at flytte alle entiteter (dvs. bygninger og tekniske anlæg), som ligger på én matrikel, til en anden matrikel. Den nye matrikel kan enten ligge på samme grund/ejendom eller på en anden grund/ejendom. Både stam-entiteter og sagsentiteter flyttes herved. En sagsentitet flyttes sammen med dens byggesag. Dette er dog kun muligt, hvis alle andre sagsentiteter i byggesagen kan flyttes med. Hvis en af de involverede byggesager indeholder sagsentiteter hørende til en anden matrikel, vil en flytning ikke være muligt. Når en bygning eller teknisk anlæg flytter til en anden matrikel, og den/det har beregnede koordinater eller slet ingen koordinater, vil disse blive opdateret med koordinater hørende til den nye matrikel (hvis det er en GST matrikel). Når en stam-entitet eller et nybyggeri har et koordinatsæt, hvis kilde er forskellig fra M eller hvis kvalitet er forskellig fra 3, bliver der kontrolleret for, om de angivne koordinater hører til den nye matrikel (hvis entiteten er knyttet til et GST matrikelnummer). Systemet vil give besked, hvis koordinaterne ikke ligger på den angivne matrikel. Når alle entiteter flyttes fra en matrikel til en anden, udskrives der både en Meddelelse for den gamle og den nye ejendom. Meddelelsen kan dog fravælges på almindelig vis. Hvis en af de flyttede entiteter har et ejerskab, kan flytningen til en ny ejendom kun foretages ved at slette ejerskabet, flytte entiteterne og oprette ejerskabet igen på den nye ejendom. Den beskrevne identændring er implementeret via metoden SiteMoveEntities, som er beskrevet i kapitel SiteKeys Denne struktur indeholder felterne som er med til at identificere en grund entydigt. Snitfladebeskrivelse Side 53 af 310

54 SiteKeys Feltnavn i OIOXML navn Kommentar Grund id SiteUniversalIdentifier Den unikke tekniske nøgle til grunden. Leveres altid når grunden er del af et svar. Udfyldes som input ved delete og update metoderne. Feltet skal ikke angives i create metoden, men id en tilføjes af systemet. Kommunekode MunicipalityCode Kommunekode. Felter er altid udfyldt både når grunden leveres som output og når grunden leveres som input til en metode. Ejendomsnummer Ejendomsnummer. MunicipalRealPropertyIdentifier Ejendomsnummeret hørende til grunden. Feltet er altid udfyldt når grunden er del af et svar, men ignoreres når grunden leveres som input til en metode. Adgangsadresse Id AddressAccessReference Reference til adgangsadressen, svarende til husnummeret i DAR Statuskode statuscode Statuskode. Feltet leveres når grunden er del af et metodesvar og grunden har en adresse. Udfyldes ved update og create metoden (stam entiteter) for at angive grundens adresse. Statuskoden er 1 for grunde i stamdelen og 3 for sager (ændringer af eksisterende grunde) Snitfladebeskrivelse Side 54 af 310

55 SiteKeys Feltnavn i OIOXML navn Kommentar Feltet kan ikke opdateres igennem snitfladen men opdateres automatisk af systemet. Feltet ignoreres således hvis det bliver sendt som en del af et input. Matrikeloplysninger landparcelidentitystructure Den eller de matrikler hørende til grunden. Se digitaliser.dk og afsnit for flere detaljer. Matrikeloplysninger ajourføres ved hjælp af GST hhv. ESR og kan ikke opdateres via denne snitflade. Strukturen ignoreres således i update/create situationer SiteInformation Denne struktur indeholder felterne som beskriver yderligere grundoplysninger. Når en grund leveres som en del af et svar er strukturen med hvis mindst et af de underliggende felter er udfyldt. Ved oprettelse eller opdatering af en grund er strukturen kun med, hvis felterne ønskes inddateret/rettet. Sender man understrukturen med, betyder det at man opdaterer alle felter i understrukturen. Hvis man undlader at sende et felt med, betyder det, at man vil slette feltindholdet. I resultatet for søgningen er strukturen med, hvis der laves en fuld søgning og mindste et af de underliggende felter er udfyldt (se mere herom i afsnit 15.2). SiteInformation Feltnavn i OIOXML navn Kommentar Ejerforholdskode OwnershipCode Ejerforholdskode Koder (hentes fra ESR): 10: Privatpersoner eller interessentskab 20: Alment boligselskab 30: Aktie-, anpart- eller andet selskab (undtagen Snitfladebeskrivelse Side 55 af 310

56 SiteInformation Feltnavn i OIOXML navn Kommentar interessentskab) 40: Forening, legat eller selvejende institution 41: Privat andelsboligforening 50: Den kommune, hvori ejendommen er beliggende 60: Anden primærkommune 70: Region 80: Staten 90: Andet, herunder moderejendomme for bebyggelser, der er opdelt i ejerlejligheder samt ejendomme, der ejes af flere kategorier af ejere Feltet leveres når grunden leveres som del af et output, men feltet kan ikke opdateres igennem snitfladen. Sikkerhedsklassifikation securityclasssification- Indicator Omfattet af sikkerhedsklassifikation. Koder: False(0) Grunden er ikke omfattet af sikkerhedshensyn True (1) - Grunden er sikkerhedsklassificeret Ophørstimestamp RecordExpiredDateTime Ophørstimestamp. Når en grund slettes eller en sag afsluttes vil entiteten få et ophørstimestamp. For entiteter med status 1 og 3 vil feltet ikke være udfyldt. For entiteter med status 2 vil feltet være udfyldt. Oprettelsestidspunkt RecordCreatedDateTime Oprettelsestimestamp. Feltet er altid udfyldt når grunden leveres som del af et svar, men feltet kan ikke opdateres idet systemet sætter dette timestamp automatisk når grunden oprettes. Sagstype updatereasoncode Sagstype som benyttes ved oprettelse og ændring af stamentitet (se afsnit 4.7) Feltet ignoreres hvis det angives for sagsentiteter. Snitfladebeskrivelse Side 56 af 310

57 SiteInformation Feltnavn i OIOXML navn Kommentar Koder i stamdata: 4 - Fejlrettelse af faktiske fejlregistreringer og udeladelser 5 - Faktisk udført ændring uden byggesagsbehandling AddressComplete Se afsnit WaterDrainage Se afsnit EntityBuildingCaseInformation Se afsnit ExternalReferences Se afsnit MunicipalityFields Se afsnit NoteStructure Se afsnit DispensationHeatSupply Se afsnit Snitfladebeskrivelse Side 57 af 310

58 5.2. BuildingStructure Strukturen BuildingStructure beskriver en bygning i alle anvendelses situationer. Både, når bygningen sendes med som input til en metode og når bygningen leveres som output til en metode. Dette gælder også søgningerne. BuildingStructure Feltnavn i OIOXML navn Kommentar Tidsstempel RecordChangeDateTime Tidspunkt for seneste rettelse af bygningen, se også afsnit 4.6. Feltet leveres altid når bygningen er del af et svar, og den skal leveres ved update og delete metoderne. Når man opretter en bygning, skal feltet ikke Snitfladebeskrivelse Side 58 af 310

59 BuildingStructure Feltnavn i OIOXML navn Kommentar udfyldes. Nøgler til bygningen BuildingKeys Felter som er med til at identificere bygningen, se også afsnit Strukturen er altid til stede idet den indeholder kommunekoden, som er et krævet felt, både ved input og output. Informationer om bygningen BuildingInformation Supplerende oplysninger om bygningen, se også afsnit Adresseoplysninger AddressComplete Adresseoplysninger for den adresse som hører til bygningen, se afsnit Ejerlejlighedsoplysninger CondominiumStructure En bygning kan være en ejerlejlighed. I givet fald giver denne struktur oplysning om ejendomsnummer, ejerlejlighedsnummer mm. Se afsnit Bygningspunkt ConstructionPoint Bygningspunkt, se afsnit Kun stamentiteter og nybyggerier kan have tilknyttet et koordinatsæt. Energioplysninger BuildingHeating Felter som beskriver bygningens energioplysninger, se afsnit Arealer BuildingArea Felter som beskriver bygningens arealer, se afsnit Indretning BuildingArrangement Felter som beskriver bygningens indretning, se afsnit Materialer BuildingMaterial Felter som beskriver bygningens materialer, se afsnit Vand- og afløbsforhold WaterDrainage Felter som beskriver bygningens vand- og afløbsforhold, se afsnit Sagsoplysninger EntityBuildingCaseInformation Hvis bygningen har status 3 leveres oplysninger om den byggesag, som denne bygning hører til. For sager som ikke er nybyggerier leveres yderligere id for den bygning, som denne sag er en ændring til. For nybyggerier leveres der id til placeholderen. Se også afsnit Snitfladebeskrivelse Side 59 af 310

60 BuildingStructure Feltnavn i OIOXML navn Kommentar Forsikring BuildingInsurance Forsikringsoplysninger, se afsnit Jornalnummer og ESDH reference ExternalReferences Journalnummer og ESDH reference, se afsnit Kommunespecifikke felter MunicipalityFields Kommunespecifikke felter, se afsnit Notater NoteStructure 0 til 99 notater som kan knyttes til bygningen, se afsnit Flytning af bygning MunicipalityRelocationStructure Hvis en bygning er ved at blive flyttet til en anden kommune vil denne struktur være udfyldt, se afsnit Gyldighedsdato AssessmentChangedDate Se afsnit 4.3. Dispensation ift. kollektiv varmeforforsyning DispensationHeatSupply Oplysninger vedr. dispensation/fritagelse ift. kollektivvarmeforsyning. Se afsnit For at se, om en bygning med status 1 har sager tilknyttet, benyttes metoden BuildingGetByParentId (se afsnit 7.5). For at hente underliggende brugsenheder, opgang/indgange, etager eller teknisk anlæg til en bygning benyttes metoderne UseUnitGetByBuildingId (se afsnit 13.4), EntranceGetByBuildingId (se afsnit 8.4), FloorGetByBuildingId (se afsnit 9.4) eller TechnicalInstallationGetByBuildingId (se afsnit 11.5) Mulighed for identændringer Følgende ident-felter må gerne rettes for en bygning i stam og for en nybyggeri-bygning: Bygningsnummer (BuildingIdentifier) Tilknytning til matrikel (landparcelidentitystructure) og derigennem Ejendomsnummer (MunicipalRealPropertyIdentifier, SiteReference) Adgangsadresse (AddressAccessReference), svarende til Husnummer ident en fra DAR Ændring af felterne matrikel og/eller ejendomsnummer resulterer i en flytning af bygningen samt dens underliggende entiteter til en ny matrikel på en eventuel ny ejendom eller grund. Ændring af felterne bygningsnummer og adgangsadresse er derimod kun en ændring af et simpelt attribut og resulterer ikke i en flytning af bygningen. Følgende ident-felter må ikke rettes for et nybyggeri: Tilknytning til byggesagen (EntityBuildingCaseInformation.BuildingCaseReference) Snitfladebeskrivelse Side 60 af 310

61 Tilknytning til stamentitet (EntityBuildingCaseInformation.BuildingParentReference) Sagstype (EntityBuildingCaseInformation.BuildingCaseTypeCode) Bygningens tilknytning til en byggesag kan dog ændres i forbindelse med at identændringer. Dette er nærmere beskrevet i kapitel Identændringer kan ikke laves for (S) entiteter, dvs. ændringer til eksisterende enheder, dog må ejerskabet rettes. Følgende felter kopieres fra stamentiteten til sagsentiteten når man opretter en (S) entitet: Bygningsnummer (BuildingIdentifier) Tilknytning til matrikel (landparcelidentitystructure) og derigennem Ejendomsnummer (MunicipalRealPropertyIdentifier, SiteReference) Adgangsadresse (AddressAccessReference), svarende til Husnummer ident en fra DAR Anvendelseskode (UseCode) Ejerskab (CondominiumStructure) Hvis felterne efterfølgende rettes i stam, slå ændringerne igennem til tilknyttede sager (dog ikke ejerskab). Flytning af bygninger Når man flytter en bygning, som enten er et nybyggeri eller som har underliggende sagsentiteteter, skal man ved flytningen tage højde for de(n) tilhørende byggesag(er). Dette er nærmere beskrevet i kapitel Når en bygning flytter til en anden matrikel, og bygningen har beregnede koordinater eller slet ingen koordinater, vil disse blive opdateret med koordinater hørende til den nye matrikel (hvis det er en GST matrikel). Når en stamentitet eller et nybyggeri har et koordinatsæt, hvis kilde er forskellig fra M eller hvis kvaliteten er forskellig fra 3, bliver der kontrolleret for, om de angivne koordinater hører til den nye matrikel (hvis entiteten er knyttet til et GST matrikelnummer). Systemet vil give besked, hvis koordinaterne ikke ligger på den angivne matrikel. Hvis en bygning flyttes fra en ejendom til en anden, udskrives der både en Meddelelse for den gamle og den nye ejendom. Meddelelsen kan dog fravælges på almindelig vis. Hvis den flyttede bygning har et ejerskab, skal dette ejerskab evt. tilrettes i forbindelse med identændringen. Hvis en af bygningens underliggende entiteter har et ejerskab, skal dette ejerskabet evt. fjernes før flytningen til en ny ejendom kan foretages. Ejerskabet kan oprettes igen på den nye ejendom. Snitfladebeskrivelse Side 61 af 310

62 BuildingKeys Denne struktur indeholder felterne som er med til at identificere en bygning entydigt. En bygning ligger altid på en matrikel og er dermed altid knyttet til en grund. BuildingKeys Feltnavn i OIOXML navn Kommentar Bygning id BuildingUniversalIdentifier Den unikke tekniske nøgle til bygningen. Leveres altid når bygningen er del af et svar. Udfyldes som input ved delete og update metoderne. Feltet skal ikke angives i create metoden, men id en tilføjes af systemet. Kommunekode MunicipalityCode Kommunekode. Felter er altid udfyldt både når bygningen leveres som output og når bygningen leveres som input til en metode. Ejendomsnummer Ejendomsnummer. MunicipalRealPropertyIdentifier Ejendomsnummeret hørende til bygningen. Feltet er altid udfyldt når bygningen er del af et svar, men ignoreres når bygningen leveres som input til en metode. Tilhørsforhold til en ejendom rettes ved at man ændrer bygningens matrikel. Bemærk, at man i matrikelstrukturen (land- ParcelIdentityStructu- Snitfladebeskrivelse Side 62 af 310

63 BuildingKeys Feltnavn i OIOXML navn Kommentar Bygningsnummer BuildingIdentifier Bygningsnummer. re)kan angive et ejendomsnummer for entydig at identificere en matrikel. Bygningsnummeret hørende til bygningen. Feltet er altid udfyldt når bygningen er del af et svar. Feltet skal udfyldes ved oprettelse eller opdatering af en bygning i stam eller en nybyggeribygning. Adgangsadresse id AddressAccessReference Id til adgangsadressen i, svarende til Husnummeret i DAR. Statuskode statuscode Statuskode. Feltet leveres altid når bygningen er del af et metode-svar. Feltet skal udfyldes ved oprettelse eller opdatering af en bygning i stam eller en nybyggeribygning. Statuskoden er 1 for bygninger i stamdelen og 3 for sager (nybyggerier eller ændringer af eksisterende bygninger) Feltet kan ikke opdateres igennem snitfladen men opdateres automatisk af systemet. Feltet ignoreres således hvis det bliver sendt som en del af et input. Grund id SiteReference Id til grunden i. Feltet leveres altid når bygningen er del af et metode-svar. Feltet ignoreres når bygningen er input til update/create metoderne. Tilhørsforhold til en grund rettes ved at man ændrer bygningens matrikel. Anvendelseskode UseCode Bygningens anvendelseskode Feltet skal angives ved en opdatering eller oprettelse af en bygning i stam eller et nybyggeri. Koder: Bygninger til helårsbe- Snitfladebeskrivelse Side 63 af 310

64 BuildingKeys Feltnavn i OIOXML navn Kommentar boelse. 110 Stuehus til landbrugsejendom. 120 Fritliggende enfamilieshus (parcelhus). 130 Række-, kæde-, eller dobbelthus (lodret adskillelse mellem enhederne). 140 Etageboligbebyggelse (flerfamiliehus, herunder to-familiehus (vandret adskillelse mellem enhederne). 150 Kollegium. 160 Døgninstitution (plejehjem, alderdomshjem, børne- eller ungdomshjem). 190 Anden bygning til helårsbeboelse. Produktions- og lagerbygninger i forbindelse med landbrug, industri, håndværk, offentlige værker o. lign. 210 Bygning til erhvervsmæssig produktion vedrørende landbrug, gartneri, råstofudvinding o. lign. 220 Bygning til erhvervsmæssig produktion vedrørende industri, håndværk m.v. (fabrik, værksted o. lign.). 230 El-, gas-, vand- eller varmeværk, forbrændingsanstalt m.v Anden bygning til landbrug, industri etc. Bygninger til handel, transport, kontor, liberale erhverv, servicevirksomhed o. lign. 310 Transport- og garageanlæg (fragtmandshal, lufthavnsbygning, banegårdsbygning, parkeringshus). Garage med plads til et eller to køretøjer registreres med anvendelseskode Bygning til kontor, handel, lager, herunder offentlig administration. 330 Bygning til hotel, restaurant, vaskeri, frisør og anden servicevirksom- Snitfladebeskrivelse Side 64 af 310

65 BuildingKeys Feltnavn i OIOXML navn Kommentar hed. 390 Anden bygning til transport, handel etc. Bygninger til kulturelle formål samt institutioner. 410 Bygning til biograf, teater, erhvervsmæssig udstilling, bibliotek, museum, kirke o. lign. 420 Bygning til undervisning og forskning (skole, gymnasium, forskningslaboratorium o. lign.). 430 Bygning til hospital, sygehjem, fødeklinik o. lign. 440 Bygning til daginstitution. 490 Bygning til anden institution, herunder kaserne, fængsel o. lign. Bygninger til fritidsformål. 510 Sommerhus. 520 Bygning til ferieformål m.v., bortset fra sommerhus (feriekoloni, vandrehjem o. lign.) 530 Bygning i forbindelse med idrætsudøvelse (klubhus, idrætshal, svømmehal o. lign.). 540 Kolonihavehus. 590 Anden bygning til fritidsformål. Mindre bygninger til garageformål, opbevaring m.v. 910 Garage med plads til et eller to køretøjer. 920 Carport. 930 Udhus. Matrikeloplysninger landparcelidentitystructure Den matrikel der hører til bygningen. Se digitaliser.dk og afsnit for flere detaljer. Strukturen skal udfyldes ved oprettelse eller opdatering af en bygning i stam eller en nybyggeribygning BuildingInformation Snitfladebeskrivelse Side 65 af 310

66 Denne struktur indeholder felterne som beskriver yderligere bygningsoplysninger. Når en bygning leveres som en del af et svar er strukturen med hvis mindst et af de underliggende felter er udfyldt. Ved oprettelse eller opdatering af en bygning er strukturen kun med, hvis felterne ønskes inddateret/rettet. Sender man understrukturen med, betyder det at man opdaterer alle felter i understrukturen. Hvis man undlader at sende et felt med, betyder det, at man vil slette feltindholdet. I resultatet for søgningen er strukturen med, hvis der laves en fuld søgning og mindste et af de underliggende felter er udfyldt (se mere herom i afsnit 15.2). BuildingInformation Feltnavn i OIOXML navn Kommentar MidlertidigStatus TemporaryCreationCode Midlertidig oprettelse/fuldførelse Feltet angiver bygningens midlertidige status i forbindelse med en byggesag. Feltet opdateres af systemet og kan ikke indberettes. Koder: 0 Bygningen har ingen midlertidig status 1 Nybyggeriet er delvis afsluttet 2 Nybyggeriet er midlertidig afsluttet 3 Om/tilbygning er delvis afsluttet 4 Om/tilbygning er midlertidig afsluttet Snitfladebeskrivelse Side 66 af 310

67 BuildingInformation Feltnavn i OIOXML navn Kommentar Udløbsdato for midlertidig opført bygning TemporaryExpirationDate Udløbsdato for midlertidig opført bygning FredningStatus PreservationCode Fredningsstatus Koder: 1 - Bygningen fredet iht. bygningsfredningsloven 2 - Som 1, men med tinglyste bevaringsbestemmelser jf. lovens Tinglyst bevaringsdeklaration, men bygningen ikke fredet 4 - På bygningens middelalderlige bygningsdele er der tinglyst fredningsbestemmelser 5 - Bygningen indeholder middelalderlige bygningsdele 6 - Bygningen og dens umiddelbare omgivelser fredet iht. bygningsfredningsloven 7 - Som 6, men med tinglyst bevaringsdeklaration 9 - Bygningen medtaget i registrant, bevaringsplan mm. Opførelsesår ConstructionYearIdentifier Opførelsesår SenesteOmTilbygningsår ReconstructionYearIdentifier År for seneste til/ombygning BK_FOT_id FOTidentifier Fælles objekttype Bevaringsværdighed Grundens ejendomsnummer 15 cifret tekniske nøgle BK_Crud_id (teknisk nøgle) 8 - Bygningen bevaringsværdig BuildingWorthyOfPreservationCode SiteMunicipalRealPropertyIdentifier For bygninger på lejet grund angiver feltet grundens ejendomsnummer. BuildinHistoricUniqueIdentifier Link til registrering i FBB Bygningens historiske tekniske nøgle. Feltet findes for at imødekomme de it systemer, som har geokodet imod den tekniske nøgle fra KMD. For nye bygninger genereres der en ny teknsik nøgle i Nyt, som kan bruges. Fremadrettet er det dog feltet BuildingUniversalIdentifier som burde benyttes. Snitfladebeskrivelse Side 67 af 310

68 BuildingInformation Feltnavn i OIOXML navn Kommentar Sikkerhedsklassifikation securityclasssification- Indicator Omfattet af sikkerhedsklassifikation. Koder: False(0) - Bygningen er ikke omfattet af sikkerhedshensyn True (1) - Bygningen er sikkerhedsklassificeret Ophørstimestamp RecordExpiredDateTime Ophørstimestamp. Når en bygning slettes eller en sag afsluttes vil entiteten får et ophørstimestamp. For entiteter med status 1 og 3 vil feltet ikke være udfyldt. For entiteter med status 2 vil feltet være udfyldt. Oprettelsestidspunkt RecordCreatedDateTime Oprettelsestimestamp. Feltet er altid udfyldt når bygningen leveres som del af et svar, men feltet kan ikke opdateres idet systemet sætter dette timestamp automatisk når grunden oprettes. Sagstype updatereasoncode Sagstype som benyttes ved oprettelse og ændring af stamentitet (se afsnit 4.7) Feltet ignoreres hvis det angives for sagsentiteter. Koder i stamdata: 4 - Fejlrettelse af faktiske fejlregistreringer og udeladelser) 5 - Faktisk udført ændring uden byggesagsbehandling 6 - Opdeling i enheder 7 - Sammenlægning af enheder AddressComplete Se afsnit CondominiumStructure Se afsnit ConstructionPoint Se afsnit Snitfladebeskrivelse Side 68 af 310

69 BuildingHeating Denne struktur indeholder felterne som beskriver bygningens energioplysninger. Når en bygning leveres som en del af et svar er strukturen med hvis mindst et af de underliggende felter er udfyldt. Ved oprettelse eller opdatering af en bygning er strukturen kun med, hvis felterne ønskes inddateret/rettet. Sender man understrukturen med, betyder det at man opdaterer alle felter i understrukturen. Hvis man undlader at sende et felt med, betyder det, at man vil slette feltindholdet. I resultatet for søgningen er strukturen med, hvis der laves en fuld søgning og mindste et af de underliggende felter er udfyldt (se mere herom i afsnit 15.2). BuildingHeating Feltnavn i OIOXML navn Kommentar Varmeinstallation HeatingInstallationCode Varmeinstallation Koder: 1 - Fjernvarme/blokvarme (radiatorsystemer el. varmluftanlæg) 2 - Centralvarme fra eget anlæg, et-kammer fyr: 3 - Ovne (kakkelovne, kamin, brændeovne o.l.) 5 - Varmepumpe 6 - Centralvarme med to fyringsenheder (fast og olie eller gas) 7 - Elovne, elpaneler 8 - Gasradiator 9 - Ingen varmeinstallation 99 - Blandet (Kræver specifikation på enhedsniveau) Opvarmningsmiddel HeatingSourceCode Opvarmningsmiddel 1 - Elektricitet 2 - Gasværksgas 3 - Flydende brændsel (olie, petroleum, flaskegas) 4 - Fast brændsel (kul, koks, brænde mm.) 6 - Halm 7 - Naturgas Snitfladebeskrivelse Side 69 af 310

70 BuildingHeating Feltnavn i OIOXML navn Kommentar 9 - Andet SupplerendeVarmeinstallation SupplementaryHeatingCode Supplerende varmeinstallation Koder: 0 - Ikke oplyst 1 - Varmepumpeanlæg 2 - Ovne til fast brændsel (brændeovn o. lign.) 3 - Ovne til flydende brændsel 4 - Solpaneler 5 - Pejs 6 - Gasradiator 7 - Elovne, elpaneler 10 - Biogasanlæg 80 - Andet 90 - Bygningen har ingen supplerende varme BuildingArea Denne struktur indeholder felterne som beskriver bygningens arealer. Snitfladebeskrivelse Side 70 af 310

71 Når en bygning leveres som en del af et svar er strukturen med hvis mindst et af de underliggende felter er udfyldt. Ved oprettelse eller opdatering af en bygning er strukturen kun med, hvis felterne ønskes inddateret/rettet. Sender man understrukturen med, betyder det at man opdaterer alle felter i understrukturen. Hvis man undlader at sende et felt med, betyder det, at man vil slette feltindholdet. Snitfladebeskrivelse Side 71 af 310

72 I resultatet for søgningen er strukturen med, hvis der laves en fuld søgning og mindste et af de underliggende felter er udfyldt (se mere herom i afsnit 15.2). BuildingArea Feltnavn i OIOXML navn Kommentar Kilde til bygningsarealer AreaSourceCode Kilde til bygningsarealer Koder: 1 - Oplyst af ejer (eller af dennes repræsentant) 2 - Oplyst af teknisk forvaltning 3 - Oplyst af andre (lukket for indberetning) 4 - Bygningen er maskinelt oprettet 5 - Oplyst og kontrolleret af teknisk forvaltning Samlet bygningsareal TotalBuildingFloorAreaMeasure Samlet bygningsareal Bygningens samlede boligareal DwellingAreaMeasure Bygningens samlede boligareal Bygningens samlede erhvervsareal BusinessPremisesAreaMeasure Bygningens erhvervsareal samlede BebyggetAreal FootprintAreaMeasure Bygningens bebyggede areal IndbyggetGarageAreal GarageAreaMeasure Areal for indbygget garage IndbyggetCarportAreal CarportAreaMeasure Areal for indbygget carport IndbyggetUdhusAreal OuthouseAreaMeasure Areal for indbygget udhus IndbyggetUdestueAreal WinterGardenAreaMeasure Areal for indbygget udestue eller lign. Samlet areal af lukkede overdækninger på bygningen Areal af affaldsrum i terrænniveau CoveredAreaClosedMeasure WasteAreaMeasure Areal af lukket overdækning i bebygget areal. Areal af affaldsrum i terrænniveau Andet areal OtherBuildingAreaMeasure Andet areal (Areal der hverken benyttes til bolig eller erhverv) Overdækket areal PorchAreaMeasure Overdækket areal Samlet areal af åbne overdækninger på bygningen CoveredAreaOpenMeasure Areal af åben overdækning i bebygget areal Adgangsareal AccessAreaMeasure Samlet adgangsareal til fordeling på bygningens enheder Beregningsprincip for areal af carport CarportAreaCalculationCode Beregningsprincip for areal af carport Koder: 1 - Carportareal er målt efter tagflade 2 - Carportarealet er målt Snitfladebeskrivelse Side 72 af 310

73 BuildingArea Feltnavn i OIOXML navn Kommentar Antal etager FloorQuantity Antal etager ½ meter inde på åbne sider Afvigende etager FloorDeviationStatusCode Afvigende etager Kælderareal m. loft <1,25 m over terræn UdnyttetTagetage BasementHeight- Below125AreaMeasure Areal af lovlig beboelse i kælder BasementDwellingAreaMeasure TopAtticExploitedAreaMeasure Første ciffer klasse 1. Andet ciffer klasse 2. Koder: 0 - Bygningen har ikke afvigende etager 10 - Bygningen har afvigende etager 11 - Bygningen indeholder hems 12 - Bygningen indeholder dobbelt højt rum 13 - Bygningen indeholder indskudt etage Kælderareal m. loft <1,25 m over terræn Feltet kan ikke indberettes, men beregnes ud fra underliggende entiteter. Areal af lovlig beboelse i kælder Feltet kan ikke indberettes, men beregnes ud fra underliggende entiteter. Areal af udnyttet del af tagetage Feltet kan ikke indberettes, men beregnes ud fra underliggende entiteter. Samlet tagetageareal TotalAtticAreaMeasure Det samlede areal af tagetagen. Feltet kan ikke indberettes, men beregnes ud fra underliggende entiteter. Samlet kælderareal TotalBasementAreaMeasure Det samlede areal af kælderetagen. Udvendig efterisolering BuildingExteriorReinsulationMeasure Feltet kan ikke indberettes, men beregnes ud fra underliggende entiteter. Arealet af udvendig efterisolering BuildingArrangement Denne struktur indeholder felterne som beskriver bygningens indretning. Snitfladebeskrivelse Side 73 af 310

74 Når en bygning leveres som en del af et svar er strukturen med hvis mindst et af de underliggende felter er udfyldt. Ved oprettelse eller opdatering af en bygning er strukturen kun med, hvis felterne ønskes inddateret/rettet. Sender man understrukturen med, betyder det at man opdaterer alle felter i understrukturen. Hvis man undlader at sende et felt med, betyder det, at man vil slette feltindholdet. I resultatet for søgningen er strukturen med, hvis der laves en fuld søgning og mindste et af de underliggende felter er udfyldt (se mere herom i afsnit 15.2). BuildingArrangement Feltnavn i OIOXML navn Kommentar Sikringsrumpladser ShelterRoomAccomodation- Quantity Sikringsrumpladser (antal personer) Antal lejligheder med køkken DwellingQuantity Antal lejligheder med køkken Værdier angives fra til Feltet beregnes for stamentiteter, men kan indberettes for sagsentiteter. Antal lejligheder uden køkken SingleRoomQuantity Antal lejligheder uden køkken Værdier angives fra til Feltet beregnes for stamentiteter, men kan indberettes for sagsentiteter BuildingMaterial Denne struktur indeholder felterne som beskriver bygningens materialer. Snitfladebeskrivelse Side 74 af 310

75 Når en bygning leveres som en del af et svar er strukturen med hvis mindst et af de underliggende felter er udfyldt. Ved oprettelse eller opdatering af en bygning er strukturen kun med, hvis felterne ønskes inddateret/rettet. Sender man understrukturen med, betyder det at man opdaterer alle felter i understrukturen. Hvis man undlader at sende et felt med, betyder det, at man vil slette feltindholdet. I resultatet for søgningen er strukturen med, hvis der laves en fuld søgning og mindste et af de underliggende felter er udfyldt (se mere herom i afsnit 15.2). BuildingMaterial Feltnavn i OIOXML navn Kommentar Ydervægsmateriale OuterWallsMaterialCode Ydervægsmateriale (for overvejende del af bygningen) Koder: 1 - Mursten (tegl, kalksten, cementsten) 2 - Letbeton (lette bloksten, gasbeton) 3 - Plader af fibercement, herunder asbest (eternit el. lign.) 4 - Bindingsværk (med udvendigt synligt træværk) 5 - Træbeklædning 6 - Betonelementer (etagehøje betonelementer) 8 - Metalplader 10 - Plader af fibercement (asbestfri) 11 - PVC 12 - Glas 80 - Ingen 90 - Andet Tagdækningsmateriale RoofingMaterialCode Tagdækningsmateriale (for overvejende del af bygningen) Koder: 1 - Built-up 2 - Tagpap (med taghældning) 3 - Fibercement, herunder asbest (bølge- eller skifereternit) 4 - Cementsten 5 - Tegl 6 - Metalplader (bølgeblik, aluminium, o.lign.) 7 - Stråtag 10 - Fibercement (asbestfri) 11 - PVC 12 Glas 20 Grønne tage Snitfladebeskrivelse Side 75 af 310

76 BuildingMaterial Feltnavn i OIOXML navn Kommentar 80 - Ingen 90 - Andet materiale Supplerende ydervægsmateriale OuterWallsSupplementaryMaterialCode Supplerende tagdækningsmateriale RoofingSupplementaryMaterialCode Kan indberettes hvis en større del af ydervægsmaterialet afviger fra det hovedsagelige materiale. Der anvendes samme koder som for den overvejende del af ydervægsmaterialet. Kan indberettes hvis en større del af tagdækningsmaterialet afviger fra det hovedsagelige materiale. Der anvendes samme koder som for den overvejende del af tagdækningsmaterialet. Asbestholdigt materiale AsbestMaterialCode Asbestholdigt materiale Koder: 1 - Asbestholdigt ydervægsmateriale 2 - Asbestholdigt tagdækningsmateriale Kilde til bygningens materialer 3 - Asbestholdigt ydervægs- og tagdækningsmateriale MaterialReportingSourceCode Kilde til bygningens materialer Koder: 1 - Oplyst af ejer (eller af dennes repræsentant) 2 - Oplyst af teknisk forvaltning 3 - Oplyst af andre (lukket for indberetning) 4 - Bygningen er maskinelt oprettet 5 - Oplyst og kontrolleret af teknisk forvaltning WaterDrainage Se afsnit EntityBuildingCaseInformation Se afsnit BuildingInsurance Denne struktur indeholder felterne som beskriver bygningens forsikringsoplysninger. Snitfladebeskrivelse Side 76 af 310

77 Når en bygning leveres som en del af et svar, er strukturen med, hvis mindst et af de underliggende felter er udfyldt. Ved oprettelse eller opdatering af en bygning er strukturen kun med, hvis felterne ønskes rettet. Sender man understrukturen med, betyder det, at man opdaterer alle felter i understrukturen. Hvis man undlader at sende et felt med, betyder det, at man vil slette feltindholdet. Dvs. hvis man vil indberette felterne vedr. stormråd, skal man også sende gældende felter for forsikringsselskab med for at sikre, at disse ikke nulstilles. I resultatet for søgningen er strukturen med, hvis der laves en fuld søgning, og mindst et af de underliggende felter er udfyldt (se mere herom i afsnit 15.2). BuildingInsurance Feltnavn i OIOXML navn Kommentar Pålæg fra stormråd/selvrisiko ved oversvømmelse jf. Stormrådet StormCouncilInstructionCode Oplysninger fra stormråd Koder: 00 - Ingen udbetalt erstatning fra Stormrådet 01 - Bygningens selvrisiko er forhøjet til Trin Bygningens selvrisiko er forhøjet til Trin 2 Dato for pålæg fra Stormrådet/Dato for skade hos Stormrådet StormCouncilInstructionDate Omfattet af byggeskadeforsikring BuildingDamageInsuranceCode Indberetningen foretages af Stormrådet og ajourføres kun ved sager, hvor der er udbetalt særlig erstatning i forbindelse med stormflods- og oversvømmelsesskader. Dato for pålæg fra Stormrådet Registrering af om en bygning er omfattet af byggeskadeforsikring. Koder: 00 - Bygningen er ikke omfattet af byggeskadeforsikring 10 - Bygningen er omfat- Snitfladebeskrivelse Side 77 af 310

78 BuildingInsurance Feltnavn i OIOXML navn Kommentar tet af byggeskadeforsikring 11 - Bygningen er opført som selvbyg Dato for byggeskadeforsikring Byggeskadeforsikringsselskab Feltet kan således ikke indberettes, men genereres maskinelt ved sammenkædning af oplysninger om bygningens anvendelse og den tegnede byggeskadeforsikring ved afslutning af en byggesag. Feltet genberegnes ved rettelse af feltet Byggeskadeforsikring. BuildingDamageInsurance- CompanyDate Dato for byggeskadeforsikring BuildingDamageInsurance- CompanyCode Byggeskadeforsikringsselskab Koder: 00 - Ingen byggeskadeforsikring 01 - Tryg 02 - Topdanmark 04 - Codan 05 - If forsikring 06 - Alm. Brand 07 - Danske Forsikring 08 - AmTrust International Underwrites Limited 10 Købstædernes Forsikring 11 ALKA 12 Frida Forsikring Agentur 13 NemForsikring 14 AXA 15 Husejernes Forsikring 99 - Ingen forsikring på grund af dispensation Feltet kan kun indberettes på et nybyggeri og en stambygning ExternalReferences Se afsnit MunicipalityFields Se afsnit Snitfladebeskrivelse Side 78 af 310

79 NoteStructure Se afsnit MunicipalityRelocation Hvis en bygning er ved at blive flyttet til en anden kommune, angives der i strukturen MunicipalityRelocation, hvilken type af flytning det drejer sig om, og til hvilken kommune bygningen er ved at blive flyttet. Strukturen kan ikke indberettes igennem OIO snitfladen, men bliver leveret hvis bygningen er under flytning til en anden kommune. Hvis strukturen angives ved en update eller create metode, bliver felterne i strukturen ignoreret. MunicipalityRelocation Feltnavn i OIOXML navn Kommentar Type af flytning RelocationCode Koden angiver typen af flytning. Koder: 2 Matrikulær ændring 3 Fysisk flytning Tilflytter kommunekode NewMunicipalityCode Kommunekode for den kommune, som bygningen er ved at blive flyttet til DispensationHeatSupply Se afsnit Snitfladebeskrivelse Side 79 af 310

80 5.3. EntranceStructure Strukturen EntranceStructure beskriver en opgang/indgang i alle situationer den bliver brugt. Både, når opgangen/indgangen sendes med som input til en metode og når opgangen/indgangen leveres som output til en metode. Dette gælder også søgningerne. EntranceStructure Feltnavn i OIOXML navn Kommentar Tidsstempel RecordChangeDateTime Tidspunkt for seneste rettelse af opgangen/indgangen, se også afsnit 4.6. Feltet leveres altid når opgangen/indgangen er del af et svar, og den skal leveres ved update og delete metoderne. Når man opretter en opgang/indgang, skal feltet ikke udfyldes. Nøgler til opgang/indgang EntranceKeys Felter som er med til at identificere opgangen/indgangen, se også afsnit Strukturen er altid til stede idet den indeholder kommunekoden, som er et krævet felt, både ved input og output. Informationer om grunden EntranceInformation Supplerende oplysninger om opgangen/indgangen, se også afsnit Adresseoplysninger AddressComplete Adresseoplysniger for den adresse som hører til Snitfladebeskrivelse Side 80 af 310

81 EntranceStructure Feltnavn i OIOXML navn Kommentar opgangen/indgangen, afsnit se Sagsoplysninger Jornalnummer og ESDH reference EntityBuildingCaseInformation ExternalReferences Hvis opgangen/indgangen har status 3 leveres oplysninger om den byggesag, som denne opgang/indgang hører til. For sager som ikke er nybyggerier leveres yderligere id for den opgang/indgang, som denne sag er en ændring til. For nybyggerier leveres der id til placeholderen. Se også afsnit Journalnummer og ESDH reference, se afsnit Kommunespecifikke felter MunicipalityFields Kommunespecifikke felter, se afsnit Notater NoteStructure 0 til 99 notater som kan knyttes til opgangen/indgangen, se afsnit Gyldighedsdato AssessmentChangedDate Se afsnit 4.3. For at se, om en opgang/indgang med status 1 har sager tilknyttet, benyttes metoden EntranceGetByParentId (se afsnit 8.5). For at hente underliggende enheder til en opgang/indgang benyttes metoden BuildingUnitGetByEntranceId (se afsnit 10.4) Mulighed for identændringer Følgende ident-felter må gerne rettes for en opgang i stam og for en nybyggeri-opgang: Adgangsadresse (AddressAccessReference), svarende til Husnummer ident en fra DAR Tilknytning til bygning (BuildingReference) og derigennem tilknytning til matrikel (landparcelidentitystructure), Ejendomsnummer (MunicipalRealPropertyIdentifier, SiteReference) Ændring af opgangs tilknytning til en bygning resulterer i en flytning af opgangen samt dens underliggende entiteter til en ny bygning på en eventuel ny ejendom eller grund. Ændring af adgangsadressen er derimod kun en ændring af et attribut og resulterer ikke i en flytning af opgangen. Dog skal man være opmærksom på, at en rettelse af opgangsadressen også resulterer i en opdatering af de underliggende entiteters enhedsadresse. Når adressen for en opgang rettes, vil også de underliggende enheder skifte adresse. Retter man f.eks. opgangens adgangsadresse fra at være Vibevej 5 til at være Vibevej 7, ændres en underliggende enhed adresse fra Vibevej 5 tv til Vibevej 7 tv. Følgende ident-felter må ikke rettes for en nybyggeri-opgang: Snitfladebeskrivelse Side 81 af 310

82 Tilknytning til byggesagen (EntityBuildingCaseInformation.BuildingCaseReference) Tilknytning til stamentitet (EntityBuildingCaseInformation.BuildingParentReference) Sagstype (EntityBuildingCaseInformation.BuildingCaseTypeCode) Opgangens tilknytning til en byggesag kan dog ændre sig i forbindelse med identændringer. Dette er nærmere beskrevet i kapitel Identændringer kan ikke laves for (S) entiteter, dvs. ændringer til eksisterende opgange. Følgende felter kopieres fra stamentiteten til sagsentiteten når man opretter en (S) entitet: Tilknytning til bygning (BuildingReference) og derigennem tilknytning til matrikel (landparcelidentitystructure), Ejendomsnummer (MunicipalRealPropertyIdentifier, SiteReference) Adgangsadresse (AddressAccessReference), svarende til Husnummer ident en fra DAR Hvis felterne efterfølgende rettes i stam, slå ændringerne igennem til tilknyttede sager. Flytning af opgange Når man flytter en opgang, som enten er et nybyggeri eller som har underliggende sagsentiteter, skal man ved flytningen tage højde for de(n) tilhørende byggesag(er). Dette er nærmere beskrevet i kapitel Hvis man flytter en stam-opgang til en stam-bygning og stam-opgangen har underliggende sagsentiteter, flyttes deres byggesager hvis muligt til den nye bygning hhv. grund. Dette er dog kun muligt, hvis alle sagsentiteter i disse byggesager kan flyttes med. Hvis en byggesag indeholder entiteter, som ikke kan flyttes med, vil byggesagen blive kopieret. Den kopierede byggesag vil have de samme attributter (dvs. byggesagsnummer, sagsbehandler mm.), som den byggesag, man kopierer. Hvis man flytter en nybyggeri-opgang til en stam-bygning vil byggesagen, som nybyggeri-opgangen ligger i, samt eventuelle andre byggesager, som indeholder sagsentiteter under opgangen flytte - hvis muligt - til den nye bygning hhv. grund. Dette er dog kun muligt, hvis alle sagsentiteter i disse byggesager kan flyttes med. Hvis en byggesag indeholder entiteter, som ikke kan flyttes med, vil byggesagen blive kopieret. Hvis man flytter en nybyggeri-opgang til en nybyggeri-bygning, kommer den til at ligge i samme byggesag som nybyggeri-bygningen. Dette gælder altid - også, selv om bygningen ikke ligger på en anden grund. Hvis en nybyggeriopgang flyttes under en nybyggeri-bygning, vil også alle andre sagsentiteter, som ligger i samme byggesag som opgangen, og som kan flyttes med, blive flyttet i samme sag. Dette forhold er forskellig fra alle andre identændringer, hvor eksisterende byggesager flyttes med sagsentiteterne og hvor byggesagerne kopieres, hvis dette ikke er muligt. Hvis en nybyggeri-opgang har underliggende sagsentiteter, som ligger i andre byggesager, end den, som opgangen ligger i, flyttes disse byggesager med til den nye bygning på almindelig vis. Snitfladebeskrivelse Side 82 af 310

83 Når en opgang identændres, udskrives der Meddelelser på almindelig vis. Hvis en opgang flyttes fra en ejendom til en anden, udskrives der både en Meddelelse for den gamle og den nye ejendom. Meddelelsen kan dog fravælges på almindelig vis EntranceKeys Denne struktur indeholder felterne som er med til at identificere en opgang/indgang entydigt. En opgang/indgang er altid knyttet til en bygning. EntranceKeys Feltnavn i OIOXML navn Kommentar Opgang/indgang id EntranceUniversalIdentifier Den unikke tekniske nøgle til opgangen/indgangen. Leveres altid når opgangen/indgangen er del af et svar. Udfyldes som input ved delete og update metoderne. Feltet skal ikke angives i create metoden, men id en tilføjes af systemet. Kommunekode MunicipalityCode Kommunekode. Felter er altid udfyldt både når opgangen/indgangen leveres som output og når opgangen/indgangen leveres som input til en metode. Ejendomsnummer Ejendomsnummer. MunicipalRealPropertyIdentifier Ejendomsnummeret hørende til opgangen/indgangen. Feltet er altid udfyldt når opgangen/indgangen er del af Snitfladebeskrivelse Side 83 af 310

84 EntranceKeys Feltnavn i OIOXML navn Kommentar et svar, men ignoreres når opgangen/indgangen leveres som input til en metode. Reference til overliggende bygning BuildingReference Reference til den bygning som denne opgang/indgang hører til. Id en peger altid på en stamentitet og kan være en placeholder id hvis bygningen er et nybyggeri (se også afsnit og 4.12). Feltet leveres altid når opgangen/indgangen er del af et metode-svar. Feltet skal udfyldes ved oprettelse eller opdatering af en opgang i stam eller en nybyggeriopgang. Adgangsadresse Id AddressAccessReference Reference til adgangsadressen, svarende til Husnummeret i DAR. Statuskode statuscode Statuskode. Feltet leveres altid når opgangen/indgangen er del af et metode-svar, idet det er et krævet felt. Feltet skal udfyldes ved oprettelse eller opdatering af en opgang/indgang i stam eller et nybyggeri. Statuskoden er 1 for opgange/indgange i stamdelen og 3 for sager (nybyggerier eller ændringer af eksisterende opgange/indgange) Feltet kan ikke opdateres igennem snitfladen men opdateres automatisk af systemet. Feltet ignoreres således hvis det bliver sendt som en del af et input. Reference til overliggende grund SiteReference Reference til den grund som denne opgang/indgang hører til. Id en peger altid på en stamentitet (se også afsnit og 4.12). Feltet leveres altid når opgangen/indgangen er del af et metode-svar. Feltet ignoreres når opgangen/indgangen er input til update/create Snitfladebeskrivelse Side 84 af 310

85 EntranceKeys Feltnavn i OIOXML navn Kommentar metoderne. Matrikeloplysninger landparcelidentitystructure Den matrikel der hører til opgangen/indgangen. Se digitaliser.dk og afsnit for flere detaljer. Det er bygningens matrikel og den kan således kun ændres ved at tilknytning til bygningen bliver ændret. Feltet ignoreres i opretteltelses/rettelsessituationer EntranceInformation Denne struktur indeholder felterne som beskriver yderligere oplysninger om opgangen/indgangen. Når en opgang/indgang leveres som en del af et svar er strukturen med hvis mindst et af de underliggende felter er udfyldt. Ved oprettelse eller opdatering af en opgang/indgang er strukturen kun med, hvis felterne ønskes inddateret/rettet. Sender man understrukturen med, betyder det at man opdaterer alle felter i understrukturen. Hvis man undlader at sende et felt med, betyder det, at man vil slette feltindholdet. I resultatet for søgningen er strukturen med, hvis der laves en fuld søgning og mindste et af de underliggende felter er udfyldt (se mere herom i afsnit 15.2). EntranceInformation Feltnavn i OIOXML navn Kommentar Indikator for elevator LiftPresenceIndicator Indikator, som angiver om opgangen/indgangen har en elevator eller ej. Koder: False (0) - Der er ikke Snitfladebeskrivelse Side 85 af 310

86 EntranceInformation Feltnavn i OIOXML navn Kommentar True (1) - Der findes person- eller vareelevator i opgangen/bygningen Sikkerhedsklassifikation elevator i opgangen/bygningen: securityclasssification- Indicator Omfattet af sikkerhedsklassifikation. Koder: False(0) - Opgang/indgangen er ikke omfattet af sikkerhedshensyn True (1) - Opgang- /indgangen er sikkerhedsklassificeret Ophørstimestamp RecordExpiredDateTime Ophørstimestamp. Når en opgang/indgang slettes eller en sag afsluttes vil entiteten får et ophørstimestamp. For entiteter med status 1 og 3 vil feltet ikke være udfyldt. For entiteter med status 2 vil feltet være udfyldt. Oprettelsestidspunkt RecordCreatedDateTime Oprettelsestimestamp. Feltet er altid udfyldt når opgangen/indgangen leveres som del af et svar, men feltet kan ikke opdateres idet systemet sætter dette timestamp automatisk når opgangen/indgangen oprettes. Sagstype updatereasoncode Sagstype som benyttes ved oprettelse og ændring af stamentitet (se afsnit 4.7) Feltet ignoreres hvis det angives for sagsentiteter. Koder i stamdata: 4 - Fejlrettelse af faktiske fejlregistreringer og udeladelser) 5 - Faktisk udført ændring uden byggesagsbehandling AddressComplete Se afsnit Snitfladebeskrivelse Side 86 af 310

87 EntityBuildingCaseInformation Se afsnit ExternalReferences Se afsnit MunicipalityFields Se afsnit NoteStructure Se afsnit Snitfladebeskrivelse Side 87 af 310

88 5.4. FloorStructure Strukturen FloorStructure beskriver en etage i alle situationer den bliver brugt. Både, når etagen sendes med som input til en metode og når etagen leveres som output til en metode. Dette gælder også søgningerne. FloorStructure Feltnavn i OIOXML navn Kommentar Tidsstempel RecordChangeDateTime Tidspunkt for seneste rettelse af etagen, se også afsnit 4.6. Når man opretter en etage, skal feltet ikke udfyldes. Nøgler til etagen FloorKeys Felter som er med til at identificere etagen, se også afsnit Strukturen er altid til stede idet den indeholder kommunekoden, som er et krævet felt, både ved input og output. Informationer om etagen FloorInformation Supplerende oplysninger om etagen, se også afsnit Arealer for etagen FloorArea Felter som beskriver etagens arealer, se afsnit Sagsoplysninger Feltet leveres altid når etagen er del af et svar, og den skal leveres ved update og delete metoderne. EntityBuildingCaseInformation Hvis etagen har status 3 leveres oplysninger om den byggesag, som denne Snitfladebeskrivelse Side 88 af 310

89 FloorStructure Feltnavn i OIOXML navn Kommentar etage hører til. For sager som ikke er nybyggerier leveres yderligere id for den etage, som denne sag er en ændring til. For nybyggerier leveres der id til placeholderen. Se også afsnit Jornalnummer og ESDH reference ExternalReferences Journalnummer og ESDH reference, se afsnit Kommunespecifikke felter MunicipalityFields Kommunespecifikke felter, se afsnit NoteStructure 0 til 99 notater som kan knyttes til etagen, se afsnit Gyldighedsdato AssessmentChangedDate Se afsnit 4.3. For at se, om en etage med status 1 har sager tilknyttet, benyttes metoden FloorGetByParentId (se afsnit 9.5). For at hente enheder og rum til en etage benyttes metoderne BuildingUnit- GetByFloorId (se afsnit 10.5) og RoomGetByFloorId (se afsnit 12.4) Mulighed for identændringer Følgende ident-felter må gerne rettes for en etage i stam eller for en nybyggeri-etage: Etagebetegnelse (FloorPhysicalIdentifier) Ændring af etagebetegnelsen er kun en ændring af et attribut og resulterer ikke i en flytning af etagen. Følgende ident-felter må ikke rettes for en etage i stam eller for en nybyggerietage: Tilknytning til bygning (BuildingReference) og derigennem tilknytning til matrikel (landparcelidentitystructure), Ejendomsnummer (MunicipalRealPropertyIdentifier, SiteReference) Det er i nuværende version af systemet ikke muligt at flytte en etage til en anden ejendom eller bygning ved at rette etagens tilknytning til en bygning. Dog vil etagen flytte med hvis den overliggende bygning flyttes i forbindelse med identændringer. Følgende ident-felter må ikke rettes for et nybyggeri: Tilknytning til byggesagen (EntityBuildingCaseInformation.BuildingCaseReference) Tilknytning til stamentitet (EntityBuildingCaseInformation.BuildingParentReference) Sagstype (EntityBuildingCaseInformation.BuildingCaseTypeCode) Etagens tilknytning til en byggesag kan dog ændre sig i forbindelse med identændringer. Dette er nærmere beskrevet i kapitel Snitfladebeskrivelse Side 89 af 310

90 Identændringer kan ikke laves for (S) entiteter, dvs. ændringer til eksisterende etager. Følgende felter kopieres fra stamentiteten til sagsentiteten når man opretter en (S) entitet: Etagebetegnelse (FloorPhysicalIdentifier) Tilknytning til bygning (BuildingReference) og derigennem tilknytning til matrikel (landparcelidentitystructure), Ejendomsnummer (MunicipalRealPropertyIdentifier, SiteReference) Hvis felterne efterfølgende rettes i stam, slå ændringerne igennem til tilknyttede sager FloorKeys Denne struktur indeholder felterne som er med til at identificere en etage entydigt. En etage er altid knyttet til en bygning. FloorKeys Feltnavn i OIOXML navn Kommentar Etage id FloorUniversalIdentifier Den unikke tekniske nøgle til etagen. Leveres altid når etagen er del af et svar. Udfyldes som input ved delete og update metoderne. Feltet skal ikke angives i create metoden, men id en tilføjes af systemet. Kommunekode MunicipalityCode Kommunekode. Felter er altid udfyldt både når etagen leveres som output og når etagen leveres som input til en metode. Snitfladebeskrivelse Side 90 af 310

91 FloorKeys Feltnavn i OIOXML navn Kommentar Ejendomsnummer Ejendomsnummer. MunicipalRealPropertyIdentifier Ejendomsnummeret hørende til etagen. Feltet er altid udfyldt når etagen er del af et svar, men ignoreres når etagen leveres som input til en metode. Bygning id BuildingReference Id til den bygning som denne etage hører til. Id en peger altid på en stamentitet og kan være en placeholder id hvis bygningen er et nybyggeri (se også afsnit og 4.12). Statuskode statuscode Statuskode. Leveres altid når etagen er del af et svar. Feltet skal angives når opgangen oprettes i stam eller som nybyggeri. Feltet kan efterfølgende ikke opdateres. Statuskoden er 1 for etager i stamdelen og 3 for sager (nybyggerier eller ændringer af eksisterende etager) Feltet kan ikke opdateres igennem snitfladen men opdateres automatisk af systemet. Feltet ignoreres således hvis det bliver sendt som en del af et input. Grund id SiteReference Id til den grund som denne etage hører til. Id en peger altid på en stamentitet (se også afsnit 4.10 og 4.12). Feltet ignoreres når etagen er input til update/create metoderne. Tilhørsforhold til en grund angives ved tilknytning til bygningen. Etagebetegnelse FloorPhysicalIdentifier Fysisk beliggenhed af etagen (etagebetegnelse) Koder: Stuetage: ST 1. sal 99. sal:01-99 Kælder: KL 2.kælder 9. kælder: K2- K9 Feltet skal udfyldes ved Snitfladebeskrivelse Side 91 af 310

92 FloorKeys Feltnavn i OIOXML navn Kommentar oprettelse eller opdatering af en etage i stam eller en nybyggeri-etage. Matrikeloplysninger landparcelidentitystructure Den matrikel der hører til etagen. Se digitaliser.dk og afsnit for flere detaljer. Det er bygningens matrikel og den kan således kun ændres ved at tilknytning til bygningen bliver ændret FloorInformation Denne struktur indeholder felterne som beskriver yderligere etageoplysninger. Når en etage leveres som en del af et svar er strukturen med hvis mindst et af de underliggende felter er udfyldt. Ved oprettelse eller opdatering af en etage er strukturen kun med, hvis felterne ønskes inddateret/rettet. Sender man understrukturen med, betyder det at man opdaterer alle felter i understrukturen. Hvis man undlader at sende et felt med, betyder det, at man vil slette feltindholdet. I resultatet for søgningen er strukturen med, hvis der laves en fuld søgning og mindste et af de underliggende felter er udfyldt (se mere herom i afsnit 15.2). FloorInformation Feltnavn i OIOXML navn Kommentar Type for tagetage FloorTypeCode Angiver om etagen er en tagetage. Koder: 0 Ikke tagetage 1 - Tagetage Sikkerhedsklassifikation Feltet ignoreres i opretteltelses/rettelsessituationer. securityclasssification- Indicator Omfattet af sikkerhedsklassifikation. Koder: False(0) - Etagen er ikke omfattet af sikkerheds- Snitfladebeskrivelse Side 92 af 310

93 FloorInformation Feltnavn i OIOXML navn Kommentar hensyn True (1) - Eatgen er sikkerhedsklassificeret Feltet leveres når etagen leveres som del af et svar. Feltet kan opdateres i update og create metoder. Ophørstimestamp RecordExpiredDateTime Ophørstimestamp. Når en etage slettes eller en sag afsluttes vil entiteten får et ophørstimestamp. For entiteter med status 1 og 3 vil feltet ikke være udfyldt. For entiteter med status 2 vil feltet være udfyldt. Oprettelsestidspunkt RecordCreatedDateTime Oprettelsestimestamp. Feltet er altid udfyldt når etagen leveres som del af et svar, men feltet kan ikke opdateres idet systemet sætter dette timestamp automatisk når etagen oprettes. Sagstype updatereasoncode Sagstype som benyttes ved oprettelse og ændring af stamentitet (se afsnit 4.7) Feltet ignoreres hvis det angives for sagsentiteter. Koder i stamdata: 4 - Fejlrettelse af faktiske fejlregistreringer og udeladelser) 5 - Faktisk udført ændring uden byggesagsbehandling FloorArea Denne struktur indeholder felterne som beskriver etagens arealer. Snitfladebeskrivelse Side 93 af 310

94 Når en etage leveres som en del af et svar er strukturen med hvis mindst et af de underliggende felter er udfyldt. Ved oprettelse eller opdatering af en etage er strukturen kun med, hvis felterne ønskes inddateret/rettet. Sender man understrukturen med, betyder det at man opdaterer alle felter i understrukturen. Hvis man undlader at sende et felt med, betyder det, at man vil slette feltindholdet. I resultatet for søgningen er strukturen med, hvis der laves en fuld søgning og mindste et af de underliggende felter er udfyldt (se mere herom i afsnit 15.2). FloorArea Feltnavn i OIOXML navn Kommentar Samlet areal af etage Kælderareal m. loft <1,25 m over terræn TotalBuildingFloorAreaMeasure Areal af udnyttet del af tagetage TopAtticExploitedAreaMeasure BasementHeigth- Below125AreaMeasure Areal af lovlig beboelse i kælder BasementDwellingAreaMeasure Det samlede areal af den pågældende etage. For tagetager og kælderetager er registreringen krævet. Areal af udnyttet del af tagetage Kælderareal m. loft <1,25 m over terræn Areal af lovlig beboelse i kælder Etagens adgangsareal AccessAreaMeasure Etagens adgangsareal EntityBuildingCaseInformation Se afsnit ExternalReferences Se afsnit MunicipalityFields Se afsnit NoteStructure Se afsnit Snitfladebeskrivelse Side 94 af 310

95 5.5. BuildingUnitStructure Strukturen BuildingUnitStructure beskriver en enhed i alle situationer den bliver brugt. Både, når enheden sendes med som input til en metode og når enheden leveres som output til en metode. Dette gælder også søgningerne. BuildingUnitStructure Feltnavn i OIOXML navn Kommentar Tidsstempel RecordChangeDateTime Tidspunkt for seneste rettelse af enheden, se også afsnit 4.6. Feltet leveres altid når enheden er del af et svar, og den skal leveres ved update og delete metoderne. Når man opretter en enhed, skal feltet ikke udfyldes. Nøgler til enheden BuildingUnitKeys Felter som er med til at identificere enheden, se også afsnit Strukturen er altid til stede idet den indeholder kommunekoden, som er et krævet felt, både ved input og output. Informationer om enheden BuildingUnitInformation Supplerende oplysninger om enheden, se også afsnit Snitfladebeskrivelse Side 95 af 310

96 BuildingUnitStructure Feltnavn i OIOXML navn Kommentar Adresseoplysninger AddressComplete Adresseoplysniger for den adresse som hører til enheden, se afsnit Sagsoplysninger EntityBuildingCaseInformation Hvis enheden har status 3 leveres oplysninger om den byggesag, som denne enhed hører til. For sager som ikke er nybyggerier leveres yderligere id for den enhed, som denne sag er en ændring til. For nybyggerier leveres der id til placeholderen. Se også afsnit Ejerlejlighedsoplysninger CondominiumStructure En enhed kan være en ejerlejlighed. I givet fald giver denne struktur oplysning om ejendomsnummer, ejerlejlighedsnummer mm. Se afsnit Energioplysninger BuildingUnitHeating Felter som beskriver enhedens energioplysninger, se afsnit Arealer for enheden BuildingUnitArea Felter som beskriver enhedens arealer, se afsnit BuildingUnitInterior Enhedens faciliteter, se afsnit Jornalnummer og ESDH reference ExternalReferences Journalnummer og ESDH reference, se afsnit Kommunespecifikke felter MunicipalityFields Kommunespecifikke felter, se afsnit Notater NoteStructure 0 til 99 notater som kan knyttes til det enheden, se afsnit Gyldighedsdato AssessmentChangedDate Se afsnit 4.3. For at se, om en enhed med status 1 har sager tilknyttet, benyttes metoden BuildingUnitGetByParentId (se afsnit 10.6). For at hente rum til en enhed benyttes metoden RoomGetByBuildingUnitId (se afsnit 12.5) Mulighed for identændringer Følgende ident-felter må gerne rettes for en enhed i stam: Enhedsadresse (AddressSpecificReference) svarende til Adresse ident en fra DAR Tilknytning til etage (FloorReference) Tilknytning til opgang (EntranceReference) og derigennem bygning og ejendom (MunicipalRealPropertyIdentifier, BuildingReference, SiteReference) Snitfladebeskrivelse Side 96 af 310

97 Adgangsadressen, som enhedens enhedsadresse hører til, skal passe sammen med den angivne opgangsid. Ændring af tilknytning til en etage resulterer i en flytning af enheden til en ny etage. Ændring af tilknytning til en opgang resulterer i en flytning af enheden til en ny opgang. Følgende ident-felter må gerne rettes for et nybyggeri: Enhedsadresse (AddressSpecificReference), svarende til Adresse ident en fra DAR. Tilknytning til opgang (EntranceReference) Det er den adgangsadresse, som enhedens enhedsadresse hører til, som afgør hvilken opgang enheden hører til. Enheden kan kun flyttes til en opgang, som ligger i samme bygning som enheden. Tilknytning til etage (FloorReference) Følgende ident-felter må ikke rettes for et nybyggeri: Tilknytning til byggesagen (EntityBuildingCaseInformation.BuildingCaseReference) Tilknytning til stamentitet (EntityBuildingCaseInformation.BuildingParentReference) Sagstype (EntityBuildingCaseInformation.BuildingCaseTypeCode) Enhedens tilknytning til en byggesag kan dog ændre sig i forbindelse med identændringer. Dette er nærmere beskrevet i kapitel Identændringer kan ikke laves for (S) entiteter, dvs. ændringer til eksisterende enheder, dog må ejerskabet rettes. Følgende felter kopieres fra stamentiteten til sagsentiteten når man opretter en (S) entitet: Tilknytning til opgang (EntranceReference) og derigennem bygning og ejendomsnummer (MunicipalRealPropertyIdentifier, SiteReference) Tilknytning til etage (FloorReference) og derigennem Ejendomsnummer (MunicipalRealPropertyIdentifier, SiteReference) Enhedsadresse (AddressSpecificReference), svarende til Adresse ident en fra DAR. Ejerskab (CondominiumStructure) Hvis felterne efterfølgende rettes i stam, slå ændringerne igennem til tilknyttede sager (dog ikke ejerskab). Snitfladebeskrivelse Side 97 af 310

98 BuildingUnitKeys En enhed er altid knyttet til en etage og til en opgang/indgang. Etagen og opgang/indgangen hører den en og samme bygning. På den måde er en enhed altid entydig knyttet til en bygning. BuildingUnitKeys Feltnavn i OIOXML navn Kommentar Enhed id BuildingUnitUniversalIdentifier Den unikke tekniske nøgle til enheden. Leveres altid når enheden er del af et svar. Feltet skal ikke angives i create metoden, men id en tilføjes af systemet. Kommunekode MunicipalityCode Kommunekode. Felter er altid udfyldt både når enheden leveres som output og når etagen leveres som input til en metode. Ejendomsnummer Ejendomsnummer. Udfyldes som input ved delete og update metoderne. MunicipalRealPropertyIdentifier Ejendomsnummeret hørende til enheden. Feltet er altid udfyldt når enheden er del af et svar, men ignoreres når enheden leveres som input til en metode. Enhedsadresse Id AddressSpecificReference Id til enhedsadressen i, svarende til Adresse ident en fra DAR. Snitfladebeskrivelse Side 98 af 310

99 BuildingUnitKeys Feltnavn i OIOXML navn Kommentar Feltet leveres altid når enheden er del af et metode-svar. Feltet skal udfyldes ved oprettelse eller opdatering af en enhed i stam eller et nybyggeri. Bygning id BuildingReference Id til den bygning som denne enhed hører til. Id en peger altid på en stamentitet (se også afsnit 4.6). Feltet ignoreres når enheden er input til update/create metoderne. Tilhørsforhold til en bygning angives ved tilknytning til opgang/indgang og etage. Opgang id EntranceReference Id til den opgang som denne enhed hører til. Id en peger altid på en stamentitet (se også afsnit 4.10 og 4.12). Feltet skal angives når enheden oprettes i stam eller som nybyggeri. Feltet kan efterfølgende kun opdateres i stam. Etage Id FloorReference Id til den etage som denne enhed hører til. Id en peger altid på en stamentitet (se også afsnit 4.10 og 4.12). Feltet skal angives når enheden oprettes i stam eller som nybyggeri. Feltet kan efterfølgende kun opdateres i stam. Grund id SiteReference Id til den grund som denne enhed hører til. Id en peger altid på en stamentitet (se også afsnit 4.10 og 4.12). Statuskode statuscode Statuskode. Feltet ignoreres når enheden er input til update/create metoderne. Tilhørsforhold til en grund angives ved tilknytning til opgang/indgang og etage. Statuskoden er 1 for enheder i stamdelen og 3 for sager (nybyggerier eller ændringer af eksisterende enheder) Snitfladebeskrivelse Side 99 af 310

100 BuildingUnitKeys Feltnavn i OIOXML navn Kommentar Feltet kan ikke opdateres igennem snitfladen men opdateres automatisk af systemet. Feltet ignoreres således hvis det bliver sendt som en del af et input. Matrikeloplysninger landparcelidentitystructure Den matrikel der hører til enheden. Se digitaliser.dk og afsnit for flere detaljer. Det er bygningens matrikel og den kan således kun ændres ved at tilknytning til bygningen bliver ændret. Feltet ignoreres i opretteltelses/rettelsessituationer BuildingUnitInformation Denne struktur indeholder felterne som beskriver yderligere enhedsoplysninger. Snitfladebeskrivelse Side 100 af 310

101 Når en enhed leveres som en del af et svar er strukturen med hvis mindst et af de underliggende felter er udfyldt. Ved oprettelse eller opdatering af en enhed er strukturen kun med, hvis felterne ønskes inddateret/rettet. Sender man understrukturen med, betyder det at man opdaterer alle felter i understrukturen. Hvis man undlader at sende et felt med, betyder det, at man vil slette feltindholdet. I resultatet for søgningen er strukturen med, hvis der laves en fuld søgning og mindste et af de underliggende felter er udfyldt (se mere herom i afsnit 15.2). BuildingUnitInformation Feltnavn i OIOXML navn Kommentar Sikkerhedsklassifikation securityclasssification- Indicator Omfattet af sikkerhedsklassifikation. Koder: False(0) - Enheden er ikke omfattet af sikkerhedshensyn True (1) - Enheden er Snitfladebeskrivelse Side 101 af 310

102 BuildingUnitInformation Feltnavn i OIOXML navn Kommentar sikkerhedsklassificeret Henvisningsenhed reference BuildingUnitAlternativeReference Henvisning fra supplementsrum til den enhed som supplementsrum tilhører. Anden Enhed reference BuildingUnitReference Feltet er ikke implementeret. Enhedens oprettelsesdato CreationDateTime Enhedens oprettelsesdato Kode for lovlig anvendelse af sommerhus til helårsbeboelse Indikator for Godkendt tom bolig LegalUseCode DwellingApprovedEmptyIndicator Kode for lovlig anvendelse af sommerhus til helårsbeboelse Koder: A - Gammelt helårshus eller ikke-personlig disp. til helårsbeboelse B - Personlig, tidsbegrænset dispensation til helårsbeboelse C - Personlig, ikketidsbegrænset dispensation til helårsbeboelse D - Personlig, ikketidsbegrænset ret til helårsbeboelse for pensionister E - Dispensation til afvikling af ulovlig helårsbeboelse I - Ikke relevant for denne enhed Indikator for Godkendt tom bolig Koder: False/ 0 Bolig med krav om persontilmelding True/100 - Bolig uden krav om persontilmelding Værdien False oversættes til kodeværdien 0 og værdien True oversættes til kodeværdien 100. Indflytningsdato OccupationDate Indflytningsdato Dispensation tidsbegrænset dato TemporaryDispensationDate Dispensation tidsbegrænset dato Offentlig støtte PublicSubsidyCode Offentlig støtte Oplysningerne hentes fra BOSSINF Koder: 0 Ingen offentlig støtte Boligenheder opført med offentlig støtte: 10 - Almen familiebolig 15 - Støttet privat udlej- Snitfladebeskrivelse Side 102 af 310

103 BuildingUnitInformation Feltnavn i OIOXML navn Kommentar ningsbolig 20 - Støttet privat andelsbolig: 25 - Almen ungdomsbolig 40 - Almen ældrebolig 42 - Almen plejebolig 30 - Støttet privat ungdomsbolig Erhvervsenheder opført med offentlig støtte: 80 - Serviceareal Boligtype DwellingTypeCode Boligtype Koder: 1 - Egentlig beboelseslejlighed (boligenhed med eget køkken). 2 - Blandet erhverv og bolig med eget køkken. 3 - Enkeltværelse (boligenhed med fast kogeinstallation, fælles køkken eller intet køkken). 4 - Fællesbolig eller fælleshusholdning. 5 - Sommer-/fritidsbolig. E - Andet (bl.a. institutioner og erhverv). Feltet kan ikke indberettes, men beregnes. Oprettelsestidspunkt RecordCreatedDateTime Oprettelsestimestamp. Feltet er altid udfyldt når enheden leveres som del af et svar, men feltet kan ikke opdateres idet systemet sætter dette timestamp automatisk når enheden oprettes. Sagstype updatereasoncode Sagstype som benyttes ved oprettelse og ændring af stamentitet (se afsnit 4.7) Feltet ignoreres hvis det angives for sagsentiteter. Koder i stamdata: 4 - Fejlrettelse af faktiske fejlregistreringer og udeladelser) 5 - Faktisk udført ændring uden byggesagsbehandling 6 - Opdeling i enheder 7 - Sammenlægning af enheder Snitfladebeskrivelse Side 103 af 310

104 BuildingUnitInformation Feltnavn i OIOXML navn Kommentar Ophørstimestamp RecordExpiredDateTime Ophørstimestamp. Når en enhed slettes eller en sag afsluttes vil entiteten får et ophørstimestamp. For entiteter med status 1 og 3 vil feltet ikke være udfyldt. For entiteter med status 2 vil feltet være udfyldt. Indikator for kondemneret boligenhed Dato for delvis ibrugtagningstilladelse HousingCondemnationIndicator UnitPartlyPossesionDate Indikator for kondemneret boligenhed Koder: 0 - Ikke kondemneret boligenhed. 1 - Kondemneret boligenhed. Dato for delvis ibrugtagningstilladelse Udlejningsforhold RentUse2Code Kode for udlejningsforhold dannet på grundlag af oplysninger i, CPR og ESR. Koder: 1 - Udlejet 2 - Benyttet af ejeren 3 - Ikke benyttet Støjisolering SoundProofingYearIdentifier Årstal for støjisolering af boligen med tilskud fra Banedanmark Flexbolig Tilladelsesart FlexDwellingPermissionCode Koder: 1 - Upersonlig tilladelse uden tidsbegrænsning 2 - Personlig tilladelse uden tidsbegrænsning 3 - Upersonlig tilladelse med tidsbegrænsning 4 - Personlig tilladel med tidsbegrænsning Feltet er obligatorisk at udfylde ved udstedelse af flexboligtilladelser. Det angives, hvorvidt tilladelsen er personlig eller tidsbegrænset. Husk at udfylde datofeltet ved tidsbegrænsede tilladelser. Er der tale om en personlig tilladelse kan navnet på den person, som tilladelsen er udstedt til evt. noteres i en notatlinje. Flexbolig Ophørsdato FlexDwellingExpirationDate Datoen skal ligge mellem år 2000 og Snitfladebeskrivelse Side 104 af 310

105 BuildingUnitInformation Feltnavn i OIOXML navn Kommentar Dato for ophør af tidsbegrænset flexboligtilladelse. Skal altid udfyldes ifm. Udstedelse af tidsbegrænsede tilladelser AddressComplete Se afsnit EntityBuildingCaseInformation Se afsnit CondominiumStructure Se afsnit BuildingUnitHeating Denne struktur indeholder felterne som beskriver enhedens energioplysninger. Når en enhed leveres som en del af et svar er strukturen med hvis mindst et af de underliggende felter er udfyldt. Ved oprettelse eller opdatering af en enhed er strukturen kun med, hvis felterne ønskes inddateret/rettet. Sender man understrukturen med, betyder det at man opdaterer alle felter i understrukturen. Hvis man undlader at sende et felt med, betyder det, at man vil slette feltindholdet. I resultatet for søgningen er strukturen med, hvis der laves en fuld søgning og mindste et af de underliggende felter er udfyldt (se mere herom i afsnit 15.2). BuildingUnitHeating Feltnavn i OIOXML navn Kommentar Varmeinstallation HeatingInstallationCode Varmeinstallation Koder: 1 - Fjernvarme/blokvarme (radiatorsystemer el. varmluftanlæg) 2 - Centralvarme fra eget anlæg, et-kammer fyr: 3 - Ovne (kakkelovne, kamin, brændeovne o.l.) Snitfladebeskrivelse Side 105 af 310

106 BuildingUnitHeating Feltnavn i OIOXML navn Kommentar 5 - Varmepumpe 6 - Centralvarme med to fyringsenheder (fast og olie eller gas) 7 - Elovne, elpaneler 8 - Gasradiator 9 - Ingen varmeinstallation Der benyttes samme skema som for bygningen, men kode 99 må ikke benyttes for enheder. Opvarmningsmiddel HeatingSourceCode Opvarmningsmiddel Koder: 1 - Elektricitet 2 - Gasværksgas 3 - Flydende brændsel (olie, petroleum, flaskegas) 4 - Fast brændsel (kul, koks, brænde mm.) 6 - Halm 7 - Naturgas 9 - Andet Supplerende varmeinstallation SupplementaryHeatingCode Supplerende varmeinstallation Koder: 0 - Ikke oplyst 1 - Varmepumpeanlæg 2 - Ovne til fast brændsel (brændeovn o. lign.) 3 - Ovne til flydende brændsel 4 - Solpaneler 5 - Pejs 6 - Gasradiator 7 - Elovne, elpaneler 10 - Biogasanlæg 80 - Andet 90 - Bygningen har ingen supplerende varme Energiforsyning EnergySupplyCode Energiforsyning Koder 1 - Gas fra værk V el fra værk V el fra værk 4 - Både 230 V el og gas fra værk 5 - Både 400 V el og gas fra værk 6 - Hverken el eller gas Snitfladebeskrivelse Side 106 af 310

107 BuildingUnitHeating Feltnavn i OIOXML navn Kommentar fra værk BuildingUnitArea Denne struktur indeholder felterne som beskriver enhedens arealer. Når en enhed leveres som en del af et svar er strukturen med hvis mindst et af de underliggende felter er udfyldt. Ved oprettelse eller opdatering af en enhed er strukturen kun med, hvis felterne ønskes inddateret/rettet. Sender man understrukturen med, betyder det at man opdaterer alle felter i understrukturen. Hvis man undlader at sende et felt med, betyder det, at man vil slette feltindholdet. I resultatet for søgningen er strukturen med, hvis der laves en fuld søgning og mindste et af de underliggende felter er udfyldt (se mere herom i afsnit 15.2). BuildingUnitArea Feltnavn i OIOXML navn Kommentar Kilde til enhedsarealer AreaSourceCode Kilde til enhedsarealer Koder: 1 - Oplyst af ejer (eller af dennes repræsentant) 2 - Oplyst af teknisk forvaltning 3 - Oplyst af andre (lukket for indberetning) 5 - Oplyst og kontrolleret af teknisk forvaltning Samlet enhedsareal TotalBuildingUnitAreaMeasure Samlet enhedsareal Enhedens samlede boligareal DwellingAreaMeasure Enhedens samlede boligareal Enhedens samlede erhvervsareal BusinessPremisesAreaMeasure Enhedens samlede erhvervsareal Samlet areal af lukkede over- CoveredAreaClosedMeasure Areal af lukket overdæk- Snitfladebeskrivelse Side 107 af 310

108 BuildingUnitArea Feltnavn i OIOXML navn Kommentar dækninger på bygningen Samlet areal af åbne overdækninger på enheden CoveredAreaOpenMeasure ning i bebygget areal. Areal af åben overdækning i bebygget areal Adgangsareal CommonAccessAreaMeasure Adgangsareal Andet areal OtherAreaMeasure Andet areal (Areal der hverken benyttes til bolig eller erhverv) BuildingUnitInterior Denne struktur indeholder felterne som beskriver enhedens faciliteter. Når en enhed leveres som en del af et svar er strukturen med hvis mindst et af de underliggende felter er udfyldt. Ved oprettelse eller opdatering af en enhed er strukturen kun med, hvis felterne ønskes inddateret/rettet. Sender man understrukturen med, betyder det at man opdaterer alle felter i understrukturen. Hvis man undlader at sende et felt med, betyder det, at man vil slette feltindholdet. I resultatet for søgningen er strukturen med, hvis der laves en fuld søgning og mindste et af de underliggende felter er udfyldt (se mere herom i afsnit 15.2). BuildingUnitInterior Feltnavn i OIOXML navn Kommentar Badeforhold BathFacilityCode Kode for badeforhold Koder: V= Badeværelser i enheden C = Adgang til badeværelse D = Hverken badeværelse eller adgang til badeværelse Antal badeværelser BathroomQuantity Antal badeværelser i enheden Antal værelser til erhverv BusinessRoomQuantity Antal værelser til erhverv Køkkenforhold KitchenFacilityCode Kode for køkkenforhold Snitfladebeskrivelse Side 108 af 310

109 BuildingUnitInterior Feltnavn i OIOXML navn Kommentar Koder: E - Eget køkken (med afløb og kogeinstallation) F - Adgang til fælles køkken G - Fast kogeinstallation i værelse eller på gang H - Ingen fast kogeinstallation Antal værelser RoomQuantity Antal værelser Toiletforhold ToiletFacilityCode Kode for toiletforhold Koder: T= Vandskyllende toilet i bolig- eller erhvervsenheden A = Vandskyllende toilet udenfor enheden B = Anden type toilet udenfor enheden eller intet toilet i forbindelse med enheden Antal toiletter ToiletQuantity Antal toiletter i enheden ExternalReferences Se afsnit MunicipalityFields Se afsnit NoteStructure Se afsnit Snitfladebeskrivelse Side 109 af 310

110 5.6. TechnicalInstallationStructure Strukturen TechnicalInstallationStructure beskriver et teknisk anlæg i alle anvendelses situationer. Både, når et teknsik anlæg sendes med som input til en metode og når et teknisk anlæg leveres som output til en metode. Dette gælder også søgningerne. TechnicalInstallationStructure Feltnavn i OIOXML navn Kommentar Tidsstempel RecordChangeDateTime Tidspunkt for seneste rettelse af det tekniske anlæg, se også afsnit 4.6. Feltet leveres altid når det tekniske anlæg er del af et svar, og den skal leveres ved update og delete metoderne. Når man opretter et teknsik anlæg, skal feltet ikke udfyldes. Nøgler til det tekniske anlæg TechnicalInstallationKeys Felter som er med til at identificere det tekniske anlæg, se også afsnit Snitfladebeskrivelse Side 110 af 310

111 TechnicalInstallationStructure Feltnavn i OIOXML navn Kommentar Strukturen er altid til stede idet den indeholder kommunekoden, som er et krævet felt, både ved input og output. Informationer om det tekniske anlæg Supplerende oplysninger om det tekniske anlæg, se også afsnit Adresseoplysninger AddressComplete Adresseoplysniger for den adresse som hører til det tekniske anlæg, se afsnit Koordinatsæt ConstructionPoint Koordinatsæt, se afsnit Kun stamentiteter og nybyggerier kan have tilknyttet et koordinatsæt. Sagsoplysninger TechnicalInstallationInformation EntityBuildingCaseInformation Hvis det tekniske anlæg har status 3 leveres oplysninger om den byggesag, som dette anlæg hører til. For sager som ikke er nybyggerier leveres yderligere id for det tekniske anlæg, som denne sag er en ændring til. For nybyggerier leveres der id til placeholderen. Se også afsnit Ejerlejlighedsoplysninger CondominiumStructure Et teknisk anlæg kan være en ejerlejlighed. I givet fald giver denne struktur oplysning om ejendomsnummer, ejerlejlighedsnummer mm. Se afsnit Jornalnummer og ESDH reference ExternalReferences Journalnummer og ESDH reference, se afsnit Kommunespecifikke felter MunicipalityFields Kommunespecifikke felter, se afsnit Notater NoteStructure 0 til 99 notater som kan knyttes til det tekniske anlæg, se afsnit Gyldighedsdato AssessmentChangedDate Se afsnit Mulighed for identændringer Følgende ident-felter må gerne rettes for et teknisk anlæg i stam og for et nybyggeri: Anlægsnummer (TechnicalInstallationIdentifier) Tilknytning til matrikel (landparcelidentitystructure), hvis det tekniske anlæg er knyttet til en bygning, skal det være bygningens matrikel Tilknytning til bygning (BuildingReference) Tilknytning til bygning/matrikel bestemmer ejendomsnummer (MunicipalRealPropertyIdentifier, SiteReference) Snitfladebeskrivelse Side 111 af 310

112 Adgangsadresse (AddressAccessReference), svarende til Husnummer ident en fra DAR Ejerskab (Ejerforholskode fra ESR er den som hører til det angivne ejerlejlighedsejendomsnummer) Ændring af felterne bygningsnummer, matrikel og/eller ejendomsnummer resulterer i en flytning af det tekniske anlæg til en ny bygning, evt. ny matrikel/ejendom/grund. Ændring af felterne anlægsnummer og adgangsadresse er derimod kun en ændring af et simpelt attribut og resulterer ikke i en flytning af det tekniske anlæg. Når man opretter/opdaterer et teknisk anlæg, SKAL matriklen altid sendes med og bygnings referencen KAN sendes med. Systemet sikrer sammenhængen mellem matriklen og bygningsreferencen dvs. der kommer en fejl, hvis man angiver en bygning, som ikke ligger på den angivne matrikel. Følgende ident-felter må ikke rettes for et nybyggeri: Tilknytning til byggesagen (EntityBuildingCaseInformation.BuildingCaseReference) Tilknytning til stamentitet (EntityBuildingCaseInformation.BuildingParentReference) Sagstype (EntityBuildingCaseInformation.BuildingCaseTypeCode) Det tekniske anlægs tilknytning til en byggesag kan dog ændre sig i forbindelse med identændringer. Dette er nærmere beskrevet i kapitel Identændringer kan ikke laves for (S) entiteter, dvs. ændringer til eksisterende tekniske anlæg, dog må ejerskabet rettes. Følgende felter kopieres fra stamentiteten til sagsentiteten når man opretter en (S) entitet: Anlægsnummer (TechnicalInstallationIdentifier) Tilknytning til matrikel (landparcelidentitystructure) Tilknytning til bygning (BuildingReference) Tilknytning til bygning/matrikel bestemmer ejendomsnummer (MunicipalRealPropertyIdentifier, SiteReference) Adgangsadresse (AddressAccessReference), svarende til Husnummer ident en fra DAR. Ejerskab (Ejerforholskode fra ESR er den som hører til det angivne ejerlejlighedsejendomsnummer) Hvis felterne rettes i stam, slå ændringerne igennem til tilknyttede sager (dog ikke ejerskab). Flytning af tekniske anlæg Når man flytter et teknisk anlæg, som enten er et nybyggeri eller som har underliggende sagsentiteteter, skal man ved flytningen tage højde for de(n) tilhørende byggesag(er). Dette er nærmere beskrevet i kapitel Når et teknisk anlæg flytter til en anden matrikel og den/det har beregnede koordinater eller slet ingen koordinater, vil disse blive opdateret med koordinater hørende til den nye matrikel (hvis det er en GST matrikel). Når en Snitfladebeskrivelse Side 112 af 310

113 stam-entitet eller et nybyggeri har et koordinatsæt, hvis kilde er forskellig fra M eller hvis kvalitet er forskellig fra 3, bliver der kontrolleret for, om de angivne koordinater hører til den nye matrikel (hvis entiteten er knyttet til et GST matrikelnummer). Systemet vil give besked, hvis koordinaterne ikke ligger på den angivne matrikel. Når et teknisk anlæg identændres, udskrives der Meddelelser på almindelig vis. Hvis et teknisk anlæg flyttes fra en ejendom til en anden, udskrives der både en Meddelelse for den gamle og den nye ejendom. Meddelelsen kan dog fravælges på almindelig vis. Hvis det flyttede tekniske anlæg har et ejerskab og flyttes til en ny ejendom, skal ejerskabet for den nye ejendom angives ved flytning TechnicalInstallationKeys Denne struktur indeholder felterne som er med til at identificere et teknisk anlæg entydigt. Et teknisk anlæg kan være knyttet til en bygning eller direkte til en matrikel. TechnicalInstallationKeys Feltnavn i OIOXML navn Kommentar ID for teknisk anlæg TechnicalInstallationUniversalIdentifier Den unikke tekniske nøgle til anlægget. Leveres altid når et tek- Snitfladebeskrivelse Side 113 af 310

114 TechnicalInstallationKeys Feltnavn i OIOXML navn Kommentar nisk anlæg er del af et svar. Feltet skal ikke angives i create metoden, men id en tilføjes af systemet. Nummer for det tekniske anlæg Udfyldes som input ved delete og update metoderne. TechnicalInstallationIdentifier Nummer for det tekniske anlæg. Anlægsnumrene 1 til 3 er forbeholdt olietanke. Numrene 4 til 9999 kan benyttes for andre anlæg. Feltet leveres altid når et teknisk anlæg er del af et svar. Feltet skal udfyldes ved oprettelse eller opdatering af et teknsik anlæg i stam eller som nybyggeri. Kommunekode MunicipalityCode Kommunekode. Felter er altid udfyldt både når anlægget leveres som output og når anlægget leveres som input til en metode. Ejendomsnummer Ejendomsnummer. MunicipalRealPropertyIdentifier Ejendomsnummeret hørende til anlægget. Feltet er altid udfyldt når anlægget er del af et svar, men ignoreres når anlægget leveres som input til en metode. Adgangssadresse Id AddressAccessReference Id til adgangsadressen i, svarende til Husnummer ident en fra DAR. Feltet leveres altid når anlægget er del af et metode-svar. Feltet skal udfyldes ved oprettelse eller opdatering af et teknisk anlæg i stam eller som nybyggeri. Indikator for tilnærmet adgangsadresse AddressApproximateIndicator Indikator, som angiver, om den angivne adgangsadresse er tilnærmet eller ej Koder: False(0) - Adgangsadressen er repræsentativ True (1) - Adgangsadressen er tilnærmet Feltet leveres når det tekniske anlæg leveres Snitfladebeskrivelse Side 114 af 310

115 TechnicalInstallationKeys Feltnavn i OIOXML navn Kommentar som del af et svar. Feltet kan opdateres i update og create metoder. Vejkode StreetCode Adgangsgivende vej. Klassifikation Feltet angives hvis der ikke kan angives en adgangsadresse eller en tilnærmet adgangsadresse. TechnicalInstallationClassificationCode Klassifikation af det tekniske anlæg Koder: Tank (Produkt på væske form) Silo (Produkt på fast form); Gasbeholder (Produkt på gas form) Affaldsbeholdere fx molok Vindmølle (elproducerende); Slanger til jordvarme Solvarme-/ solcelleanlæg Nødstrømsforsyningsanlæg Transformerstation 1260 Elskab Naturgasfyr Andre energiproducerende eller - distribuerende anlæg 1310 Vandtårn Pumpestation Swimmingpool Private rensningsanlæg f.eks. pileanlæg, nedsivningsanlæg Offentlige rensningsanlæg Regnvandsanlæg Legeplads Teknikhus Døgnpostbokse Køleanlæg (herunder aircondition) Kunstværk (springvand, mindesmærker m.v.) Sirener og master med sirener Skilte Antenne / mast fx tv, radio- og telekommunikation Dambrug Møddingsanlæg Andet teknisk Snitfladebeskrivelse Side 115 af 310

116 TechnicalInstallationKeys Feltnavn i OIOXML navn Kommentar anlæg Bygning id BuildingReference Id til den bygning som anlægget hører til. Id en peger altid på en stamentitet (se også afsnit 4.6). Feltet skal angives ved oprettelse eller opdatering hvis det teknikse anlæg ligger under en bygning. Grund id SiteReference Id til den grund som anlægget hører til. Id en peger altid på en stamentitet (se også afsnit 4.10 og 4.12). Statuskode statuscode Statuskode. Feltet leveres altid når det tekniske anlæg er del af et metode-svar. Feltet ignoreres når det tekniske anlæg er input til update/create metoderne. Tilhørsforhold til en grund rettes ved at man ændrer anlæggets matrikel. Statuskoden er 1 for tekniske anlæg i stamdelen og 3 for sager (nybyggerier eller ændringer af eksisterende tekniske anlæg) Feltet kan ikke opdateres igennem snitfladen men opdateres automatisk af systemet. Feltet ignoreres således hvis det bliver sendt som en del af et input. Matrikeloplysninger landparcelidentitystructure Den matrikel der hører til anlægget. Se digitaliser.dk og afsnit for flere detaljer. Hvis anlægget er direkte knyttet til en matrikel, angives denne matrikel. Hvis anlægget er knyttet til en bygning, angives bygningens matrikel TechnicalInstallationInformation Denne struktur indeholder felterne som beskriver yderligere oplysninger om det tekniske anlæg. Snitfladebeskrivelse Side 116 af 310

117 Snitfladebeskrivelse Side 117 af 310

118 Når et teknisk anlæg leveres som en del af et svar er strukturen med hvis mindst et af de underliggende felter er udfyldt. Ved oprettelse eller opdatering af et teknisk anlæg er strukturen kun med, hvis felterne ønskes inddateret/rettet. Sender man understrukturen med, betyder det at man opdaterer alle felter i understrukturen. Hvis man undlader at sende et felt med, betyder det, at man vil slette feltindholdet. I resultatet for søgningen er strukturen med, hvis der laves en fuld søgning og mindste et af de underliggende felter er udfyldt (se mere herom i afsnit 15.2). TechnicalInstallationInformation Feltnavn i OIOXML navn Kommentar Sikkerhedsklassifikation securityclasssification- Indicator Omfattet af sikkerhedsklassifikation. Koder: False(0) - Anlægget er ikke omfattet af sikkerhedshensyn True (1) - Anlægget er sikkerhedsklassificeret Ophørstimestamp RecordExpiredDateTime Ophørstimestamp. Når et anlæg slettes eller en sag afsluttes vil entiteten får et ophørstimestamp. For entiteter med status 1 og 3 vil feltet ikke være udfyldt. For entiteter med status 2 vil feltet være udfyldt. Oprettelsestidspunkt RecordCreatedDateTime Oprettelsestimestamp. Feltet er altid udfyldt når anlægget leveres som del af et svar, men feltet kan ikke opdateres idet systemet sætter dette timestamp automatisk når anlægget oprettes. Sagstype updatereasoncode Sagstype som benyttes ved oprettelse og ændring af stamentitet (se afsnit 4.7) Feltet ignoreres hvis det angives for sagsentiteter. Koder i stamdata: 4 - Fejlrettelse af faktiske fejlregistreringer og udeladelser) 5 - Faktisk udført ændring uden byggesagsbehandling Type TechnicalInstallationTy- Type af teknisk installati- Snitfladebeskrivelse Side 118 af 310

119 TechnicalInstallationInformation Feltnavn i OIOXML navn Kommentar pecode on Koder: 1 - Enkeltvægget 2 - Dobbeltvægget 3 - Dobbeltvægget med overvågning 4 - Overjordisk anlæg, hvor hele anlægget er tilgængeligt for udvendig visuel inspektion 5 - Tanke som er installeret før 1970, udvendig korrosionsbeskyttet med bitumenbelægning Olietankens størrelse OilTankSizeCode Olietankstørrelse. Koder: Indhold TechnicalInstallationContentCode 1 - Under liter liter 3 - Over liter Beholders (tank, silo, gasbeholder eller affaldsbeholder) indhold Koder: 10 Mineralske olieprodukter (oliebekendtgørelsens 6, stk. 1 nr. 13) 11 - Fuelolie ("tung fuloile" - kræver opvarmning) 12 - Fyringsolie 13 - Autogasolie (diselolie) 14 - Benzin 20 - Biobrændstoffer (organiske olieprodukter som f.eks. rapsolie, bioethanol m.v.) 30 - Affaldsprodukter; 31 - Oliebaserede affaldsprodukter (spildolie) 40 - Gylle 50 - Ajle, ensilagesaft, mælkerumsvand eller møddingvand; 60 - Øvrige stoffer, produkter og materialer der kan forurene grundvand, jord og undergrund (Miljøbeskyttelseslovens 19) 99 - Andet (f.eks. korn, feeding stuffrt m.v.) Størrelse Rumfang TechnicalInstallationSizeMeasure TechnicalInstallationVolumeMeasure Størrelse angives i liter (bruges fx til tanke). Rumfanget i kubikmeter kan indskrives i feltet "Rumfang". Anlæggets rumfang i m3. Areal TechnicalInstallationArea- Anlæggets bebyggede Snitfladebeskrivelse Side 119 af 310

120 TechnicalInstallationInformation Feltnavn i OIOXML navn Kommentar Measure areal i m2. Højde Effekt TechnicalInstallationHeight- Measure TechnicalInstallationEffect- Rate Anlæggets højde i m. Effekt i kw for et energiproducerende anlæg. Fabrikat eller type ProductTypeText Anlæggets fabrikat eller type. Placering TechnicalInstallationLocationCode Koder: 0 - Ukendt 1 - Negravet/underjordisk 2 Overjordisk/udendørs 3 - Indendørs Fabrikationsnummer Angiver anlæggets placering. TechnicalInstallationProductNumberIdentifier Anlæggets fabrikationsnr. Typegodkendelsesnummer TypeApprovalIdentifier Anlæggets typegodkendelsesnummer (PUFO). Koder der skal anvendes for godkendelser til bekendtgørelse 829 fra 2000 og fremefter: Der andvendes 6 cifre, på formatet AB-CDEF. AB: (01, 02...) identificerer fabrikanterne. Numrene er givet kronologisk efter tidspunktet for første ansøgning. C: Placering 1 - Nedgravet 2 - Overjordisk generelt 3 - Overjordisk lodret cylinder 4 - Villatank u. mandehul, nedgravet 5 - Villatank u. mandehul, overjordisk D: Konstruktion 0 - Cylindrisk ståltank, evt m. indvendige afstivningsringe 1 - Cylindrisk ståltank med indvendige skot 2 - Cylindrisk ståltank med udvendige afstivningsringe 3 - Oval ståltank 4 - Kasseformet ståltank 5 - Dobbeltvægget cylindrisk ståltank 6 - Dobbletvægget tank af anden konstruktion 7 = Tank af Nylon 8 = Tank af polyethylen Snitfladebeskrivelse Side 120 af 310

121 TechnicalInstallationInformation Feltnavn i OIOXML navn Kommentar 9 = Tank af GUP E: Udvendig korrosions beskyttelse 0 - GUP 1 - Indendørs opstilling 2 - Udendørs opstilling F: Indvendig korrosions beskyttelse 0 - Ubehandlet 1 - Epoxy 2 - GUP 3 - Offeranoder 4 - Uorganisk Znstøvmaling 5 - Metalsprøjtning med Zn 6 - Bundkar med belægning Koder der anvendes inden år 2000: Der andvendes 5 cifre, på formatet AB-CDE. AB: (01, 02...) identificerer fabrikanterne.numrene er givet kronologisk efter tidspunktet for første ansøgning. C: Tanken udvendigt 0 - Ståltank med polyester (bilag I) 1 - Ståltank med polyester, udvendige afstivningsringe 2 - Ståltank med polyester, indvendige skot. D: Tankkonstruktion. 0 - Cylindrisk ståltank (bilag I) 1 - Cylindrisk plasttank (bilag II 2 - Kugleformet plasttank (bilag II) 3 - Ellipsoidisk plasttank. E: Tanken indvendigt. 0 - Ståltank: ubehandlet indvendigt 1 - Ståltank: behandlet efter bilag III 2 - Ståltank: behandlet efter bilag IV 3 - Ståltank: beskyttet med magnesiumanoder 4 - Ståltank: beskyttet med uorganisk zinkstøvmaling 5 - Ståltank: beskyttet med metalsprøjtning med Snitfladebeskrivelse Side 121 af 310

122 TechnicalInstallationInformation Feltnavn i OIOXML navn Kommentar zink 9 - Anden tank, ubehandlet indvendig BK_EksternNøgle ExternalReference Den eksterne nøgle er et felt som frit kan benyttes til fx at lave referencer til eksterne database. Det vil sige kan benyttes til at angive eventuelle nøgler over til den eksterne database. Til-/ombygningsår ReconstructionYearIdentifier Til-/ombygningsår Opførelsesår/Etableringsår ConstructionYearIdentifier Etableringsår Fredning PreservationCode Koder: Felter som kun anvendes for tekniske anlæg, som er tanke 1 - Anlægget fredet iht. bygningsfredningsloven BK_EksternDatabase ExternalDatabaseIdentifier Felt til angivelse af en ekstern database (fx et vindmølleregister eller kommunens interne olietanksregister). 2 - Som 1, men med tinglyste bevaringsbestemmelser jf. lovens Tinglyst bevaringsdeklaration, men anlægget ikke fredet 4 - På anlæggets middelalderlige bygningsdele er der tinglyst fredningsbestemmelser 5 - Anlægget indeholder middelalderlige bygningsdele 6 - Anlægget og dens umiddelbare omgivelser fredet iht. bygningsfredningsloven 7 - Som 6, men med tinglyst bevaringsdeklaration 9 - Anlægget medtaget i registrant, bevaringsplan mm. Fabrikationsår Materiale 8 - Anlægget bevaringsværdig TechnicalInstallationProductYearIdentifier TechnicalInstallationMaterialCode Årstal for tankens fabrikation. For tanke omfattet af olietankbekendtgørelsen beregnes sløjfningsfristen ud fra tankens fabrikationsår. Det materiale tanken er fremstillet af Snitfladebeskrivelse Side 122 af 310

123 TechnicalInstallationInformation Feltnavn i OIOXML navn Kommentar Koder: 1 Plast 2 Stål 3 - Plasttank med udvendig stålvæg Korrosionsbeskyttelse CorrosionProtectionCode Hvis der er udført supplende indvendig korrosionsbeskyttelse på tanken, angives hvilken type supplende indvendig korrosionsbeskyttelse, der senest er udført. Der registreres kun supplende korrosionsbeskyttelse, som er udført senere end tankens oprindelige typegodkendelse. Koder: 1 Glasfiberbelægning 2 Organisk belægning 3 Anoder 4 - Zinkstøvmaling KorrosionsbeskyttelsesDato CorrosionProtectionDateTime Hvis der er udført supplende indvendig korrosionsbeskyttelse angives datoen for den senest udførte korrosionsbeskyttelse. CE-mærkning CeMarkingCode Hvis tanken er CEmærket, angives, hvilken standard tanken er CEmærket efter. Sløjfning TechnicalInstallationAbolishedCode Det angiver hvilke foranstaltninger, der er truffet i forbindelse med sløjfning af en tank/jordvarmeslanger. Koder: 01 - Tanken er afblændet 02 - Tanken er tømt og afblændet 03 - Tanken er tømt, afblændet og opfyldt 04 - Tanken er tømt, afblændet og påfyldningsstuds samt udluftningsrør er afmonteret 10 - Jordvarmeslangerne er sløjfet/taget ud af drift Sløjfningsår Navhøjde Sløjfningsfrist AbolishDate Datoen angiver den dato, en tank senest skal sløjfes. TechnicalInstallationAbolishYearIdentifier TechnicalInstallationHub- HeightMeasure Årstal for sløjfning af det tekniske anlæg Vindmøllens højde i m. målt til navet. Snitfladebeskrivelse Side 123 af 310

124 TechnicalInstallationInformation Feltnavn i OIOXML navn Kommentar Rotordiameter Vindmøllenummer TechnicalInstallationRotor- DiameterMeasure TechnicalInstallationWind- TurbineNumberIdentifier Vindmøllens rotordiameter målt i m.. Vindmøllens nummer i Energistyrelsens vindmølleregister AddressComplete Se afsnit ConstructionPoint Se afsnit EntityBuildingCaseInformation Se afsnit CondominiumStructure Se afsnit ExternalReferences Se afsnit MunicipalityFields Se afsnit NoteStructure Se afsnit Snitfladebeskrivelse Side 124 af 310

125 5.7. RoomStructure Strukturen RoomStructure beskriver et rum alle situationer den bliver brugt. Både, når rummet sendes med som input til en metode og når rummet leveres som output til en metode. Dette gælder også søgningerne. RoomStructure Feltnavn i OIOXML navn Kommentar Tidsstempel RecordChangeDateTime Tidspunkt for seneste rettelse af rummet, se også afsnit 4.6. Feltet leveres altid når rummet er del af et svar, og den skal leveres ved update og delete metoderne. Når man opretter et rum, skal feltet ikke udfyldes. Nøgler til rummet RoomKeys Felter som er med til at identificere rummet, se også afsnit Strukturen er altid til stede idet den indeholder kommunekoden, som er et krævet felt, både ved input og output. Informationer om rummet RoomInformation Supplerende oplysninger om rummet, se også afsnit Adresseoplysninger AddressComplete Hvis rummet hører til en enhed, leveres adresseoplysniger for den adresse som hører til enheden se afsnit Sagsoplysninger EntityBuildingCaseInformation Hvis rummet har status 3 leveres oplysninger om Snitfladebeskrivelse Side 125 af 310

126 RoomStructure Feltnavn i OIOXML navn Kommentar den byggesag, som dette rum hører til. For sager som ikke er nybyggerier leveres yderligere id for det rum, som denne sag er en ændring til. For nybyggerier leveres der id til placeholderen. Se også afsnit Jornalnummer og ESDH reference ExternalReferences Journalnummer og ESDH reference, se afsnit Kommunespecifikke felter MunicipalityFields Kommunespecifikke felter, se afsnit Notater NoteStructure 0 til 99 notater som kan knyttes til rummet, se afsnit For at se, om et rum med status 1 har sager tilknyttet, benyttes metoden RoomGetByParentId (se afsnit 12.6) Mulighed for identændringer Den eneste identændring, der kan foretages for et rum, er at man kan ændre rumnummeret på et stam-rum. Ændring af rumnummeret er kun en ændring af et attribut og resulterer ikke i en flytning af rummet. Det er i nuværende version af systemet ikke muligt at ændre rumnummeret på en sagsentitet eller at flytte rummet til en anden enhed eller etage. Dog vil rummet flytte med, hvis en overliggende entitet flyttes i forbindelse med identændringer. Følgende ident-felter må gerne rettes for et rum i stam: Rumnummer (RoomIdentifier) Følgende ident-felter må ikke rettes for et rum i stam: Tilknytning til etage/enhed (FloorReference, BuildingUnitIdentifier) og og derigennem tilknytning til bygning (BuildingReference), matrikel (landparcelidentitystructure) og ejendom (MunicipalRealPropertyIdentifier, SiteReference) Feltet udenfor/indefor enheden (RoomInBuildingUnitIdenticator) Følgende ident-felter må ikke rettes for et nybyggeri: Rumnummer (RoomIdentifier) Tilknytning til etage/enhed (FloorReference, BuildingUnitIdentifier) og og derigennem tilknytning til bygning (BuildingReference), matrikel (landparcelidentitystructure) og ejendom (MunicipalRealPropertyIdentifier, SiteReference) Feltet udenfor/indefor enheden (RoomInBuildingUnitIdenticator) Tilknytning til byggesagen (EntityBuildingCaseInformation.BuildingCaseReference) Tilknytning til stamentitet (EntityBuildingCaseInformation.BuildingParentReference) Sagstype (EntityBuildingCaseInformation.BuildingCaseTypeCode) Snitfladebeskrivelse Side 126 af 310

127 Rummets tilknytning til en byggesag kan dog ændre sig i forbindelse med identændringer. Dette er nærmere beskrevet i kapitel Identændringer kan ikke laves for (S) entiteter, dvs. ændringer til eksisterende rum. Følgende felter kopieres fra stamentiteten til sagsentiteten når man opretter en (S) entitet: Rumnummer (RoomIdentifier) Tilknytning til etage/enhed (FloorReference, BuildingUnitIdentifier) og og derigennem tilknytning til bygning (BuildingReference), matrikel (landparcelidentitystructure) og ejendom (MunicipalRealPropertyIdentifier, SiteReference) Feltet udenfor/indefor enheden (RoomInBuildingUnitIdenticator) Hvis felterne efterfølgende rettes i stam, slå ændringerne igennem til tilknyttede sager RoomKeys Denne struktur indeholder felterne som er med til at identificere et rum entydigt. Et rum er altid knyttet til en etage og et rum kan være knyttet til en enhed hvor det kan ligge inden eller udenfor enheden. RoomKeys Feltnavn i OIOXML navn Kommentar Rum id RoomUniversalIdentifier Den unikke tekniske nøgle til rummet. Leveres altid når rummet er del af et svar. Snitfladebeskrivelse Side 127 af 310

128 RoomKeys Feltnavn i OIOXML navn Kommentar Udfyldes som input ved delete og update metoderne. Feltet skal ikke angives i create metoden, men id en tilføjes af systemet. Kommunekode MunicipalityCode Kommunekode. Felter er altid udfyldt både når rummet leveres som output og når rummet leveres som input til en metode. Ejendomsnummer Reference til overliggende etage FloorReference Ejendomsnummer. MunicipalRealPropertyIdentifier Ejendomsnummeret hørende til rummet. Feltet er altid udfyldt når rummet er del af et svar, men ignoreres når rummet leveres som input til en metode. Reference til den etage, som rummet hører til. Id en peger altid på en stamentitet og kan være en placeholder id hvis etagen er et nybyggeri (se også afsnit og 4.12). Feltet skal udfyldes ved oprettelse eller opdatering af et rum i stam eller som nybyggeri. Vær dog opmærksom på, at tilknytningen ikke kan ændres. Rumnummer RoomIdentifier Rumnummer Feltet leveres altid når et rum er del af et svar. Feltet skal udfyldes ved oprettelse eller opdatering af et rum i stam eller som nybyggeri. Vær dog opmærksom på, at rumnummer kun kan rettes for rum i stam. Rum i enhed Reference til overliggende enhed RoomInBuildingUnitIdenticator BuildingUnitReference Idikator, som angiver om rummet ligger indefor eller udenfor enheden. Reference til den enhed, som rummet hører til hvis rummet hører til en enhed. Id en peger altid på en stamentitet og kan være en placeholder id hvis enheden er et nybyggeri (se også afsnit og Snitfladebeskrivelse Side 128 af 310

129 RoomKeys Feltnavn i OIOXML navn Kommentar 4.12). Statuskode statuscode Statuskode. Feltet skal udfyldes ved oprettelse eller opdatering af et rum i stam eller som nybyggeri. Vær dog opmærksom på, at tilknytningen ikke kan ændres. Statuskoden er 1 for rum i stamdelen og 3 for sager (nybyggerier eller ændringer af eksisterende rum) Feltet kan ikke opdateres igennem snitfladen men opdateres automatisk af systemet. Feltet ignoreres således hvis det bliver sendt som en del af et input. Reference til overliggende bygning Reference til overliggende grund Matrikeloplysninger BuildingReference SiteReference landparcelidentitystructure Reference til den bygning som rummet hører til. Feltet leveres altid når rummet er del af et metode-svar. Feltet ignoreres når rummet er input til update/create metoderne. Reference til den grund, som rummet hører til. Id en peger altid på en stamentitet (se også afsnit og 4.12). Feltet leveres altid når rummet er del af et metode-svar. Feltet ignoreres når rummet er input til update/create metoderne. Den matrikel der hører til rummet. Se digitaliser.dk og afsnit for flere detaljer. Det er bygningens matrikel og den kan således kun ændres ved at tilknytning til etagen/enheden og (dermed bygningen) bliver ændret. Feltet ignoreres i opretteltelses/rettelsessituationer. Snitfladebeskrivelse Side 129 af 310

130 RoomInformation Denne struktur indeholder felterne som beskriver yderligere rumoplysninger. Når et rum leveres som en del af et svar er strukturen med hvis mindst et af de underliggende felter er udfyldt. Ved oprettelse eller opdatering af et rum er strukturen kun med, hvis felterne ønskes inddateret/rettet. Sender man understrukturen med, betyder det at man opdaterer alle felter i understrukturen. Hvis man undlader at sende et felt med, betyder det, at man vil slette feltindholdet. I resultatet for søgningen er strukturen med, hvis der laves en fuld søgning og mindste et af de underliggende felter er udfyldt (se mere herom i afsnit 15.2). RoomInformation Feltnavn i OIOXML navn Kommentar Sikkerhedsklassifikation securityclasssification- Indicator Omfattet af sikkerhedsklassifikation. Koder: False(0) - Rummet er ikke omfattet af sikkerhedshensyn True (1) - Rummet er sikkerhedsklassificeret Ophørstimestamp RecordExpiredDateTime Ophørstimestamp. Når et rum slettes eller en sag afsluttes vil entiteten får et ophørstimestamp. For entiteter med status 1 og 3 vil feltet ikke være udfyldt. For entiteter med status 2 vil feltet være udfyldt. Oprettelsestidspunkt RecordCreatedDateTime Oprettelsestimestamp. Feltet er altid udfyldt når rummet leveres som del af et svar, men feltet kan ikke opdateres idet systemet sætter dette timestamp automatisk når rummet oprettes. Sagstype updatereasoncode Sagstype som benyttes ved oprettelse og æn- Snitfladebeskrivelse Side 130 af 310

131 RoomInformation Feltnavn i OIOXML navn Kommentar dring af stamentitet (se afsnit 4.7) Feltet ignoreres hvis det angives for sagsentiteter. Koder i stamdata: 4 - Fejlrettelse af faktiske fejlregistreringer og udeladelser) 5 - Faktisk udført ændring uden byggesagsbehandling Rummets areal RoomAreaMeasure Rummets areal Kilde til rummets areal AreaSourceCode Kode der angiver kilden til rummets areal. Koder: 1 - Oplyst af ejer (eller dennes repræsentant) 2 - Oplyst af teknisk forvaltning 5 - Oplyst og kontrolleret af teknisk forvaltning Klassifikation RoomClassificationCode Feltets definition afventer afklaring med KOM- BIT/MBBL AddressComplete Se afsnit EntityBuildingCaseInformation Se afsnit ExternalReferences Se afsnit MunicipalityFields Se afsnit NoteStructure Se afsnit Snitfladebeskrivelse Side 131 af 310

132 5.8. UseUnitStructure UseUnitStructure Feltnavn i OIOXML navn Kommentar Tidsstempel RecordChangeDateTime Tidspunkt for seneste rettelse af brugsenheden, se også afsnit 4.6. Feltet leveres altid når brugsenheden er del af et svar, og den skal leveres ved update og delete metoderne. Når man opretter en brugsenhed skal feltet ikke udfyldes. Strukturen UseUnitStructure beskriver en brugsenhed i alle situationer den bliver brugt. Både, når brugsenheden sendes med som input til en metode og når brugsenheden leveres som output til en metode. Dette gælder også søgningerne. Nøgler til brugsenheden UseUnitKeys Felter som er med til at identificere brugsenheden, se også afsnit Strukturen er altid til stede idet den indeholder kommunekoden, som er et krævet felt, både ved input og output. Informationer om brugsenheden UseUnitInformation Supplerende oplysninger om brugsenheden, se også afsnit Arealer for brugsenheden UseUnitArea Information om arealer hørende til brugsenheden, se afsnit Adresseoplysninger AddressComplete Adresseoplysniger for den adresse som hører til brugsenheden, se afsnit Snitfladebeskrivelse Side 132 af 310

133 UseUnitStructure Feltnavn i OIOXML navn Kommentar Sagsoplysninger Jornalnummer og ESDH reference EntityBuildingCaseInformation ExternalReferences Hvis brugsenheden har status 3 leveres oplysninger om den byggesag, som denne brugsenhed hører til. For sager som ikke er nybyggerier leveres yderligere id for den brugsenhed, som denne sag er en ændring til. For nybyggerier leveres der id til placeholderen. Se også afsnit Journalnummer og ESDH reference, se afsnit Kommunespecifikke felter MunicipalityFields Kommunespecifikke felter, se afsnit Notater hørende til brugsenheden NoteStructure 0 til 99 notater som kan knyttes til brugsenheden, se afsnit For at se, om en brugsenhed med status 1 har sager tilknyttet, benyttes metoden UseUnitGetByParentId (se afsnit 13.5) Mulighed for identændringer Den eneste identændring, der kan foretages for en brugsenhed, er at man kan ændre brugsenhedsnummeret på en stam-brugsenhed. Ændring af brugsenhedsnummeret er kun en ændring af et attribut og resulterer ikke i en flytning af brugsenheden. Det er i nuværende version af systemet ikke muligt at ændrebrugsenhedsnummeret på en sagsentitet eller at flytte brugsenheden til en anden bygning eller ejendom. Dog vil brugsenheden flytte med, hvis en overliggende entitet flyttes i forbindelse med identændringer. Følgende ident-felter må gerne rettes for en brugsenhed i stam: Brugsenhedsnummer (UseUnitIdentifier) Følgende ident-felter må ikke rettes for en brugsenhed i stam: Tilknytning til bygning (BuildingReference) og og derigennem tilknytning til matrikel (landparcelidentitystructure) og ejendom (MunicipalRealPropertyIdentifier, SiteReference) Enhedsadresse (AddressSpecificReference), svarende til Adresse ident en fra DAR. Følgende ident-felter må ikke rettes for et nybyggeri: Brugsenhedsnummer (UseUnitIdentifier) Tilknytning til bygning (BuildingReference) og og derigennem tilknytning til matrikel (landparcelidentitystructure) og ejendom (MunicipalRealPropertyIdentifier, SiteReference) Enhedsadresse (AddressSpecificReference), svarende til Adresse ident en fra DAR. Snitfladebeskrivelse Side 133 af 310

134 Tilknytning til byggesagen (EntityBuildingCaseInformation.BuildingCaseReference) Tilknytning til stamentitet (EntityBuildingCaseInformation.BuildingParentReference) Sagstype (EntityBuildingCaseInformation.BuildingCaseTypeCode) Følgende felter kopieres fra stamentiteten til sagsentiteten når man opretter en (S) entitet: Brugsenhedsnummer (UseUnitIdentifier) Tilknytning til bygning (BuildingReference) og og derigennem tilknytning til matrikel (landparcelidentitystructure) og ejendom (MunicipalRealPropertyIdentifier, SiteReference) Enhedsadresse (AddressSpecificReference), svarende til Adresse ident en fra DAR. Hvis felterne efterfølgende rettes i stam, slå ændringerne igennem til tilknyttede sager UseUnitKeys En brugsenhed er altid knyttet til en bygning. UseUnitKeys Feltnavn i OIOXML navn Kommentar Brugsenhed id UseUnitUniversalIdentifier Den unikke tekniske nøgle til brugsenheden. Leveres altid når brugsenheden er del af et svar. Udfyldes som input ved delete og update metoderne. Feltet skal ikke angives i create metoden, men id en tilføjes af systemet. Kommunekode MunicipalityCode Kommunekode. Snitfladebeskrivelse Side 134 af 310

135 UseUnitKeys Feltnavn i OIOXML navn Kommentar Felter er altid udfyldt både når brugsenheden leveres som output og når brugsenheden leveres som input til en metode. Ejendomsnummer Ejendomsnummer. MunicipalRealPropertyIdentifier Ejendomsnummeret hørende til brugsenheden. Feltet er altid udfyldt når brugsenheden er del af et svar, men ignoreres når brugsenheden leveres som input til en metode. Brugsenhedsnummer UseUnitIdentifier Brugsenhedsnummer Feltet er altid udfyldt når brugsenheden er del af et svar. Feltet skal udfyldes ved oprettelse af en brugsenhed i stam eller en nybyggeri-brugsenhed, idet det er et krævet felt i. Feltet kan efterfølgende kun rettes i stam. Reference til overliggende bygning BuildingReference Reference til den bygning, som brugsenheden hører til. Id en peger altid på en stamentitet og kan være en placeholder id hvis bygningen er et nybyggeri (se også afsnit og 4.12). Feltet leveres altid når brugsenheden er del af et metode-svar. Feltet skal angives når brugsenheden oprettes i stam eller som nybyggeri. Feltet kan efterfølgende ikke opdateres. Reference til overliggende grund SiteReference Reference til den grund, som brugsenheden hører til. Id en peger altid på en stamentitet (se også afsnit og 4.12). Feltet leveres altid når brugsenheden er del af et metode-svar. Feltet ignoreres når brugsenheden er input til update/create metoderne. Reference til enhedsadresse AddressSpecificReference Reference til enhedsadressen, svarende til Adresse ident en fra DAR. Snitfladebeskrivelse Side 135 af 310

136 UseUnitKeys Feltnavn i OIOXML navn Kommentar Feltet leveres altid når brugsenheden er del af et metode-svar. Feltet skal angives når brugsenheden oprettes i stam eller som nybyggeri. Feltet kan efterfølgende ikke opdateres. Anvendelseskode UnitUseCode Brugsenhedens anvendelseskode Statuskode statuscode Statuskode. Feltet skal udfyldes ved oprettelse eller opdatering af en brugsenhed i stam eller en nybyggeribrugsenhed, idet det er et krævet felt i. Statuskoden er 1 for bygninger i stamdelen og 3 for sager (nybyggerier eller ændringer af eksisterende bygninger) Feltet kan ikke opdateres igennem snitfladen men opdateres automatisk af systemet. Feltet ignoreres således hvis det bliver sendt som en del af et input. Matrikeloplysninger landparcelidentity- Structure Den matrikel der hører til brugsenheden. Det er bygningens matrikel. Se digitaliser.dk og afsnit for flere detaljer. Feltet ignoreres hvis det bliver sendt som en del af input til update/create metoderne UseUnitInformation Denne struktur indeholder felterne som beskriver yderligere brugsenhedsoplysninger. Når en brugsenhed leveres som en del af et svar er strukturen med hvis mindst et af de underliggende felter er udfyldt. Ved oprettelse eller opdatering Snitfladebeskrivelse Side 136 af 310

137 af en brugsenhed er strukturen kun med, hvis felterne ønskes inddateret/rettet. Sender man understrukturen med, betyder det at man opdaterer alle felter i understrukturen. Hvis man undlader at sende et felt med, betyder det, at man vil slette feltindholdet. I resultatet for søgningen er strukturen med, hvis der laves en fuld søgning og mindste et af de underliggende felter er udfyldt (se mere herom i afsnit 15.2). UseUnitInformation Feltnavn i OIOXML navn Kommentar Sikkerhedsklassifikation securityclasssification- Indicator Omfattet af sikkerhedsklassifikation. Koder: False(0) - Brugsenheden er ikke omfattet af sikkerhedshensyn True (1) - Brugsenheden er sikkerhedsklassificeret Ophørstimestamp RecordExpiredDateTime Ophørstimestamp. Når en bygning slettes eller en sag afsluttes vil entiteten får et ophørstimestamp. For entiteter med status 1 og 3 vil feltet ikke være udfyldt. For entiteter med status 2 vil feltet være udfyldt. Oprettelsestidspunkt RecordCreatedDateTime Oprettelsestimestamp. Feltet er altid udfyldt når bygningen leveres som del af et svar, men feltet kan ikke opdateres idet systemet sætter dette timestamp automatisk når grunden oprettes. Sagstype updatereasoncode Sagstype som benyttes ved oprettelse og ændring af stamentitet (se afsnit 4.7) Feltet ignoreres hvis det angives for sagsentiteter. Koder i stamdata: 4 - Fejlrettelse af faktiske fejlregistreringer og udeladelser) 5 - Faktisk udført ændring uden byggesagsbehandling UseUnitArea Denne struktur indeholder felterne som beskriver brugsenhedens arealer. Snitfladebeskrivelse Side 137 af 310

138 Når en brugsenhed leveres som en del af et svar er strukturen med hvis mindst et af de underliggende felter er udfyldt. Ved oprettelse eller opdatering af en brugsenhed er strukturen kun med, hvis felterne ønskes inddateret/rettet. Sender man understrukturen med, betyder det at man opdaterer alle felter i understrukturen. Hvis man undlader at sende et felt med, betyder det, at man vil slette feltindholdet. I resultatet for søgningen er strukturen med, hvis der laves en fuld søgning og mindste et af de underliggende felter er udfyldt (se mere herom i afsnit 15.2). UseUnitArea Feltnavn i OIOXML navn Kommentar Kilde til brugsenhedens arealer AreaSourceCode Kode der angiver kilden til brugsenhendes areal. Koder: 1 - Oplyst af ejer (eller dennes repræsentant) 5 - Oplyst og kontrolleret af teknisk forvaltning Samlet areal TotalUnitAreaMeasure Samlet areal Areal til beboelse DwellingAreaMeasure Areal til beboelse Areal til Erhverv 2 - Oplyst af teknisk forvaltning BusinessPremisesAreaMeasure Areal til Erhverv AddressComplete Se afsnit EntityBuildingCaseInformation Se afsnit ExternalReferences Se afsnit MunicipalityFields Se afsnit NoteStructure Se afsnit Snitfladebeskrivelse Side 138 af 310

139 5.9. BuildingCaseStructure En byggesag er altid beskrevet i strukturen BuildingCaseStructure, som beskriver en byggesag i alle situationer, både når en byggesag leveres som input til en metode og når den leveres som output. Det gælder også søgningerne. Byggesagens nøglefelter findes i strukturen BuildingCaseKeys. Strukturen BuildingCaseInformation samler diverse oplysninger om en byggesag. Derudover findes der 3 strukturer, som indeholder datoer hørende til en byggesag og som er relevant i forskellige situationer. BuildingCaseStructure Feltnavn i OIOXML navn Kommentar Tidsstempel RecordChangeDateTime Tidspunkt for seneste rettelse af byggesagen, se også afsnit 4.6. Feltet leveres altid når byggesagen er del af et svar, og den skal leveres ved update og delete metoderne. Når man opretter en byggesag, skal feltet ikke udfyldes. Nøgler til byggesagen BuildingCaseKeys Felter som er med til at identificere byggesagen, se også afsnit Strukturen er altid til stede idet den indeholder kommunekoden, som er et krævet felt, både ved input og output. Informationer om byggesagen BuildingCaseInformation Supplerende oplysninger om byggesagen, se også afsnit Datoer relevant for byggesagen BuildingCaseDates Datoer relevant i forbindelse med byggesagens byggesagsdato. Se også Snitfladebeskrivelse Side 139 af 310

140 BuildingCaseStructure Feltnavn i OIOXML navn Kommentar afsnit Datoer relevant for byggesagen Datoer relevant for afslutning af byggesagen BuildingCaseInformationDates BuildingCaseCompletionDates Andre datoer relevant for en byggesag. Se også afsnit Datoer relevant i forbindelse med afslutning af en byggesag. Se også afsnit Gyldighedsdato AssessmentChangedDate Se afsnit BuildingCaseKeys BuildingCaseKeys Feltnavn i OIOXML navn Kommentar Byggesag ID For at se, hvilke sagsentiteter en byggesag har, benyttes metoden Building- CaseGetAllEntities. For at hente en byggesag hørende til en sagsentitet benyttes metoden BuildingCaseGetByEntityId. BuildingCaseUniversalIdentifier Den unikke tekniske nøgle til byggesagen. Leveres altid når byggesagen er del af et svar. Feltet skal ikke angives i create metoden, men id en tilføjes af systemet. Kommunekode MunicipalityCode Kommunekode. Felter er altid udfyldt både når byggesagen leveres som output og når byggesagen leveres som input til en metode. Ejendomsnummer Ejendomsnummer. Udfyldes som input ved delete og update metoderne. MunicipalRealPropertyIdentifier Ejendomsnummeret hørende til byggesagen. Feltet er altid udfyldt når byggesagen er del af et svar, men ignoreres når Snitfladebeskrivelse Side 140 af 310

141 BuildingCaseKeys Feltnavn i OIOXML navn Kommentar byggesagen leveres som input til en metode. Byggesagsnummer BuildingCaseIdentifier Byggesagsnummer Reference til grund SiteReference Reference til den grund, som byggesagen hører til. Id en peger altid på en stamentitet. Feltet leveres altid når byggesagen er del af et metode-svar. Feltet skal angives når byggesagen skal oprettes, men kan efterfølgende ikke ændres BuildingCaseInformation Denne struktur indeholder felterne som beskriver yderligere byggesagsoplysninger, dog ikke datoer. Når en byggesag leveres som en del af et svar er strukturen med hvis mindst et af de underliggende felter er udfyldt. Ved oprettelse eller opdatering af en byggesag er strukturen kun med, hvis felterne ønskes inddateret/rettet. Sender man understrukturen med, betyder det at man opdaterer alle felter i understrukturen. Hvis man undlader at sende et felt med, betyder det, at man vil slette feltindholdet. I resultatet for søgningen er strukturen med, hvis der laves en fuld søgning og mindste et af de underliggende felter er udfyldt (se mere herom i afsnit 15.2). BuildingCaseInformation Feltnavn i OIOXML navn Kommentar Byggesagskode BuildingCaseCode Kode for en byggesag. Koden angiver, efter hvilket bygningsreglement den enkelte byggesag skal styres. Snitfladebeskrivelse Side 141 af 310

142 BuildingCaseInformation Feltnavn i OIOXML navn Kommentar Koder: 1 - BR - Tilladelsessag uden ibrugtagningstilladelse 2 - BR - Anmeldelsessag (garager, carporte, udhuse og nedrivning) 3 - BR - Tilladelsessag med ibrugtagningstilladelse 4 - BR - Tilladelsessag landbrugsbygning 5 - BR - Anmeldelsessag (øvrige) Bygherreforhold BuildingCaseOwnerCode Kode for bygherreforhold gældende i den enkelte byggesag. Koder: 10 - privatpersoner eller interessentskab 20 - alment boligselskab 30 - aktie-, anpart-, eller andet selskab (undtagen interessentskab) 40 - forening, legat eller selvejende institution 41 - privat andelsboligforening 50 - den kommune. hvori ejendommen er beliggende 70 - region 80 - staten 90 - andet, herunder moderejendomme for bebyggelser der er opdelt Færdigt bygningsareal 60 - anden primærkommune BuildingFinishedAreaMeasure Angiver det bygningsareal, som er færdiggjort ved delvis afslutning af en byggesag (se afsnit 3.5.4) Foreløbig færdiggjort antal lejligheder uden køkken Foreløbig færdiggjort bygningsareal PreliminaryFinishedAreaMeasure FlatWithoutKitchenPrelimaryFinishedQuantity Foreløbig færdiggjort bygningsareal i alt Feltet beregnes ved delvis afslutning af en byggesag (se afsnit 3.5.4) og kan således ikke indberettes. Foreløbig færdiggjort antal lejligheder uden køkken Feltet beregnes ved delvis afslutning af en byggesag (se afsnit 3.5.4) og kan Snitfladebeskrivelse Side 142 af 310

143 BuildingCaseInformation Feltnavn i OIOXML navn Kommentar således ikke indberettes. Foreløbig færdiggjort antal lejligheder FlatPrelimaryFinishedQuantity Foreløbig færdiggjort antal lejligheder Feltet beregnes ved delvis afslutning af en byggesag (se afsnit 3.5.4) og kan således ikke indberettes Litra BuildingCaseLitraCode Byggesags litra kode kan tilføjes en byggesag for at adskille den fra andre. En byggesag kan tilføjes Litra fra A-Z, men O, Q, I og J må ikke forekomme. Sagsbehandler CaseWorkerReference Initialer for byggesagsbehandleren BuildingCaseDates Denne struktur indeholder datoer, som er relevante i forbindelse med byggesagsdatoen. Byggesagsdatoen er en read-only felt og sættes ud fra en af de andre datoer som findes i strukturen BuildingCaseDates. Byggesagsdatoen sættes alt efter byggesagskode og sagstype ud fra følgende datoer: Anmeldelse af byggearbejde Anmeldelse af nedrivning Byggetilladelsesdato Når en byggesag leveres som en del af et svar er strukturen med hvis mindst et af de underliggende felter er udfyldt. Ved oprettelse eller opdatering af en byggesag er strukturen kun med, hvis felterne ønskes inddateret/rettet. Sender man understrukturen med, betyder det at man opdaterer alle felter i understrukturen. Hvis man undlader at sende et felt med, betyder det, at man vil slette feltindholdet. I resultatet for søgningen er strukturen med, hvis der laves en fuld søgning og mindste et af de underliggende felter er udfyldt (se mere herom i afsnit 15.2). BuildingCaseDates Feltnavn i OIOXML navn Kommentar Byggesagsdato BuildingCaseDate Dato for oprettelse af Snitfladebeskrivelse Side 143 af 310

144 BuildingCaseDates Feltnavn i OIOXML navn Kommentar byggesagen Dato for Anmeldelse af byggearbejde Dato for Anmeldelse af nedrivning ConstructionNotificationDate DemolitionPermitDate Dato for Anmeldelse af byggearbejde Datoen bliver til byggesagsdatoen ved en anmeldelsessag med sagstype nybyggeri eller til/ombygning. Dato for Anmeldelse af nedrivning Datoen bliver til byggesagsdatoen ved en anmeldelsessag med sagstype nedrivning. Dato for Byggetilladelse BuildingLicenseDate Dato for Byggetilladelse Datoen bliver til byggesagsdatoen ved en tilladelsessag BuildingCaseInformationDates Denne struktur samler diverse datoer relevant for byggesagen. Når en byggesag leveres som en del af et svar er strukturen med hvis mindst et af de underliggende felter er udfyldt. Ved oprettelse eller opdatering af en byggesag er strukturen kun med, hvis felterne ønskes inddateret/rettet. Sender man understrukturen med, betyder det at man opdaterer alle felter i understrukturen. Hvis man undlader at sende et felt med, betyder det, at man vil slette feltindholdet. I resultatet for søgningen er strukturen med, hvis der laves en fuld søgning og mindste et af de underliggende felter er udfyldt (se mere herom i afsnit 15.2). BuildingCaseInformationDates Feltnavn i OIOXML navn Kommentar Dato for naboorientering NeighbourHearingDate Dato for naboorientering Snitfladebeskrivelse Side 144 af 310

145 BuildingCaseInformationDates Feltnavn i OIOXML navn Kommentar Dato for færdigbehandling af naboorientering Forventet påbegyndelsesdato NeighbourHearingCompletedDate ConstructionExpectedStart- Date Dato for færdigbehandling af naboorientering Påbegyndelsesdato ConstructionStartDate Påbegyndelsesdato Forventet fuldført dato Dato for modtagelse af ansøgning om byggetilladelse Forventet påbegyndelsesdato ConstructionExpectedCompletedDate ApplicationReceivedDate Dato for fyldestgørende ansøgning ApplicationAdequateReceivedDate Forventet fuldført dato Dato for modtagelse af ansøgning om byggetilladelse Dato for fyldestgørende ansøgning BuildingCaseCompletionDates Datoer som har betydning for afslutning af en byggesag. Når en byggesag leveres som en del af et svar er strukturen med hvis mindst et af de underliggende felter er udfyldt. Ved oprettelse eller opdatering af en byggesag er strukturen kun med, hvis felterne ønskes inddateret/rettet. Sender man understrukturen med, betyder det at man opdaterer alle felter i understrukturen. Hvis man undlader at sende et felt med, betyder det, at man vil slette feltindholdet. I resultatet for søgningen er strukturen med, hvis der laves en fuld søgning og mindste et af de underliggende felter er udfyldt (se mere herom i afsnit 15.2). BuildingCaseCompletionDates Feltnavn i OIOXML navn Kommentar Dato for ibrugtagningstilladelse Dato for delvis ibrugtagningstilladelse PossessionDate PartlyPossessionDate Dato for ibrugtagningstilladelse, se også afsnit og Dato for delvis ibrugtagningstilladelse, se også afsnit og Dato for fuldførelse af byggeri ConstructionCompletedDate Dato for fuldførelse af byggeri Dato for gennemført nedrivning DemolitionCompletedDate Dato for gennemført nedrivning Dato for henlæggelse BuildingCaseShelvingDate Dato for henlæggelse Snitfladebeskrivelse Side 145 af 310

146 5.10. Fælles strukturer landparcelidentitystructure Strukturen leverer matrikeloplysninger. Bemærk at nogle matrikel kun kan identificeres entydig ved at angive ejendomsnummer. Dette gøres i matrikel strukturen og ikke i key strukturen. mmentar landparcelidentitystructure Navn i OIOXML navn Kommentar Matrikeloplysninger MATRLandParcelIdentification Matrikeloplysninger (kernekomponent fra namespace GST), indeholder matrikelnummer, matrikelbogstav, landsejerlav samt e-ref, den fælles ejendomsreference. Matriklens delnummer SubLandParcelIdentifier Matriklens delnummer Matriklens opdelingsnummer opdelings- Matriklens nummer AlternateSubLandParcelIdentifier Matriklens artskode LandParcelTypeCode Matriklens artskode Ejendomsnummer MunicipalRealPropertyIdentifier Ejendomsnummer For ikke GST matrikelnumre kan ejendomsnummeret være med til at identificere en matrikel entydigt AddressComplete Denne struktur beskriver adressen hørende til en entitet. Strukturen er en kernekomponent fra OIO komitéen, som indeholder oplysninger om vejkode, vejnavn, husnummer mm. Strukturen benyttes til at beskrive både adgangsog enhedsadresser i denne webservice. Snitfladebeskrivelse Side 146 af 310

147 Når en entitet leveres som en del af et svar eller som resultat af en søgning er strukturen med hvis entiteten har en adresse. Ved oprettelse eller opdatering af en entitet benyttes strukturen ikke, idet adressen angives ved hjælp af en id ConstructionPoint Strukturen ConstructionPoint beskriver det koordinatsæt, som kan knyttes til en bygning eller et teknisk anlæg (se også afsnit 3.7). Snitfladebeskrivelse Side 147 af 310

148 Koordinater kan kun tilknyttes til stamentiteter eller nybyggerier, men ikke til sager, som er ændringer til stamentiteter ((S) entiteter). Derfor vil strukturen ConstructionPoint aldrig være udfyldt for (S) bygninger eller (S) tekniske anlæg - hverken når de leveres som et svar eller når sendes som input. Kun stamentiteter og nybyggerier kan have tilknyttet et koordinatsæt. Når en bygning leveres som en del af et svar er strukturen med hvis bygningen har tilknyttet et bygningspunkt. Ved oprettelse eller opdatering af en bygning er strukturen kun med, hvis bygningspunktet ønskes inddateret/rettet. Hvis koordinatsættet ikke angives, tildeles værdien M for Kvalitet af koordinatsæt og værdien 3 for Kilde til koordinatsæt og koordinatsættet hentes ud fra GST ud fra matrikeloplsyningerne. I resultatet for søgningen er strukturen med, hvis der laves en fuld søgning og bygningspunktet eksisterer for bygningen (se mere herom i afsnit 15.2). ConstructionPoint Feltnavn i NYT OIOXML navn Kommentar Id for koordinatsæt ConstructionPointIdentifier Id for koordinatsæt Vær opmærksom på, at denne id ikke benyttes i forbindelse med opdatering eller oprettelse af geometrien. Der angives i stedet for id en for bygningen hhv. det tekniske anlæg i key strukturerne for disse entiteter. Id for koordinatsæt leveres med når ConstructionPoint strukturen leveres som en del af et svar. Nøjagtighedsklasse (nyt navn: Kvalitet af koordinatsæt) ConstructionPointQualityClassCode Kvalitet af koordinatsæt: Feltets kodeliste 1 Sikker geokodning 3 Usikker geokodning Værdien null tillades ikke. Revisionsdato Kilde til koordinatsæt 2 Næsten sikker geokodning ConstructionPointRevisionDateTime ConstructionPointSourceCode Dato for seneste revision (godkendelse eller ændring) af geometridata Kilde til koordinatsæt Feltets kodeliste K Kommune Snitfladebeskrivelse Side 148 af 310

149 ConstructionPoint Feltnavn i NYT OIOXML navn Kommentar L Landinspektør E Ejer M Maskinelt dannet Værdien null tillades ikke. Angiver den part som senest har ajourført koordinatsættet for bygningen. M henviser til at koordinatsættet er maskinelt dannet, mens K henviser til, at oplysningen er verificeret af kommunen. For nuværende er det ikke muligt for ejere og landinspektører at ajourfører koordinater i, men systemet er forberedt til det. Easting koordinat GeographicEastingMeasure x-koordinat i UTM ETRS89 Zone 32 Northing koordinat Supplerende oplysning om koordinatsæt GeographicNorthingMeasure ConstructionPointAdditionalInformationCode y-koordinat i UTM ETRS89 Zone 32 Som supplement oplyses om koordinatsættet er så nøjagtigt, at det ligger indenfor den geografiske afgrænsning af bygningen eller om det blot vides at koordinatsættet ligger på den rigtige matrikel. Tillige oplyses om bygningen ligger under jorden og dermed ikke fremgår af luftfotos. Kodeliste: 11 Koordinatsæt ligger i bygningen/det tekniskeanlæg (over jorden) 12 Koordinatsæt ligger i bygningen/det tekniske anlæg (under jorden) 21 Koordinatsæt ligger i bygningen/det tekniske anlæg (over jorden) 22 Koordinatsæt ligger i bygningen/det tekniske anlæg (under jorden) 31 Koordinatsæt ligger Snitfladebeskrivelse Side 149 af 310

150 ConstructionPoint Feltnavn i NYT OIOXML navn Kommentar på matriklen 32 Ukendt Feltet er ikke krævet. Hvis feltet supplerende oplysning om koordinatsæt indberettes, udføres der følgende valideringer: Hvis feltet angives som 11 eller 12, skal Kvalitet af koordinatsæt være angivet med værdi 1. Tilsvarende gælder hvis feltet angives som 21 eller 22 - så skal Kvalitet af koordinatsæt være angivet med værdi 2 og hvis feltet angives som 31 eller 32, skal Kvalitet af koordinatsæt være angivet med værdi 3. Strukturen benytter skemaet GeographicPointLocation, som indeholder elementet GeographicHeightMeasure. Dette felt benyttes ikke i forbindelse med denne snitflade. For (S) entiteter gælder følgende i forbindelse med ConstructionPoint strukturen: Hvis man sender ConstructionPoint strukturen med ved opdatering eller oprettelse en en (S) entitet, vil strukturen blive ignoreret, idet man som tidligere skrevet ikke har et koordinatsæt på (S) entiteter. For nybyggerier og stamentiteter gælder de i afsnit 3.6 beskrevne regler. Hvis man sender strukturen ConstructionPoint fordi man vil oprette eller opdatere geometrien for et nybyggeri eller en stamentitet, skal felterne have de i nedenstående tabel bekrevne værdier: Opdateringsregler for strukturen ConstructionPoint Feltnavn i NYT OIOXML navn Kommentar Nøjagtighedsklasse/Kvalitet af koordinatsæt Revisionsdato Id for koordinatsæt ConstructionPointIdentifier Feltet ignoreres ved oprettelse/opdatering. ConstructionPointQualityClassCode ConstructionPointRevisionDateTime Feltet er krævet. Feltet er ikke krævet. Hvis feltet ikke sendes med ved opdatering/oprettelse eller hvis den udfyldte værdi er nulværdien T00:00:00 vil systemet indsætte dagsdato Snitfladebeskrivelse Side 150 af 310

151 Opdateringsregler for strukturen ConstructionPoint Feltnavn i NYT OIOXML navn Kommentar Kilde til geometri som revisionsdato. Feltet er krævet. Easting koordinat GeographicEastingMeasure Feltet er krævet. Northing koordinat ConstructionPointSourceCode GeographicNorthingMeasure Feltet er krævet. Hvis man sender strukturen ConstructionPoint fordi man vil slette geometrien, skal felterne have de i nedenstående tabel bekrevne værdier: Angivelse af felter ved sletning af ConstructionPoint Feltnavn i NYT OIOXML navn Kommentar Id for koordinatsæt ConstructionPointIdentifier Feltet ignoreres. Nøjagtighedsklasse/Kvalitet af koordinatsæt Revisionsdato Kilde til koordinatsæt Feltet er krævet. Feltet ignoreres. Feltet ignoreres. Easting koordinat GeographicEastingMeasure Feltet skal angives med værdi 0. Northing koordinat ConstructionPointQualityClassCode ConstructionPointRevisionDateTime ConstructionPointSourceCode GeographicNorthingMeasure Feltet skal angives med værdi 0. Vær opmærksom på, at der hentes nye foreløbige koordinater til bygningen hhv. det tekniske anlæg når man sletter det eksisterende koordinatsæt WaterDrainage Denne struktur indeholder felterne som beskriver spiledvand oplysninger for grunde hhv. bygninger. Snitfladebeskrivelse Side 151 af 310

152 Når en entitet leveres som en del af et svar er strukturen med hvis mindst et af de underliggende felter er udfyldt. Ved oprettelse eller opdatering af en entitet er strukturen kun med, hvis felterne ønskes inddateret/rettet. Sender man understrukturen med, betyder det at man opdaterer alle felter i understrukturen. Hvis man undlader at sende et felt med, betyder det, at man vil slette feltindholdet. I resultatet for søgningen er strukturen med, hvis der laves en fuld søgning og mindst et af de underliggende felter er udfyldt (se mere herom i afsnit 15.2). WaterDrainage Feltnavn i OIOXML navn Kommentar Vandforsyning WaterSupplyCode Vandforsyning for grund eller bygning Koder: 1 - Alment vandforsyningsanlæg (tideliger offentligt) 2 - Privat, alment vandforsyningsanlæg 3 - Vandindvindingsanlæg (egen boring til 1 el. 2 ejendomme) 4 - Brønd 6 - Ikke alment vandforsyningsanlæg (forsyner mindre end 10 ejendomme) 7 - Blandet vandforsyning 9 - Ingen vandforsyning Kode 7 benyttes kun ved grunde. Afløbsforhold DrainageCode Afløbsforhold Snitfladebeskrivelse Side 152 af 310

153 WaterDrainage Feltnavn i OIOXML navn Kommentar Koder: 1 - Fælleskloakeret: spildevand + tag- og overfladevand 2 - Fælleskloakeret: spildevand + delvis tagog overfladevand 3 - Fælleskloakeret: spildevand 4 - Fælleskloakeret: tagog overfladevand 5 - Separatkloakeret: spildevand + tag- og overfladevand 6 - Separatkloakeret: spildevand + delvis tagog overfladevand; 7 - Separatkloakeret: spildevand 8 - Separatkloakeret: tag- og overfladevand 9 - Spildevandskloakeret: Spildevand 10 - Afløb til spildevandsforsyningens renseanlæg; 11 - Afløb til fællesprivat spildevandsanlæg; 12 - Afløb til fællesprivat kloakledning med tilslutning til spildevandsforsyningens renseanlæg 20 - Afløb til samletank 21 - Afløb til samletank for toiletvand og mekanisk rensning af øvrigt spildevand 29 - Mekanisk rensning med nedsivningsanlæg med tilladelse 30 - Mekanisk rensning med nedsivningsanlæg (tilladelse ikke påkrævet) 31 - Mekanisk rensning med privat udledn. dir. til vandløb, sø eller hav 32 - Mekanisk og biologisk rensning (ældre anlæg uden renseklasse) 70 - Udledning uden rensning direkte til vandløb, søer eller havet 75 - Blandet afløbsforhold på ejendom (er specificeret på bygninger) 80 - Anden type afløb 90 - Ingen udledning SOP: Minirenseanlæg med direkte udledning SOP: Minirenseanlæg med udledning til markdræn Snitfladebeskrivelse Side 153 af 310

154 WaterDrainage Feltnavn i OIOXML navn Kommentar SOP: Minirenseanlæg med nedsivning i faskine SOP: Nedsivning til sivedræn105 - SOP: Samletank SOP: Pileanlæg med nedsivning (uden membran) SOP: Pileanlæg uden udledning (med membran) 108 SOP: Beplantede filteranlæg med nedsivning i faskine 109 SOP: Sandfiltre med P-fældning i bundfældningstanken og direkte udledning 110 SOP: Sandfiltre med P-fældning i bundfældningstanken og udledning til markdræn SOP: Andet SO: Biologisk sandfilter med direkte udledning SO: Biologisk sandfilter med udledning til markdræn SO: Minirenseanlæg med direkte udledning SO: Minirenseanlæg med udledning til markdræn SO: Beplantede filteranlæg med direkte udledning SO: Beplantede filteranlæg med udledning til markdræn 290 SO: Andet OP: Minirenseanlæg med direkte udledning OP: Minirenseanlæg med udledning til markdræn 390 OP: Andet O: Rodzoneanlæg med direkte udledning O: Rodzoneanlæg med udledning til markdræn O: Minirenseanlæg med direkte udledning O: Minirenseanlæg med udledning til markdræn 490 O: Andet Øvrige renseløsninger: Mekanisk med direkte udledning 502 Øvrige renseløsninger: Mekanisk med ud- Snitfladebeskrivelse Side 154 af 310

155 WaterDrainage Feltnavn i OIOXML navn Kommentar ledning til markdræn 503 Øvrige renseløsninger: Ældre nedsivningsanlæg med nedsivning til sivebrønd 504 Øvrige renseløsninger: Udledning til jordoverfladen 505 Øvrige renseløsninger: Urenset 590: Øvrige renseløsninger: Andet Anden type afløb (større end 30 PE med egen udledning) Intet afløb Kode 75 benyttes kun ved grunde. Afløbsforholdtilladelse/Udledningstilladelse DrainagePermissionCode For grunde/bygninger udenfor kloakopland (afløbskoder ) angiver feltet status for deres udledningstillaldelse (tilladelse for afløbsforhold). Medlemskab af spildevandsforsyning WastewaterUtilityCompanyMembershipCode Koder: 0 - Ikke oplyst 1 - Udledningstilladelse mangler 2 - Renseanlæg etableret før 1974, derfor ikke behov for tilladelse 3 - Udledningstilladelse til enkeltprivat renseanlæg 4 - Udledningstilladelse til fællesprivat renseanlæg 5 - Der foreligger ingen kendt tilladelse (kode 0 i tidligere versioner) 6 - Der foreligger tilladelse (kode 1 i tidligere versioner) 7 - Tilladelsesforhold er oplyst på bygningsniveau (kode 2 i tidligere versioner) For grunde/bygninger udenfor kloakopland (afløbskoder ) angiver feltet om der indgået kontraktligt medlemskab med et spildevandsforsyningsselskab Koder: 0 - Ikke oplyst (blank defaultværdi) 1 - Ikke medlemskab af spildevandsforsyning Snitfladebeskrivelse Side 155 af 310

156 WaterDrainage Feltnavn i OIOXML navn Kommentar Påbud om forbedret rensning 2 - Medlemskab af spildevandsforsyning WastewaterImprovementInjunctionCode For grunde/bygninger udenfor kloakopland (afløbskoder ) angiver feltet om kommunen har givet påbud om at etablere forbedret rensning, så regionplanens og vandplanens renseklasser overholdes. Koder: 0 Ikke oplyst 1 - Rensning ok. Intet påbud 2 - Rensning skal forbedres til SOP 3 - Rensning skal forbedres til SO 4 - Rensning skal forbedres til OP 5 - Rensning skal forbedres til O 6 Skal tilsluttes spildevandsforsyningsselskab Frist for forbedret rensning Tilladelse til udtræden 7 Skal tilsluttes seperatkloakering WastewaterImprovementInjunctionDate ResignationPermission- Code For grunde/bygninger udenfor kloakopland (afløbskoder ), hvor der ifølge feltet Påbud om forbedret rensning er givet et påbud, angiver feltet datoen for hvornår fristen for forbedret rensning udløber. For grunde/bygninger indenfor kloakopland (afløbskoder 1-9) angiver feltet status for tilladelse til hel eller delvis udtræden af det offentlige kloakfællesskab (Spildevandsforsyning) jf. Spildevandsbekendtgørelsen 11, stk. 1. Dato for tilladelse til udtræden ResignationPermission- Date Koder: 0 Ikke oplyst 1 Tilladelse meddelt 2 Tilladelse bortfaldet Dato for tilladelse til udtræden Tilladelse til alternativ bortskaf- AlternativeDisposalPer- For grunde/bygninger Snitfladebeskrivelse Side 156 af 310

157 WaterDrainage Feltnavn i OIOXML navn Kommentar felse eller afledning missioncode indenfor kloakopland (afløbskoder 1-9) angiver feltet status for tilladelse til alternativ bortskaffelse eller afledning jf. Spildevandsbekendtgørelsens 11, stk. 2. Koder: 0 Ikke oplyst 1 Tilladelse meddelt 2 Tilladelse bortfaldet Dato for tilladelse til alternativ bortskaffelse eller afledning AlternativeDisposalPermissionDate Dato for tilladelse til alternativ bortskaffelse eller afledning EntityBuildingCaseInformation Entiteter (bygninger, grunde, enheder, opgange/indgange, tekniske anlæg, etager, rum, brugsenheder) som leveres med statuskode 3, dvs. entiteter som er en del af en byggesag, leveres med en EntityBuildingCaseInformation struktur. Denne struktur indeholder information om sagens type, den byggesag sagen hører til og den entitet sagen referer til i stamdelen, dvs. dens parent. For ændringer til eksisternede entiteter i stamdelen refereres til den entitet sagen er en ændring til. For nybyggeri gælder det, at der refereres til nybyggeriets placeholder i stamdelen. Når byggesagen engang bliver afsluttet, vil entiteten have placeholderens id. Snitfladebeskrivelse Side 157 af 310

158 Når en entitet leveres som en del af et svar (også ved søgningen) er strukturen med hvis entiteten har status 3. Ved oprettelse af en entitet med status 3 skal strukturen udfyldes. Ved opdatering af en entitet bliver strukturen ignoreret, idet tilknytning til en byggesag mm ikke kan ændres efter oprettelsen. EntityBuildingCaseInformation Feltnavn i OIOXML navn Kommentar FK_Byggesag_id BuildingCaseReference Byggesagens id Sagstype BuildingCaseTypeCode Angiver hvilken sagstype sagsentiteten har. Koder: 1 - Nybyggeri 2 - Til/ombygning 3 - Nedrivning (hel eller delvis) FK_BygningStam_id BuildingParentReference Denne nøgle peger på stamentiteten. Det kan FK_EnhedStam_id UnitParentReference også være en placeholder FK_GrundStam_id SiteParentReference som beskrevet i afsnit FK_OpgangStam_id EntranceParentReference FK_TekniskanlaegStam_id FK_EtageStam_id UnitParentReference FloorParentReference FK_RumStam_id FK_BrugsenhedStam_id RoomParentReference UseUnitParentReference ExternalReferences Strukturen indeholder felter som beskriver referencer til eksterne systemer. Når en entitet leveres som en del af et svar er strukturen med hvis mindst et af de underliggende felter er udfyldt. Ved oprettelse eller opdatering af en entitet er strukturen kun med, hvis felterne ønskes inddateret/rettet. Sender man understrukturen med, betyder det at man opdaterer alle felter i understrukturen. Hvis man undlader at sende et felt med, betyder det, at man vil slette feltindholdet. I resultatet for søgningen er strukturen med, hvis der laves en fuld søgning og mindst et af de underliggende felter er udfyldt (se mere herom i afsnit 15.2). ExternalReferences Snitfladebeskrivelse Side 158 af 310

159 Feltnavn i NYT OIOXML navn Kommentar Journalnummer FileNumberIdentifier Journalnummer ESDH reference ESDHreferenceIdentifier ESDH reference MunicipalityFields Strukturen beskriver kommunespecifikke felter. Hver kommune kan definere op til 6 kommunespecifikke felter pr. entitet (dog ikke byggesag). Tre af disse felter er kodefelter, hvor kommunen kan fastlægge mulige koder og deres betydning. Tre af felterne er numeriske felter. Når en entitet leveres som en del af et svar er strukturen med hvis mindst et af de underliggende felter er udfyldt. Ved oprettelse eller opdatering af en entitet er strukturen kun med, hvis felterne ønskes inddateret/rettet. Sender man understrukturen med, betyder det at man opdaterer alle felter i understrukturen. Hvis man undlader at sende et felt med, betyder det, at man vil slette feltindholdet. I resultatet for søgningen er strukturen med, hvis der laves en fuld søgning og mindst et af de underliggende felter er udfyldt (se mere herom i afsnit 15.2) CondominiumStructure Når en enhed, bygning eller teknisk anlæg er en ejerlejlighed, leveres strukturen CondominiumStructure. Snitfladebeskrivelse Side 159 af 310

160 Strukturen består af ejerlejlighedens ejendomsnummer samt 0 til mange ejerskaber (CondominiumUnitStructure strukturer), som er særskilte tinglyste lejligheder, som tilsammen udgør ejerlejligheden. Det er i Nyt at man opretter ejerlejligheder. I webservicen gør man det ved at angive ejendomsnummeret for ejerlejligheden i CondominiumStructure. Oplysninger om ejerlejlighedsnummer, kode for mere end en lejlighed samt ejerforholdskode samt tinglyst areal hentes fra ESR. Når en bygning/et teknisk anlæg/en enhed leveres som en del af et svar (også ved søgningen) er strukturen med hvis entiteten er en ejerlejlighed. Ved oprettelse/opdatering af en en af de nævnte entiteter er strukturen udfyldt hvis man vil angive, at entiteten er en ejerlejlighed. I en update/create situation vil alle andre felter end ejerlejlighedens ejendomsnummer blive ignoreret. For at slette et ejerskab skal man sætte feltet til 0. CondominiumStructure Feltnavn i OIOXML navn Kommentar Ejendomsnr.for ejerlejlighed CondominiumRealPropertyIdentifier Ejerlejlighedsnummer Ejendomsnr.for ejerlejlighed CondominiumtSerialNumberIdentifier Ejerlejlighedsnummer. (hentes fra ESR) Kode for mere end en lejlighed CondominiumUnitCode Kode for mere end 1 ejerlejlighed (hentes fra ESR) Koder: E - En enhed M - Mere end 1 enhed Ejerforholdskode OwnershipCode Ejerforholskode (hentes fra ESR) Koder: 10: Privatpersoner eller interessentskab 20: Alment boligselskab 30: Aktie-, anpart- eller andet selskab (undtagen interessentskab) 40: Forening, legat eller selvejende institution 41: Privat andelsboligforening 50: Den kommune, hvori ejendommen er beliggende 60: Anden primærkommune 70: Region 80: Staten 90: Andet, herunder Snitfladebeskrivelse Side 160 af 310

161 CondominiumStructure Feltnavn i OIOXML navn Kommentar moderejendomme for bebyggelser, der er opdelt i ejerlejligheder samt ejendomme, der ejes af flere kategorier af ejere Tinglyst areal RegisteredAreaMeasure Tinglyst areal (hentes I ESR) Værdier angives fra til NoteStructure Strukturen NoteStructure beskriver et notat i alle situationer det bliver brugt. Både, når notatet sendes med som input til en metode og når det leveres som output til en metode. Der kan tilknyttes notater til følgende entiteter i : Grund Bygning Enhed Etage Opgang/indgang Brugsenhed Rum Teknisk anlæg Der kan oprettes 99 notatlinjer, nummereret fra 1 til 99, for hver entitet. Formatet for notatteksten er frit. Kommunerne har dog tit fastlagt regler for brug af notatlinjenumre og deres tekster. De enkelte kommuner har retningslinier for brug af de enkelte notatlinjer Et notat består af et notatlinjenummer og en notatlinje med tekst. Når en entitet leveres som en del af et svar, leveres der en NoteStructure struktur pr. notatlinje. Ved oprettelse eller opdatering af en grund skal der sendes en NoteStructure struktur for hver notatlinje man ønsker at oprette, rette eller slette. I resultatet for søgningen er strukturen med, hvis der laves en fuld søgning og der findes mindst en notatlinje (se mere herom i afsnit 15.2). Snitfladebeskrivelse Side 161 af 310

162 Hvis man vil oprette, opdatere eller slette et notat skal man sende en Note- Structure struktur med det tilhørende notatlinjenummer med. Ved en oprettelse eller opdatering af et notat skal den ønskede notattekst sendes med. Ved en sletning af notatet, skal notattektsen udfyldes med en tom string. Det vil resultere i, at notatet bliver slettet. Eksisterende notater på entiteten som ikke sendes med i inputtet til en opdatering vil ikke blive berørt af opdateringen. Ved opdatering og sletning af notater skal den rigtige RecordChangeDate- Time angives. NoteStructure Feltnavn i OIOXML navn Kommentar Tidsstempel RecordChangeDateTime Tidspunkt for seneste rettelse af notatet, se også afsnit 4.6. Feltet leveres altid når et notat er del af et svar, og den skal leveres når man ønsker at opdatere eller slette et notat. Når man opretter en notat, skal feltet ikke udfyldes. Notatlinjenummer NoteNumberReference Notatlinjenummer Notatlinjetekst NoteText Notatlinjetekst Ophørstimestamp NoteExpiredDateTime Ophørstimestamp. Når et notat slettes vil notatet får et ophørstimestamp. I denne version af snitfladen leveres kun gældende notater og feltet vil derfor aldrig være udfyldt DispensationHeatSupply Strukturen DispensationHeatSupply er en understruktur til bygning og grund. Felterne benyttes til at registrere, om en grund hhv. bygning er omfattet af dispensation/fritagelse ift. kollektivvarmeforsyning. DispensationHeatSupply Snitfladebeskrivelse Side 162 af 310

163 Feltnavn i OIOXML navn Kommentar Dispensation/fritagelse ift kollektiv varmeforsyning Dato for dispensation/fritagelse ift kollektiv varmeforsyning DispensationHeatSupply- Code For bygninger/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 Når en ubebygget grund bliver bebygget, skal registreringen så vidt muligt flyttes til bygningen/bygningerne. DispensationHeatSupplyDate For bygninger/ubebyggede grunde, hvor der ifølge feltet Dispensation/fritagelse er udstedt dispensation eller fritagelse, angives dato for udstedelse af dispensation eller fritagelsen. Snitfladebeskrivelse Side 163 af 310

164 6. Metoder til entitet grund Der findes 9 metoder for entiteten grund: SiteGetById henter en grund ved angivelse af dens id SiteGetByIds henter et antal grunde ved angivelse af deres id er SiteGet - henter en grund ved angivelse af en matrikel SiteGetByMunicipalRealPropertyId - hent en eller flere grund ved angivelse af et ejendomsnummer SiteGetByParentId - henter en eller flere sager (ændringer til en eksisterende grund) ved angivelse af id for en grund i stam. SiteGetSubStructuresById henter underliggende entiteter til en grund ved angivelse af grundens id SiteCreate - opretter en ny grund (kun med status 3) SiteUpdate - opdaterer en grund SiteDelete - sletter en grund (kun med status 3) SiteMoveEntities - flytter entiteter fra en matrikel til en anden Metoderne er beskrevet i de 10 næste afsnit. En grund er altid beskrevet i strukturen SiteStructure, som beskriver en grund i alle situationer, både når en grund leveres som input til en metode og når det leveres som output. Strukturen er beskrevet i afsnit 5.1. En grund består af et jordstykke, dvs. et antal matrikler, som udgør grunden. Til disse matrikler kan der være tilknyttet bygninger og tekniske anlæg. For at flere matrikler kan høre til samme grund, skal de i matriklen være samnoteret. Det vil sige noteret som én samlet fast ejendom og være geografisk sammenhængende matrikler. Er der matrikler, der ikke er samnoteret, vil de være registreret som særskilte grunde (GRU). I givet fald vil der være flere grunde med samme ejendomsnummer. Ønsker man at hente bygninger hørende til en grund, benyttes metoden BuildingGet- BySiteId, som returnerer alle stambygninger og eventuelle nybyggeri bygninger under en grund. Metoden er beskrevet i kapitel 6, som beskriver bygningernes metoder. Ønsker man at hente tekniske anlæg hørende til en grund, benyttes metoden TechnicalInstallationGetBySiteId, som returnerer alle tekniske anlæg i stam og eventuelle nybyggeri tekniske anlæg under en grund. Metoden er beskrevet i kapitel 7, som beskriver metoder til tekniske anlæg. Hver grund kan være en del af en byggesag. I givet fald vil statuskoden være 3 og strukturen EntityBuildingCaseInformation (se afsnit ) vil være udfyldt. Snitfladebeskrivelse Side 164 af 310

165 Hvis en grund har status 1, kan man med metoden SiteGetByParentId hente eventuelle sagsentiteter hørende til grunden. Grunde med status 1 (dvs. i stamdel) kan ikke oprettes eller slettes igennem snitfladen. Oplysninger om nye og slettede grunde samt hvilke matrikler der hører til en grund stammer fra GST og ESR og opdateres løbende derfra og ikke igennem systemet. Resultatet for alle metode kald leveres tilbage i en struktur kaldt ReturnMessage. Strukturen er beskrevet i afsnit SiteGetById Metoden SiteGetById henter en grund ved angivelse af id en for grunden. Det kan både være en id for en stamentitet eller en (S)entitet. Der findes ingen (N)entiteter for grunde. De i afsnit og viste tegninger viser metodens input og output struktur. Metoden har id en for grunden og en kommunekode som input. Strukturen angiver, at begge input felter er obligatoriske, dvs. skal udfyldes, når operationen SiteGetById kaldes. Metoden leverer den ønskede grund samt et resultat for metode kaldet tilbage. Grunden leveres i strukturen SiteStructure. Alle typer grunde leveres tilbage, dvs. gældende grunde i stamdelen (status 1) samt sager, dvs. ændringer til eksisterende grunde (status 3). Når IncludeHistoricIndicator er lig med true, leveres også udgåede stamgrunde. I følgende situatoner fejler metodekaldet: - Ved kald med en ukendt id. Der henvises til afsnit 4.8 for relevante returkoder SiteGetByIdRequestStructure SiteGetByIdRequestStructure Feltnavn i OIOXML navn Kommentar Grund ID SiteUniversalIdentifier Feltet skal udfyldes med id en for den grund man ønsker at hente. Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode. Snitfladebeskrivelse Side 165 af 310

166 SiteGetByIdRequestStructure Feltnavn i OIOXML navn Kommentar Medtag historik IncludeHistoricIndicator Indikatoren skal være true for at hente en udgået stam-grund med status 2. Se også afsnit SiteGetByIdResponseStructure SiteGetByIdResponseStructure Feltnavn i OIOXML navn Kommentar SiteStructure Den hentede grund (hvis den kunne findes), se afsnit 5.1. ReturnMessage Resultatet for metode kaldet, se afsnit SiteGetByIds Metoden SiteGetByIds henter et antal grunde ved angivelse af et antal grund id er. Det kan både være id er for en stamentiteter eller for (S)entiteter. (Der findes ingen (N)entiteter for grunde). De i afsnit og viste tegninger viser metodens input og output struktur. Metoden leverer de ønskede grunde samt et resultat for metode kaldet tilbage. Grundene leveres i strukturen SiteStructure. Der leveres én besked pr. sendt grund id tilbage. Som beskrevet under søgningen (afsnit 15.2) kan man ved hjælp af indikatoren ResultTypeCode angive, om man ønsker at få leveret hele strukturen SiteStructure tilbage eller om man ønsker kun at få leveret en mindre del af strukturen. Ellers gælder det samme som for metoden GetById SiteGetByIdsRequestStructure Snitfladebeskrivelse Side 166 af 310

167 SiteGetByIdsRequestStructure Feltnavn i OIOXML navn Kommentar Grund ID SiteUniversalIdentifier Feltet skal udfyldes med id er for de grunde man ønsker at hente. Der skal angives mindst en id. Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode. ResultTypeCode Indikator, som angiver, om man ønsker at få grundene leveret med alle deres understrukturer eller om man ønsker kun at få leveret de vigtigste oplysninger om grundene (se afsnit 15.2). Hvis indikatoren ikke angives, er den pr. default true. True betyder at hele strukturen leveres tilbage. Medtag historik IncludeHistoricIndicator Indikatoren skal være true for også at hente udgåede stam-grunde med status 2. Se også afsnit SiteGetByIdsResponseStructure SiteGetByIdsResponseStructure Feltnavn i OIOXML navn Kommentar SiteStructure De hentede grunde (hvis de findes), se afsnit 5.1. Snitfladebeskrivelse Side 167 af 310

168 SiteGetByIdsResponseStructure Feltnavn i OIOXML navn Kommentar ReturnMessage Resultatet for metode kaldet, se afsnit 4.8. Der leveres én Return- Message pr. grund SiteGet Metoden SiteGet henter en grund ved angivelse af en brugervendt nøgle, her en matrikel ident. De i afsnit og viste tegninger viser metodens input og output struktur. Denne metode leverer kun grunde i stamdelen med status 1 tilbage, og ikke sager på eksisterende grunde. Grunden kan altid entydig identificeres ved angivelse af en matrikel og get metoden returnerer således altid højst en grund tilbage. Grunden leveres i strukturen SiteStructure. I følgende situatoner fejler metodekaldet: - Ved kald med en ukendt matrikel Der henvises til afsnit 4.8 for relevante returkoder SiteGetRequestStructure SiteGetRequestStructure Feltnavn i OIOXML navn Kommentar Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode. Matrikeloplysninger landparcelidentity- Structure Oplysninger om en matrikel, se afsnit SiteGetResponseStructure SiteGetResponseStructure Snitfladebeskrivelse Side 168 af 310

169 Feltnavn i OIOXML navn Kommentar SiteStructure Den hentede grund (hvis den kunne findes), se afsnit 5.1. ReturnMessage Resultatet for metode kaldet, se afsnit SiteGetByMunicipalRealPropertyId Metoden SiteGetByMunicipalRealPropertyId henter en eller evt. flere grunde ved angivelse af et ejendomsnummer. Metoden returnerer grunde i stamdel med status 1, dog ikke sager på eksisterende grunde. De i afsnit og viste tegninger viser metodens input og output struktur. Den (eller de) grund(e) leveres i strukturen SiteStructure. I følgende situatoner fejler metodekaldet: - Ved kald med et ukendt ejendomsnummer Der henvises til afsnit 4.8 for relevante returkoder SiteGetByMunicipalRealPropertyIdRequestStructure SiteGetByMunicipalRealPropertyIdRequestStructure Feltnavn i OIOXML navn Kommentar Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode. Ejendomsnummer MunicipalRealPropertyIdentifier Feltet skal udfyldes med ejendomsnummer SiteGetByMunicipalRealPropertyIdResponseStructure Snitfladebeskrivelse Side 169 af 310

170 SiteGetByMunicipalRealPropertyIdResponseStructure Feltnavn i OIOXML navn Kommentar SiteStructure Den (hvis den findes) eller de hentede grunde, se afsnit 5.1. ReturnMessage Resultatet for metode kaldet, se afsnit SiteGetByParentId Metoden SiteGetByParentId henter sager (dvs. grunde med status 3) hørende til en eksisterende grund i stam. De i afsnit og viste tegninger viser metodens input og output struktur. Den (eller de) sager leveres i strukturen SiteStructure. Strukturen Entity- BuildingCaseInformation vil altid være udfyldt for disse grunde idet de har status 3. I følgende situatoner fejler metodekaldet: - Hvis der ikke findes sager til den angivne stamid - Ved kald med en ukendt id Der henvises til afsnit 4.8 for relevante returkoder SiteGetByParentIdRequestStructure SiteGetByParentIdRequestStructure Feltnavn i OIOXML navn Kommentar Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode. Grund stam id SiteParentReference Feltet skal udfyldes med id en for en grund i stamdelen. Snitfladebeskrivelse Side 170 af 310

171 SiteGetByParentIdResponseStructure SiteGetByParentIdResponseStructure Feltnavn i OIOXML navn Kommentar SiteStructure Den eller de hentede grund(e), se afsnit 5.1. ReturnMessage Resultatet for metode kaldet, se afsnit SiteGetSubStructuresById Metoden SiteGetSubStructuresById henter alle underliggende entiteter hørende til en grund. Metoden benyttes med fordel ved opbygning af et resultattræ. Ved hjælp af entiteternes id og de leverede referencer, dvs. id er til overliggende entiteter, er det muligt at opbygge forskellige træstrukturer alt efter situation og ønske. Metoden returenere også alle byggesager, som er knyttet til den angivne grund. De i afsnit og viste tegninger viser metodens input og output struktur. Grundens underliggende entiteter leveres i de kendte <Entity>Structure strukturer. Der leveres både stamentiteter og nybyggerier (N entiteter). Metoden SiteGetSubStructuresById skal kaldes med en grund id for en stamentitet. Hvis der ikke findes underliggende entiteter returneres returnidentifier 0 og reasonidentifier SiteGetSubStructuresByIdRequestStructure SiteGetSubStructuresByIdRequestStructure Snitfladebeskrivelse Side 171 af 310

172 Feltnavn i OIOXML navn Kommentar Grund ID SiteUniversalIdentifier Feltet skal udfyldes med id en for den grund, som man ønsker at hente understrukturer til. Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode. ResultTypeCode Indikator, som angiver, om man ønsker at få grundens underliggende entiteter leveret med alle deres understrukturer eller om man ønsker kun at få leveret de vigtigste oplysninger om entiteterne (se afsnit 15.2). Hvis indikatoren ikke angives, er den pr. default true. True betyder at hele strukturen leveres tilbage. Feltet kan med fordel benyttes i forbindelse med søgningen, se afsnit SiteGetSubStructuresByIdResponseStructure Snitfladebeskrivelse Side 172 af 310

173 SiteGetSubStructuresByIdResponseStructure Feltnavn i OIOXML navn Kommentar Grund SiteStructure Den grund, hvis stamid man har kaldt metoden med. Bygninger BuildingStructure Bygningerne hørende til grunden, se afsnit 5.2 Tekniske anlæg TechnicalInstallationStrcuture Tekniske anlæg hørende til grunden, se afsnit 5.6. Der leveres både de teknsike anlæg som ligger på en matrikel der hører til grunden og de teknsike anlæg som hører til en af grundens bygninger. Opgange/indgange EntranceStructure Opgange/indgange hørende til grunden, se afsnit 5.3. Der leveres alle opgange/indgange som ligger under grundens bygninger. Etager FloorStructure Etager hørende til grunden, se afsnit 5.4. Der leveres alle etager, som ligger under grundens bygninger. Enheder BuildingUnitStructure Enheder hørende til grunden, se afsnit 5.5. Der leveres alle enheder som ligger under grundens bygninger. Brugsenheder UseUnitStructure Brugsenheder hørende til grunden, se afsnit 5.8. Der leveres alle brugsenheder som ligger under grundens bygninger. Rum RoomStructure Rum hørende til grunden, se afsnit 5.7. Der leveres alle rum som ligger under de enheder eller etager, som hører til grundens bygninger. Byggesager BuildingCaseStructure Byggesager hørende til grunden, se afsnit 5.9. ReturnMessage Resultat for metode kald, se afsnit SiteCreate Metoden SiteCreate opretter en grund ved angivelse af attributterne for den grund man ønsker at oprette. De i afsnit og viste tegninger viser metodens input og output struktur. Snitfladebeskrivelse Side 173 af 310

174 Grunden sendes som input til metoden i strukturen SiteStructure. Det er ikke muligt at oprette grunde i stam eller som nybyggerier. Det er alene mulighed for at oprette sager på eksisterende grunde i stam (grunde med status 3). Som resultat for metoden returneres den oprettede grund (hvis det lykkedes) i strukturen "SiteStructure. For at kunne oprette en grund skal der som minimum angives følgende felter i strukturen SiteStructure : Kommunenummer Sagstype (for grunde giver kun sagstype til/ombygning mening) Grund stam id (grund som denne sag er en ændring til) Byggesag id (den byggesag sagen skal høre til) Der kan kun oprettes grunde med status 3 som er ændringer til eksisterende grunde SiteCreateRequestStructure SiteCreateRequestStructure Feltnavn i OIOXML navn Kommentar SiteStructure Grunden, som man ønsker at oprette, se afsnit 5.1. IgnoreWarningIndicator Se afsnit 4.1. printenableindicator Se afsnit SiteCreateResponseStructure SiteCreateResponseStructure Feltnavn i OIOXML navn Kommentar SiteStructure Den oprettede grund (hvis det lykkedes), se afsnit 5.1. Snitfladebeskrivelse Side 174 af 310

175 SiteCreateResponseStructure Feltnavn i OIOXML navn Kommentar ReturnMessage Resultatet for metode kaldet, se afsnit SiteUpdate Metoden SiteUpdate opdaterer en grund ved angivelse af de attributter man ønsker at opdatere. De i afsnit og viste tegninger viser metodens input og output struktur. For at opdatere en grund, skal der angives grundens id. Der angives endvidere det eller de felter man ønsker at opdatere ved hjælp af strukturen "Site- Structure (se afsnit 5.1). Som resultat for metoden returneres den opdaterede grund i strukturen "SiteStructure. For at kunne opdatere en grund skal der som minimum angives følgende felter i strukturen SiteStructure : Kommunekode Grund id RecordChangeDateTime Bortset fra RecordChangeDateTime ligger disse felter i understrukturen Site- Keys, dvs. at denne understruktur altid skal sendes med ved en opdatering. Der henvises til afsnit 4.4 for en beskrivelse af den implementerede opdateringsmekanisme og til kapitel 5 for en beskrivelse for key strukturen SiteUpdateRequestStructure SiteUpdateRequestStructure Feltnavn i OIOXML navn Kommentar SiteStructure Grunden, som man ønsker at opdatere, se afsnit 5.1. IgnoreWarningIndicator Se afsnit 4.1. printenableindicator Se afsnit 4.2. Snitfladebeskrivelse Side 175 af 310

176 SiteUpdateResponseStructure SiteUpdateResponseStructure Feltnavn i OIOXML navn Kommentar SiteStructure Den opdaterede grund, se afsnit 5.1. ReturnMessage Resultatet for metode kaldet, se afsnit SiteDelete Metoden SiteDelete sletter en grund. De i afsnit og viste tegninger viser metodens input og output struktur. En grund slettes ved angivelse af id en for. Som nævnt i starten af kapitel 6 kan man ikke oprette eller slette grunde med status 1. Man kan således kun slette en (S)entitet, dvs. en ændring til en eksisterende grund i stam. I følgende situatoner fejler metodekaldet: - Ved kald med en id som ikke er en id for en (S) entitet. - Ved kald med en ukendt id. Der henvises til afsnit 4.8 for relevante fejlkoder SiteDeleteRequestStructure SiteDeleteRequestStructure Feltnavn i OIOXML navn Kommentar Grund ID SiteUniversalIdentifier Feltet skal altid udfyldes med id en for den grund man ønsker at slette. Snitfladebeskrivelse Side 176 af 310

177 SiteDeleteRequestStructure Feltnavn i OIOXML navn Kommentar Kommunekode MunicipalityCode Feltet skal altid udfyldes med 4 cifren kommunekode, fx IgnoreWarningIndicator Se afsnit 4.1. printenableindicator Se afsnit 4.2. Tidsstempel RecordChangeDateTime Se afsnit 4.6. Gyldighedsdato AssessmentChangedDate Se afsnit SiteDeleteResponseStructure SiteDeleteResponseStructure Feltnavn i OIOXML navn Kommentar ReturnMessage Resultat for metode kald, se afsnit SiteMoveEntities Metoden SiteMoveEntities flytter entiteter fra én matrikel til en anden. Metoden er beskrevet i detaljer i afsnit Alle entiteter kan flyttes fra én matrikel til en anden ved at angive den matrikel, som man ønsker at flytte entiteter væk fra og ved at angive den matrikel, som entiteterne skal flyttes til. De i afsnit og viste tegninger viser metodens input og output struktur. Der henvises til afsnit 4.8 for relevante fejlkoder SiteMoveEntitiesRequestStructure Snitfladebeskrivelse Side 177 af 310

178 SiteMoveEntitiesRequestStructure Feltnavn i OIOXML navn Kommentar Matrikel fra LandParcelFromReference Feltet skal altid udfyldes med den matrikel man ønsker at flytte entiteterne væk fra. Til angivelse af matrikelen benyttes strukturen landparcelidentitystructure (afsnit ) Matrikel til LandParcelToReference Feltet skal altid udfyldes med den matrikel man ønsker at flytte entiteterne til. Til angivelse af matrikelen benyttes strukturen landparcelidentitystructure (afsnit ) Kommunekode MunicipalityCode Feltet skal altid udfyldes med 4 cifren kommunekode, fx IgnoreWarningIndicator Se afsnit 4.1. printenableindicator Se afsnit 4.2. Tidsstempel RecordChangeDateTime Se afsnit 4.6. Gyldighedsdato AssessmentChangedDate Se afsnit SiteMoveEntitiesResponseStructure SiteMoveEntitiesResponseStructure Feltnavn i OIOXML navn Kommentar ReturnMessage Resultat for metode kald, se afsnit 4.8. Snitfladebeskrivelse Side 178 af 310

179 Snitfladebeskrivelse Side 179 af 310

180 7. Metoder til entitet bygning Der findes 9 metoder til at hente, opdatere, oprette og slette bygninger: BuildingGetById henter en bygning ved angivelse af dens id BuildingGetByIds henter et antal bygninger ved angivelse af deres id er BuildingGet - henter en (eller flere) bygninger ved angivelse af et ejendomsnummer og et bygningsnummer BuildingGetBySiteId - henter en eller flere bygninger til en grund BuildingGetByParentId - henter en eller flere sager (ændringer til en eksisterende bygning) ved angivelse af id for en stambygning BuildingCreate - opretter en ny bygning BuildingUpdate - opdaterer en bygning BuildingDelete - sletter en bygning BuildingDeleteHistoric - sletter en bygning fra historikken Metoderne er beskrevet i de 9 næste afsnit. En bygning er altid beskrevet i strukturen BuildingStructure, som beskriver en bygning i alle situationer, både når den leveres som input til en metode og når den leveres som output. Strukturen er beskrevet i afsnit 5.2. En bygning er altid knyttet til en matrikel og derigennem hører den altid til en grund. En matrikel/grund kan have nul, en eller flere bygninger tilknyttet. For bygninger på lejet grund skelner man mellem den grund som bygningens matrikel hører til og den grund som bygningen ligger på fysisk. For bygninger på lejet grund vil der blive leveret både den grund som bygningens matrikel hører til og den grund som bygningen ligger på fysisk. For hver bygning kan der findes et antal underliggende brugsenheder, opgang/indgange, etager eller teknisk anlæg. Disse vil ikke blive leveret sammen med bygningen, men skal hentes med de respektive metoder under de nævnte entiteter: o TechnicalInstallationGetByBuildingId o EntranceGetByBuildingId o FloorGetByBuildingId o UseUnitGetByBuildingId En bygning med status 1 er en gældende bygning i stamdelen. En bygning med status 3 er en bygning under sagsbehandling. Dette kan enten være et nybyggeri (N)BYG eller en ændring til en eksisterende bygning (S)BYG. En bygning med status 3 vil være en del af en byggesag. I givet fald vil strukturen EntityBuildingCaseInformation (se afsnit ) være udfyldt. Snitfladebeskrivelse Side 180 af 310

181 Resultatet for alle metode kald leveres tilbage i en struktur kaldt ReturnMessage. Strukturen er beskrevet i afsnit BuildingGetById Metoden BuildingGetById henter en bygning ved angivelse af bygningens id. Det kan både være en id for en stamentitet eller en id for en (S) eller (N) entitet. De i afsnit og viste tegninger viser metodens input og output struktur. Metoden har en bygnings id og en kommunekode som input. Strukturen angiver, at begge input felter er obligatoriske, dvs. skal udfyldes, når operationen BuildingGetById kaldes. Metoden leverer den ønskede bygning samt et resultat for metode kaldet tilbage. Bygningen leveres i strukturen BuildingStructure. Alle typer bygninger leveres tilbage ved kald by id, dvs. eksisterende bygninger i stamdelen samt sager (herunder ændringer ((S)BYG entiteter) og nybyggerier ((N)BYG entiteter). Når IncludeHistoricIndicator er lig med true, leveres også udgåede stambygninger. I følgende situatoner fejler metodekaldet: - Ved kald med en placeholder id (se også afsnit ). - Ved kald med en ukendt id. Der henvises til afsnit 4.8 for relevante returkoder BuildingGetByIdRequestStructure BuildingGetByIdRequestStructure Feltnavn i OIOXML navn Kommentar BygningID BuildingUniversalIdentifier Feltet skal udfyldes med id en for den bygning man ønsker at hente. Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode. Medtag historik IncludeHistoricIndicator Indikatoren skal være true for at hente en udgået stam-bygning med status 2. Se også afsnit Snitfladebeskrivelse Side 181 af 310

182 BuildingGetByIdRequestStructure Feltnavn i OIOXML navn Kommentar BuildingGetByIdResponseStructure BuildingGetByIdResponseStructure Feltnavn i OIOXML navn Kommentar BuildingStructure Den hentede bygning (hvis den findes), se afsnit 5.2. ReturnMessage Resultat for metode kald, se afsnit BuildingGetByIds Metoden BuildingGetByIds henter et antal bygninger ved angivelse af deres id er. Det kan både være id er for stamentiteter eller id er for (S) eller (N) entiteter. De i afsnit og viste tegninger viser metodens input og output struktur. Metoden leverer de ønskede bygninger samt et resultat for metode kaldet tilbage. Bygningerne leveres i strukturen BuildingStructure. Der leveres én besked pr. sendt bygning id tilbage. Som beskrevet under søgningen (afsnit 15.2) kan man ved hjælp af indikatoren ResultTypeCode angive, om man ønsker at få leveret hele strukturen BuildingStructure tilbage eller om man ønsker kun at få leveret en mindre del af strukturen. Ellers gælder det samme som for metoden GetById. Snitfladebeskrivelse Side 182 af 310

183 BuildingGetByIdsRequestStructure BuildingGetByIdsRequestStructure Feltnavn i OIOXML navn Kommentar Bygning ID BuildingUniversalIdentifier Feltet skal udfyldes med id er for de bygninger man ønsker at hente. Der skal angives mindst en id. Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode. ResultTypeCode Indikator, som angiver, om man ønsker at få bygningerne leveret med alle deres understrukturer eller om man ønsker kun at få leveret de vigtigste oplysninger om bygningerne (se afsnit 15.2). Hvis indikatoren ikke angives, er den pr. default true. True betyder at hele strukturen leveres tilbage. Medtag historik IncludeHistoricIndicator Indikatoren skal være true for også at hente udgåede stam-bygninger med status 2. Se også afsnit BuildingGetByIdsResponseStructure BuildingGetByIdsResponseStructure Feltnavn i OIOXML navn Kommentar Snitfladebeskrivelse Side 183 af 310

184 BuildingGetByIdsResponseStructure Feltnavn i OIOXML navn Kommentar BuildingStructure ReturnMessage De hentede bygninger, se afsnit 5.2. Resultat for metode kald, se afsnit 4.8. Der leveres én Return- Message pr. bygning BuildingGet Metoden BuildingGet henter en bygning ved angivelse af et ejendomsnummer og et bygningsnummer. Metoden leverer kun stambygninger og nybyggerier ((N)BYG entiteter) tilbage, og ikke ændringer til stambygninger ((S)BYG entiteter). De i afsnit og viste tegninger viser metodens input og output struktur. Bygningen(erne) leveres i strukturen BuildingStructure. I følgende situatoner fejler metodekaldet: - Hvis der ikke findes en bygning med det angivne bygningsnummer og ejendomsnummer Der henvises til afsnit 4.8 for relevante returkoder BuildingGetRequestStructure BuildingGetRequestStructure Feltnavn i OIOXML navn Kommentar Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode. Ejendomsnummer Ovenstående betyder, at get metoden for bygninger altid returner højst en stamentitet (status 1). I nogle sjældne tilfælde kan der forekomme en nybyggeri-bygning med samme identifikation som en stamentitet. I givet fald skal der dog eksistere en nedrivningssag på stambygningen. Get metoden returner i disse sjældne tilfælde både den eksisterende stamentitet og nybyggeriet. MunicipalRealPropertyIdentifier Feltet skal udfyldes med et ejendomsnummer. Snitfladebeskrivelse Side 184 af 310

185 BuildingGetRequestStructure Feltnavn i OIOXML navn Kommentar Bygningsnummer BuildingIdentifier Feltet skal udfyldes med et bygningsnummer BuildingGetResponseStructure BuildingGetResponseStructure Feltnavn i OIOXML navn Kommentar BuildingStructure Bygningen(erne), som har det angivne ejendomsnummer og bygningsnummer, se afsnit 5.2. ReturnMessage Resultatet for metode kaldet, se afsnit BuildingGetBySiteId Metoden BuildingGetBySiteId henter en eller evt. flere bygninger hørende til en grund. Metoden skal kaldes med en grund id for en stamentitet. Hvis man sætter IncludeHistoricIndicator til true, vil metoden også kunne kaldes med en id for en udgået grund. Metoden returnerer alle stambygninger og eventuelle nybyggeri bygninger under en grund. Hvis man sætter IncludeHistoricIndicator til true, vil metoden også levere udgåede stamentiteter. De i afsnit og viste tegninger viser metodens input og output struktur. For at hente bygninger til en grund, kalder man metoden med grundens id. Den eller de bygninger leveres i strukturen BuildingStructure. Hvis der ikke findes en bygning på den angivne grund returneres returnidentifier 0 og reasonidentifier 10. Snitfladebeskrivelse Side 185 af 310

186 BuildingGetBySiteIdRequestStructure BuildingGetBySiteIdRequestStructure Feltnavn i OIOXML navn Kommentar Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode. Grund id SiteUniversalIdentifier Feltet skal udfyldes med grund id. Medtag historik IncludeHistoricIndicator Indikatoren skal være true for at hente udgåede entiteter med status 2. Se også afsnit BuildingGetBySiteIdResponseStructure BuildingGetBySiteIdResponseStructure Feltnavn i OIOXML navn Kommentar BuildingStructure Den eller de hentede bygninger, se afsnit 5.2. ReturnMessage Resultat for metodekald se afsnit BuildingGetByParentId Metoden BuildingGetByParentId henter sager (dvs. bygninger med status 3) hørende til en eksisterende bygning i stam. De i afsnit og viste tegninger viser metodens input og output struktur. Den (eller de) sager/bygninger leveres i strukturen BuildingStructure. Strukturen EntityBuildingCaseInformation vil altid være udfyldt for disse bygninger idet de har status 3. Snitfladebeskrivelse Side 186 af 310

187 For at hente sager til en eksisterende stamentitet kalder man metoden med stamentitetens id. For at hente sager til et nybyggeri, skal man kalde metoden med nybyggerietes placeholder og ikke med nybyggeriets id. Når man kalder BuildingGetByParentId metoden med en placeholder id for et nybyggeri vil man få selve nybyggeriet (og eventuelle sager på selve nybyggeriet) leveret retur. I følgende situatoner fejler metodekaldet: - Hvis der ikke findes sager til den angivne stamid - Ved kald med en id for et nybyggeri - Ved kald med en ukendt id Der henvises til afsnit 4.8 for relevante returkoder BuildingGetByParentIdRequestStructure BuildingGetByParentIdRequestStructure Feltnavn i OIOXML navn Kommentar Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode. Bygning stam id BuildingParentReference Feltet skal udfyldes med id en for en bygning i stamdelen BuildingGetByParentIdResponseStructure BuildingGetByParentIdResponseStructure Feltnavn i OIOXML navn Kommentar BuildingStructure Den eller de hentede bygninger, se afsnit 5.2. ReturnMessage Resultatet for metode kaldet, se afsnit 4.8. Snitfladebeskrivelse Side 187 af 310

188 7.6. BuildingCreate Metoden BuildingCreate opretter en bygning ved angivelse af bygningens attributter. De i afsnit og viste tegninger viser metodens input og output struktur. Bygningen sendes som input til metoden i strukturen BuildingStructure. Som resultat for metoden returneres den oprettede bygning (hvis det lykkedes) i strukturen "BuildingStructure. For at kunne oprette en bygning i stam eller et nybyggeri skal der som minimum angives følgende felter i strukturen SiteStructure : Kommunenummer Bygningsnummer Matrikelidentifikation Disse felter ligger i understrukturen BuildingKeys, dvs. at denne understruktur altid skal sendes med når man opretter en bygning. For sager (nybyggerier eller ændringer til eksisterende bygninger) skal der yderligere angives følgende felter i understrukturen EntityBuildingCaseInformation : Sagstype (Nybyggeri, nedrivning eller til/ombygning) Bygning stam id (for ændringer til eksisterende bygning) Byggesag id (den byggesag sagen skal høre til) BuildingCreateRequestStructure BuildingCreateRequestStructure Feltnavn i OIOXML navn Kommentar BuildingStructure Bygningen, som man ønsker at oprette, se afsnit 5.2. IgnoreWarningIndicator Se afsnit 4.1. printenableindicator Se afsnit 4.2. Snitfladebeskrivelse Side 188 af 310

189 BuildingCreateResponseStructure BuildingCreateResponseStructure Feltnavn i OIOXML navn Kommentar BuildingStructure ReturnMessage Den oprettede bygning se afsnit 5.2. Resultat for metodekald, se afsnit BuildingUpdate Metoden BuildingUpdate opdaterer en bygning ved angivelse af de attributter man ønsker at opdatere. De i afsnit og viste tegninger viser metodens input og output struktur. For at opdatere en bygning, skal der angives bygningens id. Der angives endvidere det eller de felter man ønsker at opdatere ved hjælp af strukturen "BuildingStructure (se afsnit 5.2). Som resultat for metoden returneres den opdaterede bygning i strukturen "BuildingStructure. For at kunne opdatere en bygning skal der som minimum angives følgende felter i strukturen BuildingStructure : Kommunenummer Bygning id RecordChangeDateTime Bortset fra RecordChangeDateTime ligger disse felter i understrukturen BuildingKeys, dvs. at denne understruktur altid skal sendes med når man opdaterer en bygning. Der henvises til afsnit 4.4 for en beskrivelse af den implementerede opdateringsmekanisme og til kapitel 5 for en beskrivelse for key strukturen BuidlingUpdateRequestStructure Snitfladebeskrivelse Side 189 af 310

190 BuildingUpdateRequestStructure Feltnavn i OIOXML navn Kommentar BuildingStructure Bygningen, som man ønsker at opdatere, se afsnit 5.2. IgnoreWarningIndicator Se afsnit 4.1. printenableindicator Se afsnit BuildingUpdateResponseStructure BuildingUpdateResponseStructure Feltnavn i OIOXML navn Kommentar BuildingStructure ReturnMessage Den opdaterede bygning, se afsnit 5.2. Resultat for metode kald se afsnit BuildingDelete Metoden BuildingDelete sletter en bygning. De i afsnit og viste tegninger viser metodens input og output struktur. Bygningen slettes ved angivelse af bygningens id. Det skal være en id til en stamentitet, et nybyggeri eller en (S)entitet, dvs. en ændring til en eksisterende bygning i stam. En bygning i stam (eller et nybyggeri) kan kun slettes, hvis der ikke findes en tilhørende sagsentitet. Når man sletter en bygning, sletter man også de underliggende brugsenheder, opgange/indgange, etager, teknisk anlæg, rum og enheder. Dette gælder både stam- og sagsentiteter. I følgende situatoner fejler metodekaldet: - Ved kald med en id for en allerede udgået bygning. - Ved kald med en placeholder id (se også afsnit ). - Ved kald med en ukendt id. - Ved kald med en id for en stamentitet (eller nybyggeri) som har en sag tilknyttet Der henvises til afsnit 4.8 for relevante fejlkoder. Snitfladebeskrivelse Side 190 af 310

191 BuildingDeleteRequestStructure BuildingDeleteRequestStructure Feltnavn i OIOXML navn Kommentar Bygning ID BuildingUniversalIdentifier Feltet skal altid udfyldes med bygningens id. Kommunekode MunicipalityCode Feltet skal altid udfyldes med 4 cifren kommunekode, fx IgnoreWarningIndicator Se afsnit 4.1. printenableindicator Se afsnit 4.2. Tidsstempel RecordChangeDateTime Se afsnit 4.6. Gyldighedsdato AssessmentChangedDate Se afsnit BuildingDeleteResponseStructure BuildingDeleteResponseStructure Feltnavn i OIOXML navn Kommentar ReturnMessage Resultat for metode kald, se afsnit BuildingDeleteHistoric Metoden BuildingDeleteHistoric sletter en bygning fra historikken. De i afsnit og viste tegninger viser metodens input og output struktur. Bygningen slettes ved angivelse af bygningens id. Det skal være en id til en udgået stamentitet. Snitfladebeskrivelse Side 191 af 310

192 Når man sletter en bygning fra historikken, sletter man også de underliggende brugsenheder, opgange/indgange, etager, teknisk anlæg, rum og enheder samt tilhørende afsluttede sagsentiteter fra historikken BuildingDeleteHistoricRequestStructure BuildingDeleteHistoricRequestStructure Feltnavn i OIOXML navn Kommentar Bygning ID BuildingUniversalIdentifier Feltet skal altid udfyldes med bygningens id. Kommunekode MunicipalityCode Feltet skal altid udfyldes med 4 cifren kommunekode, fx BuildingDeleteHistoricResponseStructure BuildingDeleteHistoricResponseStructure Feltnavn i OIOXML navn Kommentar ReturnMessage Resultat for metode kald, se afsnit 4.8. Snitfladebeskrivelse Side 192 af 310

193 8. Metoder til entitet opgang/indgang Der findes 9 metoder til at hente, opdatere, oprette og slette opgange/indgange: EntranceGetById henter en opgang/indgang ved angivelse af dens id EntranceGetByIds henter et antal opgange/indgange ved angivelse af deres id er EntranceGet - henter en (eller flere) opgange/indgange ved angivelse af et ejendomsnummer og et bygningsnummer, vejkode og husnummer EntranceGetByBuildingId - henter alle opgange/indgange hørende til en bygning EntranceGetByParentId - henter en eller flere sager (ændringer til en eksisterende opgang/indgang) ved angivelse af en stam opgang/indgang id. EntranceCreate - opretter en opgang/indgang EntranceUpdate - opdaterer en opgang/indgang EntranceDelete - sletter en opgang/indgang EntranceDeleteHistoric - sletter en opgang/indgang fra historikken Metoderne er beskrevet i de 9 næste afsnit. En opgang/indgang er altid beskrevet i strukturen EntranceStructure, som beskriver en opgang/indgang i alle situationer, både når en opgang/indgang leveres som input til en metode og når det leveres som output. Strukturen er beskrevet i afsnit 5.3. En opgang/indgang er altid knyttet til en bygning. En bygning kan have tilknyttet nul, en eller flere opgange/indgange. En opgang/indgang kan have tilknyttet et antal enheder. Disse enheder refererer både til en opgang/indgang og til en etage. En opgang/indgang med status 1 er en opgang/indgang i stamdelen. En opgang/indgang med status 3 er en opgang/indgang under sagsbehandling. Dette kan enten være et nybyggeri (N)OPG eller en ændring til en eksisterende opgang (S)OPG. En opgang/indgang med status 3 er en del af en byggesag. I givet fald vil strukturen EntityBuildingCaseInformation (se afsnit ) være udfyldt, som bl.a. angiver hvilken byggesag sagen hører til og hvilken stamentitet der refereres til. For hver opgang/indgang kan der findes et antal underliggende enheder. Disse vil ikke blive leveret sammen med opgangen/indgangen, men skal hentes med den respektive metode under enheden: o BuildingUnitGetByEntranceId Resultatet for alle metode kald leveres tilbage i en struktur kaldt ReturnMessage. Strukturen er beskrevet i afsnit EntranceGetById Metoden EntranceGetById henter en opgang/indgang ved angivelse af id en for opgangen/indgangen. Det kan både være en id for en stamentitet eller en id for en (S) eller (N) entitet. Snitfladebeskrivelse Side 193 af 310

194 De i afsnit og viste tegninger viser metodens input og output struktur. Metoden har id en for opgangen/indgangen og en kommunekode som input. Strukturen angiver, at begge input felter er obligatoriske, dvs. skal udfyldes, når operationen EntranceGetById kaldes. Metoden leverer den ønskede opgang/indgang samt et resultat for metode kaldet tilbage. Opgangen/indgangen leveres i strukturen EntranceStructure. Alle typer opgang/indgange leveres tilbage ved kald by id, dvs. eksisterende opgange/indgange i stamdelen samt sager, herunder ændringer ((S)OPG entiteter) og nybyggerier ((N)OPG entiteter). I følgende situatoner fejler metodekaldet: - Ved kald med en placeholder id (se også afsnit ). - Ved kald med en ukendt id. Der henvises til afsnit 4.8 for relevante returkoder EntranceGetByIdRequestStructure EntranceGetByIdRequestStructure Feltnavn i OIOXML navn Kommentar Opgang/Indgang ID Når IncludeHistoricIndicator er lig med true, leveres også udgåede stamopgange/indgange. EntranceUniversalIdentifier Feltet skal udfyldes med id en for den opgang/indgang man ønsker at hente. Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode. Medtag historik IncludeHistoricIndicator Indikatoren skal være true for at hente en udgået stam-opgang med status 2. Se også afsnit EntranceGetByIdResponseStructure Snitfladebeskrivelse Side 194 af 310

195 EntranceGetByIdResponseStructure Feltnavn i OIOXML navn Kommentar EntranceStructure Den hentede opgang/indgang (hvis den findes), se afsnit 5.3. ReturnMessage Resultat for metode kald, se afsnit EntranceGetByIds Metoden EntranceGetByIds henter et antal opgange/indgange ved angivelse af deres id er. Det kan både være id er for stamentiteter eller id er for (S) eller (N) entiteter. De i afsnit og viste tegninger viser metodens input og output struktur. Metoden leverer de ønskede opgange/indgange samt et resultat for metode kaldet tilbage. Opgangene/indgangene leveres i strukturen EntranceStructure. Der leveres én besked pr. sendt opgang/indgang id tilbage. Som beskrevet under søgningen (afsnit 15.2) kan man ved hjælp af indikatoren ResultTypeCode angive, om man ønsker at få leveret hele strukturen EntranceStructure tilbage eller om man ønsker kun at få leveret en mindre del af strukturen. Ellers gælder det samme som for metoden GetById EntranceGetByIdsRequestStructure Snitfladebeskrivelse Side 195 af 310

196 EntranceGetByIdsRequestStructure Feltnavn i OIOXML navn Kommentar Opgang/Indgang ID EntranceUniversalIdentifier Feltet skal udfyldes med id er for de opgange/indgange man ønsker at hente. Der skal angives mindst en id. Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode. ResultTypeCode Indikator, som angiver, om man ønsker at få opgangene/indgangene leveret med alle deres understrukturer eller om man ønsker kun at få leveret de vigtigste oplysninger om opgangene/indgangene(se afsnit 15.2). Hvis indikatoren ikke angives, er den pr. default true. True betyder at hele strukturen leveres tilbage. Medtag historik IncludeHistoricIndicator Indikatoren skal være true for også at hente udgåede stam-opgange med status 2. Se også afsnit EntranceGetByIdsResponseStructure EntranceGetByIdsResponseStructure Feltnavn i OIOXML navn Kommentar EntranceStructure De hentede opgange/indgange, se afsnit 5.3. ReturnMessage Resultat for metode kald, se afsnit 4.8. Der leveres én Return- Message pr. opgang/indgang EntranceGet Metoden EntranceGet henter en opgang/indgang ved angivelse af et ejendomsnummer, et bygningsnummer, en vejkode og et husnummer. Snitfladebeskrivelse Side 196 af 310

197 Metoden leverer kun stamentiteter og nybyggerier ((N)OPG entiteter) tilbage, og ikke ændringer til stamentiteter ((S)OPG entiteter). De i afsnit og viste tegninger viser metodens input og output struktur. Det (eller de) opgange/indgange leveres i strukturen EntranceStructure. I følgende situatoner fejler metodekaldet: - Hvis der ikke findes en opgang med de angivne parametre Der henvises til afsnit 4.8 for relevante returkoder EntranceGetRequestStructure EntranceGetRequestStructure Feltnavn i OIOXML navn Kommentar Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode. Ejendomsnummer Feltet skal udfyldes med et ejendomsnummer. Bygningsnummer BuildingIdentifier Feltet skal udfyldes med et bygningsnummer. Vejkode StreetCode Feltet skal udfyldes med en vejkode. Bygningsnummeret er taget med som input parameter for at gør svaret entydig. Det kan godt findes flere opgange med samme adgangsadresse i forskellige bygninger (anneksproblematik), men adgangsadresser for opgange i samme bygning er entydige. Ovenstående betyder, at get metoden for opgange altid returner højst en stamentitet (status 1). I nogle sjældne tilfælde kan der forekomme en nybyggeri-opgang med samme identifikation som en stamentitet. I givet fald skal der dog eksistere en nedrivningssag på stam-opgangen. Get metoden returner i disse sjældne tilfælde både den eksisterende stamentitet og nybyggeriet. MunicipalRealPropertyIdentifier Husnummer og husbogstav StreetBuildingIdentifier Feltet skal udfyldes med et husnummer/husbogstav. Snitfladebeskrivelse Side 197 af 310

198 EntranceGetResponseStructure EntranceGetResponseStructure Feltnavn i OIOXML navn Kommentar EntranceStructure ReturnMessage Den (eller de) hentede opgang(e)/indgang(e), se afsnit 5.3. Resultat for metode kald, se afsnit EntranceGetByBuildingId Metoden EntranceGetByBuildingId henter en eller evt. flere opgange/indgange hørende til en bygning. Metoden skal kaldes med en bygning id for en stamentitet. Hvis man sætter IncludeHistoricIndicator til true, vil metoden også kunne kaldes med en id for en udgået bygning. Metoden returnerer alle stamentiteter og eventuelle nybyggeri opgange/indgange under en bygning. Hvis man sætter IncludeHistoricIndicator til true, vil metoden også levere udgåede stamentiteter. De i afsnit og viste tegninger viser metodens input og output struktur. For at hente bygninger til en grund, kalder man metoden med grundens id. For at hente underliggende opgange til en bygning, kalder man metoden med stambygnigens id. For at hente underliggende entiteter til et nybyggeri, skal man kalde metoden med nybyggerietes placeholder og ikke med nybyggeriets id. Den eller de opgange/indgange leveres i strukturen EntranceStructure. I følgende situatoner fejler metodekaldet: - Ved kald med en id for et nybyggeri - Ved kald med en ukendt id Der henvises til afsnit 4.8 for relevante returkoder. Snitfladebeskrivelse Side 198 af 310

199 EntranceGetByBuildingIdRequestStructure EntranceGetByBuildingIdRequestStructure Feltnavn i OIOXML navn Kommentar Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode. Bygning id BuildingUniversalIdentifier Feltet skal udfyldes med bygningens id. Medtag historik IncludeHistoricIndicator Indikatoren skal være true for at hente udgåede entiteter med status 2. Se også afsnit EntranceGetByBuildingIdResponseStructure EntranceGetByBuildingIdResponseStructure Feltnavn i OIOXML navn Kommentar EntranceStructure Den eller de hentede opgange/indgange, se afsnit 5.3. ReturnMessage Resultatet for metode kaldet, se afsnit EntranceGetByParentId Metoden EntranceGetByParentId henter sager (dvs. opgange/indgange med status 3) hørende til en eksisterende opgang/indgang i stam. De i afsnit og viste tegninger viser metodens input og output struktur. Snitfladebeskrivelse Side 199 af 310

200 Den (eller de) sager/opgange/indgange leveres i strukturen EntranceStructure. Strukturen EntityBuildingCaseInformation vil altid være udfyldt for disse opgange/indgange idet de har status 3. For at hente sager til en eksisterende stamentitet kalder man metoden med stamentitetens id. For at hente sager til et nybyggeri, skal man kalde metoden med nybyggerietes placeholder og ikke med nybyggeriets id. Når man kalder EntranceGetByParentId metoden med en placeholder id for et nybyggeri vil man få selve nybyggeriet (og eventuelle sager på selve nybyggeriet) leveret retur. I følgende situatoner fejler metodekaldet: - Hvis der ikke findes sager til den angivne stamid - Ved kald med en id for et nybyggeri - Ved kald med en ukendt id Der henvises til afsnit 4.8 for relevante returkoder EntranceGetByParentIdRequestStructure EntranceGetByParentIdRequestStructure Feltnavn i OIOXML navn Kommentar Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode. Opgang/indgang stam id EntranceParentReference Feltet skal udfyldes med id en for en opgang/indgang i stamdelen EntranceGetByParentIdResponseStructure EntranceGetByParentIdResponseStructure Feltnavn i OIOXML navn Kommentar EntranceStructure Den eller de hentede opgange/indgange, se afsnit 5.3. Snitfladebeskrivelse Side 200 af 310

201 EntranceGetByParentIdResponseStructure Feltnavn i OIOXML navn Kommentar ReturnMessage Resultatet for metode kaldet, se afsnit EntranceCreate Metoden EntranceCreate opretter en opgang/indgang ved angivelse af attributterne for den opgang/indgang man ønsker at oprette. De i afsnit og viste tegninger viser metodens input og output struktur. Opgangen/indgangen sendes som input til metoden i strukturen Entrance- Structure. Som resultat for metoden returneres den oprettede opgang/indgang (hvis det lykkedes) i strukturen "EntranceStructure. For at kunne oprette en opgang/indgang i stam eller som nybyggeri skal der som minimum angives følgende felter: Kommunenummer Bygning id Disse felter ligger i understrukturen EntranceKeys, dvs. at denne understruktur altid skal sendes med når man opretter en opgang/indgang. For sager skal der angives: Sagstype (Nybyggeri, nedrivning eller til/ombygning) Opgang/indgang stam id (for ændringer til eksisterende opgang/indgang) Byggesag id (den byggesag sagen skal høre til) EntranceCreateRequestStructure EntranceCreateRequestStructure Feltnavn i OIOXML navn Kommentar EntranceStructure Den opgange/indgang, som man ønsker at oprette, se afsnit 5.3. IgnoreWarningIndicator Se afsnit 4.1. printenableindicator Se afsnit 4.2. Snitfladebeskrivelse Side 201 af 310

202 EntranceCreateResponseStructure EntranceCreateResponseStructure Feltnavn i OIOXML navn Kommentar EntranceStructure Den oprettede opgang/indgang, se afsnit 5.3. ReturnMessage Resultatet for metode kaldet, se afsnit EntranceUpdate Metoden EntranceUpdate opdaterer en opgang/indgang ved angivelse af de attributter man ønsker at opdatere. De i afsnit og viste tegninger viser metodens input og output struktur. For at opdatere en opgang/indgang, skal der angives id en for den opgang/indgang man ønsker at opdatere. Det skal være en id til en stamentitet, et nybyggeri eller en (S)entitet, dvs. en ændring til en eksisterende opgang/indgang i stam. Der angives endvidere det eller de felter man ønsker at opdatere ved hjælp af strukturen "EntranceStructure. Som resultat for metoden returneres den opdaterede opgang/indgang i strukturen "EntranceStructure. For at kunne opdatere en opgang/indgang skal der som minimum angives følgende felter: Opgang/indgang id Kommunenummer RecordChangeDateTime Bortset fra RecordChangeDateTime ligger disse felter i understrukturen EntranceKeys, dvs. at denne understruktur altid skal sendes med ved en opdatering. Der henvises til afsnit 4.4 for en beskrivelse af den implementerede opdateringsmekanisme og til kapitel 5 for en beskrivelse for key strukturen EntranceUpdateRequestStructure Snitfladebeskrivelse Side 202 af 310

203 EntranceUpdateRequestStructure Feltnavn i OIOXML navn Kommentar EntranceStructure Den opgang/indgang, som man ønsker at opdatere, se afsnit 5.3. IgnoreWarningIndicator Se afsnit 4.1. printenableindicator Se afsnit EntranceUpdateResponseStructure EntranceUpdateResponseStructure Feltnavn i OIOXML navn Kommentar EntranceStructure Den opdaterede opgang/indgang, se afsnit 5.3. ReturnMessage Resultatet for metode kaldet, se afsnit EntranceDelete Metoden EntranceDelete sletter en opgang/indgang. De i afsnit og viste tegninger viser metodens input og output struktur. En opgang/indgang slettes ved angivelse af id en for den opgang/indgang man ønsker at slette. Det skal være en id til en stamentitet, et nybyggeri eller en (S)entitet, dvs. en ændring til en eksisterende opgang/indgang i stam. En opgang/indgang i stam (eller et nybyggeri) kan kun slettes, hvis der ikke findes en tilhørende sagsentitet. Når man sletter en opgang/indgang, sletter man også de underliggende enheder og rum. Dette gælder både stam- og sagsentiteter. I følgende situatoner fejler metodekaldet: - Ved kald med en id for en allerede udgået opgang/indgang. - Ved kald med en placeholder id (se også afsnit ). Snitfladebeskrivelse Side 203 af 310

204 - Ved kald med en ukendt id. - Ved kald med en id for en stamentitet (eller nybyggeri) som har en sag tilknyttet Der henvises til afsnit 4.8 for relevante fejlkoder EntranceDeleteRequestStructure EntranceDeleteRequestStructure Feltnavn i OIOXML navn Kommentar Opgang/indgang ID EntranceUniversalIdentifier Feltet skal altid udfyldes med id en for den opgang/indgang man ønsker at slette. Kommunekode MunicipalityCode Feltet skal altid udfyldes med 4 cifren kommunekode, fx Tidsstempel RecordChangeDateTime Se afsnit 4.6. IgnoreWarningIndicator Se afsnit 4.1. printenableindicator Se afsnit 4.2. Gyldighedsdato AssessmentChangedDate Se afsnit EntranceDeleteResponseStructure EntranceDeleteResponseStructure Feltnavn i OIOXML navn Kommentar ReturnMessage Resultatet for metode kaldet, se afsnit EntranceDeleteHistoric Metoden EntranceDeleteHistoric sletter en opgang/indgang fra historikken. Snitfladebeskrivelse Side 204 af 310

205 EntranceDeleteHistoricRequestStructure EntranceDeleteHistoricRequestStructure Feltnavn i OIOXML navn Kommentar Opgang/indgang ID De i afsnit og viste tegninger viser metodens input og output struktur. En opgang/indgang slettes fra historikken ved angivelse af id en for den opgang/indgang man ønsker at slette fra historikken. Det skal være en id til en udgået stamentitet. Når man sletter en opgang/indgang fra historikken, sletter man også de underliggende enheder og rum samt tilhørende afsluttede sagsentiteter fra historikken. EntranceUniversalIdentifier Feltet skal altid udfyldes med id en for den opgang/indgang man ønsker at slette fra historikken. Kommunekode MunicipalityCode Feltet skal altid udfyldes med 4 cifren kommunekode, fx EntranceDeleteHistoricResponseStructure EntranceDeleteHistoricResponseStructure Feltnavn i OIOXML navn Kommentar ReturnMessage Resultatet for metode kaldet, se afsnit 4.8. Snitfladebeskrivelse Side 205 af 310

206 9. Metoder til entitet etage Der findes 9 metoder til at hente, opdatere, oprette og slette etager: FloorGetById henter etage ved angivelse af dens id FloorGetByIds - henter et antal etager ved angivelse af deres id er FloorGet - henter en (eller flere) etager ved angivelse af et ejendomsnummer, et bygningsnummer og en etagebetegnelse FloorGetByBuildingId - henter alle etager hørende til en bygning FloorGetByParentId - henter en eller flere sager (ændringer til en eksisterende etage) ved angivelse af en id til en etage i stam. FloorCreate - opretter en etage FloorUpdate - opdaterer en etage FloorDelete - sletter en etage FloorDeleteHistoric - sletter en etage fra historikken Metoderne er beskrevet i de 9 næste afsnit. En etage er altid beskrevet i strukturen FloorStructure, som beskriver en etage i alle situationer, både når en etage leveres som input til en metode og når det leveres som output. Strukturen er beskrevet i afsnit 5.4. En etage er altid knyttet til en bygning. En bygning kan have tilknyttet nul, en eller flere etager. En etage med status 1 er en etage i stamdelen. En etage med status 3 er en etage under sagsbehandling. Dette kan enten være et nybyggeri (N)ETA eller en ændring til en eksisterende etage (S)ETA. En etage med status 3 er en del af en byggesag. I givet fald vil strukturen EntityBuildingCaseInformation (se afsnit ) være udfyldt. For hver etage kan der findes et antal underliggende enheder og rum. Disse vil ikke blive leveret sammen med etagen, men skal hentes med den respektive metode under entiteten enhed hhv. rum: o UnitGetByFloorId o RoomGetByFloorId Resultatet for alle metode kald leveres tilbage i en struktur kaldt ReturnMessage. Strukturen er beskrevet i afsnit FloorGetById Metoden FloorGetById henter en etage ved angivelse af etagens id. Det kan både være en id for en stamentitet eller en id for en (S) eller (N) entitet. De i afsnit og viste tegninger viser metodens input og output struktur. Snitfladebeskrivelse Side 206 af 310

207 Metoden har etagens id og en kommunekode som input. Strukturen angiver, at begge input felter er obligatoriske, dvs. skal udfyldes, når operationen FloorGetById kaldes. Metoden leverer den ønskede etage samt et resultat for metode kaldet tilbage. Etagen leveres i strukturen FloorStructure. Alle typer etager leveres tilbage ved kald by id, dvs. eksisterende etager i stamdelen samt sager, herunder ændringer ((S)OPG entiteter) og nybyggerier ((N)OPG entiteter). Når IncludeHistoricIndicator er lig med true, leveres også udgåede stametager. I følgende situatoner fejler metodekaldet: - Ved kald med en placeholder id (se også afsnit ). - Ved kald med en ukendt id. Der henvises til afsnit 4.8 for relevante returkoder FloorGetByIdRequestStructure FloorGetByIdRequestStructure Feltnavn i OIOXML navn Kommentar Etage ID FloorUniversalIdentifier Feltet skal udfyldes med id en for den etage man ønsker at hente. Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode. Medtag historik IncludeHistoricIndicator Indikatoren skal være true for at hente en udgået stam-etage med status 2. Se også afsnit FloorGetByIdResponseStructure Snitfladebeskrivelse Side 207 af 310

208 FloorGetByIdResponseStructure Feltnavn i OIOXML navn Kommentar FloorStructure Den hentede etage (hvis den fidnes), se afsnit 5.4. ReturnMessage Resultatet for metode kaldet, se afsnit FloorGetByIds Metoden FloorGetByIds henter et antal etager ved angivelse af deres id er. Det kan både være id er for stamentiteter eller id er for (S) eller (N) entiteter. De i afsnit og viste tegninger viser metodens input og output struktur. Metoden leverer de ønskede etager samt et resultat for metode kaldet tilbage. Etagerne leveres i strukturen FloorStructure. Der leveres én besked pr. sendt etage id tilbage. Som beskrevet under søgningen (afsnit 15.2) kan man ved hjælp af indikatoren ResultTypeCode angive, om man ønsker at få leveret hele strukturen FloorStructure tilbage eller om man ønsker kun at få leveret en mindre del af strukturen. Ellers gælder det samme som for metoden GetById FloorGetByIdsRequestStructure FloorGetByIdsRequestStructure Feltnavn i OIOXML navn Kommentar Etage ID FloorUniversalIdentifier Feltet skal udfyldes med id er for de etager man ønsker at hente. Der skal angives mindst en id. Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode. ResultTypeCode Indikator, som angiver, om man ønsker at få Snitfladebeskrivelse Side 208 af 310

209 FloorGetByIdsRequestStructure Feltnavn i OIOXML navn Kommentar etagerne leveret med alle deres understrukturer eller om man ønsker kun at få leveret de vigtigste oplysninger om etagerne(se afsnit 15.2). Hvis indikatoren ikke angives, er den pr. default true. True betyder at hele strukturen leveres tilbage. Medtag historik IncludeHistoricIndicator Indikatoren skal være true for også at hente udgåede stam-etager med status 2. Se også afsnit FloorGetByIdsResponseStructure FloorGetByIdsResponseStructure Feltnavn i OIOXML navn Kommentar FloorStructure ReturnMessage De hentede etager, se afsnit 5.4. Resultat for metode kald, se afsnit 4.8. Der leveres én Return- Message pr. etage FloorGet Metoden FloorGet henter en etage ved angivelse af et ejendomsnummer, et bygningsnummer og en etagebetegnelse. Metoden leverer kun stamentiteter og nybyggerier ((N)ETA entiteter) tilbage, og ikke ændringer til stamentiteter ((S)ETA entiteter). En kombination af ejendomsnummer, bygningsnummer og etagebetegnelse er entydig. Det betyder, at get metoden for opgange altid returner højst en stamentitet (status 1). I nogle sjældne tilfælde kan der forekomme en nybyggeri-etage med samme identifikation som en stamentitet. I givet fald skal der dog eksistere en nedrivningssag på stam-etagen. Get metoden returner i disse sjældne tilfælde både den eksisterende stamentitet og nybyggeriet. De i afsnit og viste tegninger viser metodens input og output struktur. Snitfladebeskrivelse Side 209 af 310

210 Etagen/Etagerne leveres i strukturen FloorStructure. I følgende situatoner fejler metodekaldet: - Hvis der ikke findes en etage med de angivne parametre Der henvises til afsnit 4.8 for relevante returkoder FloorGetRequestStructure FloorGetRequestStructure Feltnavn i OIOXML navn Kommentar Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode. Ejendomsnummer MunicipalRealPropertyIdentifier Feltet skal udfyldes med et ejendomsnummer. Bygningsnummer BuildingIdentifier Feltet skal udfyldes med et bygningsnummer. Etagebetegnelse FloorPhysicalIdentifier Feltet skal udfyldes med etagebetegnelse FloorGetResponseStructure FloorGetResponseStructure Feltnavn i OIOXML navn Kommentar FloorStructure Den (eller de) hentede etage(r), se afsnit 5.4. ReturnMessage Resultatet for metode kaldet, se afsnit FloorGetByBuildingId Metoden FloorGetByBuildingId henter etager hørende til en bygning. Metoden skal kaldes med en bygning id for en stamentitet. Hvis man sætter Inclu- Snitfladebeskrivelse Side 210 af 310

211 dehistoricindicator til true, vil metoden også kunne kaldes med en id for en udgået bygning. Metoden returnerer alle stamentiteter og eventuelle nybyggeri etager under en bygning. Hvis man sætter IncludeHistoricIndicator til true, vil metoden også levere udgåede stamentiteter. De i afsnit og viste tegninger viser metodens input og output struktur. For at hente etager til en bygning, kalder man metoden med bygningens id. For at hente underliggende etager til en stambygning kalder man metoden med stambygningens id. For at hente underliggende entiteter til et nybyggeri, skal man kalde metoden med nybyggerietes placeholder og ikke med nybyggeriets id. Den eller de opgange/indgange leveres i strukturen FloorStructure. I følgende situatoner fejler metodekaldet: - Ved kald med en id for et nybyggeri - Ved kald med en ukendt id Der henvises til afsnit 4.8 for relevante returkoder FloorGetByBuildingIdRequestStructure FloorGetByBuildingIdRequestStructure Feltnavn i OIOXML navn Kommentar Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode. Bygning id BuildingUniversalIdentifier Feltet skal udfyldes med bygningens id. Medtag historik IncludeHistoricIndicator Indikatoren skal være true for at hente udgåede entiteter med status 2. Se også afsnit 3.7. Snitfladebeskrivelse Side 211 af 310

212 FloorGetByBuildingIdResponseStructure FloorGetByBuildingIdResponseStructure Feltnavn i OIOXML navn Kommentar FloorStructure Den eller de etager, se afsnit 5.4. ReturnMessage Resultatet for metode kaldet, se afsnit FloorGetByParentId Metoden FloorGetByParentId henter sager (dvs. etager med status 3) hørende til en eksisterende etage i stam. De i afsnit og viste tegninger viser metodens input og output struktur. Den (eller de) sager/etager leveres i strukturen FloorStructure. Strukturen EntityBuildingCaseInformation vil altid være udfyldt for disse etager idet de har status 3. For at hente sager til en eksisterende stamentitet kalder man metoden med stamentitetens id. For at hente sager til et nybyggeri, skal man kalde metoden med nybyggerietes placeholder og ikke med nybyggeriets id. Når man kalder FloorGetByParentId metoden med en placeholder id for et nybyggeri vil man få selve nybyggeriet (og eventuelle sager på selve nybyggeriet) leveret retur. I følgende situatoner fejler metodekaldet: - Hvis der ikke findes sager til den angivne stamid - Ved kald med en id for et nybyggeri - Ved kald med en ukendt id Der henvises til afsnit 4.8 for relevante returkoder FloorGetByParentIdRequestStructure FloorGetByParentIdRequestStructure Feltnavn i OIOXML navn Kommentar Snitfladebeskrivelse Side 212 af 310

213 FloorGetByParentIdRequestStructure Feltnavn i OIOXML navn Kommentar Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode. Etage stam id FloorParentReference Feltet skal udfyldes med id en for en etage i stamdelen FloorGetByParentIdResponseStructure FloorGetByParentIdResponseStructure Feltnavn i OIOXML navn Kommentar FloorStructure Den eller de hentede etager, se afsnit 5.4. ReturnMessage Resultatet for metode kaldet, se afsnit FloorCreate Metoden FloorCreate opretter en etage ved angivelse af attributterne for den etage man ønsker at oprette. De i afsnit og viste tegninger viser metodens input og output struktur. Etagen sendes som input til metoden i strukturen FloorStructure. Som resultat for metoden returneres den oprettede etage (hvis det lykkedes) i strukturen "FloorStructure. For at kunne oprette en etage i stam eller som nybyggeri skal der som minimum angives følgende felter: Kommunenummer Bygning id Etagebetegnelse Disse felter ligger i understrukturen FloorKeys, dvs. at denne understruktur altid skal sendes med når man opretter en etage. For sager skal der angives: Sagstype (Nybyggeri, nedrivning eller til/ombygning) Etage stam id (for ændringer til eksisterende etage) Byggesag id (den byggesag sagen skal høre til) Snitfladebeskrivelse Side 213 af 310

214 FloorCreateRequestStructure FloorCreateRequestStructure Feltnavn i OIOXML navn Kommentar FloorStructure Den etage, som man ønsker at oprette, se afsnit 5.4. IgnoreWarningIndicator Se afsnit 4.1. printenableindicator Se afsnit FloorCreateResponseStructure FloorCreateResponseStructure Feltnavn i OIOXML navn Kommentar FloorStructure Den oprettede etage, se afsnit 5.4. ReturnMessage Resultatet for metode kaldet, se afsnit FloorUpdate Metoden FloorUpdate opdaterer en etage ved angivelse af de attributter man ønsker at opdatere. De i afsnit og viste tegninger viser metodens input og output struktur. For at opdatere en etage, skal der angives id en for den etage man ønsker at opdatere. Det skal være en id til en stamentitet, et nybyggeri eller en (S)entitet, dvs. en ændring til en eksisterende etage i stam. Der angives endvidere det eller de felter man ønsker at opdatere ved hjælp af strukturen "FloorStructure. Snitfladebeskrivelse Side 214 af 310

215 Som resultat for metoden returneres den opdaterede etage i strukturen "FloorStructure. For at kunne opdatere en etage skal der som minimum angives følgende felter: Etage id Kommunenummer RecordChangeDateTime Bortset fra RecordChangeDateTime ligger disse felter i understrukturen FloorKeys, dvs. at denne understruktur altid skal sendes med ved en opdatering. Der henvises til afsnit 4.4 for en beskrivelse af den implementerede opdateringsmekanisme og til kapitel 5 for en beskrivelse for key strukturen FloorUpdateRequestStructure FloorUpdateRequestStructure Feltnavn i OIOXML navn Kommentar FloorStructure Den etage, som man ønsker at opdatere, se afsnit 5.4. IgnoreWarningIndicator Se afsnit 4.1. printenableindicator Se afsnit FloorUpdateResponseStructure FloorUpdateResponseStructure Feltnavn i OIOXML navn Kommentar FloorStructure Den opdaterede etage, se afsnit 5.4. ReturnMessage Resultatet for metode kaldet, se afsnit FloorDelete Metoden FloorDelete sletter en etage. Snitfladebeskrivelse Side 215 af 310

216 De i afsnit og viste tegninger viser metodens input og output struktur. En etage slettes ved angivelse af id en for den etage man ønsker at slette. Det skal være en id til en stamentitet, et nybyggeri eller en (S)entitet, dvs. en ændring til en eksisterende etage i stam. En etage i stam (eller et nybyggeri) kan kun slettes, hvis der ikke findes en tilhørende sagsentitet. Når man sletter en etage, sletter man også de underliggende rum og enheder. Dette gælder både stam- og sagsentiteter. I følgende situatoner fejler metodekaldet: - Ved kald med en id for en allerede udgået etage. - Ved kald med en placeholder id (se også afsnit ). - Ved kald med en ukendt id. - Ved kald med en id for en stamentitet (eller nybyggeri) som har en sag tilknyttet Der henvises til afsnit 4.8 for relevante fejlkoder FloorDeleteRequestStructure FloorDeleteRequestStructure Feltnavn i OIOXML navn Kommentar Etage ID FloorUniversalIdentifier Feltet skal altid udfyldes med id en for den etageman ønsker at slette. Kommunekode MunicipalityCode Feltet skal altid udfyldes med 4 cifren kommunekode, fx Tidsstempel RecordChangeDateTime Se afsnit 4.6. IgnoreWarningIndicator Se afsnit 4.1. printenableindicator Se afsnit 4.2. Gyldighedsdato AssessmentChangedDate Se afsnit 4.3. Snitfladebeskrivelse Side 216 af 310

217 FloorDeleteResponseStructure FloorDeleteResponseStructure Feltnavn i OIOXML navn Kommentar ReturnMessage Resultatet for metode kaldet, se afsnit FloorDeleteHistoric Metoden FloorDeleteHistoric sletter en etage fra historikken. De i afsnit og viste tegninger viser metodens input og output struktur. En etage slettes ved angivelse af id en for den etage man ønsker at slette fra historikken. Det skal være en id til en udgået stamentitet. Når man sletter en etage fra historikken, sletter man også de underliggende rum og enhede samt afsluttede sagsentiteter fra histroikken FloorDeleteHistoricRequestStructure FloorDeleteHistoricRequestStructure Feltnavn i OIOXML navn Kommentar Etage ID FloorUniversalIdentifier Feltet skal altid udfyldes med id en for den etageman ønsker at slette fra historikken. Kommunekode MunicipalityCode Feltet skal altid udfyldes med 4 cifren kommunekode, fx FloorDeleteHistoricResponseStructure FloorDeleteHistoricResponseStructure Snitfladebeskrivelse Side 217 af 310

218 Feltnavn i OIOXML navn Kommentar ReturnMessage Resultatet for metode kaldet, se afsnit 4.8. Snitfladebeskrivelse Side 218 af 310

219 10. Metoder til entitet enhed Der findes 10 metoder til at hente, opdatere, oprette og slette bygninger: BuildingUnitGetById henter en enhed ved angivelse af dens id BuildingUnitGetByIds henter et antal enheder ved angivelse af deres id er BuildingUnitGet - henter en (eller flere) enheder ved angivelse af et ejendomsnummer, et bygningsnummer, en vejkode, et husnummer, en etagebetegnelse og et side/dørnummer. BuildingUnitGetByEntranceId - henter en eller flere enheder til en opgang/indgang BuildingUnitGetByFloorId - henter en eller flere enheder til en etage BuildingUnitGetByParentId - henter en eller flere sager (ændringer til en eksisterende enhed) ved angivelse af en stam enhed id. BuildingUnitCreate - opretter en ny enhed BuildingUnitUpdate - opdaterer en enhed BuildingUnitDelete - sletter en enhed BuildingUnitDeleteHistoric - sletter en enhed fra historikken Metoderne er beskrevet i de 10 næste afsnit. En enhed er altid beskrevet i strukturen BuildingUnitStructure, som beskriver en enhed i alle situationer, både når en enhed leveres som input til en metode og når det leveres som output. Strukturen er beskrevet i afsnit 5.5. En enhed er altid knyttet til en etage og til en opgang/indgang. Etagen og opgang/indgangen hører den en og samme bygning. På den måde er en enhed altid entydig knyttet til en bygning. For hver enhed kan der findes et antal underliggende rum. Disse vil ikke blive leveret sammen med enheden, men skal hentes med den respektive metode under rum: o RoomGetByBuildingUnitId En enhed med status 1 er en gældende enhed i stamdelen. En enhed med status 3 er en enhed under sagsbehandling. Dette kan enten være et nybyggeri (N)ENH eller en ændring til en eksisterende enhed (S)ENH. En enhed med status 3 vil være en del af en byggesag. I givet fald vil strukturen EntityBuildingCaseInformation (se afsnit ) være udfyldt. Resultatet for alle metode kald leveres tilbage i en struktur kaldt ReturnMessage. Strukturen er beskrevet i afsnit 4.8. Snitfladebeskrivelse Side 219 af 310

220 10.1. BuildingUnitGetById Metoden BuildingUnitGetById henter en enhed ved angivelse af id en for enheden. Det kan både være en id for en stamentitet eller en id for en (S) eller (N) entitet. De i afsnit og viste tegninger viser metodens input og output struktur. Metoden har id en for enheden og en kommunekode som input. Strukturen angiver, at begge input felter er obligatoriske, dvs. skal udfyldes, når operationen BuildingUnitGetById kaldes. Metoden leverer den ønskede enhed samt et resultat for metode kaldet tilbage. Enheden leveres i strukturen BuildingUnitStructure. Alle typer enheder leveres tilbage ved kald by id, dvs. eksisterende enheder i stamdelen samt sager, herunder ændringer ((S)ENH entiteter) og nybyggerier ((N)ENH entiteter). I følgende situatoner fejler metodekaldet: - Ved kald med en placeholder id (se også afsnit ). - Ved kald med en ukendt id. Der henvises til afsnit 4.8 for relevante returkoder BuildingUnitGetByIdRequestStructure BuildingUnitGetByIdRequestStructure Feltnavn i OIOXML navn Kommentar Enhed ID Når IncludeHistoricIndicator er lig med true, leveres også udgåede stamenheder. BuildingUnitUniversalIdentifier Feltet skal udfyldes med id en for den enhed, som man ønsker at hente. Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode. Medtag historik IncludeHistoricIndicator Indikatoren skal være true for at hente en udgået stam-enhed med status 2. Se også afsnit BuildingUnitGetByIdResponseStructure Snitfladebeskrivelse Side 220 af 310

221 BuildingUnitGetByIdResponseStructure Feltnavn i OIOXML navn Kommentar BuildingUnitStructure Den hentede enhed (hvis den findes), se afsnit 5.5. ReturnMessage Resultatet for metode kaldet, se afsnit BuildingUnitGetByIds Metoden BuildingUnitGetByIds henter et antal enheder ved angivelse af deres id er. Det kan både være id er for stamentiteter eller id er for (S) eller (N) entiteter. De i afsnit og viste tegninger viser metodens input og output struktur. Metoden leverer de ønskede enheder samt et resultat for metode kaldet tilbage. Enhederne leveres i strukturen BuildingUnitStructure. Der leveres én besked pr. sendt enhed id tilbage. Som beskrevet under søgningen (afsnit 15.2) kan man ved hjælp af indikatoren ResultTypeCode angive, om man ønsker at få leveret hele strukturen BuildingUnitStructure tilbage eller om man ønsker kun at få leveret en mindre del af strukturen. Ellers gælder det samme som for metoden GetById BuildingUnitGetByIdsRequestStructure BuildingUnitGetByIdsRequestStructure Snitfladebeskrivelse Side 221 af 310

222 Feltnavn i OIOXML navn Kommentar Enhed ID BuildingUnitUniversalIdentifier Feltet skal udfyldes med id er for de enheder man ønsker at hente. Der skal angives mindst en id. Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode. ResultTypeCode Indikator, som angiver, om man ønsker at få enhederne leveret med alle deres understrukturer eller om man ønsker kun at få leveret de vigtigste oplysninger om enhederne(se afsnit 15.2). Hvis indikatoren ikke angives, er den pr. default true. True betyder at hele strukturen leveres tilbage. Medtag historik IncludeHistoricIndicator Indikatoren skal være true for også at hente en udgåede stam-enheder med status 2. Se også afsnit BuildingUnitGetByIdsResponseStructure BuildingUnitGetByIdsResponseStructure Feltnavn i OIOXML navn Kommentar BuildingUnitStructure ReturnMessage De hentede enheder, se afsnit 5.5. Resultat for metode kald, se afsnit 4.8. Der leveres én Return- Message pr. enhed BuildingUnitGet Metoden BuildingUnitGet henter en enhed ved angivelse af en brugervendt nøgle. Den brugervendte nøgle for en enhed er kommunenummer, ejendomsnummer, bygningsnummer, vejkode, husnummer, etagebetegnelse og side/dørnummer. De i afsnit og viste tegninger viser metodens input og output struktur. Snitfladebeskrivelse Side 222 af 310

223 Den brugervendte nøgler er entydig. Det betyder, at get metoden for enheder altid returner højst en stamentitet (status 1). I nogle sjældne tilfælde kan der forekomme en nybyggeri-enhed med samme identifikation som en stamentitet. I givet fald skal der dog eksistere en nedrivningssag på stam-enheden. Get metoden returner i disse sjældne tilfælde både den eksisterende stamentitet og nybyggeriet. Enheden/enhederne leveres i strukturen BuildingUnitStructure. I følgende situatoner fejler metodekaldet: - Hvis der ikke findes en enhed med de angivne parametre Der henvises til afsnit 4.8 for relevante returkoder BuildingUnitGetRequestStructure BuildingUnitGetRequestStructure Feltnavn i OIOXML navn Kommentar Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode. Ejendomsnummer MunicipalRealPropertyIdentifier Feltet skal udfyldes med et ejendomsnummer. Bygningsnummer BuildingIdentifier Feltet skal udfyldes med et bygningsnummer. Vejkode (enhedsadresse) StreetCode Feltet skal udfyldes med vejkoden hørende til enhedsadressen. Husnummer og husbogstav (enhedsadresse) StreetBuildingIdentifier Feltet skal udfyldes med husnummer/husbog-stav hørende til enhedsadressen. (enhedsadres- Etagebetegnelse se) FloorIdentifier Feltet skal udfyldes med etagebetegnelse i enhedsadressen (kan være blank, derfor er feltet optional) Side/dørnummer SuiteIdentifier Feltet skal udfyldes med side/dørnummer (kan være blank, derfor er feltet optional) Snitfladebeskrivelse Side 223 af 310

224 BuildingUnitGetResponseStructure BuildingUnitGetResponseStructure Feltnavn i OIOXML navn Kommentar BuildingUnitStructure Den (eller de)hentede enhed(er), se afsnit 5.5. ReturnMessage Resultatet for metode kaldet, se afsnit BuildingUnitGetByEntranceId Metoden BuildingUnitGetByEntranceId henter enheder hørende til en opgang/indgang. Metoden skal kaldes med en opgang id for en stamentitet. Hvis man sætter IncludeHistoricIndicator til true, vil metoden også kunne kaldes med en id for en udgået opgang. Metoden returnerer alle stamentiteter og eventuelle nybyggeri enheder under en opgang. Hvis man sætter IncludeHistoricIndicator til true, vil metoden også levere udgåede stamentiteter. De i afsnit og viste tegninger viser metodens input og output struktur. For at hente enheder til en opgang, kalder man metoden med opgangens id. For at hente underliggende enheder til en stamopgang kalder man metoden med stamopgangens id. For at hente underliggende entiteter til et nybyggeri, skal man kalde metoden med nybyggerietes placeholder og ikke med nybyggeriets id. Den eller de enheder leveres i strukturen BuildingUnitStructure. I følgende situatoner fejler metodekaldet: - Ved kald med en id for et nybyggeri - Ved kald med en ukendt id Der henvises til afsnit 4.8 for relevante returkoder. Snitfladebeskrivelse Side 224 af 310

225 BuildingUnitGetByEntranceIdRequestStructure BuildingUnitGetByEntranceIdRequestStructure Feltnavn i OIOXML navn Kommentar Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode. Opgang/indgang id EntranceUniversalIdentifier Feltet skal udfyldes med id for opgangen/indgangen. Medtag historik IncludeHistoricIndicator Indikatoren skal være true for at hente udgåede entiteter med status 2. Se også afsnit BuildingUnitGetByEntranceIdResponseStructure BuildingUnitGetByEntranceIdResponseStructure Feltnavn i OIOXML navn Kommentar BuildingUnitStructure Den eller de enheder, se afsnit 5.5. ReturnMessage Resultatet for metode kaldet, se afsnit BuildingUnitGetByFloorId Metoden BuildingUnitGetByFloorId henter enheder hørende til en etage. Metoden skal kaldes med en etage id for en stamentitet. Hvis man sætter IncludeHistoricIndicator til true, vil metoden også kunne kaldes med en id for en udgået etage. Metoden returnerer alle stamentiteter og eventuelle nybyggeri enheder under en etage. Hvis man sætter IncludeHistoricIndicator til true, vil metoden også levere udgåede stamentiteter. De i afsnit og viste tegninger viser metodens input og output struktur. Snitfladebeskrivelse Side 225 af 310

226 For at hente enheder til en etage, kalder man metoden med etagens id. For at hente underliggende enheder til en stametage kalder man metoden med stametagens id. For at hente underliggende entiteter til et nybyggeri, skal man kalde metoden med nybyggerietes placeholder og ikke med nybyggeriets id. Den eller de enheder leveres i strukturen BuildingUnitStructure. I følgende situatoner fejler metodekaldet: - Ved kald med en id for et nybyggeri - Ved kald med en ukendt id Der henvises til afsnit 4.8 for relevante returkoder BuildingUnitGetByFloorIdRequestStructure BuildingUnitGetByFloorIdRequestStructure Feltnavn i OIOXML navn Kommentar Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode. Etage id FloorUniversalIdentifier Feltet skal udfyldes med id for etagen. Medtag historik IncludeHistoricIndicator Indikatoren skal være true for at hente udgåede entiteter med status 2. Se også afsnit BuildingUnitGetByFloorIdResponseStructure BuildingUnitGetByFloorIdResponseStructure Feltnavn i OIOXML navn Kommentar BuildingUnitStructure Den eller de enheder, se afsnit 5.5. Snitfladebeskrivelse Side 226 af 310

227 BuildingUnitGetByFloorIdResponseStructure Feltnavn i OIOXML navn Kommentar ReturnMessage Resultatet for metode kaldet, se afsnit BuildingUnitGetByParentId Metoden BuildingUnitGetByParentId henter sager (dvs. etager med status 3) hørende til en eksisterende enhed i stam. De i afsnit og viste tegninger viser metodens input og output struktur. Den (eller de) sager/etager leveres i strukturen BuildingUnitStructure. Strukturen EntityBuildingCaseInformation vil altid være udfyldt for disse enheder idet de har status 3. For at hente sager til en eksisterende stamentitet kalder man metoden med stamentitetens id. For at hente sager til et nybyggeri, skal man kalde metoden med nybyggerietes placeholder og ikke med nybyggeriets id. Når man kalder BuildingUnitGetByParentId metoden med en placeholder id for et nybyggeri vil man få selve nybyggeriet (og eventuelle sager på selve nybyggeriet) leveret retur. I følgende situatoner fejler metodekaldet: - Hvis der ikke findes sager til den angivne stamid - Ved kald med en ukendt id - Ved kald med en id for et nybyggeri Der henvises til afsnit 4.8 for relevante returkoder BuildingUnitGetByParentIdRequestStructure BuildingUnitGetByParentIdRequestStructure Feltnavn i OIOXML navn Kommentar Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode. Enhed stam id BuildingUnitParentReference Feltet skal udfyldes med id en for en enhed i stamdelen. Snitfladebeskrivelse Side 227 af 310

228 BuildingUnitGetByParentIdResponseStructure BuildingUnitGetByParentIdResponseStructure Feltnavn i OIOXML navn Kommentar BuildingUnitStructure Den eller de hentede enheder, se afsnit 5.5. ReturnMessage Resultatet for metode kaldet, se afsnit BuildingUnitCreate Metoden BuildingUnitCreate opretter en enhed ved angivelse af attributterne for den enhed man ønsker at oprette. De i afsnit og viste tegninger viser metodens input og output struktur. Enheden sendes som input til metoden i strukturen BuildingUnitStructure. Som resultat for metoden returneres den oprettede enhed (hvis det lykkedes) i strukturen "BuildingUnitStructure. For at kunne oprette en enhed i stam eller som nybyggeri skal der som minimum angives følgende felter: Kommunenummer Etage id Opgang id Disse felter ligger i understrukturen BuildingUnitKeys, dvs. at denne understruktur altid skal sendes med når man opretter en enhed. For sager skal der yderligere angives: Sagstype (Nybyggeri, nedrivning eller til/ombygning) Opgang/indgang stam id (for ændringer til eksisterende enhed) Byggesag id (den byggesag sagen skal høre til) BuildingUnitCreateRequestStructure Snitfladebeskrivelse Side 228 af 310

229 BuildingUnitCreateRequestStructure Feltnavn i OIOXML navn Kommentar BuildingUnitStructure Enheden, som man ønsker at oprette, se afsnit 5.5. IgnoreWarningIndicator Se afsnit 4.1. printenableindicator Se afsnit BuildingUnitCreateResponseStructure BuildingUnitCreateResponseStructure Feltnavn i OIOXML navn Kommentar BuildingUnitStructure Den oprettede enhed, se afsnit 5.5. ReturnMessage Resultatet for metode kaldet, se afsnit BuildingUnitUpdate Metoden BuildingUnitUpdate opdaterer en enhed ved angivelse af de attributter man ønsker at opdatere. De i afsnit og viste tegninger viser metodens input og output struktur. For at opdatere en enhed, skal der angives id en for enheden. Der angives endvidere det eller de felter man ønsker at opdatere ved hjælp af strukturen "BuildingUnitStructure. Som resultat for metoden returneres den opdaterede enhed i strukturen "BuildingUnitStructure. For at kunne opdatere en enhed skal der som minimum angives følgende felter i enhedsstrukturen: RecordChangeDateTime Kommunenummer Enhed id Bortset fra RecordChangeDateTime ligger disse felter i understrukturen BuildingUnitKeys, dvs. at denne understruktur altid skal sendes med ved en opdatering. Snitfladebeskrivelse Side 229 af 310

230 Der henvises til afsnit 4.4 for en beskrivelse af den implementerede opdateringsmekanisme og til kapitel 5 for en beskrivelse for key strukturen. Der henvises til afsnit 4.4 for en beskrivelse af den implementerede opdateringsmekanisme og til kapitel 5 for en beskrivelse for key strukturen BuildingUnitUpdateRequestStructure BuildingUnitUpdateRequestStructure Feltnavn i OIOXML navn Kommentar BuildingUnitStructure Enheden, som man ønsker at opdatere, se afsnit 5.5. IgnoreWarningIndicator Se afsnit 4.1. printenableindicator Se afsnit 4.2. Gyldighedsdato AssessmentChangedDate Se afsnit BuildingUnitUpdateResponseStructure BuildingUnitUpdateResponseStructure Feltnavn i OIOXML navn Kommentar BuildingUnitStructure Dent opdaterede enhed, se afsnit 5.5. ReturnMessage Resultatet for metode kaldet, se afsnit BuildingUnitDelete Metoden BuildingUnitDelete sletter en enhed. De i afsnit og viste tegninger viser metodens input og output struktur. En enhed slettes ved angivelse af dens id. Det skal være en id til en stamentitet, et nybyggeri eller en (S)entitet, dvs. en ændring til en eksisterende enhed i stam. En enhed i stam (eller et nybyggeri) kan kun slettes, hvis der ikke findes en tilhørende sagsentitet. Snitfladebeskrivelse Side 230 af 310

231 Når man sletter en enhed, sletter man også de underliggende rum. Dette gælder både stam- og sagsentiteter. I følgende situatoner fejler metodekaldet: - Ved kald med en id for en allerede udgået enhed. - Ved kald med en placeholder id (se også afsnit ). - Ved kald med en ukendt id. - Ved kald med en id for en stamentitet (eller nybyggeri) som har en sag tilknyttet Der henvises til afsnit 4.8 for relevante fejlkoder BuildingUnitDeleteRequestStructure BuildingUnitDeleteRequestStructure Feltnavn i OIOXML navn Kommentar Enhed ID BuildingUnitUniversalIdentifier Feltet skal altid udfyldes med enhedens id. Kommunekode MunicipalityCode Feltet skal altid udfyldes med 4 cifren kommunekode, fx Tidsstempel RecordChangeDateTime Se afsnit 4.6. IgnoreWarningIndicator Se afsnit 4.1. printenableindicator Se afsnit 4.2. Gyldighedsdato AssessmentChangedDate Se afsnit BuildingUnitDeleteResponseStructure BuildingUnitDeleteResponseStructure Feltnavn i OIOXML navn Kommentar ReturnMessage Resultatet for metode kaldet, se afsnit 4.8. Snitfladebeskrivelse Side 231 af 310

232 BuildingUnitDeleteHistoric Metoden BuildingUnitDeleteHistoric sletter en enhed fra historikken. De i afsnit og viste tegninger viser metodens input og output struktur. En enhed slettes fra historikken ved angivelse af dens id. Det skal være en id til en udgået stamentitet. Når man sletter en enhed fra historikken, sletter man også de underliggende rum og afsluttede sagsentiteter fra historikken BuildingUnitDeleteHistoricRequestStructure BuildingUnitDeleteHistoricRequestStructure Feltnavn i OIOXML navn Kommentar Enhed ID BuildingUnitUniversalIdentifier Feltet skal altid udfyldes med enhedens id. Kommunekode MunicipalityCode Feltet skal altid udfyldes med 4 cifren kommunekode, fx BuildingUnitDeleteHistoricResponseStructure BuildingUnitHistoricDeleteResponseStructure Feltnavn i OIOXML navn Kommentar ReturnMessage Resultatet for metode kaldet, se afsnit 4.8. Snitfladebeskrivelse Side 232 af 310

233 11. Metoder til entitet teknisk anlæg Der findes 10 metoder til at hente, opdatere, oprette og slette tekniske anlæg: TechnicalInstallationGetById henter et teknisk anlæg ved angivelse af dens id TechnicalInstallationGetByIds henter et antal tekniske anlæg ved angivelse af deres id er TechnicalInstallationGet - henter en (eller flere) teknisk anlæg ved angivelse af et ejendomsnummer og et anlægsnummer TechnicalInstallationGetBySiteId - henter en eller flere tekniske anlæg til en grund TechnicalInstallationGetByBuildingId - henter en eller flere tekniske anlæg til en grund TechnicalInstallationGetByParentId - henter en eller flere sager (ændringer til et eksisterende teknisk anlæg) ved angivelse af id for et et teknisk anlæg i stam TechnicalInstallationCreate - opretter et teknisk anlæg TechnicalInstallationUpdate - opdaterer et teknisk anlæg TechnicalInstallationDelete - sletter et teknisk anlæg TechnicalInstallationDeleteHistoric - sletter et teknisk anlæg fra historikken Metoderne er beskrevet i de 10 næste afsnit. Et teknisk anlæg er altid beskrevet i strukturen TechnicalInstallationStructure, som beskriver et teknisk anlæg i alle situationer, både når et teknisk anlæg leveres som input til en metode og når det leveres som output. Strukturen er beskrevet i afsnit 5.6. Et teknisk anlæg er altid knyttet til en matrikel og derigennem hører den altid til en grund. Nogle gange er et teknisk anlæg også knyttet til en bygning. I givet fald skal denne bygning høre til samme matrikel som det tekniske anlæg. En matrikel eller en bygning kan have tilknyttet nul, en eller flere tekniske anlæg. Et teknisk anlæg med status 1 er et teknisk anlæg i stamdelen. Et teknisk anlæg med status 3 er et teknisk anlæg under sagsbehandling. Dette kan enten være et nybyggeri (N)TEK eller en ændring til et eksisterende teknisk anlæg (S)TEK. Et teknisk anlæg med status 3 er en del af en byggesag. I givet fald vil strukturen EntityBuildingCaseInformation (se afsnit ) være udfyldt. Et teknisk anlæg har ingen underliggende entiteter. Resultatet for alle metode kald leveres tilbage i en struktur kaldt ReturnMessage. Strukturen er beskrevet i afsnit TechnicalInstallationGetById Metoden TechnicalInstallationGetById henter et teknisk anlæg ved angivelse af id en for det teknsike anlæg. Det kan både være en id for en stamentitet eller en id for en (S) eller (N) entitet. Snitfladebeskrivelse Side 233 af 310

234 De i afsnit og viste tegninger viser metodens input og output struktur. Metoden har id en for det tekniske anlæg og en kommunekode som input. Strukturen angiver, at begge input felter er obligatoriske, dvs. skal udfyldes, når operationen TechnicalInstallationGetById kaldes. Metoden leverer det ønskede tekniske anlæg samt et resultat for metode kaldet tilbage. Det tekniske anlæg leveres i strukturen TechnicalInstallationStructure. Alle typer tekniske anlæg leveres tilbage ved kald by id, dvs. eksisterende tekniske anlæg i stamdelen samt sager, herunder ændringer ((S)TEK entiteter) og nybyggerier ((N)TEK entiteter). Når IncludeHistoricIndicator er lig med true, leveres også udgåede stamtekniske anlæg. I følgende situatoner fejler metodekaldet: - Ved kald med en placeholder id (se også afsnit ). - Ved kald med en ukendt id. Der henvises til afsnit 4.8 for relevante returkoder TechnicalInstallationGetByIdRequestStructure TechnicalInstallationGetByIdRequestStructure Feltnavn i OIOXML navn Kommentar Teknisk anlæg ID TechnicalInstallationUniversalIdentifier Feltet skal udfyldes med id en for det tekniske anlæg man ønsker at hente. Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode. Medtag historik IncludeHistoricIndicator Indikatoren skal være true for at hente et udgået stam-teknisk anlæg med status 2. Se også afsnit 3.7. Snitfladebeskrivelse Side 234 af 310

235 TechnicalInstallationGetByIdResponseStructure TechnicalInstallationGetByIdResponseStructure Feltnavn i OIOXML navn Kommentar TechnicalInstallationStructure Det hentede tekniske anlæg (hvis den findes), se afsnit 5.6. ReturnMessage Resultatet for metode kaldet, se afsnit TechnicalInstallationGetByIds Metoden TechnicalInstallationGetByIds henter et antal tekniske anlæg ved angivelse af deres id er. Det kan både være id er for stamentiteter eller id er for (S) eller (N) entiteter. De i afsnit og viste tegninger viser metodens input og output struktur. Metoden leverer de ønskede tekniske anlæg samt et resultat for metode kaldet tilbage. De tekniske anlæg leveres i strukturen TechnicalInstallationStructure. Der leveres én besked pr. sendt teknisk anlæg id tilbage. Som beskrevet under søgningen (afsnit 15.2) kan man ved hjælp af indikatoren ResultTypeCode angive, om man ønsker at få leveret hele strukturen TechnicalInstallationStructure tilbage eller om man ønsker kun at få leveret en mindre del af strukturen. Ellers gælder det samme som for metoden GetById TechnicalInstallationGetByIdsRequestStructure Snitfladebeskrivelse Side 235 af 310

236 TechnicalInstallationGetByIdsRequestStructure Feltnavn i OIOXML navn Kommentar Teknisk anlæg ID TechnicalInstallationUniversalIdentifier Feltet skal udfyldes med id er for de tekniske anlæg man ønsker at hente. Der skal angives mindst en id. Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode. ResultTypeCode Indikator, som angiver, om man ønsker at få de tekniske anlæg leveret med alle deres understrukturer eller om man ønsker kun at få leveret de vigtigste oplysninger om de tekniske anlæg(se afsnit 15.2). Hvis indikatoren ikke angives, er den pr. default true. True betyder at hele strukturen leveres tilbage. Medtag historik IncludeHistoricIndicator Indikatoren skal være true for også at hente udgåede stamtekniske anlæg med status 2. Se også afsnit TechnicalInstallationGetByIdsResponseStructure TechnicalInstallationGetByIdsResponseStructure Feltnavn i OIOXML navn Kommentar TechnicalInstallationStructure ReturnMessage De hentede teknsike anlæg, se afsnit 5.6. Resultat for metode kald, se afsnit 4.8. Der leveres én Return- Message pr. teknisk anlæg. Snitfladebeskrivelse Side 236 af 310

237 11.3. TechnicalInstallationGet Metoden TechnicalInstallationGet henter et teknisk anlæg ved angivelse af en brugervendt nøgle. Den brugervendte nøgle for et teknisk anlæg er kommunenummer, ejendomsnummer og teknisk anlægsnummer. Den brugervendte nøgler er entydig. Det betyder, at get metoden for tekniske anlæg altid returner højst en stamentitet (status 1). I nogle sjældne tilfælde kan der forekomme et nybyggeri-teknisk anlæg med samme identifikation som en stamentitet. I givet fald skal der dog eksistere en nedrivningssag på det tekniske anlæg i stam. Get metoden returner i disse sjældne tilfælde både den eksisterende stamentitet og nybyggeriet. De i afsnit og viste tegninger viser metodens input og output struktur. I følgende situatoner fejler metodekaldet: - Hvis der ikke findes et teknisk anlæg med de angivne parametre Der henvises til afsnit 4.8 for relevante returkoder TechnicalInstallationGetRequestStructure TechnicalInstallationGetRequestStructure Feltnavn i OIOXML navn Kommentar Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode. Ejendomsnummer Teknisk anlægs nummer Det (eller de) tekniske anlæg leveres i strukturen TechnicalInstallationStructure. MunicipalRealPropertyIdentifier TechnicalInstallationIdentifier Feltet skal udfyldes med et ejendomsnummer. Feltet skal udfyldes med nummeret for det tekniske anlæg. Snitfladebeskrivelse Side 237 af 310

238 TechnicalInstallationGetResponseStructure TechnicalInstallationGetResponseStructure Feltnavn i OIOXML navn Kommentar TechnicalInstallationStructure Det (eller de) hentede tekniske anlæg, se afsnit 5.6. ReturnMessage Resultatet for metode kaldet, se afsnit TechnicalInstallationGetBySiteId Metoden TechnicalInstallationGetBySiteId henter tekniske anlæg hørende til en grund. Metoden skal kaldes med en grund id for en stamentitet. Hvis man sætter IncludeHistoricIndicator til true, vil metoden også kunne kaldes med en id for en udgået grund. Metoden returnerer alle stamentiteter og eventuelle nybyggeri tekniske anlæg under en grund. Hvis man sætter IncludeHistoricIndicator til true, vil metoden også levere udgåede stamentiteter. De i afsnit og viste tegninger viser metodens input og output struktur. For at hente tekniske anlæg til en grund, kalder man metoden med grundens id. Den eller de tekniske anlæg leveres i strukturen TechnicalInstallationStructure. I følgende situatoner fejler metodekaldet: - Ved kald med en id for et nybyggeri - Ved kald med en ukendt id Der henvises til afsnit 4.8 for relevante returkoder. Snitfladebeskrivelse Side 238 af 310

239 TechnicalInstallationGetBySiteIdRequestStructure TechnicalInstallationGetBySiteIdRequestStructure Feltnavn i OIOXML navn Kommentar Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode. Grund id SiteUniversalIdentifier Feltet skal udfyldes med grundens id. Medtag historik IncludeHistoricIndicator Indikatoren skal være true for at hente udgåede entiteter med status 2. Se også afsnit TechnicalInstallationGetBySiteIdResponseStructure TechnicalInstallationGetBySiteIdResponseStructure Feltnavn i OIOXML navn Kommentar TechnicalInstallationStructure Den eller de tekniske anlæg, se afsnit 5.6. ReturnMessage Resultatet for metode kaldet, se afsnit TechnicalInstallationGetByBuildingId Metoden TechnicalInstallationGetByBuildingId henter tekniske anlæg hørende til en byning. Metoden skal kaldes med en grund id for en stamentitet. Hvis man sætter IncludeHistoricIndicator til true, vil metoden også kunne kaldes med en id for en udgået grund. Metoden returnerer alle stamentiteter og eventuelle nybyggeri tekniske anlæg under en bygning. Hvis man sætter IncludeHistoricIndicator til true, vil metoden også levere udgåede stamentiteter. Snitfladebeskrivelse Side 239 af 310

240 De i afsnit og viste tegninger viser metodens input og output struktur. For at hente tekniske anlæg til en bygning, kalder man metoden med bygningens id. For at hente tekniske anlæg til en stambygning kalder man metoden med stambygningens id. For at hente tekniske anlæg til en nybyggeri bygning, skal man kalde metoden med nybyggerietes placeholder og ikke med nybyggeriets id. Den eller de tekniske anlæg leveres i strukturen TechnicalInstallationStructure. I følgende situatoner fejler metodekaldet: - Ved kald med en id for et nybyggeri - Ved kald med en ukendt id Der henvises til afsnit 4.8 for relevante returkoder TechnicalInstallationGetByBuildingIdRequestStructure TechnicalInstallationGetByBuildingIdRequestStructure Feltnavn i OIOXML navn Kommentar Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode. Bygning id BuildingUniversalIdentifier Feltet skal udfyldes med bygningens id. Medtag historik IncludeHistoricIndicator Indikatoren skal være true for at hente udgåede entiteter med status 2. Se også afsnit TechnicalInstallationGetByBuildingIdResponseStructure TechnicalInstallationGetByBuildingIdResponseStructure Snitfladebeskrivelse Side 240 af 310

241 Feltnavn i OIOXML navn Kommentar TechnicalInstallationStructure Den eller de tekniske anlæg, se afsnit 5.6. ReturnMessage Resultatet for metode kaldet, se afsnit TechnicalInstallationGetByParentId Metoden TechnicalInstallationGetByParentId henter sager (dvs. tekniske anlæg med status 3) hørende til et eksisterende teknisk anlæg i stam. De i afsnit og viste tegninger viser metodens input og output struktur. Den (eller de) sager/tekniske anlæg leveres i strukturen TechnicalInstallationStructure. Strukturen EntityBuildingCaseInformation vil altid være udfyldt for disse tekniske anlæg idet de har status 3. For at hente sager til en eksisterende stamentitet kalder man metoden med stamentitetens id. For at hente sager til et nybyggeri, skal man kalde metoden med nybyggerietes placeholder og ikke med nybyggeriets id. Når man kalder TechnicalInstallationGetByParentId metoden med en placeholder id for et nybyggeri vil man få selve nybyggeriet (og eventuelle sager på selve nybyggeriet) leveret retur. I følgende situatoner fejler metodekaldet: - Hvis der ikke findes sager til den angivne stamid - Ved kald med en ukendt id - Ved kald med en id for et nybyggeri Der henvises til afsnit 4.8 for relevante returkoder TechnicalInstallationGetByParentIdRequestStructure TechnicalInstallationGetByParentIdRequestStructure Feltnavn i OIOXML navn Kommentar Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode. Teknisk anlæg stam id TechnicalInstallationParentReference Feltet skal udfyldes med id en for et teknisk anlæg i stamdelen. Snitfladebeskrivelse Side 241 af 310

242 TechnicalInstallationGetByParentIdResponseStructure TechnicalInstallationGetByParentIdResponseStructure Feltnavn i OIOXML navn Kommentar TechnicalInstallationStructure Den eller de hentede tekniske anlæg, se afsnit 5.6. ReturnMessage Resultatet for metode kaldet, se afsnit TechnicalInstallationCreate Metoden TechnicalInstallationCreate opretter et teknisk anlæg ved angivelse af attributterne for det tekniske anlæg man ønsker at oprette. De i afsnit og viste tegninger viser metodens input og output struktur. Det tekniske anlæg sendes som input til metoden i strukturen Technical- InstallationStructure. Som resultat for metoden returneres det oprettede tekniske anlæg (hvis det lykkedes) i strukturen "TechnicalInstallationStructure. For at kunne oprette et teknisk anlæg i stam eller som nybyggeri, skal der som minimum angives følgende felter: Kommunenummer Teknisk anlæg id Matrikel id Adgangsadresse id, svarende til Husnummer id fra DAR Disse felter ligger i understrukturen TechnicalInstallationKeys, dvs. at denne understruktur altid skal sendes med når man opretter et teknisk anlæg. For sager skal der angives: Sagstype (Nybyggeri, nedrivning eller til/ombygning) Teknisk anlæg stam id (for ændringer til et eksisterende teknsik anlæg) Byggesag id (den byggesag sagen skal høre til) Snitfladebeskrivelse Side 242 af 310

243 TechnicalInstallationCreateRequestStructure TechnicalInstallationCreateRequestStructure Feltnavn i OIOXML navn Kommentar Det tekniske anlæg, som man ønsker at oprette, se afsnit 5.6. IgnoreWarningIndicator Se afsnit 4.1. printenableindicator Se afsnit TechnicalInstallationCreateResponseStructure TechnicalInstallationCreateResponseStructure Feltnavn i OIOXML navn Kommentar TechnicalInstallationStructure TechnicalInstallationStructure Det oprettede tekniske anlæg, se 5.6. ReturnMessage Resultatet for metode kaldet, se afsnit TechnicalInstallationUpdate Metoden TechnicalInstallationUpdate opdaterer et teknisk anlæg ved angivelse af de attributter man ønsker at opdatere. De i afsnit og viste tegninger viser metodens input og output struktur. For at opdatere et teknisk anlæg, skal der angives id en for det tekniske anlæg man ønsker at opdatere. Der angives endvidere det eller de felter man ønsker at opdatere ved hjælp af strukturen "TechnicalInstallationStructure. Som resultat for metoden returneres det opdaterede tekniske anlæg i strukturen "TechnicalInstallationStructure. Snitfladebeskrivelse Side 243 af 310

244 For at kunne opdatere et teknisk anlæg skal der som minimum angives følgende felter i enhedsstrukturen: RecordChangeDateTime Kommunenummer Teknisk anlæg id Bortset fra RecordChangeDateTime ligger disse felter i understrukturen TechnicalInstallationKeys, dvs. at denne understruktur altid skal sendes med ved en opdatering. Der henvises til afsnit 4.4 for en beskrivelse af den implementerede opdateringsmekanisme og til kapitel 5 for en beskrivelse for key strukturen TechnicalInstallationUpdateRequestStructure TechnicalInstallationUpdateRequestStructure Feltnavn i OIOXML navn Kommentar TechnicalInstallationStructure Det tekniske anlæg, som man ønsker at opdatere, se afsnit 5.6. IgnoreWarningIndicator Se afsnit 4.1. printenableindicator Se afsnit TechnicalInstallationUpdateResponseStructure TechnicalInstallationUpdateResponseStructure Feltnavn i OIOXML navn Kommentar Snitfladebeskrivelse Side 244 af 310

245 TechnicalInstallationUpdateResponseStructure Feltnavn i OIOXML navn Kommentar TechnicalInstallationStructure Det opdaterede tekniske anlæg, se afsnit 5.6. ReturnMessage Resultatet for metode kaldet, se afsnit TechnicalInstallationDelete Metoden TechnicalInstallationDelete sletter et teknisk anlæg. De i afsnit og viste tegninger viser metodens input og output struktur. Et teknisk anlæg slettes ved angivelse af id en for det tekniske anlæg. Det skal være en id til en stamentitet, et nybyggeri eller en (S)entitet, dvs. en ændring til et eksisterende teknisk anlæg i stam. Et teknisk anlæg i stam (eller et nybyggeri) kan kun slettes, hvis der ikke findes en tilhørende sagsentitet. I følgende situatoner fejler metodekaldet: - Ved kald med en id for et allerede udgået teknisk anlæg. - Ved kald med en placeholder id (se også afsnit ). - Ved kald med en ukendt id. - Ved kald med en id for en stamentitet (eller nybyggeri) som har en sag tilknyttet Der henvises til afsnit 4.8 for relevante fejlkoder TechnicalInstallationDeleteRequestStructure TechnicalInstallationDeleteRequestStructure Feltnavn i OIOXML navn Kommentar Teknisk anlæg ID TechnicalInstallationUniversalIdentifier Feltet skal altid udfyldes med id en for det tekniske anlæg, som man ønsker at slette. Kommunekode MunicipalityCode Feltet skal altid udfyldes med 4 cifren kommunekode, fx Tidsstempel RecordChangeDateTime Se afsnit 4.6. Snitfladebeskrivelse Side 245 af 310

246 TechnicalInstallationDeleteRequestStructure Feltnavn i OIOXML navn Kommentar IgnoreWarningIndicator Se afsnit 4.1. printenableindicator Se afsnit 4.2. Gyldighedsdato AssessmentChangedDate Se afsnit TechnicalInstallationDeleteResponseStructure TechnicalInstallationDeleteResponseStructure Feltnavn i OIOXML navn Kommentar ReturnMessage Resultatet for metode kaldet, se afsnit TechnicalInstallationDeleteHistoric Metoden TechnicalInstallationDeleteHistoric sletter et teknisk anlæg fra historikken. De i afsnit og viste tegninger viser metodens input og output struktur. Et teknisk anlæg slettes fra historikken ved angivelse af id en for det tekniske anlæg man ønsker at slette. Det skal være en id til en udgået stamentitet. Når man sletter et teknisk anlæg fra historikken, sletter man også de underliggende afsluttede sagsentiteter fra historikken TechnicalInstallationDeleteHistoricRequestStructure TechnicalInstallationDeleteHistoricRequestStructure Feltnavn i OIOXML navn Kommentar Teknisk anlæg ID TechnicalInstallationUniversalIdentifier Feltet skal altid udfyldes med id en for det tekniske anlæg, som man ønsker at slette fra historikken. Kommunekode MunicipalityCode Feltet skal altid udfyldes med 4 cifren kommunekode, fx Snitfladebeskrivelse Side 246 af 310

247 TechnicalInstallationDeleteHistoricResponseStructure TechnicalInstallationDeleteHistoricResponseStructure Feltnavn i OIOXML navn Kommentar ReturnMessage Resultatet for metode kaldet, se afsnit 4.8. Snitfladebeskrivelse Side 247 af 310

248 12. Metoder til entitet rum Der findes 10 metoder til at hente, opdatere, oprette og slette rum: RoomGetById henter et rum ved angivelse af dens id RoomGetByIds henter et antal rum ved angivelse af deres id er RoomGet - henter en (eller flere) rum ved angivelse af et ejendomsnummer, et bygningsnummer, en etagebetegnelse og et rumnummer RoomGetByBuildingUnitId - henter en eller flere rum til en enhed RoomGetByFloorId - henter en eller flere rum til en etage RoomGetByParentId - henter en eller flere sager (ændringer til et eksisterende rum) ved angivelse af en id til et rum i stam RoomCreate - opretter et ny rum RoomUpdate - opdaterer et rum RoomDelete - sletter et rum RoomDeleteHistoric - sletter et rum fra historikken Metoderne er beskrevet i de 10 næste afsnit. Et rum er altid beskrevet i strukturen RoomStructure, som beskriver et rum i alle situationer, både når et rum leveres som input til en metode og når det leveres som output. Strukturen er beskrevet i afsnit 5.7. Et rum er altid knyttet til en etage. Nogle gange er et rum også knyttet til en enhed, hvor den kan ligge inden eller udenfor enheden. Enheden behøver ikke nødvendigvis ligge på samme etage som rummet. Et rum har ingen underliggende entiteter. Et rum med status 1 er et gældende rum i stamdelen. Et rum med status 3 er et rum under sagsbehandling. Dette kan enten være et nybyggeri (N)RUM eller en ændring til et eksisterende rum (S)RUM. Et rum med status 3 vil være en del af en byggesag. I givet fald vil strukturen EntityBuildingCaseInformation (se afsnit ) være udfyldt. Resultatet for alle metode kald leveres tilbage i en struktur kaldt ReturnMessage. Strukturen er beskrevet i afsnit 4.8. Når et rum engang er blevet oprettet kan referencerne til etagen og evt. enheden samt feltet udenfor/indefor enheden ikke ændres hverken direkte i stam eller via en byggesag. Snitfladebeskrivelse Side 248 af 310

249 12.1. RoomGetById Metoden RoomGetById henter et rum ved angivelse af id en for det teknsike anlæg. Det kan både være en id for en stamentitet eller en id for en (S) eller (N) entitet. De i afsnit og viste tegninger viser metodens input og output struktur. Metoden har id en for rummet og en kommunekode som input. Strukturen angiver, at begge input felter er obligatoriske, dvs. skal udfyldes, når operationen RoomGetById kaldes. Metoden leverer det ønskede rum samt et resultat for metode kaldet tilbage. Rummet leveres i strukturen RoomStructure. Alle typer rum leveres tilbage ved kald by id, dvs. eksisterende rum i stamdelen samt sager, herunder ændringer ((S)RUM entiteter) og nybyggerier ((N)RUM entiteter). Når IncludeHistoricIndicator er lig med true, leveres også udgåede stam-rum. I følgende situatoner fejler metodekaldet: - Ved kald med en placeholder id (se også afsnit ). - Ved kald med en ukendt id. Der henvises til afsnit 4.8 for relevante returkoder RoomGetByIdRequestStructure RoomGetByIdRequestStructure Feltnavn i OIOXML navn Kommentar Rum ID RoomUniversalIdentifier Feltet skal udfyldes med id en for rummet man ønsker at hente. Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode. Medtag historik IncludeHistoricIndicator Indikatoren skal være true for at hente et udgået stam-rum med status 2. Se også afsnit RoomGetByIdResponseStructure Snitfladebeskrivelse Side 249 af 310

250 RoomGetByIdResponseStructure Feltnavn i OIOXML navn Kommentar RoomStructure Det hentede rum (hvis det findes), se afsnit 5.7. ReturnMessage Resultatet for metode kaldet, se afsnit RoomGetByIds Metoden RoomGetByIds henter et antal rum ved angivelse af deres id er. Det kan både være id er for stamentiteter eller id er for (S) eller (N) entiteter. De i afsnit og viste tegninger viser metodens input og output struktur. Metoden leverer de ønskede rum samt et resultat for metode kaldet tilbage. Rummene leveres i strukturen RoomStructure. Der leveres én besked pr. sendt rum id tilbage. Som beskrevet under søgningen (afsnit 15.2) kan man ved hjælp af indikatoren ResultTypeCode angive, om man ønsker at få leveret hele strukturen RoomStructure tilbage eller om man ønsker kun at få leveret en mindre del af strukturen. Ellers gælder det samme som for metoden GetById RoomGetByIdsRequestStructure RoomGetByIdsRequestStructure Feltnavn i OIOXML navn Kommentar Snitfladebeskrivelse Side 250 af 310

251 RoomGetByIdsRequestStructure Feltnavn i OIOXML navn Kommentar Rum ID RoomUniversalIdentifier Feltet skal udfyldes med id er for de rum man ønsker at hente. Der skal angives mindst en id. Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode. ResultTypeCode Indikator, som angiver, om man ønsker at få rummene leveret med alle deres understrukturer eller om man ønsker kun at få leveret de vigtigste oplysninger om rummene (se afsnit 15.2). Hvis indikatoren ikke angives, er den pr. default true. True betyder at hele strukturen leveres tilbage. Medtag historik IncludeHistoricIndicator Indikatoren skal være true for også at hente udgåede stam-rum med status 2. Se også afsnit RoomGetByIdsResponseStructure RoomGetByIdsResponseStructure Feltnavn i OIOXML navn Kommentar RoomStructure ReturnMessage De hentede rum, se afsnit 5.7. Resultat for metode kald, se afsnit 4.8. Der leveres én Return- Message pr. rum RoomGet Metoden RoomGet henter et rum ved angivelse af en brugervendt nøgle. Den brugervendte nøgle for et rum er et kommunenummer, et ejendomsnummer, et bygningsnummer, en etagebetegnelse og et rumnummer. Den brugervendte nøgler er entydig. Det betyder, at get metoden for rum altid returner højst en stamentitet (status 1). I nogle sjældne tilfælde kan der forekomme et nybyggeri-rum med samme identifikation som en stamentitet. I givet fald skal der dog eksistere en nedrivningssag på stam-rummet. Get Snitfladebeskrivelse Side 251 af 310

252 metoden returner i disse sjældne tilfælde både den eksisterende stamentitet og nybyggeriet. De i afsnit og viste tegninger viser metodens input og output struktur. Det (eller de) rum leveres i strukturen RoomStructure. I følgende situatoner fejler metodekaldet: - Hvis der ikke findes et rum med de angivne parametre Der henvises til afsnit 4.8 for relevante returkoder RoomGetRequestStructure RoomGetRequestStructure Feltnavn i OIOXML navn Kommentar Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode. Ejendomsnummer MunicipalRealPropertyIdentifier Feltet skal udfyldes med et ejendomsnummer. Bygningsnummer BuildingIdentifier Feltet skal udfyldes med et bygningsnummer. Etagebetegnelse FloorPhysicalIdentifier Feltet skal udfyldes med etagebetegnelse. Rumnummer RoomIdentifier Feltet skal udfyldes med rumnummer RoomGetResponseStructure RoomGetResponseStructure Feltnavn i OIOXML navn Kommentar RoomStructure Det hentede rum, se Snitfladebeskrivelse Side 252 af 310

253 RoomGetResponseStructure Feltnavn i OIOXML navn Kommentar afsnit 5.7. ReturnMessage Resultatet for metode kaldet, se afsnit RoomGetByFloorId Metoden RoomGetByFloorId henter rum hørende til en etage. Metoden skal kaldes med en etage id for en stamentitet. Hvis man sætter IncludeHistoricIndicator til true, vil metoden også kunne kaldes med en id for en udgået etage. Metoden returnerer alle stamentiteter og eventuelle nybyggeri rum under en etage. Hvis man sætter IncludeHistoricIndicator til true, vil metoden også levere udgåede stamentiteter. De i afsnit og viste tegninger viser metodens input og output struktur. For at hente rum til en etage, kalder man metoden med etagens id. For at hente underliggende entiteter til en stametage kalder man metoden med stametagens id. For at hente underliggende entiteter til en nybyggeri-etage, skal man kalde metoden med nybyggerietes placeholder og ikke med nybyggeriets id. Den eller de rum leveres i strukturen RoomStructure. I følgende situatoner fejler metodekaldet: - Ved kald med en id for et nybyggeri - Ved kald med en ukendt id Der henvises til afsnit 4.8 for relevante returkoder RoomGetByFloorIdRequestStructure RoomGetByFloorIdRequestStructure Feltnavn i OIOXML navn Kommentar Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode. Etage id FloorUniversalIdentifier Feltet skal udfyldes med id for etagen. Snitfladebeskrivelse Side 253 af 310

254 RoomGetByFloorIdRequestStructure Feltnavn i OIOXML navn Kommentar Medtag historik IncludeHistoricIndicator Indikatoren skal være true for at hente udgåede entiteter med status 2. Se også afsnit RoomGetByFloorIdResponseStructure RoomGetByFloorIdResponseStructure Feltnavn i OIOXML navn Kommentar RoomStructure Den eller de rum, se afsnit 5.7. ReturnMessage Resultatet for metode kaldet, se afsnit RoomGetByBuildingUnitId Metoden RoomGetByBuildingUnitId henter rum hørende til en enhed. Metoden skal kaldes med en enhed id for en stamentitet. Hvis man sætter IncludeHistoricIndicator til true, vil metoden også kunne kaldes med en id for en udgået enhed. Metoden returnerer alle stamentiteter og eventuelle nybyggeri rum under en enhed. Hvis man sætter IncludeHistoricIndicator til true, vil metoden også levere udgåede stamentiteter. De i afsnit og viste tegninger viser metodens input og output struktur. For at hente rum til en enhed, kalder man metoden med enhedens id. For at hente underliggende rum til en stamenhed kalder man metoden med stamenhedens id. For at hente underliggende rum til et nybyggeri-rum, skal man kalde metoden med nybyggerietes placeholder og ikke med nybyggeriets id. Den eller de rum leveres i strukturen RoomStructure. I følgende situatoner fejler metodekaldet: - Ved kald med en id for et nybyggeri - Ved kald med en ukendt id Der henvises til afsnit 4.8 for relevante returkoder. Snitfladebeskrivelse Side 254 af 310

255 RoomGetByBuildingUnitIdRequestStructure RoomGetByBuildingUnitIdRequestStructure Feltnavn i OIOXML navn Kommentar Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode. Enhed id BuildingUnitUniversalIdentifier Feltet skal udfyldes med id for enheden. Medtag historik IncludeHistoricIndicator Indikatoren skal være true for at hente udgåede entiteter med status 2. Se også afsnit RoomGetByBuildingUnitIdResponseStructure RoomGetByBuildingUnitIdResponseStructure Feltnavn i OIOXML navn Kommentar RoomStructure Den eller de rum, se afsnit 5.7. ReturnMessage Resultatet for metode kaldet, se afsnit RoomGetByParentId Metoden RoomGetByParentId henter sager (dvs. rum med status 3) hørende til et eksisterende rum i stam. De i afsnit og viste tegninger viser metodens input og output struktur. Den (eller de) sager/rum leveres i strukturen RoomStructure. Strukturen EntityBuildingCaseInformation vil altid være udfyldt for disse rum idet de har status 3. Snitfladebeskrivelse Side 255 af 310

256 For at hente sager til en eksisterende stamentitet kalder man metoden med stamentitetens id. For at hente sager til et nybyggeri, skal man kalde metoden med nybyggerietes placeholder og ikke med nybyggeriets id. Når man kalder RoomGetByParentId metoden med en placeholder id for et nybyggeri vil man få selve nybyggeriet (og eventuelle sager på selve nybyggeriet) leveret retur. I følgende situatoner fejler metodekaldet: - Hvis der ikke findes sager til den angivne stamid - Ved kald med en id for et nybyggeri - Ved kald med en ukendt id Der henvises til afsnit 4.8 for relevante returkoder RoomGetByParentIdRequestStructure RoomGetByParentIdRequestStructure Feltnavn i OIOXML navn Kommentar Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode. Rum stam id RoomParentReference Feltet skal udfyldes med id en for et rum i stamdelen RoomGetByParentIdResponseStructure RoomGetByParentIdResponseStructure Feltnavn i OIOXML navn Kommentar RoomStructure Den eller de hentede rum, se afsnit 5.7. ReturnMessage Resultatet for metode kaldet, se afsnit RoomCreate Metoden RoomCreate opretter et rum ved angivelse af attributterne for det rum man ønsker at oprette. Snitfladebeskrivelse Side 256 af 310

257 De i afsnit og viste tegninger viser metodens input og output struktur. Rummet sendes som input til metoden i strukturen RoomStructure. Som resultat for metoden returneres det oprettede rum (hvis det lykkedes) i strukturen "RoomStructure. For at kunne oprette et rum i stam eller som nybyggeri skal der som minimum angives følgende felter i strukturen RoomStructure : Kommunenummer Rumnummer Etage id Hvis rummet hører under en enhed, skal enhedens id angives samt oplysning om rummet ligger indenfor eller udenfor enheden. Disse felter ligger i understrukturen RoomKeys, dvs. at denne understruktur altid skal sendes med når man opretter et rum. For sager skal der angives: Sagstype (Nybyggeri, nedrivning eller til/ombygning) Rum stam id (for ændringer til eksisterende rum) Byggesag id (den byggesag sagen skal høre til) RoomCreateRequestStructure RoomCreateRequestStructure Feltnavn i OIOXML navn Kommentar RoomStructure Rummet, som man ønsker at oprette, se afsnit 5.7. IgnoreWarningIndicator Se afsnit 4.1. printenableindicator Se afsnit 4.2. Gyldighedsdato AssessmentChangedDate Se afsnit RoomCreateResponseStructure Snitfladebeskrivelse Side 257 af 310

258 RoomCreateResponseStructure Feltnavn i OIOXML navn Kommentar RoomStructure Det oprettede rum (hvis det lykkedes) se afsnit 5.7. ReturnMessage Resultatet for metode kaldet, se afsnit RoomUpdate Metoden RoomUpdate opdaterer et rum ved angivelse af de attributter man ønsker at opdatere. De i afsnit og viste tegninger viser metodens input og output struktur. For at opdatere et rum, skal der angives id en for rummet. Det skal være en id til en stamentitet, et nybyggeri eller en (S)entitet, dvs. en ændring til et eksisterende rum i stam. Der angives endvidere det eller de felter man ønsker at opdatere ved hjælp af strukturen "RoomStructure. Som resultat for metoden returneres det opdaterede rum i strukturen "Room- Structure. For at kunne opdatere et rum skal der som minimum angives følgende felter: Rum id Kommunenummer RecordChangeDateTime Bortset fra RecordChangeDateTime ligger disse felter i understrukturen RoomKeys, dvs. at denne understruktur altid skal sendes med ved en opdatering. Der henvises til afsnit 4.4 for en beskrivelse af den implementerede opdateringsmekanisme og til kapitel 5 for en beskrivelse for key strukturen RoomUpdateRequestStructure RoomUpdateRequestStructure Feltnavn i OIOXML navn Kommentar RoomStructure Det rum, som man ønsker Snitfladebeskrivelse Side 258 af 310

259 RoomUpdateRequestStructure Feltnavn i OIOXML navn Kommentar at opdatere, se afsnit 5.7. IgnoreWarningIndicator Se afsnit 4.1. printenableindicator Se afsnit 4.2. Gyldighedsdato AssessmentChangedDate Se afsnit RoomUpdateResponseStructure RoomUpdateResponseStructure Feltnavn i OIOXML navn Kommentar RoomStructure Det opdaterede rum, se afsnit 5.7. ReturnMessage Resultatet for metode kaldet, se afsnit RoomDelete Metoden RoomDelete sletter et rum. De i afsnit og viste tegninger viser metodens input og output struktur. Et rum slettes ved angivelse af id en for det rum, som man ønsker at slette. Det skal være en id til en stamentitet, et nybyggeri eller en (S)entitet, dvs. en ændring til et eksisterende rum i stam. Et rum i stam (eller et nybyggeri) kan kun slettes, hvis der ikke findes en tilhørende sagsentitet. I følgende situatoner fejler metodekaldet: - Ved kald med en id for et allerede udgået rum. - Ved kald med en placeholder id (se også afsnit ). - Ved kald med en ukendt id. - Ved kald med en id for en stamentitet (eller nybyggeri) som har en sag tilknyttet Der henvises til afsnit 4.8 for relevante fejlkoder. Snitfladebeskrivelse Side 259 af 310

260 RoomDeleteRequestStructure RoomDeleteRequestStructure Feltnavn i OIOXML navn Kommentar Rum ID RoomUniversalIdentifier Feltet skal altid udfyldes med id en for det rum man ønsker at slette. Kommunekode MunicipalityCode Feltet skal altid udfyldes med 4 cifren kommunekode, fx Tidsstempel RecordChangeDateTime Se afsnit 4.6. IgnoreWarningIndicator Se afsnit 4.1. printenableindicator Se afsnit 4.2. Gyldighedsdato AssessmentChangedDate Se afsnit RoomDeleteResponseStructure RoomDeleteResponseStructure Feltnavn i OIOXML navn Kommentar ReturnMessage Resultatet for metode kaldet, se afsnit RoomDeleteHistoric Metoden RoomDeleteHistoric sletter et rum fra historikken. De i afsnit og viste tegninger viser metodens input og output struktur. Et rum slettes fra historikken ved angivelse af id en for det rum, som man ønsker at slette. Det skal være en id til en udgået stamentitet. Snitfladebeskrivelse Side 260 af 310

261 Når man sletter et rum fra historikken, sletter man også de underliggende afsluttede sagsentiteter fra historikken RoomDeleteHistoricRequestStructure RoomDeleteHistoricRequestStructure Feltnavn i OIOXML navn Kommentar Rum ID RoomUniversalIdentifier Feltet skal altid udfyldes med id en for det rum man ønsker at slette fra historikken. Kommunekode MunicipalityCode Feltet skal altid udfyldes med 4 cifren kommunekode, fx RoomDeleteHistoricResponseStructure RoomDeleteHistoricResponseStructure Feltnavn i OIOXML navn Kommentar ReturnMessage Resultatet for metode kaldet, se afsnit 4.8. Snitfladebeskrivelse Side 261 af 310

262 13. Metoder til entitet brugsenhed Der findes 9 metoder til at hente, opdatere, oprette og slette brugsenheder: UseUnitGetById henter en brugsenhed ved angivelse af dens id UseUnitGetByIds henter et antal brugsenheder ved angivelse af deres id er UseUnitGet - henter en (eller flere) brugsenheder ved angivelse af et ejendomsnummer, et bygningsnummer og et brugsenhedsnummer UseUnitGetByBuildingId - henter en eller flere brugsenheder til en bygning UseUnitGetByParentId - henter en eller flere sager (ændringer til en eksisterende brugsenhed) ved angivelse af id for en brugsenhed i stam. UseUnitCreate - opretter en ny brugsenhed UseUnitUpdate - opdaterer en brugsenhed UseUnitDelete - sletter en brugsenhed UseUnitDeleteHistoric - sletter en brugsenhed fra historikken Metoderne er beskrevet i de 9 næste afsnit. En brugsenhed er altid beskrevet i strukturen UseUnitStructure, som beskriver en brugsenhed i alle situationer, både når den leveres som input til en metode og når den leveres som output. Strukturen er beskrevet i afsnit 5.1. En brugsenhed er altid knyttet til en bygning. En bygning kan have nul, en eller flere brugsenheder tilknyttet. Tilknytning til en bygning kan ikke ændres efter oprettelsen, hverken direkte i stam eller igennem en byggesag. En brugsenhed har ingen underliggende entiteter. En brugsenhed med status 1 er en gældende brugsenhed i stamdelen. En brugsenhed med status 3 er en brugsenhed under sagsbehandling. Dette kan enten være et nybyggeri (N)BRU eller en ændring til en eksisterende brugsenhed (S)BRU. En brugsenhed med status 3 vil være en del af en byggesag. I givet fald vil strukturen EntityBuilding- CaseInformation (se afsnit ) være udfyldt. Resultatet for alle metode kald leveres tilbage i en struktur kaldt ReturnMessage. Strukturen er beskrevet i afsnit UseUnitGetById Metoden UseUnitGetById henter en brugsenhed ved angivelse af id en for brugsenheden. Det kan både være en id for en stamentitet eller en id for en (S) eller (N) entitet. De i afsnit og viste tegninger viser metodens input og output struktur. Snitfladebeskrivelse Side 262 af 310

263 Metoden har id en for brugsenheden og en kommunekode som input. Strukturen angiver, at begge input felter er obligatoriske, dvs. skal udfyldes, når operationen UseUnitGetById kaldes. Metoden leverer den ønskede brugsenhed samt et resultat for metode kaldet tilbage. Brugsenheden leveres i strukturen UseUnitStructure. Alle typer brugsenheder leveres tilbage ved kald by id, dvs. eksisterende brugsenheder i stamdelen samt sager, herunder ændringer ((S)BRU entiteter) og nybyggerier ((N)BRU entiteter). Når IncludeHistoricIndicator er lig med true, leveres også udgåede stambrugsenheder. I følgende situatoner fejler metodekaldet: - Ved kald med en placeholder id (se også afsnit ). - Ved kald med en ukendt id. Der henvises til afsnit 4.8 for relevante returkoder UseUnitGetByIdRequestStructure UseUnitGetByIdRequestStructure Feltnavn i OIOXML navn Kommentar Brugsenhed ID UseUnitUniversalIdentifier Feltet skal udfyldes med id en for den brugsenhed, som man ønsker at hente. Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode. Medtag historik IncludeHistoricIndicator Indikatoren skal være true for at hente en udgået stam-brugsenhed med status 2. Se også afsnit UseUnitGetByIdResponseStructure UseUnitGetByIdResponseStructure Snitfladebeskrivelse Side 263 af 310

264 Feltnavn i OIOXML navn Kommentar UseUnitStructure Den hentede brugsenhed (hvis den findes), se afsnit 5.8. ReturnMessage Resultatet for metode kaldet, se afsnit UseUnitGetByIds Metoden UseUnitGetByIds henter et antal brugsenheder ved angivelse af deres id er. Det kan både være id er for stamentiteter eller id er for (S) eller (N) entiteter. De i afsnit og viste tegninger viser metodens input og output struktur. Metoden leverer de ønskede brugsenheder samt et resultat for metode kaldet tilbage. Brugsenhederne leveres i strukturen UseUnitStructure. Der leveres én besked pr. sendt brugsenhed id tilbage. Som beskrevet under søgningen (afsnit 15.2) kan man ved hjælp af indikatoren ResultTypeCode angive, om man ønsker at få leveret hele strukturen UseUnitStructure tilbage eller om man ønsker kun at få leveret en mindre del af strukturen. Ellers gælder det samme som for metoden GetById UseUnitGetByIdsRequestStructure UseUnitGetByIdsRequestStructure Feltnavn i OIOXML navn Kommentar Brugsenhed ID UseUnitUniversalIdentifier Feltet skal udfyldes med id er for de brugsenheder man ønsker at hente. Der skal angives mindst en id. Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode. ResultTypeCode Indikator, som angiver, om man ønsker at få Snitfladebeskrivelse Side 264 af 310

265 UseUnitGetByIdsRequestStructure Feltnavn i OIOXML navn Kommentar brugsenhederne leveret med alle deres understrukturer eller om man ønsker kun at få leveret de vigtigste oplysninger om brugsenhederne (se afsnit 15.2). Hvis indikatoren ikke angives, er den pr. default true. True betyder at hele strukturen leveres tilbage. Medtag historik IncludeHistoricIndicator Indikatoren skal være true for at hente udgåede stam-brugsenheder med status 2. Se også afsnit UseUnitGetByIdsResponseStructure UseUnitGetByIdsResponseStructure Feltnavn i OIOXML navn Kommentar UseUnitStructure ReturnMessage De hentede brugsenheder, se afsnit 5.8. Resultat for metode kald, se afsnit 4.8. Der leveres én Return- Message pr. brugsenhed UseUnitGet Metoden UseUnitGet henter en brugsenhed ved angivelse af en brugervendt nøgle. Den brugervendte nøgle for en brugsenhed er et kommunenummer, et ejendomsnummer, et bygningsnummer og et rumnummer. Den brugervendte nøgler er entydig. Det betyder, at get metoden for rum altid returner højst en stamentitet (status 1). I nogle sjældne tilfælde kan der forekomme en nybyggeri-brugsenhed med samme identifikation som en stamentitet. I givet fald skal der dog eksistere en nedrivningssag på stamrummet. Get metoden returner i disse sjældne tilfælde både den eksisterende stamentitet og nybyggeriet. De i afsnit og viste tegninger viser metodens input og output struktur. Snitfladebeskrivelse Side 265 af 310

266 Brugsenheden/brugsenhederne leveres i strukturen UseUnitStructure. I følgende situatoner fejler metodekaldet: - Hvis der ikke findes en brugsenhed med de angivne parametre Der henvises til afsnit 4.8 for relevante returkoder UseUnitGetRequestStructure UseUnitGetRequestStructure Feltnavn i OIOXML navn Kommentar Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode. Ejendomsnummer MunicipalRealPropertyIdentifier Feltet skal udfyldes med et ejendomsnummer. Bygningsnummer BuildingIdentifier Feltet skal udfyldes med et bygningsnummer. Brugsenhedsnummer UseUnitIdentifier Feltet skal udfyldes med et brugsenhedsnummer UseUnitGetResponseStructure UseUnitGetResponseStructure Feltnavn i OIOXML navn Kommentar UseUnitStructure Det hentede brugsenhed, se afsnit 5.8. ReturnMessage Resultatet for metode kaldet, se afsnit UseUnitGetByBuildingId Metoden UseUnitGetByBuildingId henter brugsenheder hørende til en byning. Metoden skal kaldes med en bygning id for en stamentitet. Snitfladebeskrivelse Side 266 af 310

267 Hvis man sætter IncludeHistoricIndicator til true, vil metoden også kunne kaldes med en id for en udgået bygning. Metoden returnerer alle stamentiteter og eventuelle nybyggeri brugsenheder under en bygning. Hvis man sætter IncludeHistoricIndicator til true, vil metoden også levere udgåede stamentiteter. De i afsnit og viste tegninger viser metodens input og output struktur. For at hente brugsenheder til en bygning, kalder man metoden med bygningens id. For at hente underliggende brugsenheder til en stambygning, kalder man metoden med stambygningens id. For at hente underliggende brugsenheder til en nybyggeri-bygning, skal man kalde metoden med nybyggerietes placeholder og ikke med nybyggeriets id. Brugsenheden/Brugsenhederne leveres i strukturen UseUnitStructure. I følgende situatoner fejler metodekaldet: - Ved kald med en id for et nybyggeri - Ved kald med en ukendt id Der henvises til afsnit 4.8 for relevante returkoder UseUnitGetByBuildingIdRequestStructure UseUnitGetByBuildingIdRequestStructure Feltnavn i OIOXML navn Kommentar Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode. Bygning id BuildingUniversalIdentifier Feltet skal udfyldes med bygningens id. Medtag historik IncludeHistoricIndicator Indikatoren skal være true for at hente udgåede entiteter med status 2. Se også afsnit 3.7. Snitfladebeskrivelse Side 267 af 310

268 UseUnitGetByBuildingIdResponseStructure UseUnitGetByBuildingIdResponseStructure Feltnavn i OIOXML navn Kommentar UseUnitStructure Den eller de brugsenheder, se afsnit 5.8. ReturnMessage Resultatet for metode kaldet, se afsnit UseUnitGetByParentId Metoden UseUnitGetByParentId henter sager (dvs. brugsenheder med status 3) hørende til en eksisterende brugsenhed i stam. De i afsnit og viste tegninger viser metodens input og output struktur. Den (eller de) sager/brugsenheder leveres i strukturen UseUnitStructure. Strukturen EntityBuildingCaseInformation vil altid være udfyldt for disse brugsenheder idet de har status 3. For at hente sager til en eksisterende stamentitet kalder man metoden med stamentitetens id. For at hente sager til et nybyggeri, skal man kalde metoden med nybyggerietes placeholder og ikke med nybyggeriets id. Når man kalder UseUnitGetByParentId metoden med en placeholder id for et nybyggeri vil man få selve nybyggeriet (og eventuelle sager på selve nybyggeriet) leveret retur. I følgende situatoner fejler metodekaldet: - Hvis der ikke findes sager til den angivne stamid - Ved kald med en id for et nybyggeri - Ved kald med en ukendt id Der henvises til afsnit 4.8 for relevante returkoder UseUnitGetByParentIdRequestStructure Snitfladebeskrivelse Side 268 af 310

269 UseUnitGetByParentIdRequestStructure Feltnavn i OIOXML navn Kommentar Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode. Brugsenhed stam id UseUnitParentReference Feltet skal udfyldes med id en for en brugsenhed i stamdelen UseUnitGetByParentIdResponseStructure UseUnitGetByParentIdResponseStructure Feltnavn i OIOXML navn Kommentar UseUnitStructure Den eller de hentede brugsenheder, se afsnit 5.8. ReturnMessage Resultatet for metode kaldet, se afsnit UseUnitCreate Metoden UseUnitCreate opretter en brugsenhed ved angivelse af attributterne for den brugsenhed man ønsker at oprette. De i afsnit og viste tegninger viser metodens input og output struktur. Brugsenheden sendes som input til metoden i strukturen UseUnitStructure. Som resultat for metoden returneres den oprettede brugsenhed (hvis det lykkedes) i strukturen "UseUnitStructure. For at kunne oprette en brugsenhed i stam eller som nybyggeri skal der som minimum angives følgende felter i strukturen UseUnitStructure : Kommunenummer Brugsenhedsnummer Bygning id Enhedsadresse id, svarende til Adresse id fra DAR Disse felter ligger i understrukturen UseUnitKeys, dvs. at denne understruktur altid skal sendes med når man opretter en brugsenhed. For sager (dvs. nybyggerier og (S) entiteter) skal der angives: Sagstype (Nybyggeri, nedrivning eller til/ombygning) Snitfladebeskrivelse Side 269 af 310

270 Brugsenhed stam id (for ændringer til eksisterende brugsenheder) Byggesag id (den byggesag sagen skal høre til) UseUnitCreateRequestStructure UseUnitCreateRequestStructure Feltnavn i OIOXML navn Kommentar UseUnitStructure Brugsenheden, som man ønsker at oprette, se afsnit 5.8. IgnoreWarningIndicator Se afsnit 4.1. printenableindicator Se afsnit 4.2. Gyldighedsdato AssessmentChangedDate Se afsnit UseUnitCreateResponseStructure UseUnitCreateResponseStructure Feltnavn i OIOXML navn Kommentar UseUnitStructure Den oprettede brugsenhed (hvis det lykkedes) se afsnit 5.8. ReturnMessage Resultatet for metode kaldet, se afsnit UseUnitUpdate Metoden UseUnitUpdate opdaterer en brugsenhed ved angivelse af de attributter man ønsker at opdatere. De i afsnit og viste tegninger viser metodens input og output struktur. For at opdatere en brugsenhed, skal der angives id en for brugsenheden. Snitfladebeskrivelse Side 270 af 310

271 Det skal være en id til en stamentitet, et nybyggeri eller en (S)entitet, dvs. en ændring til en eksisterende brugsenhed i stam. Der angives endvidere det eller de felter man ønsker at opdatere ved hjælp af strukturen "UseUnitStructure. Som resultat for metoden returneres den opdaterede brugsenhed i strukturen "UseUnitStructure. For at kunne opdatere en brugsenhed skal der som minimum angives følgende felter: Brugsenhed id Kommunenummer RecordChangeDateTime Disse felter ligger i understrukturen UseUnitKeys, dvs. at denne understruktur altid skal sendes med ved en opdatering. Der henvises til afsnit 4.4 for en beskrivelse af den implementerede opdateringsmekanisme og til kapitel 5 for en beskrivelse for key strukturen UseUnitUpdateRequestStructure UseUnitUpdateRequestStructure Feltnavn i OIOXML navn Kommentar UseUnitStructure Den brugsenhed, som man ønsker at opdatere, se afsnit 5.8. IgnoreWarningIndicator Se afsnit 4.1. printenableindicator Se afsnit 4.2. Gyldighedsdato AssessmentChangedDate Se afsnit UseUnitUpdateResponseStructure UseUnitUpdateResponseStructure Snitfladebeskrivelse Side 271 af 310

272 Feltnavn i OIOXML navn Kommentar UseUnitStructure Den opdaterede brugsenhed, se afsnit 5.8. ReturnMessage Resultatet for metode kaldet, se afsnit UseUnitDelete Metoden UseUnitDelete sletter en brugsenhed. De i afsnit og viste tegninger viser metodens input og output struktur. En brugsenhed slettes ved angivelse af id en for brugsenheden. Det skal være en id til en stamentitet, et nybyggeri eller en (S)entitet, dvs. en ændring til en eksisterende brugsenhed i stam. En brugsenhed i stam (eller et nybyggeri) kan kun slettes, hvis der ikke findes en tilhørende sagsentitet. I følgende situatoner fejler metodekaldet: - Ved kald med en id for en allerede udgået brugsenhed. - Ved kald med en placeholder id (se også afsnit ). - Ved kald med en ukendt id. - Ved kald med en id for en stamentitet (eller nybyggeri) som har en sag tilknyttet Der henvises til afsnit 4.8 for relevante fejlkoder UseUnitDeleteRequestStructure UseUnitDeleteRequestStructure Feltnavn i OIOXML navn Kommentar Brugsenhed ID UseUnitUniversalIdentifier Feltet skal altid udfyldes med id en for brugsenheden. Kommunekode MunicipalityCode Feltet skal altid udfyldes med 4 cifren kommunekode, fx Tidsstempel RecordChangeDateTime Se afsnit 4.6. IgnoreWarningIndicator Se afsnit 4.1. printenableindicator Se afsnit 4.2. Snitfladebeskrivelse Side 272 af 310

273 UseUnitDeleteRequestStructure Feltnavn i OIOXML navn Kommentar Gyldighedsdato AssessmentChangedDate Se afsnit UseUnitDeleteResponseStructure UseUnitDeleteResponseStructure Feltnavn i OIOXML navn Kommentar ReturnMessage Resultatet for metode kaldet, se afsnit UseUnitDeleteHistoric Metoden UseUnitDeleteHistoric sletter en brugsenhed fra historikken. De i afsnit og viste tegninger viser metodens input og output struktur. En brugsenhed slettes fra historikken ved angivelse af id en for brugsenheden. Det skal være en id til en udgået stamentitet. Når man sletter en brugsenhed fra historikken, sletter man også de underliggende afsluttede sagsentiteter fra historikken UseUnitDeleteHistoricRequestStructure UseUnitDeleteHistoricRequestStructure Feltnavn i OIOXML navn Kommentar Brugsenhed ID UseUnitUniversalIdentifier Feltet skal altid udfyldes med id en for brugsenheden. Kommunekode MunicipalityCode Feltet skal altid udfyldes med 4 cifren kommunekode, fx Snitfladebeskrivelse Side 273 af 310

274 UseUnitDeleteHistoricResponseStructure UseUnitDeleteHistoricResponseStructure Feltnavn i OIOXML navn Kommentar ReturnMessage Resultatet for metode kaldet, se afsnit 4.8. Snitfladebeskrivelse Side 274 af 310

275 14. Metoder til entitet byggesag Der findes 9 metoder for entiteten byggesag: BuildingCaseGetById - henter byggesag ved angivelse af dens id BuildingCaseGetByIds - henter byggesager ved angivelse af deres id BuildingCaseGet - henter en (eller flere) byggesager ved angivelse af et ejendomsnummer og byggesagsnummer BuildingCaseGetBySiteId - henter en (eller flere) byggesager hørende til en grund BuildingCaseGetByEntityId henter byggesag hørende til en sagsentitet, som kan være en af de mulige 8 entiteter beskrevet i kapitel 6 til 13 BuildingCaseGetAllEntities henter alle sagsentiteter til en byggesag ved angivelse af byggesagens id BuildingCaseCreate - opretter en byggesag BuildingCaseUpdate - opdaterer en byggesag BuildingCaseDelete - sletter en byggesag Metoderne er beskrevet i de 9 næste afsnit. Derudover findes der pr. entitet en metode, som henter sagsentiteter hørende til en stamentitet. Disse metoder beskrevet under de enkelte entiteter. En byggesag er altid beskrevet i strukturen BuildingCaseStructure, som beskriver en byggesag i alle situationer, både når den leveres som input til en metode og når det leveres som output. Strukturen er beskrevet i afsnit 5.9. En byggesag har altid 0, 1 eller flere entiteter tilknyttet, dog højst en bygning. Resultatet for alle metode kald leveres tilbage i en struktur kaldt ReturnMessage. Strukturen er beskrevet i afsnit BuildingCaseGetById Metoden BuildingCaseGetById henter en byggesag ved angivelse af byggesagens id. Når man har en (S) eller en (N) entitet, kan man finde byggesags-id en i strukturen EntityBuildingCaseInformation. Feltet hedder BuildingCaseReference. De i afsnit og viste tegninger viser metodens input og output struktur. Metoden har en byggesag id og en kommunekode som input. Begge input felter er obligatoriske, dvs. skal udfyldes, når operationen BuildingCaseGetBy- Id kaldes. Snitfladebeskrivelse Side 275 af 310

276 Metoden leverer den ønskede byggesag samt et resultat for metode kaldet tilbage. Byggesagen leveres i strukturen BuildingCaseStructure. I følgende situatoner fejler metodekaldet: - Ved kald med en id for en udgået byggesag. - Ved kald med en ukendt id. Der henvises til afsnit 4.8 for relevante returkoder BuildingCaseGetByIdRequestStructure BuildingCaseGetByIdRequestStructure Feltnavn i OIOXML navn Kommentar Byggesag ID BuildingCaseUniversalIdentifier Feltet skal udfyldes med id en for den byggesag man ønsker at hente. Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode BuildingCaseGetByIdResponseStructure BuildingCaseGetByIdResponseStructure Feltnavn i OIOXML navn Kommentar BuildingCaseStructure Den hentede byggesag (hvis den findes), se afsnit 5.9. ReturnMessage Resultatet for metode kaldet, se afsnit BuildingCaseGetByIds Metoden BuildingCaseGetByIds henter et antal byggesager ved angivelse af deres id er. De i afsnit og viste tegninger viser metodens input og output struktur. Metoden leverer de ønskede byggesager samt et resultat for metode kaldet tilbage. Byggesagerne leveres i strukturen BuildingCaseStructure. Snitfladebeskrivelse Side 276 af 310

277 Der leveres én besked pr. sendt byggesag id tilbage. Som beskrevet under søgningen (afsnit 15.2) kan man ved hjælp af indikatoren ResultTypeCode angive, om man ønsker at få leveret hele strukturen BuildingCaseStructure tilbage eller om man ønsker kun at få leveret en mindre del af strukturen. Ellers gælder det samme som for metoden GetById BuildingCaseGetByIdsRequestStructure BuildingCaseGetByIdsRequestStructure Feltnavn i OIOXML navn Kommentar Byggesag ID BuildingCaseUniversalIdentifier Feltet skal udfyldes med id er for de byggesager man ønsker at hente. Der skal angives mindst en id. Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode. ResultTypeCode Indikator, som angiver, om man ønsker at få byggesagerne leveret med alle deres understrukturer eller om man ønsker kun at få leveret de vigtigste oplysninger om byggesagerne (se afsnit 15.2). Hvis indikatoren ikke angives, er den pr. default true. True betyder at hele strukturen leveres tilbage BuildingCaseGetByIdsResponseStructure BuildingCaseGetByIdsResponseStructure Feltnavn i OIOXML navn Kommentar Snitfladebeskrivelse Side 277 af 310

278 BuildingCaseGetByIdsResponseStructure Feltnavn i OIOXML navn Kommentar BuildingCaseStructure ReturnMessage De hentede byggesager, se afsnit 5.9. Resultat for metode kald, se afsnit 4.8. Der leveres én Return- Message pr. byggesag BuildingCaseGet Metoden BuildingCaseGet henter en byggesag ved angivelse af et ejendomsnummer og et byggesagsnummer. Der kan eksistere flere byggesager med samme ejendomsnummer og byggesagsnummer. De i afsnit og viste tegninger viser metodens input og output struktur. Byggesagen(erne) leveres i strukturen BuildingCaseStructure. I følgende situatoner fejler metodekaldet: - Hvis der ikke findes en byggesag med de angivne parametre Der henvises til afsnit 4.8 for relevante returkoder BuildingCaseGetRequestStructure BuildingCaseGetRequestStructure Feltnavn i OIOXML navn Kommentar Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode. Ejendomsnummer MunicipalRealPropertyIdentifier Feltet skal udfyldes med et ejendomsnummer. Byggesagsnummer BuildingCaseIdentifier Feltet skal udfyldes med et byggesagsnummer BuildingCaseGetResponseStructure Snitfladebeskrivelse Side 278 af 310

279 BuildingCaseGetResponseStructure Feltnavn i OIOXML navn Kommentar BuildingCaseStructure Byggesagen(erne), som har det angivne ejendomsnummer og byggesagsnummer, se afsnit 5.9. ReturnMessage Resultatet for metode kaldet, se afsnit BuildingCaseGetBySiteId Metoden BuildingCaseGetBySiteId henter en eller evt. flere byggesager hørende til en grund. Metoden skal kaldes med en grund id for en stamentitet. Metoden returnerer alle byggesager hørende til en grund. De i afsnit og viste tegninger viser metodens input og output struktur. Den eller de byggesager leveres i strukturen BuildingCaseStructure. Hvis der ikke findes en byggesag på den angivne grund returneres returnidentifier 0 og reasonidentifier BuildingCaseGetBySiteIdRequestStructure BuildingCaseGetBySiteIdRequestStructure Feltnavn i OIOXML navn Kommentar Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode. Grund id SiteUniversalIdentifier Feltet skal udfyldes med grund id BuildingCaseGetBySiteIdResponseStructure Snitfladebeskrivelse Side 279 af 310

280 BuildingCaseGetBySiteIdResponseStructure Feltnavn i OIOXML navn Kommentar BuildingCaseStructure Den eller de hentede byggesager, se afsnit 5.9. ReturnMessage Resultat for metodekald se afsnit BuildingCaseGetByEntityId Metoden BuildingCaseGetByEntityId henter alle byggesager hørende til en stamentitet. Metoden har en reference til en stamentitet og en kommunekode som input. Begge input felter er obligatoriske, dvs. skal udfyldes, når operationen BuildingCaseGetByEntityId kaldes. For at hente byggesager til en eksisterende stamentitet kalder man metoden med stamentitetens id. For at hente byggesager til et nybyggeri, skal man kalde metoden med nybyggerietes placeholder og ikke med id en for et nybyggeri Når man kalder en EntityGetByParentId metoden med en placeholder id for et nybyggeri vil man få leveret byggesagen til selve nybyggeriet (og byggesager for eventuelle sager på selve nybyggeriet) retur. Nybyggeriet er en sag hørende til dens placeholder i stamdelen. De i afsnit og viste tegninger viser metodens input og output struktur. Metoden leverer den eller de byggesager samt et resultat for metode kaldet tilbage. Byggesagerne leveres i strukturen BuildingCaseStructure. I følgende situatoner fejler metodekaldet: - Hvis der kaldes med en nybyggeri id - Hvis id en er ukendt - Hvis id en hører til en (S) entitet - Hvis der ikke findes en byggesag til den angivne id Der henvises til afsnit 4.8 for relevante returkoder. Snitfladebeskrivelse Side 280 af 310

281 BuildingCaseGetByEntityIdRequestStructure Tegnet i request strukturen betyder choice, dvs. kun eet af felterne skal udfyldes. BuildingCaseGetByEntityIdRequestStructure Feltnavn i OIOXML navn Kommentar Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode. Grund id SiteParentReference Feltet skal udfyldes med id en for en grund, som er en sagsentitet (S). Bygning id BuildingParentReference Feltet skal udfyldes med id en for en bygning, som er en sagsentitet (S) eller et nybyggeri. Rum id RoomParentReference Feltet skal udfyldes med id en for et rum, som er en sagsentitet (S) eller et nybyggeri. Enhed id BuildingUnitParentReference Feltet skal udfyldes med id en for en enhed, som er en sagsentitet (S) eller et nybyggeri. Brugsenhed id UseUnitParentReference Feltet skal udfyldes med id en for en brugsenhed, som er en sagsentitet (S) eller et nybyggeri. Etage id FloorParentReference Feltet skal udfyldes med id en for en etage, som er en sagsentitet (S) eller et nybyggeri. Opgang/indgang id EntranceParentReference Feltet skal udfyldes med id en for en opgang/indgang, som er en sagsentitet (S) eller et nybyggeri. Snitfladebeskrivelse Side 281 af 310

282 BuildingCaseGetByEntityIdRequestStructure Feltnavn i OIOXML navn Kommentar Teknisk anlæg id TechnicalInstallationParentReference Feltet skal udfyldes med id en for et teknisk anlæg, som er en sagsentitet (S) eller et nybyggeri BuildingCaseGetByEntityIdResponseStructure BuildingCaseGetByEntityIdResponseStructure Feltnavn i OIOXML navn Kommentar BuildingCaseStructure Den eller hentede byggesager se afsnit 5.9. ReturnMessage Resultatet for metode kaldet, se afsnit BuildingCaseGetAllEntities Metoden BuildingCaseGetAllEntities henter alle sagsentiteter til en byggesag ved angivelse af byggesagens id. De i afsnit og viste tegninger viser metodens input og output struktur. Metoden har en byggesag id og en kommunekode som input. Begge input felter er obligatoriske, dvs. skal udfyldes, når operationen BuildingCaseGetAllEntities kaldes. Metoden leverer de enkelte sagsentiteter samt et resultat for metode kaldet tilbage. Sagsentiteterne leveres i deres respektive strukturer, grunde leveres i strukturen SiteStructure, bygningen i strukturen BuildingStructure osv. Sagsentiteter kan både være ændringer til eksisterende entiteter i stam ((S) entiteter) eller nybyggerier ((N) entiteter) BuildingCaseGetAllEntitiesRequestStructure Snitfladebeskrivelse Side 282 af 310

283 BuildingCaseGetAllEntitiesRequestStructure Feltnavn i OIOXML navn Kommentar Byggesag ID BuildingCaseUniversalIdentifier Feltet skal udfyldes med byggesag id. Kommunekode MunicipalityCode Feltet skal udfyldes med kommunekode BuildingCaseGetAllEntitiesResponseStructure BuildingCaseGetAllEntitiesResponseStructure Feltnavn i OIOXML navn Kommentar SiteStructure Grunde (sagsentiteter) hørende til byggesagen. BuildingStructure RoomStructure Bygninger (sagsentiteter) hørende til byggesagen. Rum (sagsentiteter) hørende til byggesagen. BuildingUnitStructure Enheder (sagsentiteter) hørende til byggesagen. UseUnitStructure Brugsenheder (sagsentiteter) hørende til byggesagen. Snitfladebeskrivelse Side 283 af 310

284 BuildingCaseGetAllEntitiesResponseStructure Feltnavn i OIOXML navn Kommentar FloorStructure Etager (sagsentiteter) hørende til byggesagen. EntranceStructure TechnicalInstallationStructure Opgange/indgange (sagsentiteter) hørende til byggesagen. Tekniske anlæg (sagsentiteter) hørende til byggesagen. ReturnMessage Resultatet for metode kaldet, se afsnit BuildingCaseCreate Metoden BuildingCaseCreate opretter en byggesag ved angivelse af byggesagens attributter. De i afsnit og viste tegninger viser metodens input og output struktur. Byggesagen sendes som input til metoden i strukturen BuildingCaseStructure. Som resultat for metoden returneres den oprettede byggesag (hvis det lykkedes) i strukturen "BuildingCaseStructure. For at kunne oprette en byggesag skal der som minimum angives følgende felter: Kommunenummer Grund id Byggesagskode Disse felter ligger i understrukturen BuildingCaseKeys, dvs. at denne understruktur altid skal sendes med når man opretter en byggesag BuildingCaseCreateRequestStructure BuildingCreateRequestStructure Feltnavn i OIOXML navn Kommentar BuildingCaseStructure Byggesagen, som man ønsker at oprette, se Snitfladebeskrivelse Side 284 af 310

285 BuildingCreateRequestStructure Feltnavn i OIOXML navn Kommentar afsnit 5.9. IgnoreWarningIndicator Se afsnit 4.1. printenableindicator Se afsnit BuildingCaseCreateResponseStructure BuildingCaseCreateResponseStructure Feltnavn i OIOXML navn Kommentar BuildingCaseStructure Den oprettede byggesag se 5.9. ReturnMessage Resultatet for metode kaldet, se afsnit BuildingCaseUpdate Metoden BuildingCaseUpdate opdaterer en byggesag ved angivelse af de attributter man ønsker at opdatere. De i afsnit og viste tegninger viser metodens input og output struktur. For at opdatere en byggesag, skal der angives byggesagens id. Der angives endvidere det eller de felter man ønsker at opdatere ved hjælp af strukturen "BuildingCaseStructure. Som resultat for metoden returneres den opdaterede byggesag i strukturen "BuildingCaseStructure. Hvis opdateringen dog resulterer i en afslutning af byggesagen, vil byggesagen ikke returneres tilbage. I givet fald returneres en ReturnMessage, hvor ResponseReturnIdentifier er 0, ResponseReasonIdentifier er 20 og ResponseReasonText er BuildingCase closed. For at kunne opdatere en byggesag skal der som minimum angives følgende felter: Byggesag id Kommunenummer RecordChangeDateTime Bortset fra feltet RecordChangeDateTime ligger disse felter ligger i understrukturen BuildingCaseKeys, dvs. at denne understruktur altid skal sendes med ved en opdatering. Der henvises til afsnit 4.4 for en beskrivelse af den implementerede opdateringsmekanisme og til kapitel 5 for en beskrivelse for key strukturen. Snitfladebeskrivelse Side 285 af 310

286 BuidlingCaseUpdateRequestStructure BuildingCaseUpdateRequestStructure Feltnavn i OIOXML navn Kommentar BuildingCaseStructure Byggesagen, som man ønsker at opdatere, se afsnit 5.9. IgnoreWarningIndicator Se afsnit 4.1. printenableindicator Se afsnit BuildingCaseUpdateResponseStructure BuildingCaseUpdateResponseStructure Feltnavn i OIOXML navn Kommentar BuildingCaseStructure Den opdaterede byggesag, se afsnit 5.9. Hvis byggesagen blev afsluttet ved den udførte update metode, leveres byggesagen ikke med tilbage, idet den har fået et ophørstimestamp. ResponseReturnIdentifier er i givet fald 0 og ResponseReasonCode vil være 20. ReturnMessage Resultatet for metode kaldet, se afsnit BuildingCaseDelete Metoden BuildingCaseDelete sletter en byggesag. Se også afsnit De i afsnit og viste tegninger viser metodens input og output struktur. Byggesagen slettes ved angivelse af byggesagens id. Snitfladebeskrivelse Side 286 af 310

287 Hvis byggesagen slettes vil også alle de sagsentiteter der ligger i byggesagen blive slettet. I følgende situatoner fejler metodekaldet: - Ved kald med en ukendt id. Der henvises til afsnit 4.8 for relevante fejlkoder BuildingCaseDeleteRequestStructure BuildingCaseDeleteRequestStructure Feltnavn i OIOXML navn Kommentar Byggesag ID BuildingCaseUniversalIdentifier Feltet skal altid udfyldes med byggesagens id. Kommunekode MunicipalityCode Feltet skal altid udfyldes med 4 cifren kommunekode, fx Tidsstempel RecordChangeDateTime Se afsnit 4.6. IgnoreWarningIndicator Se afsnit 4.1. printenableindicator Se afsnit 4.2. Gyldighedsdato AssessmentChangedDate Se afsnit BuildingCaseDeleteResponseStructure BuildingCaseDeleteResponseStructure Feltnavn i OIOXML navn Kommentar ReturnMessage Resultatet for metode kaldet, se afsnit Snitfladebeskrivelse Side 287 af 310

288 15. Metoder til søgninger Der findes en søgning pr. entitet, som henter et antal entiteter ud fra et antal angivne søgekriterier: SiteSearch - fremsøger grunde med et antal søgekriterier BuildingSearch - fremsøger bygninger med et antal søgekriterier EntranceSearch - fremsøger opgange/indgange med et antal søgekriterier FloorSearch - fremsøger etager med et antal søgekriterier TechnicalInstallationSearch - fremsøger tekniske anlæg med et antal søgekriterier BuildingUnitSearch - fremsøger enheder med et antal søgekriterier RoomSearch - fremsøger rum med et antal søgekriterier UseUnitSearch - fremsøger brugesenheder med et antal søgekriterier BuildingCaseSearch - fremsøger brugesenheder med et antal søgekriterier De enkelte metoder er beskrevet i afsnit 15.3 til Afsnit 15.1 beskriver den generelle struktur for søgekriterierne, som gælder for alle metoder og afsnit beskriver generelle forhold som gælder for søgemetoderne og søgeresultatet. For at kunne opbygge et søgetræ, som det kendes fra Kommune, er der brug for flere metoder end de ovenstående søgemetoder. Lad os antage, at der er blevet udført en af de ovenstående søgninger, fx har man fremsøgt en række bygninger. Nu vil man vise disse bygninger i et søgetræ, som viser hvilke grunde disse bygninger ligger under. Bygningerne leveres sammen med referencer til de entiteter (dvs. matrikel, grund) som de hører til. Det giver dog ikke ret megen mening at vise disse grund id er i et resultattræ. Man vil hellere vise de overliggende grunde med nogle brugervendte nøgler, som fx ejendomsnummer. Man har således brug for nogle grundoplysninger for at kunne vise dem i et resultatræ i stedet for grund id erne. Til dette formål er der udviklet de under de enkelte entiteter beskrevne <Entitete>GetByIds metoderne. Disse metoder henter et antal entiteter ud fra et antal id er til entiteterne. Man kan i vores eksempel benytte SiteGetByIds metoden for at hente grundoplysninger for et antal grunde ved angivelse af deres id er. Disse <Entitet>GetByIds metoder er beskrevet i under de enkelte entiteter i kapitlerne 6 til 14. I modsætning til de andre metoder beskrevet under de enkelte entiteter har disse metoder det input flagget ResultTypeCode (se afsnit 15.2), som angiver om man ønsker hele strukturen tilbage eller kun dele. Til sidste er der brug for en metode, som henter underliggende entiteter til en entitet. Snitfladebeskrivelse Side 288 af 310

289 Til dette formål kan man benytte <Entitet1>GetBy<Entitet2>Id metoderne eller man kan benytte SiteGetSubStructuresById metoden som henter alle underliggende entiteter til en grund. Hvis man forestiller sig, at man ønsker at hente alle opgange hørende til en af den fremsøgte bygninger og vise dem i resultatlisten, kan man benytte EntranceGetByBuildingId metoden eller SiteGetSubStructuresById metoden Søgekriterier Der kan søges med forskellige søgekriterier. Hvis flere søgekriterier er udfyldt, betyder det, at alle udfyldte søgekriterier skal være opfyldt. Søgekriterierne er delt op i 10 forskellige substrukturer, som tager udgangspunkt i de felter man søger efter. Søgekriterierne som vedrører felter adresseoplysninger findes fx i strukturen SearchAddressRequestSubStructure. Der findes følgende 10 substrukturer: AddressSearchRequestSubStructure - søgekriterier vedrørende adresseoplysninger SiteSearchRequestSubStructure - søgekriterier vedrørende grundoplysninger BuildingSearchRequestSubStructure - søgekriterier vedrørende bygningsoplysninger FloorSearchRequestSubStructure - søgekriterier vedrørende etageoplysninger BuildingUnitSearchRequestSubStructure - søgekriterier vedrørende enhedsoplysninger CondominiumSearchRequestSubStructure - søgekriterier vedrørende ejerlejlighedsoplysninger TechnicalInstallationSearchRequestSubStructure - søgekriterier vedrørende oplysninger om tekniske anlæg RoomSearchRequestSubStructure - søgekriterier vedrørende rumoplysninger UseUnitSearchRequestSubStructure - søgekriterier vedrørende oplysninger om brugsenheder BuildingCaseSearchRequestSubStructure - søgekriterier vedrørende byggesagsoplysninger Kun hvis de enkelte understrukturer sendes med i søgningen tages højde for de felter som understrukturen indeholder. Hvis en understruktur ikke sendes med, betragtes alle felter i understrukturen som ikke udfyldt. Der gøres opmæksom på, at ikke alle understrukturer kan benyttes ved alle søgninger. For eksempel kan understrukturen SearchTechnicalInstallation- RequestSubStructure kun sendes med, når der søges på tekniske anlæg. Nogle andre understrukturer, som f.ek.s SearchAddressRequestSubStructure giver mening ved søgning på forskellige entiteter. Man kan se under de enkelte metoder hvilke understrukturer der må benyttes. De forskellige substrukturer er forklaret i detaljer i de næste 10 afsnit. Snitfladebeskrivelse Side 289 af 310

290 AddressSearchRequestSubStructure Denne struktur indeholder de søgekriterier som vedrører en adresse. Det kan både være en adgangsadresse eller en enhedsadresse. Udfylder man et af felterne etage eller side/dørnummer søger man med en enhedsadresse, ellers søger man med en adgangsadresse. AddressSearchRequestSubStructure Feltnavn i OIOXML navn Kommentar Vejkode StreetCode Der kan søges på vejkode. Hvis feltet er udfyldt med en vejkode, leveres kun adresser med den vejkode, hvis ikke udfyldt leveres alle vejkoder Husnummer og husbogstav StreetBuidlingFromIdentifier husnummer/husbogstav Der kan søges fra et fra til et andet. Hvis ikke Husnummer og husbogstav StreetBuildingToIdentifier udfyldt søges på alle til husnumre. Hvis kun fra felt er udfyldt, søges fra dette nummer og opefter, hvis kun til feltet er udfyldt søges fra 0 til det husnummer. Postnummer PostCodeIdentifier Der kan søges på postnummer. Bynavn DistrictSubdivisionIdentifier Der kan søges på bynavn. MailDeliverySublocationIdentifier Bygningsnavn? Etage FloorIdentifier Der kan søges på adressens etagebetegnelse. Side/dørnummer SuiteIdentifier Der kan søges på side/dørnummer. Der kan kun søges med vejkode og ikke med vejnavn. Det betyder at man skal oversætte et vejnavn til en vejkode før søgningen. Det samme gælder postnummer og postdistrikt. Her kan der kun søges med postnummer. Snitfladebeskrivelse Side 290 af 310

291 Den i StreetName vejledningen beskrevne webservice leverer alle mulige vejkoder og sammen med deres vejnavne. Bemærk, at FloorSearchRequestSubStructure også har feltet etagebetegnelse, kaldt FloorPhysicalIdentifier. Når man søger på feltet FloorIdentifier i forbindelse med den ovenfor beskrevne adressesøgning søger man på enhedsadressen. Når man søger på feltet FloorPsysicalIdentifier i forbindelse med FloorSearch- RequestSubStructure, søger man på etagebetegnelsen på entiteten Etage. Feltet FloorPhysicalIdentifier kan ikke være blank i modsætning til etagebetegnelsen i en enhedsadresse SiteSearchRequestSubStructure Denne struktur indeholder de søgekriterier som vedrører grundoplysninger. Det kan både være et ejendomsnummer eller en matrikel. SiteSearchRequestSubStructure Feltnavn i OIOXML navn Kommentar Ejendomsnummer Matrikeloplysninger MunicipalRealPropertyIdnetifier landparcelidentity- Structure Der kan søges på ejendomsnummer. Hvis feltet er udfyldt, leveres kun entiteter hørende til dette ejendomsnummer. Hvis feltet ikke er udfyldt leveres entiteter for alle ejendomsnumre. Der kan søges med matrikeloplysninger. Se afsnit for en beskrivelse af denne struktur BuildingSearchRequestSubStructure Denne struktur indeholder de søgekriterier som vedrører bygningsoplysninger. Snitfladebeskrivelse Side 291 af 310

292 BuildingSearchRequestSubStructure Feltnavn i OIOXML navn Kommentar Bygningsnummer fra Bygningsnummer til BuildingFromIdentifier BuildingToIdentifier Der kan søges fra et bygningsnummer til et andet. Hvis ikke udfyldt søges på alle bygningsnumre. Hvis kun fra felt er udfyldt, søges fra dette nummer og opefter, hvis kun til feltet er udfyldt søges fra 0 til det bygningsnummer. Anvendelseskode UseCode Der kan søges på bygningens anvendelseskode Udløbsdato for midlertidig opført bygning 15 cifret tekniske nøgle BK_Crud_id (teknisk nøgle) TemporaryExpirationDate BuildingHistoricUniversalIdentifier Udløbsdato for midlertidig opført bygning. Der kan søges med den 15 cifrede tekniske nøgle FloorSearchRequestSubStructure Denne struktur indeholder de søgekriterier som vedrører etageoplysninger. Strukturen indeholder kun feltet FloorPhysicalIdentifier. Bemærk, at AddressSearchRequestSubStructure også har feltet FloorIdentifier. Når man søger på feltet FloorIdentifier i forbindelse med adressen, søger man på enhedsadressens etagebetegnelse, søger man på feltet FloorPhysicalIdentifier i denne understruktur søger man på etagebetegnelsen på entiteten Etage. FloorSearchRequestSubStructure Feltnavn i OIOXML navn Kommentar Etage FloorPhysicalIdentifier Der kan søges på etagebetegnelse BuildingUnitSearchRequestSubStructure Denne struktur indeholder de søgekriterier som vedrører enhedsoplysninger. Snitfladebeskrivelse Side 292 af 310

293 BuildingUnitSearchRequestSubStructure Feltnavn i OIOXML navn Kommentar Anvendelseskode UnitUseCode Der kan søges på enhedens anvendelseskode TemporaryDispensationDate CondominiumSearchRequestSubStructure CondominiumSearchRequestSubStructure Feltnavn i OIOXML navn Kommentar Ejendomsnr.for ejerlejlighed Ejerlejlighedsnummer Denne struktur indeholder de søgekriterier som vedrører ejerlejlighedsoplysninger. CondominiumtRealPropertyIdentifier Der kan søges på ejerlejlighedens ejendomsnummer. CondominiumtSerialNumberIdentifier Der kan søges på ejerlejlighedsnummeret TechnicalInstallationSearchRequestSubStructure Denne struktur indeholder de søgekriterier som vedrører oplysninger om tekniske anlæg. TechnicalInstallationSearchRequestSubStructure Feltnavn i OIOXML navn Kommentar Anlægsnummer fra Anlægsnummer til TechnicalInstallationFromIdentifier Hvis kun fra felt er udfyldt, søges fra dette nummer og opefter, hvis kun til feltet er udfyldt søges fra 0 til det anlægsnummer. TechnicalInstallationToIdentifier Der kan søges fra et anlægsnummer til et andet. Hvis ikke udfyldt søges på alle anlægsnumre. Snitfladebeskrivelse Side 293 af 310

294 RoomSearchRequestSubStructure Denne struktur indeholder de søgekriterier som vedrører rumoplysninger. RoomSearchRequestSubStructure Feltnavn i OIOXML navn Kommentar Rumnummer fra RoomFromIdentifier Der kan søges fra et Rumnummer til RoomToIdentifier rumnummer til et andet. Hvis ikke udfyldt søges på alle rumnumre. Hvis kun fra felt er udfyldt, søges fra dette nummer og opefter, hvis kun til feltet er udfyldt søges fra 0 til det angivne rumnummer UseUnitSearchRequestSubStructure Denne struktur indeholder de søgekriterier som vedrører oplysninger om brugsenheder. UseUnitSearchRequestSubStructure Feltnavn i OIOXML navn Kommentar Brugsenhedens nummer fra Brugsenhedens nummer til UseUnitFromIdentifier UseUnitToIdentifier Der kan søges fra et nummer til et andet. Hvis ikke udfyldt søges på alle numre. Hvis kun fra felt er udfyldt, søges fra dette nummer og opefter, hvis kun til feltet er udfyldt søges fra 0 til det angivne nummer BuildingCaseSearchRequestSubStructure Denne struktur indeholder de søgekriterier som vedrører byggesagsoplysninger. Snitfladebeskrivelse Side 294 af 310

295 BuildingCaseSearchRequestSubStructure Feltnavn i OIOXML navn Kommentar Byggesagsnummer BuildingCaseIdentifier Der kan søges på byggesagsnummer. Hvis feltet er udfyldt med et byggesagsnummer, leveres kun byggesager eller entiteter hørende til en byggesag med det angivne byggesagsnummer. Hvis feltet ikke er udfyldt leveres byggesager eller sagsentiteter for alle byggesagsnumre. Byggesagsbehandler CaseWorkerReference Der kan søges på sagsbehandler. Hvis feltet er udfyldt med en sagsbehandler, leveres kun byggesager eller entiteter hørende til en byggesag med den angivne sagsbehandler. Hvis feltet ikke er udfyldt leveres byggesager eller sagsentiteter for alle sagsbehandler. Byggesagsdato (fra-dato) BuildingCaseFileFromDato Udfyldes felterne, leveres kun entiteter (byggesager Byggesagsdato (til-dato) BuildingCaseFileToDato eller sagsentiteter) som har en byggesagsdato eller hører til en byggesag med byggesagsdato som ligger i perioden fra til. Hvis kun fra-datoen angives, sættes tildatoen til dagsdato. Hvis kun til-datoen angives, leveres alle entiteter med byggesagsdato mindre eller lige med tildatoen Søgemetoder og søgeresultat Søgeresultatet returnerer altid en collection af den entitet man har søgt efter. Der benyttes de i kapitel 5 beskrevne entitetsstrukturer. Snitfladebeskrivelse Side 295 af 310

296 Der leveres højst 100 søgeresultater. Hvis flere end 100 entiteter opfylder søgekriteriet kan man begrænse søgekriteriet for at få reduceret antal af svar. Hvis der findes mere end 100 søgeresultater returneres returnidentifier 0 og reasonidentifier 40. IncludeHistoricIndicator er en indikator, som angiver om man ønsker at udføre en søgning medtaget historik eller ej. Hvis man sætter flaget til true, vil søgningen returnere stamentiteter og udgåede stamentiteter, men ikke sagsentiteter, hverken gældende eller udgåede. ResultTypeCode er en indikator, som angiver om man ønsker at få leveret hele entitetsstrukturen tilbage som resultat for søgningen eller om man kun ønsker at få leveret en del af informationen. Flaget er blevet indført af performancehensyn. Når man vælger at få hele strukturen leveret i søgningen, vil hele strukturen blive leveret. Vælger man kun at få leveret identifikationen som søgeresultat, leveres entitetsstrukturerne kun med følgende 4 understrukturer: EntityKeys AddressComplete (hvis entiteten har en adresse) CondominiumStructure (hvis ejerlejlighed) EntityBuildingCaseInformation (hvis sagstype 3) Pr. default leveres hele strukturer. Ud over den nævnte collection leverer søgemetoderne et resultat for metodekaldet. Dette resultat bliver som ved alle andre metoder beskrevet i strukturen ReturnMessage. Der henvises til afsnit 4.8 for en detaljeret beskrivelse af denne struktur. Snitfladebeskrivelse Side 296 af 310

297 15.3. Søgning på grunde Metoden SiteSearch fremsøger grunde med angivelse af et antal søgekriterier. Følgende søgekriterier (understrukturer) kan angives ved søgning på grunde: AddressSearchRequestSubStructure - søgekriterier vedrørende adresseoplysninger SiteSearchRequestSubStructure - søgekriterier vedrørende grundoplysninger BuildingCaseSearchRequestSubStructure - søgekriterier vedrørende byggesagsoplysninger De i afsnit og viste tegninger viser metodens input og output struktur. Grundene leveres i strukturen SiteStructure. Hvis der ikke findes en grund som opfylder søgekriterierne returneres returnidentifier 0 og reasonidentifier 10 i strukturen ReturnMessage SiteSearchRequestStructure SiteSearchResponseStructure Snitfladebeskrivelse Side 297 af 310

298 15.4. Søgning på bygninger Metoden BuildingSearch fremsøger bygninger med angivelse af et antal søgeskriterier. Følgende søgekriterier (understrukturer) kan angives ved søgning på bygninger: AddressSearchRequestSubStructure - søgekriterier vedrørende adresseoplysninger SiteSearchRequestSubStructure - søgekriterier vedrørende grundoplysninger BuildingSearchRequestSubStructure - søgekriterier vedrørende bygningsoplysninger BuildingCaseSearchRequestSubStructure - søgekriterier vedrørende byggesagsoplysninger De i afsnit og viste tegninger viser metodens input og output struktur. Bygningerne leveres i strukturen BuildingStructure. Hvis der ikke findes en bygning som opfylder søgekriterierne returneres returnidentifier 0 og reasonidentifier 10 i strukturen ReturnMessage. Hvis man søger bygninger frem ved angivelse af en adresse, fremfindes både bygninger, hvor den angivne adresse er bygningernes repræsentative adresse og bygninger, hvor den angivne adresse er knyttet til bygningernes opgang(e) BuildingSearchRequestStructure Snitfladebeskrivelse Side 298 af 310

299 BuildingSearchResponseStructure Snitfladebeskrivelse Side 299 af 310

300 15.5. Søgning på opgange/indgange Metoden EntranceSearch fremsøger opgange/indgange med angivelse af et antal søgekriterier. Følgende søgekriterier (understrukturer) kan angives ved søgning på opgange/indgange: AddressSearchRequestSubStructure - søgekriterier vedrørende adresseoplysninger SiteSearchRequestSubStructure - søgekriterier vedrørende grundoplysninger BuildingSearchRequestSubStructure - søgekriterier vedrørende bygningsoplysninger BuildingCaseSearchRequestSubStructure - søgekriterier vedrørende byggesagsoplysninger De i afsnit og viste tegninger viser metodens input og output struktur. Opgange/indgange leveres i strukturen EntranceStructure. Hvis der ikke findes en opgang/indgang som opfylder søgekriterierne returneres returnidentifier 0 og reasonidentifier 10 i strukturen ReturnMessage EntranceSearchRequestStructure EntranceSearchResponseStructure Snitfladebeskrivelse Side 300 af 310

301 15.6. Søgning på etager Metoden FloorSearch fremsøger etager med angivelse af et antal søgekriterier. Følgende søgekriterier (understrukturer) kan angives ved søgning på etager: AddressSearchRequestSubStructure - søgekriterier vedrørende adresseoplysninger SiteSearchRequestSubStructure - søgekriterier vedrørende grundoplysninger BuildingSearchRequestSubStructure - søgekriterier vedrørende bygningsoplysninger FloorSearchRequestSubStructure - søgekriterier vedrørende etageoplysninger BuildingCaseSearchRequestSubStructure - søgekriterier vedrørende byggesagsoplysninger En etage har ingen selvstændig adresse, men der søges på den overliggende bygningens adresse. Hvis feltet FloorIdentifier i AddressSearch- RequestSubStructure bliver udfyldt, ignoreres dette. Derimod kan man søge med feltet FloorPhysicalIdentifier i understrukturen FloorSearch- RequestSubStructure. De i afsnit og viste tegninger viser metodens input og output struktur. Etager leveres i strukturen FloorStructure. Hvis der ikke findes en etage som opfylder søgekriterierne returneres returni dentifier 0 og reasonidentifier 10 i strukturen ReturnMessage FloorSearchRequestStructure Snitfladebeskrivelse Side 301 af 310

302 FloorSearchResponseStructure Snitfladebeskrivelse Side 302 af 310

303 15.7. Søgning på enheder Metoden BuildingUnitSearch fremsøger enheder med angivelse af et antal søgekriterier. Følgende søgekriterier (understrukturer) kan angives ved søgning på enheder: AddressSearchRequestSubStructure - søgekriterier vedrørende adresseoplysninger SiteSearchRequestSubStructure - søgekriterier vedrørende grundoplysninger BuildingSearchRequestSubStructure - søgekriterier vedrørende bygningsoplysninger BuildingUnitSearchRequestSubStructure - søgekriterier vedrørende enhedsoplysninger CondominiumSearchRequestSubStructure - søgekriterier vedrørende ejerlejlighedsoplysninger BuildingCaseSearchRequestSubStructure - søgekriterier vedrørende byggesagsoplysninger De i afsnit og viste tegninger viser metodens input og output struktur. Enheder leveres i strukturen BuildingUnitStructure. Hvis der ikke findes en enhed som opfylder søgekriterierne returneres returnidentifier 0 og reasonidentifier 10 i strukturen ReturnMessage BuildingUnitSearchRequestStructure Snitfladebeskrivelse Side 303 af 310

304 BuildingUnitSearchResponseStructure Søgning på tekniske anlæg Metoden TechnicalInstallationSearch fremsøger tekniske anlæg med angivelse af et antal søgekriterier. Følgende søgekriterier (understrukturer) kan angives ved søgning på tekniske anlæg: AddressSearchRequestSubStructure - søgekriterier vedrørende adresseoplysninger SiteSearchRequestSubStructure - søgekriterier vedrørende grundoplysninger BuildingSearchRequestSubStructure - søgekriterier vedrørende bygningsoplysninger TechnicalInstallationSearchRequestSubStructure - søgekriterier vedrørende oplysninger om tekniske anlæg BuildingCaseSearchRequestSubStructure - søgekriterier vedrørende byggesagsoplysninger De i afsnit og viste tegninger viser metodens input og output struktur. Tekniske anlæg leveres i strukturen TechnicalInstallationStructure. Hvis der ikke findes et teknisk anlæg som opfylder søgekriterierne returneres returnidentifier 0 og reasonidentifier 10 i strukturen ReturnMessage TechnicalInstallationSearchRequestStructure Snitfladebeskrivelse Side 304 af 310

305 TechnicalInstallationSearchResponseStructure Søgning på rum Metoden RoomSearch fremsøger rum med angivelse af et antal søgekriterier. Følgende søgekriterier (understrukturer) kan angives ved søgning på rum: AddressSearchRequestSubStructure - søgekriterier vedrørende adresseoplysninger SiteSearchRequestSubStructure - søgekriterier vedrørende grundoplysninger BuildingSearchRequestSubStructure - søgekriterier vedrørende bygningsoplysninger RoomSearchRequestSubStructure - søgekriterier vedrørende oplysninger om rum BuildingCaseSearchRequestSubStructure - søgekriterier vedrørende byggesagsoplysninger De i afsnit og viste tegninger viser metodens input og output struktur. Rum leveres i strukturen RoomStructure. Hvis der ikke findes et rum som opfylder søgekriterierne returneres returnidentifier 0 og reasonidentifier 10 i strukturen ReturnMessage RoomSearchRequestStructure Snitfladebeskrivelse Side 305 af 310