LookupPropertyByAddress
Description
This method is used to retrieve property details along with plant information (if there is any) when the street address is provided. The property information is retrieved from Infoland service and combined with details like the boligmappaNumber if the property is already registered in Boligmappa.
In addition, it provides plant information if the plant is created by a particular company of the current user. Results returned by this method includes the address, Matrikkel, basic building details and property owners. The results can either be zero, or one or more Property Plants which are returned as a list.
Properties located inside a particular building are associated to that building. Properties for which the main building could not be located due to the unavailability of data is separately displayed.
Address list in Norway [New]
Implement an "Address Auto-suggestion" in the application when integrating Boligmappa API to avoid getting zero results due to spelling mistakes in the input address. The official address database in Norway can be downloaded here.
Request
Parameter | Type | Mandatory/Optional | Maximum character length/limit | Description |
---|---|---|---|---|
address | address | Mandatory | Not Relevant | Address of the property to be looked up. It is not necessary to provide the City which is available in the Address model |
municipalityNumber | int | Optional | Not Relevant | Municipality number of the area. |
applicationName | string | Mandatory | Should be less than or equal to 10 characters | The name of the integration partner |
Note
- The search is based on all parameters that are provided.
- municipalityNumber, ZipCode and HouseNumber are optional parameters that help Boligmappa to find the results quickly and more efficiently.
Request - input sample
<LookupPropertyByAddress>
<MethodParameters>
<UserAuthentication>
<UserName>username</UserName>
<Password>password</Password>
<AnyAttr attr0="XmlAttributeArray" isNull="false">
<XmlAttributeArray0>System.Xml.XmlAttribute</XmlAttributeArray0>
</AnyAttr>
</UserAuthentication>
<address>
<StreetName>Rosenlundveien</StreetName>
<HouseNumber>20</HouseNumber>
<HouseLetter>B</HouseLetter>
<ZipCode>3150</ZipCode>
<City>TOLVSRØD</City>
</address>
<municipalityNumber>0</municipalityNumber>
<applicationName>test</applicationName>
</MethodParameters>
</LookupPropertyByAddress>
Response
Returns a list of BuildingPlants and within them the PropertyPlants, if executed successfully.
Type | Description |
---|---|
List<Plant> | List of Plant objects. |
Response - output sample
<LookupPropertyByAddress>
<MethodParameters>
<PlantArray>
<PlantArray0 actualtype="BuildingPlant" basetype="Plant">
<BuildingId>4006</BuildingId>
<BoligmappaNumber>KAE0063</BoligmappaNumber>
<BuildingNumber>22186795</BuildingNumber>
<Iteration>0</Iteration>
<BuildingTypeCode>131</BuildingTypeCode>
<BuildingType>REKKEHUS</BuildingType>
<BuildingStatus>TATT I BRUK</BuildingStatus>
<Matrikkel>
<Knr>704</Knr>
<Gnr>139</Gnr>
<Bnr>53</Bnr>
<Fnr>0</Fnr>
<Snr>1</Snr>
</Matrikkel>
<FloorCount>3</FloorCount>
<PropertyCount>1</PropertyCount>
<TotalBuildingArea>221.0</TotalBuildingArea>
<UtilizedBuildingArea>221.0</UtilizedBuildingArea>
<UsedFrom>2005</UsedFrom>
<Properties attr0="PropertyPlantArray" isNull="false">
<PropertyPlantArray0>
<PropertyCategory>S</PropertyCategory>
<Matrikkel>
<Knr>704</Knr>
<Gnr>139</Gnr>
<Bnr>53</Bnr>
<Fnr>0</Fnr>
<Snr>1</Snr>
</Matrikkel>
<ShareNumber>0</ShareNumber>
<StreetAddress>Rosenlundveien 20 B, 3150 TOLVSRØD</StreetAddress>
<Address>
<StreetName>Rosenlundveien</StreetName>
<HouseNumber>20</HouseNumber>
<HouseLetter>B</HouseLetter>
<ZipCode>3150</ZipCode>
<City>TOLVSRØD</City>
</Address>
<BoligmappaNumber>AAA5296</BoligmappaNumber>
<UnitNumber>H0101</UnitNumber>
<PropertyType>REKKEHUS</PropertyType>
<Latitude>59.2805125005847</Latitude>
<Longitude>10.4860321350478</Longitude>
<MainBuildingNumber>22186795</MainBuildingNumber>
<MainBuildingIteration>0</MainBuildingIteration>
<PropertyOwners attr0="PropertyOwnerArray" isNull="false">
<PropertyOwnerArray0>
<FirstName>Hege Synnøve</FirstName>
<LastName>Lunder</LastName>
<DefaultAddress>Rosenlundveien 20B, 3150 TOLVSRØD</DefaultAddress>
<OrganizationNumber>0</OrganizationNumber>
</PropertyOwnerArray0>
</PropertyOwners>
<PlantId>5986</PlantId>
<PlantName>Rosenlundveien 20 B, 3150 TOLVSRØD</PlantName>
<CreatedTime>6/30/2016 4:16:51 PM</CreatedTime>
</PropertyPlantArray0>
</Properties>
<PlantId>6226</PlantId>
<PlantName>Rosenlundveien, 3150 TOLVSRØD - 22186795</PlantName>
<CreatedTime>12/10/2016 5:16:46 PM</CreatedTime>
</PlantArray0>
</PlantArray>
</MethodParameters>
</LookupPropertyByAddress>
Exceptions
Error Code | Description |
---|---|
101 | Postal number does not exist in the system |
102 | The street address cannot be null or empty |
123 | An exception occured while processing your request |
138 | applicationName length has exceeded the maximum character limit allowed (10) |
139 | Current version of Boligmappa does not support these type of properties (aksje/obligasjonsleiligheter) |
146 | The applicationName is not set |
212 | Invalid Zip code |