LookupPropertiesForBuilding
Description
This method is used to get all the properties registered to a particular building.
Request
Parameter | Type | Mandatory/Optional | Maximum character length/limit | Description |
---|---|---|---|---|
boligmappaNumber | string | Mandatory/Optional | Not Relevant | A number generated by Boligmappa to uniquely identify properties registered in Boligmappa. (e.g. AAF1234) |
buildingInput | buildingInput | Mandatory/Optional | Not Relevant | The number assigned to a building E.g. 80361149 , Iteration of the building E.g. 1 |
applicationName | string | Mandatory | Should be less than or equal to 10 characters | The name of the integration partner |
Note:
- It is mandatory to provide either the boligmappaNumber or the buildingInput.
- Building Iteration will soon be obsolete and it is not necessary to provide it.
Request - input sample
<LookupPropertiesForBuilding>
<MethodParameters>
<UserAuthentication>
<UserName>username</UserName>
<Password>password</Password>
<AnyAttr attr0="XmlAttributeArray" isNull="false">
<XmlAttributeArray0>System.Xml.XmlAttribute</XmlAttributeArray0>
</AnyAttr>
</UserAuthentication>
<boligmappaNumber>KAF7974</boligmappaNumber>
<buildingInput>
<BuildingNumber>0</BuildingNumber>
<Iteration>0</Iteration>
</buildingInput>
<applicationName>test</applicationName>
</MethodParameters>
</LookupPropertiesForBuilding>
Response
Type | Description |
---|---|
List<Property> | List of properties in the building |
Response - output sample
<LookupPropertiesForBuilding>
<MethodParameters>
<PropertyArray>
<PropertyArray0>
<BoligmappaNumber>AAE7005</BoligmappaNumber>
<Matrikkel>
<Knr>1102</Knr>
<Gnr>38</Gnr>
<Bnr>1154</Bnr>
<Fnr>0</Fnr>
<Snr>0</Snr>
</Matrikkel>
<ShareNumber>0</ShareNumber>
<UnitNumber>H0101</UnitNumber>
<OrganizationNumber>0</OrganizationNumber>
<BuildingNumber>170194659</BuildingNumber>
<Iteration>0</Iteration>
<Address>
<StreetName>Gamle Austråttvei</StreetName>
<HouseNumber>28</HouseNumber>
<HouseLetter isNull="true" />
<ZipCode>4326</ZipCode>
<City>SANDNES</City>
</Address>
<PropertyOwners attr0="PropertyOwnerArray" isNull="false">
<PropertyOwnerArray0>
<FirstName>Colin Roy</FirstName>
<LastName>Ter Braak</LastName>
<DefaultAddress>Gamle Austråttvei 28, 4326 SANDNES</DefaultAddress>
<OrganizationNumber>0</OrganizationNumber>
</PropertyOwnerArray0>
<PropertyOwnerArray1>
<FirstName>Marianne</FirstName>
<LastName>Ter Braak-Budel</LastName>
<DefaultAddress>Gamle Austråttvei 28, 4326 SANDNES</DefaultAddress>
<OrganizationNumber>0</OrganizationNumber>
</PropertyOwnerArray1>
</PropertyOwners>
</PropertyArray0>
</PropertyArray>
</MethodParameters>
</LookupPropertiesForBuilding>
Exceptions
Error Code | Description |
---|---|
123 | An exception occurred while processing your request |
138 | applicationName length has exceeded the maximum character limit allowed (10) |
146 | The applicationName is not set |
239 | Invalid boligmappaNumber |
255 | No input is provided for boligmappaNumber or buildingNumber. Provide an input for at least one of these fields |
256 | Ambiguous input. Ensure the boligmappaNumber and the buildingNumber refer to the same building |
257 | Provided building does not exist in the system |