AddRoomsForTenant

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 create rooms for tenants

Note: 

  • Multiple rooms can be added at the same time.
  • Multiple rooms with the same name for the given tenant is not allowed.

Request

ParameterTypeMandatory/OptionalComments
inputAddRoomsForTenantInputMandatoryAdd Rooms for Tenants input model


Request - sample input

<AddRoomsForTenant>
  <MethodParameters>
    <UserAuthentication>
      <UserName>username</UserName>
      <Password>password</Password>
      <AnyAttr attr0="XmlAttributeArray" isNull="false">
        <XmlAttributeArray0>System.Xml.XmlAttribute</XmlAttributeArray0>
      </AnyAttr>
    </UserAuthentication>
    <input>
      <TenantId>5</TenantId>
      <Rooms attr0="TenantRoomInputArray" isNull="false">
        <TenantRoomInputArray0>
          <RoomTypeId>5</RoomTypeId>
          <RoomName>test</RoomName>
          <RoomDescription isNull="false" />
        </TenantRoomInputArray0>
      </Rooms>
    </input>
    <applicationName>test</applicationName>
  </MethodParameters>
</AddRoomsForTenant>

Response

TypeDescription
AddRoomsForTenantOutputAdd room for tenant output model


AddRoomsForTenantOutput

Parameter
Type
Description
StatusesList<AddRoomForTenantStatus>Project room creation statuses list

Response - sample output

<AddRoomsForTenant>
  <MethodParameters>
    <AddRoomsForTenantOutput>
      <Statuses attr0="AddRoomForTenantStatusArray" isNull="false">
        <AddRoomForTenantStatusArray0>
          <Status>1</Status>
          <Room>
            <RoomId>6</RoomId>
            <RoomTypeId>5</RoomTypeId>
            <RoomTypeName>Kjøkken</RoomTypeName>
            <RoomName>test</RoomName>
            <RoomDescription isNull="false" />
            <CreatedDate>3/6/2018 9:26:42 AM</CreatedDate>
            <UpdatedDate>3/6/2018 9:26:42 AM</UpdatedDate>
          </Room>
          <ErrorCode>0</ErrorCode>
        </AddRoomForTenantStatusArray0>
      </Statuses>
    </AddRoomsForTenantOutput>
  </MethodParameters>
</AddRoomsForTenant>

Exceptions

Error CodeDescription
110Input parameters contain null or invalid data
123An exception occured while processing your request
138applicationName length has exceeded the maximum character limit allowed (10) 
146The applicationName is not set
281Room already exists
283roomName is not provided
286Invalid roomType
296Do not insert a comma in the roomName
300roomName length has exceeded the maximum character limit allowed (50) 
301Room description length has exceeded the maximum character limit allowed (250) 
401Tenant does not exist
402You are not authorized for this tenant
411You need to have the Tenants Addon to perform this action
412The office space (tenant) no longer exists and this workspace has been deactivated.