Conference Room



[tags: DMA]

Resource Root

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

Summary


Resources Methods
https://localhost:8443/api/rest/conference-rooms

GET Retrieves a list of conference rooms filtered by optional query parameters.

POST  Creates a Conference Room.

https://localhost:8443/api/rest/conference-rooms/{conference-room-identifier}

GET  Retrieves the conference room specified by this conference-room-identifier DMA roles required: administrator, provisioner [tags: DMA] .

PUT  Updates a Conference Room specified by this conference room identifier.

DELETE  Deletes the Conference Room specified by this conference room identifier DMA roles required: administrator, provisioner [tags: DMA] .

https://localhost:8443/api/rest/conference-rooms/{domain}/{username}/default

GET  Retrieves the conference room default values.

https://localhost:8443/api/rest/conference-rooms/generate-random

GET  Retrieves a valid random id within configured range.

Resources


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


Methods

GET

Retrieves a list of conference rooms filtered by optional query parameters. [tags: DMA]

Request

Query Parameters

Name Type Description
start-before xs:dateTime
Filter to conference rooms whose availability starts before this time.
start-after xs:dateTime
Filter to conference rooms whose availability starts after this time.
not-before xs:dateTime
Filter to conference rooms whose availability does not end before this time.
passthru xs:string
Filter to conference rooms that contain this string in their passthru field.
passback xs:string
Filter to conference rooms that contain this string in their passback field.
domain xs:string
Part of the unique ID of Users, will search for conference rooms within this domain.
Must be used with username query parameter. Search by domain alone is not supported.
username xs:string
Filter to conference rooms owned by a user with this username. To make unique to a
specific user, also include domain.
wildcard-enabled xs:string
Filter to enable wildcard search. By default, it is set to TRUE. When this is set to TRUE, username
will become wild card enabled. User can search using "a*", "ad*", etc.
limit xs:int
Limit the number of users returned to this number, even if more results match the query.
Note 1: The valid integer range is 1 to 500; values between 501 and 2147483647 will result in the default limit of 500 being used.
Note 2: If the limit value is less than or equal to 0, the default of 500 will be used.
Note 3: If the limit value is greater than 2147483647, the system will respond with "404 Not Found".
This is a framework response that is due to a numeric value that exceeds a integer type.
page xs:int
When limiting the results, this specifies which page/subset of data to view.
Note 1: The valid integer range is 1 to 2147483647.
Note 2: If the page value is less than or equal to 0, the default of 1 will be used.
Note 3: If the page value is greater than 2147483647, the system will respond with "404 Not Found".
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-conference-room-list+xml
application/vnd.plcm.plcm-conference-room-list+json
application/vnd.plcm.plcm-conference-room-list-v2+xml
application/vnd.plcm.plcm-conference-room-list-v2+json
application/vnd.plcm.plcm-conference-room-list-v3+xml
application/vnd.plcm.plcm-conference-room-list-v3+json
application/vnd.plcm.plcm-conference-room-list-v4+xml
application/vnd.plcm.plcm-conference-room-list-v4+json
Conference Room information successfully retrieved
304
Conference Room information has not changed since the last search.

Note: The API client must provide the "plcm-conference-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-conference-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
conference rooms on the server.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. DMA roles required: administrator, provisioner
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Search by domain only is not supported.

POST


Creates a Conference Room.
Username is required. All Conference Rooms are tied to a user.
DMA roles required: administrator, provisioner

[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-conference-room+xml
application/vnd.plcm.plcm-conference-room+json
application/vnd.plcm.plcm-conference-room-v2+xml
application/vnd.plcm.plcm-conference-room-v2+json
application/vnd.plcm.plcm-conference-room-v3+xml
application/vnd.plcm.plcm-conference-room-v3+json
application/vnd.plcm.plcm-conference-room-v4+xml
application/vnd.plcm.plcm-conference-room-v4+json

Response

Status Representation Description
201 Conference Room created successfully.
400 text/plain
Bad request.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. DMA roles required: administrator, provisioner
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The conference room identifier cannot begin with the enterprise override prefix (EOVR:).
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The conference room identifier is already assigned to another user.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The conference room identifier is already being used by a virtual entry queue.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
This conference room identifier is already in use.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
No available room IDs. Please reconfigure the room ID generation range.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Conference room owner does not exist.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Invalid MCU Pool Order.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Invalid Territory
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The Conference Room already exists.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Conference owner domain is required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Conference owner username is required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The chairperson passcode and the conference passcode cannot be the same.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Invalid conference start or end time.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
plcm-itu-phone-number choice is not yet implemented. Please use dial-string instead.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
For dial strings that begin with "sip:", "sips:", or "tel:", the settings "audio-only", "encrypted-media", and "auto-disconnect" must be set to "false" and "dtmf-suffix" must be empty. This version of the DMA system does not support these features for SIP calls.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Invalid dial string.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-conference-template-name is false but conference template name is specified with a value other than default.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-max-participants is false but max participant is specified with a value other than default.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-duration-in-minutes is false but duration in minutes is specified with a value other than default.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-territory-name is false but territory name is specified with a value other than default.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-mcu-pool-order-name is false but MCU pool order name is specified with a value other than default.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-first-caller-mcu-affinity is false but first caller mcu affinity is specified with a value other than default.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-chairperson-passcode is false but chairperson passcode is specified with a value other than default.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-conference-passcode is false but conference passcode is specified with a value other than default.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-resource-priority is false but resource priority is specified with a value other than default.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-conference-template-name is true but conference template name is not specified.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-max-participants is true but max participant is not specified.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-duration-in-minutes is true but duration in minutes is not specified.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-territory-name is true but territory name is not specified.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-mcu-pool-order-name is true but MCU pool order name is not specified.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-first-caller-mcu-affinity is true but first caller mcu affinity is not specified.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-chairperson-passcode is true but chairperson passcode is not specified.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-conference-passcode is true but conference passcode is not specified.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-resource-priority is true but resource priority is not specified.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-conference-template-name is not specified but conference template name is specified.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-max-participants is not specified but max participant is specified.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-duration-in-minutes is not specified but duration in minutes is specified.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-territory-name is not specified but territory name is specified.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-mcu-pool-order-name is not specified but MCU pool order name is specified.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-first-caller-mcu-affinity is not specified but first caller mcu affinity is specified.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-chairperson-passcode is not specified but chairperson passcode is specified.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-conference-passcode is not specified but conference passcode is specified.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-resource-priority is not specified but resource priority is specified.

https://localhost:8443/api/rest/conference-rooms/{conference-room-identifier}


Template Parameters

Name Type Description
conference-room-identifier xs:string Conference room identifier of the Conference Room.

Methods

GET


Retrieves the conference room specified by this conference-room-identifier
DMA roles required: administrator, provisioner

[tags: DMA]

Response

Status Representation Description
200 application/vnd.plcm.plcm-conference-room+xml
application/vnd.plcm.plcm-conference-room+json
application/vnd.plcm.plcm-conference-room-v2+xml
application/vnd.plcm.plcm-conference-room-v2+json
application/vnd.plcm.plcm-conference-room-v3+xml
application/vnd.plcm.plcm-conference-room-v3+json
application/vnd.plcm.plcm-conference-room-v4+xml
application/vnd.plcm.plcm-conference-room-v4+json
Conference Room information successfully retrieved.
304
Conference Room information has not changed since the last search.

Note: The API client must provide the "plcm-conference-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
search in the "If-None-Match" header, then the HTTP response will contain the
search results in the message body.

The "plcm-conference-room" 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
the conference room on the server.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. DMA roles required: administrator, provisioner
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The conference room identifier cannot begin with the enterprise override prefix (EOVR:).
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The size of the conference must be larger than 0.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
No such Conference Room.

PUT


Updates a Conference Room specified by this conference room identifier.
DMA roles required: administrator, provisioner

[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-conference-room+xml
application/vnd.plcm.plcm-conference-room+json
application/vnd.plcm.plcm-conference-room-v2+xml
application/vnd.plcm.plcm-conference-room-v2+json
application/vnd.plcm.plcm-conference-room-v3+xml
application/vnd.plcm.plcm-conference-room-v3+json
application/vnd.plcm.plcm-conference-room-v4+xml
application/vnd.plcm.plcm-conference-room-v4+json

Response

Status Representation Description
204 Conference Room successfully updated.
301 Conference Room successfully updated and conference room identifier changed.
400 text/plain
Bad request.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. DMA roles required: administrator, provisioner
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The conference room identifier of an enterprise backend conference cannot be changed.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
A conference room with the supplied conference room identifier already exists.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
No such Conference Room.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Updating conference room owner is not allowed.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Conference owner domain is required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Conference owner username is required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Cannot edit a PCO conference.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The chairperson passcode and the conference passcode cannot be the same.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Invalid conference start or end time.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
plcm-itu-phone-number choice is not yet implemented. Please use dial-string instead.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Invalid dial string.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-conference-template-name is false but conference template name is specified with a value other than default.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-max-participants is false but max participant is specified with a value other than default.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-duration-in-minutes is false but duration in minutes is specified with a value other than default.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-territory-name is false but territory name is specified with a value other than default.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-mcu-pool-order-name is false but MCU pool order name is specified with a value other than default.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-first-caller-mcu-affinity is false but first caller mcu affinity is specified with a value other than default.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-chairperson-passcode is false but chairperson passcode is specified with a value other than default.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-conference-passcode is false but conference passcode is specified with a value other than default.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-resource-priority is false but resource priority is specified with a value other than default.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-conference-template-name is true but conference template name is not specified.