Conference Factory



[tags: DMA]

Resource Root

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

Summary


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

GET Retrieves conference factories.

POST  Creates a conference factory.

https://localhost:8443/api/rest/conference-factories/{conference-factory-identifier}

GET Retrieves a conference factory.

PUT Updates a conference factory.

DELETE Deletes a conference factory.

Resources


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


Methods

GET

Retrieves conference factories. [tags: DMA]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-conference-factory-list+xml
application/vnd.plcm.plcm-conference-factory-list+json
Information successfully retrieved.
304
Conference factory information has not changed since the last search.

Note: The API client must provide the "plcm-conference-factory-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-factory-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 factories 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

POST


Creates a conference factory. Any submitted ID is ignored. The ID is assigned by the system.

DMA roles required: administrator, provisioner

[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-conference-factory+xml
application/vnd.plcm.plcm-conference-factory+json

Response

Status Representation Description
201
Conference factory created successfully. The ETag returned in the HTTP header represents the version
of the conference factory.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Bad request.
401 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unauthorized. DMA roles required: administrator, provisioner
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
This conference factory ID is in use as a conference factory.
409 application/vnd.plcm.plcm-error+xml
This conference factory ID is in use as a conference room.
409 application/vnd.plcm.plcm-error+xml
This conference factory ID is in use as a conference room alias.
409 application/vnd.plcm.plcm-error+xml
This conference factory ID is in use as a VEQ.
409 application/vnd.plcm.plcm-error+xml
This conference factory ID is in use as an active conference.
409 application/vnd.plcm.plcm