GetRoomsForProperty

Description

This method returns details of rooms for the given boligmappaNumber.

Request

Parameter	Type	Mandatory/Optional	Maximum character length/limit	Description
boligmappaNumber	String	Mandatory	Not relevant	A number generated by Boligmappa to uniquely identify properties registered in Boligmappa. (e.g. AAF1234)
applicationName	String	Mandatory	Should be less than or equal to 10 characters	The name of the integration partner.

Request - sample input

<GetRoomsForProperty>
  <MethodParameters>
    <UserAuthentication>
      <UserName>username</UserName>
      <Password>password</Password>
      <AnyAttr attr0="XmlAttributeArray" isNull="false">
        <XmlAttributeArray0>System.Xml.XmlAttribute</XmlAttributeArray0>
      </AnyAttr>
    </UserAuthentication>
    <boligmappaNumber>AAE7005</boligmappaNumber>
    <applicationName>test</applicationName>
  </MethodParameters>
</GetRoomsForProperty>

Response

Type	Description
List<Room>	List of rooms for the given boligmappaNumber

Note

The output room list is not retrieved from the government registry. These rooms are created by property owners or other professionals as per the NS3600 standard rooms list.

Response - sample output

<GetRoomsForProperty>
  <MethodParameters>
    <RoomArray>
      <RoomArray0>
        <Id>40442</Id>
        <RoomName>Hele eiendommen1</RoomName>
        <RoomTypeId>0</RoomTypeId>
      </RoomArray0>
      <RoomArray1>
        <Id>40498</Id>
        <RoomName>Kjøkken1</RoomName>
        <RoomTypeId>5</RoomTypeId>
      </RoomArray1>
      <RoomArray2>
        <Id>40499</Id>
        <RoomName>Loft1</RoomName>
        <RoomTypeId>9</RoomTypeId>
      </RoomArray2>
      <RoomArray3>
        <Id>40443</Id>
        <RoomName>Soverom1</RoomName>
        <RoomTypeId>7</RoomTypeId>
      </RoomArray3>
    </RoomArray>
  </MethodParameters>
</GetRoomsForProperty>

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
167	You are not authorized to use this method
176	boligmappaNumber is not provided
177	No property was found for the given boligmappaNumber