EditRoomForPlants (Not In Production)

Description

This method is used to edit room details for a given property. It returns the status (success/fail) of the edit operation.

Note

Rooms can only be created for properties. Not for buildings
A user can only create rooms for properties with a plant
User can not edit room details of a plant which are not owned by the user.

Request

Parameter	Type	Mandatory/Optional	Maximum character length/limit	Description

Parameter	Type	Mandatory/Optional	Maximum character length/limit	Description
plantId	int	Mandatory	Not relevant	Id of the plant which connects the particular property and company. Here the property is the one to which the room is added
propertyUnitId	int	Mandatory	Not relevant	Type of room to be added. All room types are listed in the Room model.
propertyUnitName	string	Mandatory	Should be less than or equal to 50 characters	Name of the room added
propertyUnitTypeId	int	Mandatory	Not relevant	The name of the integration partner

Request - Sample Input

<AddRoom>
  <MethodParameters>
    <UserAuthentication>
      <UserName>username</UserName>
      <Password>password</Password>
      <AnyAttr attr0="XmlAttributeArray" isNull="false">
        <XmlAttributeArray0>System.Xml.XmlAttribute</XmlAttributeArray0>
      </AnyAttr>
    </UserAuthentication>
    <plantId>6731</plantId>
    <roomTypeId>2</roomTypeId>
    <roomName>Bedroom</roomName>
    <applicationName>test</applicationName>
  </MethodParameters>
</AddRoom>

Response

Property	Type	Description

Property	Type	Description
status	boolean	Return true if the edit is successful
errorcode	int	Return 0 if the edit is successful

Request - sample output

<Status>boolean</Status>

</EditRoomResult>

Exceptions

Error Code	Description

Error Code	Description
110	Input parameters contain null or invalid data
111	plantId does not exist for your company or your license does not authorize you to access this plantId
123	An exception occurred while processing your request
130	Input plantId is either zero or negative. Please enter a positive value for the id
132	plantId does not exist
138	applicationName length has exceeded the maximum character limit allowed (10)
146	The applicationName is not set
152	No property is connected to the given plantId
157	plantId is required
167	You are not authorized to use this method
207	RoomId does not exist or belong to the given plant
281	Room already exists
283	roomName is not provided
284	You are not authorized to add a room to this property or your license does not authorize you to access this property
286	Invalid roomType
296	Do not insert a comma in the roomName
300	roomName length has exceeded the maximum character limit allowed (50)