MCU Pool Order



[tags: DMA]

Resource Root

https://localhost:8443/api/rest/mcu-pool-orders

Summary


Resources Methods
https://localhost:8443/api/rest/mcu-pool-orders

GET  Get all MCU pool orders on the DMA.

POST  Creates an MCU pool order.

https://localhost:8443/api/rest/mcu-pool-orders/{value}

GET  Get an MCU pool order on the DMA.

PUT Updates information about an MCU pool order.

DELETE Deletes an MCU pool order.

Resources


https://localhost:8443/api/rest/mcu-pool-orders


Methods

GET


Get all MCU pool orders on the DMA.
[tags: DMA]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-mcu-pool-order-list+xml
application/vnd.plcm.plcm-mcu-pool-order-list+json
application/vnd.plcm.plcm-mcu-pool-order-list-v2+xml
application/vnd.plcm.plcm-mcu-pool-order-list-v2+json
MCU pool orders information successfully retrieved
304
MCU pool order has not changed since the last search.

Note: The API client must provide the "plcm-mcu-pool-order-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-mcu-pool-order-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 the
MCU pool order on the server.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Permission denied. DMA roles required: administrator, provisioner

POST


Creates an MCU pool order.
Name is required.
DMA roles required: administrator

[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-mcu-pool-order+xml
application/vnd.plcm.plcm-mcu-pool-order+json
application/vnd.plcm.plcm-mcu-pool-order-v2+xml
application/vnd.plcm.plcm-mcu-pool-order-v2+json

Response

Status Representation Description
201 The MCU pool order definition was created successfully.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Bad request.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Name is required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Name must be between 1 and 30 characters in length, inclusive.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The supplied name contains invalid character(s), e.g. comma, quotation mark.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The supplied name is in use by another MCU pool order.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The MCU pool list contains an empty or missing MCU pool identifier.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The MCU pool list contains an MCU pool identifier that does not map to a known MCU pool.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The MCU pool list contains an MCU pool more than once.

https://localhost:8443/api/rest/mcu-pool-orders/{value}


Template Parameters

Name Type Description
value xs:string Unique name or identifier of the MCU pool order.

Methods

GET


Get an MCU pool order on the DMA.
[tags: DMA]

Request

Query Parameters

Name Type Description
type xs:string
Specifies an enumerated type that will indicate that the resource should be read by its
human-readable name or immutable, unique identifier such as a UUID, integer, etc.

The purpose of allowing the API client to specify an enumerated type ensures the option
to read this resource by its human-readable name. Unfortunately, the name can be modified
in the system and, as a result, will invalidate the resource URL. However, the API client
has the option of reading this resource by its immutable, unique identifier that can be
retrieved in the entity body.

Note 1: The URL form is https://{host}:{port}/api/rest/{resource}/{value}?type={name|id}
Note 2: If the "name" enumeration is specified, then the value should correspond to the name.
Otherwise, the resource cannot not be found.
Note 3: If the "id" enumeration is specified, the the value should correspond to the unique
identifier. Otherwise, the resource cannot not be found.
Note 4: The read will default to the "id" type enumeration. As a result, the {value} parameter
can simply specify the unique identifier and the query parameter, "?type=id", is not required.

Response

Status Representation Description
200 application/vnd.plcm.plcm-mcu-pool-order+xml
application/vnd.plcm.plcm-mcu-pool-order+json
application/vnd.plcm.plcm-mcu-pool-order-v2+xml
application/vnd.plcm.plcm-mcu-pool-order-v2+json
MCU pool order information successfully retrieved
304
MCU pool order has not changed since the last search.

Note: The API client must provide the "plcm-mcu-pool-order" 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-mcu-pool-order" 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
MCU pool order on the server.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Permission denied. DMA roles required: administrator
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
No such MCU pool order

PUT

Updates information about an MCU pool order. [tags: DMA]

Request

Query Parameters

Name Type Description
type xs:string
Specifies an enumerated type that will indicate that the resource should be read by its
human-readable name or immutable, unique identifier such as a UUID, integer, etc.

The purpose of allowing the API client to specify an enumerated type ensures the option
to read this resource by its human-readable name. Unfortunately, the name can be modified
in the system and, as a result, will invalidate the resource URL. However, the API client
has the option of reading this resource by its immutable, unique identifier that can be
retrieved in the entity body.

Note 1: The URL form is https://{host}:{port}/api/rest/{resource}/{value}?type={name|id}
Note 2: If the "name" enumeration is specified, then the value should correspond to the name.
Otherwise, the resource cannot not be found.
Note 3: If the "id" enumeration is specified, the the value should correspond to the unique
identifier. Otherwise, the resource cannot not be found.
Note 4: The read will default to the "id" type enumeration. As a result, the {value} parameter
can simply specify the unique identifier and the query parameter, "?type=id", is not required.

Representations

application/vnd.plcm.plcm-mcu-pool-order+xml
application/vnd.plcm.plcm-mcu-pool-order+json
application/vnd.plcm.plcm-mcu-pool-order-v2+xml
application/vnd.plcm.plcm-mcu-pool-order-v2+json

Response

Status Representation Description
204 MCU pool order successfully updated.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Bad request.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
No MCU pool order with the given identifier could be found.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Name is required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Name must be between 1 and 30 characters in length, inclusive.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The supplied name contains invalid character(s), e.g. comma, quotation mark.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The MCU pool list contains an empty or missing MCU pool identifier.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The MCU pool list contains an MCU pool identifier that does not map to a known MCU pool.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The MCU pool list contains an MCU pool more than once.

DELETE

Deletes an MCU pool order. [tags: DMA]

Request

Query Parameters

Name Type Description
type xs:string
Specifies an enumerated type that will indicate that the resource should be read by its
human-readable name or immutable, unique identifier such as a UUID, integer, etc.

The purpose of allowing the API client to specify an enumerated type ensures the option
to read this resource by its human-readable name. Unfortunately, the name can be modified
in the system and, as a result, will invalidate the resource URL. However, the API client
has the option of reading this resource by its immutable, unique identifier that can be
retrieved in the entity body.

Note 1: The URL form is https://{host}:{port}/api/rest/{resource}/{value}?type={name|id}
Note 2: If the "name" enumeration is specified, then the value should correspond to the name.
Otherwise, the resource cannot not be found.
Note 3: If the "id" enumeration is specified, the the value should correspond to the unique
identifier. Otherwise, the resource cannot not be found.
Note 4: The read will default to the "id" type enumeration. As a result, the {value} parameter
can simply specify the unique identifier and the query parameter, "?type=id", is not required.

Response

Status Representation Description
204 MCU pool order successfully deleted.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Bad request.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The MCU pool order cannot be deleted. It is configured as the default MCU pool order.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
This MCU pool order cannot be deleted. It is used by one or more External SIP Peers.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
This MCU pool order cannot be deleted. It is used by one or more Resolve to Lync conference ID dial rules.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
No MCU pool order with the given identifier could be found.