NamingSipuri



[tags: RPRM]

Resource Root

https://localhost:8443/api/rest/naming/naming-sipuri/schemes

Summary


Resources Methods
https://localhost:8443/api/rest/naming/naming-sipuri/schemes

GET Retrieves the current SIP URI's system name scheme.

POST Configures the server's sipuri naming settings.

PUT Configures the server's sipuri naming settings.

https://localhost:8443/api/rest/naming/naming-sipuri/schemes/naming-fields

GET  Retrieves the current list of the supported SIP URI naming fields.

https://localhost:8443/api/rest/naming/naming-sipuri/schemes/naming-separators

GET  Retrieves the current list of the supported SIP URI naming separators.

Resources


https://localhost:8443/api/rest/naming/naming-sipuri/schemes


Methods

GET

Retrieves the current SIP URI's system name scheme.

Request

Query Parameters

Name Type Description
area-identifier xs:string Return only sipuri scheme that match the area-id. An area has a sipuri scheme.

Response

Status Representation Description
200 application/vnd.plcm.plcm-naming-sipuri-scheme+xml
application/vnd.plcm.plcm-naming-sipuri-scheme+json
Retrieval of sipuri naming configuration was successful
304
sipuri naming configuration has not changed.

Note: The API client must provide the "plcm-naming-sipuri-scheme" 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
request in the "If-None-Match" header, then the HTTP response will contain the
same information in the message body as the previous request.

The "plcm-naming-sipuri-scheme" ETag can be accessed from the initial request result's HTTP
response header.

If another client has changed the sipuri naming configuration, the ETag value will be out of date
and a request with the outdated ETag will return the full "plcm-naming-sipuri-scheme".
401 application/vnd.plcm.plcm-error+xml
Invalid credentials.
403 application/vnd.plcm.plcm-error+xml
Area feature is not available.
404 application/vnd.plcm.plcm-error+xml
The scheme does not exist.

POST

Configures the server's sipuri naming settings.

Request

Query Parameters

Name Type Description
area-identifier xs:string Disable sipuri scheme that match the area-id. An area has a sipuri scheme.

Response

Status Representation Description
204 sipuri naming settings were applied successfully
401 application/vnd.plcm.plcm-error+xml
Invalid credentials.
403 application/vnd.plcm.plcm-error+xml
Area feature is not available.
404 application/vnd.plcm.plcm-error+xml
The scheme does not exist.

PUT

Configures the server's sipuri naming settings.

Request

Query Parameters

Name Type Description
area-identifier xs:string Update only sipuri scheme that match the area-id. An area has a sipuri scheme.

Representations

application/vnd.plcm.plcm-naming-sipuri-scheme+xml
application/vnd.plcm.plcm-naming-sipuri-scheme+json

Response

Status Representation Description
204 sipuri naming settings were applied successfully
401 application/vnd.plcm.plcm-error+xml
Invalid credentials.
403 application/vnd.plcm.plcm-error+xml
Area feature is not available.
404 application/vnd.plcm.plcm-error+xml
The scheme does not exist.
409 application/vnd.plcm.plcm-error+xml
The scheme rule can't be empty.

https://localhost:8443/api/rest/naming/naming-sipuri/schemes/naming-fields


Methods

GET


Retrieves the current list of the supported SIP URI naming fields. The list of SIP URI naming fields
is dependent on the server's implementation.

Response

Status Representation Description
200 application/vnd.plcm.plcm-naming-field-list+xml
application/vnd.plcm.plcm-naming-field-list+json
List of the current SIP URI naming fields supported on the server
304
Note: The API client must provide the "plcm-naming-field-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
request in the "If-None-Match" header, then the HTTP response will contain the
same information in the message body as the previous request.

The "plcm-naming-field-list" ETag can be accessed from the initial request result's HTTP
response header.

If another client has changed the naming-field configuration, the ETag value will be out of date
and a request with the outdated ETag will return the full "plcm-naming-field-list".
401 application/vnd.plcm.plcm-error+xml
Invalid credentials.

https://localhost:8443/api/rest/naming/naming-sipuri/schemes/naming-separators


Methods

GET


Retrieves the current list of the supported SIP URI naming separators. The list of SIP URI naming separators
is dependent on the server's implementation.

Response

Status Representation Description
200 application/vnd.plcm.plcm-naming-separator-list+xml
application/vnd.plcm.plcm-naming-separator-list+json
List of the current SIP URI naming separators supported on the server
304
Note: The API client must provide the "plcm-naming-separator-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
request in the "If-None-Match" header, then the HTTP response will contain the
same information in the message body as the previous request.

The "plcm-naming-separator-list" ETag can be accessed from the initial request result's HTTP
response header.

If another client has changed the separator configuration, the ETag value will be out of date
and a request with the outdated ETag will return the full "plcm-naming-separator-list".
401 application/vnd.plcm.plcm-error+xml
Invalid credentials.