DialAlias

[tags: RPRM]

Resource Root

https://localhost:8443/api/rest/dial-alias

Summary

Resources	Methods
https://localhost:8443/api/rest/dial-alias
https://localhost:8443/api/rest/dial-alias/h323-alias	GET Retrieves all reserved h323 alias of owner. POST Creates a h323 alias.
https://localhost:8443/api/rest/dial-alias/h323-alias/{alias-uuid}	PUT Updates values for the h323-alias. GET Retrieves h323 alias with passed id. DELETE Deletes h323-alias by id.
https://localhost:8443/api/rest/dial-alias/sip-alias	GET Retrieves all reserved sip alias of owner. POST Creates a sip alias.
https://localhost:8443/api/rest/dial-alias/sip-alias/{alias-uuid}	PUT Updates values for the sip-alias. GET Retrieves sip alias with passed id. DELETE Deletes sip-alias by id.

Resources

https://localhost:8443/api/rest/dial-alias

https://localhost:8443/api/rest/dial-alias/h323-alias

Methods

GET

Retrieves all reserved h323 alias of owner.
[tags: RPRM]

Request

Query Parameters

Name	Type	Description
owner-uuid	xs:string	Return only h323 alias that match the owner UUID.

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-h323-alias-list+xml application/vnd.plcm.plcm-h323-alias-list+json	H323 alias list information successfully retrieved.
304		H323 alias information has not changed since the last retrieval. Note: The API client must provide the "plcm-h323-alias-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 single h323 alias retrieval in the "If-None-Match" header, then the HTTP response will contain the device representation in the message body. The "plcm-h323-alias-list" ETag can be accessed from the initial retrieval result's HTTP response header. Also, subsequent retrievals require the identical domain and user name to ensure an equivalent ETag value. This also assumes no other client made changes to devices on the server.
403	application/vnd.plcm.plcm-error+xml	Unable to get permission.

POST

Creates a h323 alias.
[tags: RPRM]

Request

Representations

application/vnd.plcm.plcm-h323-alias+xml

application/vnd.plcm.plcm-h323-alias+json

Response

Status	Representation	Description
201		Dial-string-reservation created successfully
400	text/plain	Bad request
403	application/vnd.plcm.plcm-error+xml	Unable to get permission.
409	application/vnd.plcm.plcm-error+xml	User Link does not exist in Links.

https://localhost:8443/api/rest/dial-alias/h323-alias/{alias-uuid}

Template Parameters

Name	Type	Description
alias-uuid	xs:string

Methods

PUT

Updates values for the h323-alias.
[tags: RPRM]

Request

Representations

application/vnd.plcm.plcm-h323-alias+xml

application/vnd.plcm.plcm-h323-alias+json

Response

Status	Representation	Description
204		H323 alias information successfully updated. Note: The response will only contain both an ETag value and link to the updated h323-alias resource in the HTTP header.
409	application/vnd.plcm.plcm-error+xml	H323Alias alias-identifier is invalid.
409	application/vnd.plcm.plcm-error+xml	H323Alias alias-identifier in object does not match the URI.
428	application/vnd.plcm.plcm-error+xml	API resource update requires Etag value.

GET

Retrieves h323 alias with passed id.
Dial-string-reservation-identifier list can be get through get method of plcm-user.
[tags: RPRM]

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-h323-alias+xml application/vnd.plcm.plcm-h323-alias+json	H323 alias successfully retrieved
304		H323 alias information has not changed since the last search. Note: The API client must provide the "plcm-h323-alias" 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-h323-alias" 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 h323-alias on the server.
409	application/vnd.plcm.plcm-error+xml	H323Alias's alias-identifier is required.
409	application/vnd.plcm.plcm-error+xml	H323Alias alias-identifier is invalid.

DELETE

Deletes h323-alias by id.
[tags: RPRM]

Response

Status	Representation	Description
204		H323 alias is deleted successfully
404	application/vnd.plcm.plcm-error+xml	Bad Request
409	application/vnd.plcm.plcm-error+xml	H323Alias's alias-identifier is required.

https://localhost:8443/api/rest/dial-alias/sip-alias

Methods

GET

Retrieves all reserved sip alias of owner.
[tags: RPRM]

Request

Query Parameters

Name	Type	Description
owner-uuid	xs:string	Return only sip alias that match the owner UUID.

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-sip-alias-list+xml application/vnd.plcm.plcm-sip-alias-list+json	Sip alias list information successfully retrieved.
304		Sip alias information has not changed since the last retrieval. Note: The API client must provide the "plcm-sip-alias-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 single sip alias retrieval in the "If-None-Match" header, then the HTTP response will contain the device representation in the message body. The "plcm-sip-alias-list" ETag can be accessed from the initial retrieval result's HTTP response header. Also, subsequent retrievals require the identical domain and user name to ensure an equivalent ETag value. This also assumes no other client made changes to devices on the server.
403	application/vnd.plcm.plcm-error+xml	Unable to get permission.

POST

Creates a sip alias.
[tags: RPRM]

Request

Representations

application/vnd.plcm.plcm-sip-alias+xml

application/vnd.plcm.plcm-sip-alias+json

Response

Status	Representation	Description
201		Dial-string-reservation created successfully
400	text/plain	Bad request
403	application/vnd.plcm.plcm-error+xml	Unable to get permission.
409	application/vnd.plcm.plcm-error+xml	User Link does not exist in Links.

https://localhost:8443/api/rest/dial-alias/sip-alias/{alias-uuid}

Template Parameters

Name	Type	Description
alias-uuid	xs:string

Methods

PUT

Updates values for the sip-alias.
[tags: RPRM]

Request

Representations

application/vnd.plcm.plcm-sip-alias+xml

application/vnd.plcm.plcm-sip-alias+json

Response

Status	Representation	Description
204		Sip alias information successfully updated. Note: The response will only contain both an ETag value and link to the updated sip-alias resource in the HTTP header.
409	application/vnd.plcm.plcm-error+xml	SipAlias alias-identifier is invalid.
409	application/vnd.plcm.plcm-error+xml	SipAlias alias-identifier in object does not match the URI.
428	application/vnd.plcm.plcm-error+xml	API resource update requires Etag value.

GET

Retrieves sip alias with passed id.
Dial-string-reservation-identifier list can be get through get method of plcm-user.
[tags: RPRM]

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-sip-alias+xml application/vnd.plcm.plcm-sip-alias+json	Sip alias successfully retrieved
304		Sip alias information has not changed since the last search. Note: The API client must provide the "plcm-sip-alias" 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-sip-alias" 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 sip-alias on the server.
409	application/vnd.plcm.plcm-error+xml	SipAlias's alias-identifier is required.
409	application/vnd.plcm.plcm-error+xml	SipAlias alias-identifier is invalid.

DELETE

Deletes sip-alias by id.
[tags: RPRM]

Response

Status	Representation	Description
204		Sip alias is deleted successfully
404	application/vnd.plcm.plcm-error+xml	Bad Request
409	application/vnd.plcm.plcm-error+xml	SipAlias's alias-identifier is required.