Room

[tags: RPRM]

Resource Root

https://localhost:8443/api/rest/rooms

Summary

Resources	Methods
https://localhost:8443/api/rest/rooms	GET Retrieves a list of rooms matching the input search filter parameters. GET Retrieves a list of paginated rooms matching the input search filter parameters. POST Creates a local room account.
https://localhost:8443/api/rest/rooms/{value}	GET Retrieves information about a room account. DELETE Deletes information about a local room account [tags: RPRM] . PUT Updates information about a room account.
https://localhost:8443/api/rest/rooms/{value}/associated-devices	GET Get associated deviceIds of room. POST Associate devices with room.

Resources

https://localhost:8443/api/rest/rooms

Methods

GET

Retrieves a list of rooms matching the input search filter parameters.
[tags: RPRM]

Request

Query Parameters

Name	Type	Description
site-uuid	xs:string	Return only rooms that match the site-uuid.
limit	xs:int	Limit the number of rooms returned to this number, even if more rooms match the query. Note 1: The valid limit range is 1 to 1000. Note 2: If the limit value is less than or equal to zero, the system will ignore the limit request and return all results. Note 3: If the limit value is greater than 1000, the system will just return 1000 rooms". This is a framework response that is due to a numeric value that exceeds a integer type.

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-room-list+xml application/vnd.plcm.plcm-room-list+json	Room information successfully retrieved
304		Room information has not changed since the last search. Note: The API client must provide the "plcm-room-list" representation's ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval. This will improve network performance by reducing bandwidth consumption. If the API client chooses to exclude an ETag value from a previous, identical search in the "If-None-Match" header, then the HTTP response will contain the search results in the message body. The "plcm-room-list" ETag can be accessed from the initial search result's HTTP response header. Also, subsequent searches require the identical search filter to ensure an equivalent ETag value. This also assumes no other client made changes to rooms on the server.
403	application/vnd.plcm.plcm-error+xml	Current user does not have permission to request information.

GET

Retrieves a list of paginated rooms matching the input search filter parameters.
[tags: RPRM]

Request

Query Parameters

Name	Type	Description
site-uuid	xs:string	Return only rooms that match the site-uuid.
tenant-id	xs:int	Return only rooms that match the tenant-id (Area).
page-size	xs:int	Quantity of rooms by page
current-page	xs:int	Page number

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-room-list+xml application/vnd.plcm.plcm-room-list+json	Room information successfully retrieved
304		Room information has not changed since the last search. Note: The API client must provide the "plcm-room-list" representation's ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval. This will improve network performance by reducing bandwidth consumption. If the API client chooses to exclude an ETag value from a previous, identical search in the "If-None-Match" header, then the HTTP response will contain the search results in the message body. The "plcm-room-list" ETag can be accessed from the initial search result's HTTP response header. Also, subsequent searches require the identical search filter to ensure an equivalent ETag value. This also assumes no other client made changes to rooms on the server.
403	application/vnd.plcm.plcm-error+xml	Current user does not have permission to request information.

POST

Creates a local room account. Enterprise room accounts may not be created with this method. They must be imported from an enterprise directory.
UUID is optional. If not specified, one will be assigned.
Domain is optional. If specified, it must be set to LOCAL.
[tags: RPRM]

Request

Representations

application/vnd.plcm.plcm-room+xml

application/vnd.plcm.plcm-room+json

Response

Status	Representation	Description
201		Room created successfully.
400	text/plain	Bad request.
409	application/vnd.plcm.plcm-error+xml	The room already exists.
409	application/vnd.plcm.plcm-error+xml	Roomname is required.

https://localhost:8443/api/rest/rooms/{value}

Template Parameters

Name	Type	Description
value	xs:string	the uuid of room

Methods

GET

Retrieves information about a room account.
[tags: RPRM]

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-room+xml application/vnd.plcm.plcm-room+json	Room information successfully retrieved.
304		Room information has not changed since the last retrieval. Note: The API client must provide the "plcm-room" representation's ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval. This will improve network performance by reducing bandwidth consumption. If the API client chooses to exclude an ETag value from a previous, identical single room retrieval in the "If-None-Match" header, then the HTTP response will contain the room representation in the message body. The "plcm-room" ETag can be accessed from the initial retrieval result's HTTP response header. Also, subsequent retrievals require the identical domain and room name to ensure an equivalent ETag value. This also assumes no other client made changes to rooms on the server.
404	application/vnd.plcm.plcm-error+xml	No such room

DELETE

Deletes information about a local room account
[tags: RPRM]

Response

Status	Representation	Description
204		Room information successfully deleted
403	application/vnd.plcm.plcm-error+xml	Unable to get permission. User roles required: administrator, provisioner
404	application/vnd.plcm.plcm-error+xml	No such room.

PUT

Updates information about a room account.
[tags: RPRM]

Request

Representations

application/vnd.plcm.plcm-room+xml

application/vnd.plcm.plcm-room+json

Response

Status	Representation	Description
204		Room information successfully updated. Note: The response will only contain both an ETag value and link to the updated room resource.
400	text/plain	Bad request.
403	application/vnd.plcm.plcm-error+xml	Unable to get permission. User roles required: administrator, provisioner
404	application/vnd.plcm.plcm-error+xml	No such room.
412	application/vnd.plcm.plcm-error+xml	The room resource has changed on the server. Note: The response will contain the ETag value and link that reflects the server's room resource in the HTTP response header. The API client must supply the ETag in the message body that is bounded by the "entity-tag" XML tag. Refer to the "plcm-room.xsd" for details. If the message body does not contain the ETag value, the server will look for the ETag in the "If-Match" header.
428	application/vnd.plcm.plcm-error+xml	The API client must supply the ETag in the message body that is bounded by the "entity-tag" XML tag. Refer to the "plcm-room.xsd" for details. If the message body does not contain the ETag value, the server will look for the ETag in the "If-Match" header.

https://localhost:8443/api/rest/rooms/{value}/associated-devices

Template Parameters

Name	Type	Description
value	xs:string	the uuid of room

Methods

GET

Get associated deviceIds of room.
[tags: RPRM]

Request

Response

Status	Representation	Description
204	application/vnd.plcm.plcm-string-list+xml application/vnd.plcm.plcm-string-list+json	Get Associated deviceIds of room successfully.
400	application/vnd.plcm.plcm-error+xml	UUID is invalid
400	application/vnd.plcm.plcm-error+xml	The user-uuid is required.
403	application/vnd.plcm.plcm-error+xml	API access not available.
404	application/vnd.plcm.plcm-error+xml	User can not be found by UUID
403	application/vnd.plcm.plcm-error+xml	Unable to get permission.

POST

Associate devices with room.
[tags: RPRM]

Request

Representations

application/vnd.plcm.plcm-string-list+xml

application/vnd.plcm.plcm-string-list+json

Response

Status	Representation	Description
204		Associate devices with room successfully.
403	application/vnd.plcm.plcm-error+xml	Unable to get permission.