Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

...

Description

This method returns details of rooms for the given boligmappaNumber.

Request

)
ParameterTypeMandatory/OptionalCommentsMaximum character length/limitDescription

boligmappaNumber

String

Mandatory

Not relevant

Boligmappa Number of the propertyA number generated by Boligmappa to uniquely identify properties registered in Boligmappa. (e.g. AAF1234)

applicationName

String

MandatoryThird party application identifier, identifying the client consuming the web service – (Length of the applicationName should

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

TypeDescription

List<Room>

List of rooms for the given Boligmappa numberboligmappaNumber

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 CodeDescription

123

An exception occured occurred while processing your request

138

ApplicationName applicationName length is has exceeded the maximum allowed character limit allowed (10)

146

The application name applicationName is not set

167

You are not authorized to use this web method

176

Boligmappa number boligmappaNumber is not provided

177

No property was found for the given Boligmappa number

 

 

given boligmappaNumber