GetRoomsForTenant

Description


Important

Professionals are required to have purchased a valid license consisting of the 'Tenant' feature in order to use this web method. Please contact per.christian@boligmappa.no or yohanw@99x.lk to get a license set up for your company.

This method is used to get rooms in a tenant/office space. User should have a valid work-space for the given tenant in order to get rooms of that particular tenant/office space.

Request

ParameterTypeMandatory/OptionalComments
inputGetRoomsForTenantInputMandatoryGet Rooms for Tenant Input

applicationName

String

Mandatory

Should be less than or equal to 10 characters.

The name of the integration partner

Note: Use GetTenants web method to find the TenantId.

Request - sample input

<GetRoomsForTenant>
  <MethodParameters>
    <UserAuthentication>
      <UserName>username</UserName>
      <Password>password</Password>
      <AnyAttr attr0="XmlAttributeArray" isNull="false">
        <XmlAttributeArray0>System.Xml.XmlAttribute</XmlAttributeArray0>
      </AnyAttr>
    </UserAuthentication>
    <input>
      <TenantId>192</TenantId>
    </input>
    <applicationName>test</applicationName>
  </MethodParameters>
</GetRoomsForTenant>

Response

TypeDescription
GetRoomsForTenantOutputGet rooms for tenant output model

Response - sample output

<GetRoomsForTenant>
  <MethodParameters>
    <GetRoomsForTenantOutput>
      <TenantRoomArray>
        <TenantRoomArray0>
          <RoomId>5</RoomId>
          <RoomTypeId>7</RoomTypeId>
          <RoomTypeName>Soverom</RoomTypeName>
          <RoomName>testroom</RoomName>
          <RoomDescription isNull="false" />
          <CreatedDate>3/6/2018 11:03:39 AM</CreatedDate>
          <UpdatedDate>3/6/2018 11:03:39 AM</UpdatedDate>
        </TenantRoomArray0>
      </TenantRoomArray>
    </GetRoomsForTenantOutput>
  </MethodParameters>
</GetRoomsForTenant>

Exceptions

Error CodeDescription
110Input parameters contain null or invalid data

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

167You are not authorized to use this method
401Tenant does not exist
402You are not authorized for this tenant