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 project.

Request

ParameterTypeMandatory/Optional
Comments
Maximum character length/limitDescription

projectId

long

Mandatory/Empty*Not relevantThe
project Id
projectId of the project
projectCodestringOptional/Mandatory*
Project code
Not relevantprojectCode of the project E.g. ABC0001-A1 

applicationName

String

Mandatory

Third party application identifier, identifying the client consuming the web service. (Length of the ApplicationName should
Should be less than or equal to 10
)

Note: * Need to provide at least one of these fields (project Id, project code). Always project ID will be given first priority and considered as the only input whenever provided.

characters

The name of the integration partner

Note

It is mandatory to provide either the projectCode or the projectId. Preference is given to the projectId, if both the projectCode and the projectId are provide


Request - sample input

<GetRoomsForProject>
  <MethodParameters>
    <UserAuthentication>
      <UserName>username</UserName>
      <Password>password</Password>
      <AnyAttr attr0="XmlAttributeArray" isNull="false">
        <XmlAttributeArray0>System.Xml.XmlAttribute</XmlAttributeArray0>
      </AnyAttr>
    </UserAuthentication>
    <projectId>1211</projectId>
    <projectCode isNull="false" />
    <applicationName>test</applicationName>
  </MethodParameters>
</GetRoomsForProject>

Response

TypeDescription

List<GetRoomsForProjectDetails>

List of rooms in given project

Response - sample output

<GetRoomsForProject>
  <MethodParameters>
    <GetRoomsForProjectDetailsArray>
      <GetRoomsForProjectDetailsArray0>
        <Room>
          <RoomId>325</RoomId>
          <RoomTypeId>1</RoomTypeId>
          <RoomName>Bedroom</RoomName>
          <RoomDescription isNull="false" />
        </Room>
        <RoomType>Våtrom</RoomType>
      </GetRoomsForProjectDetailsArray0>
      <GetRoomsForProjectDetailsArray1>
        <Room>
          <RoomId>278</RoomId>
          <RoomTypeId>12</RoomTypeId>
          <RoomName>Kjølerom1rt</RoomName>
          <RoomDescription isNull="false" />
        </Room>
        <RoomType>Kjølerom</RoomType>
      </GetRoomsForProjectDetailsArray1>
      <GetRoomsForProjectDetailsArray2>
        <Room>
          <RoomId>285</RoomId>
          <RoomTypeId>14</RoomTypeId>
          <RoomName>Kontor1</RoomName>
          <RoomDescription isNull="false" />
        </Room>
        <RoomType>Kontor</RoomType>
      </GetRoomsForProjectDetailsArray2>
      <GetRoomsForProjectDetailsArray3>
        <Room>
          <RoomId>279</RoomId>
          <RoomTypeId>14</RoomTypeId>
          <RoomName>Kontor1rt</RoomName>
          <RoomDescription>treter</RoomDescription>
        </Room>
        <RoomType>Kontor</RoomType>
      </GetRoomsForProjectDetailsArray3>
      <GetRoomsForProjectDetailsArray4>
        <Room>
          <RoomId>284</RoomId>
          <RoomTypeId>4</RoomTypeId>
          <RoomName>Toalett (ikke bad)1</RoomName>
          <RoomDescription isNull="false" />
        </Room>
        <RoomType>Toalett-ikke bad</RoomType>
      </GetRoomsForProjectDetailsArray4>
    </GetRoomsForProjectDetailsArray>
  </MethodParameters>
</GetRoomsForProject>

Exceptions

...

Error CodeDescription

123

An exception occured 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

167You are not authorized to use this method

227

The project does not exist or the company is not connected to the given project

252

No input is provided

to project Id or project code. Need at least one of them

for projectId or projectCode. Provide the input for at least one of these fields

254Invalid
project code
projectCode 
273Project does not exist