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-error+xml	This conference factory ID is in use for the room ID of an enterprise user.
409	application/vnd.plcm.plcm-error+xml	An override-default field was false but the corresponding field was specified with a value other than the default.
409	application/vnd.plcm.plcm-error+xml	An override-default field was true but the corresponding field was not specified.

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

Template Parameters

Name	Type	Description
value	xs:string	Unique identifier of the factory. [tags: DMA]

Methods

GET

Retrieves a conference factory. [tags: DMA]

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-conference-factory+xml application/vnd.plcm.plcm-conference-factory+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" 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" 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 factory 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
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	There is no factory with the identifier supplied in the URL.

PUT

Updates a conference factory. [tags: DMA]

Response

Status	Representation	Description
204		Conference factory updated successfully. The ETag returned in the HTTP header represents the current 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
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	There is no factory with the identifier supplied in the URL.
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-error+xml	This conference factory ID is in use for the room ID of an enterprise user.
409	application/vnd.plcm.plcm-error+xml	An override-default field was false but the corresponding field was specified with a value other than the default.
409	application/vnd.plcm.plcm-error+xml	An override-default field was true but the corresponding field was not specified.
412	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The ETag supplied in the header and/or body does not match that on the server. This usually means that the factory upon which the update is based has changed since the last time you accessed it.
428	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The ETag is missing and required.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The ETag in the header does not match that in the body Only one of these is required but if they are both supplied they must match.

DELETE

Deletes a conference factory. [tags: DMA]

Response

Status	Representation	Description
204		Conference factory deleted successfully.
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
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	There is no factory with the identifier supplied in the URL.