PlcmRoom

PlcmRoom

A system room account. Room accounts may be viewed, created, updated, and deleted using this API. Content-Type: application/vnd.plcm.plcm-room+xml. All attributes are used in ETag calculation except for entity-tag and atom-link.


PlcmRoom Fields

NameTypeDescriptionAttributes
atomLinkList Array of LinkSee Definition of Link
associatedDeviceArray of PlcmDevice
roomUuidstring Identifier of the room. Leave it blank if this is a new room
roomnameRoomname The room's name. Roomname uniquely identifies a room. Mandatory
domainstring The domain associated with the room. All rooms added manually to the system are in the LOCAL domain. Modification of this field is not allowed.
emailAddressEmailAddress The email address of the room.
descriptionDescription The description of the room.
tenantIdstring The tenant that this room belongs to.
siteUuidSiteUuid The site that the room belongs to. Mandatory
siteNameSiteName The site name that the room belongs to. This field is read only.
entityTagEntityTag The unique value generated from the server object instance. This value is the same value that MUST be applied to the HTTP Entity Tag (ETag) header for a single instance of this object. Client modification of this field is not allowed for this instance.


Nested Types/Restrictions


NameTypeRestrictions
EntityTagstring
Length of value must be >=1
Length of value must be <=64
SiteNamestring
Length of value must be >=0
Length of value must be <=512
SiteUuidstring
Length of value must be >=1
Length of value must be <=512
Descriptionstring
Length of value must be >=0
Length of value must be <=512
EmailAddressstring
Length of value must be >=0
Length of value must be <=512
Roomnamestring
Length of value must be >=0
Length of value must be <=256