DialStringReservation

[tags: RPRM]

Resource Root

https://localhost:8443/api/rest/dial-string-reservations

Summary

Resources	Methods
https://localhost:8443/api/rest/dial-string-reservations	POST Creates a dial string reservation.
https://localhost:8443/api/rest/dial-string-reservations/{dial-string-identifier}	PUT Updates values for the dial-string-reservation.
https://localhost:8443/api/rest/dial-string-reservations/{dial-string-identifier}/{dial-string-type}	GET Retrieves dial string reservation with passed id. DELETE Deletes dial-string-reservation by id and dial-string-type Dial-string-reservation-identifier list can be get through get method of plcm-user.

Resources

https://localhost:8443/api/rest/dial-string-reservations

Methods

POST

Creates a dial string reservation. H323 or SIP dial string may be created with this method.
[tags: RPRM]

Request

Representations

application/vnd.plcm.plcm-dial-string-reservation+xml

application/vnd.plcm.plcm-dial-string-reservation+json

Response

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

https://localhost:8443/api/rest/dial-string-reservations/{dial-string-identifier}

Template Parameters

Name	Type	Description
dial-string-identifier	xs:string

Methods

PUT

Updates values for the dial-string-reservation.
Dial-string-reservation-identifier list can be get through get method of plcm-user.
[tags: RPRM]

Request

Representations

application/vnd.plcm.plcm-dial-string-reservation+xml

Response

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

https://localhost:8443/api/rest/dial-string-reservations/{dial-string-identifier}/{dial-string-type}

Template Parameters

Name	Type	Description
dial-string-identifier	xs:string
dial-string-type	xs:string

Methods

GET

Retrieves dial string reservation 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-dial-string-reservation+xml application/vnd.plcm.plcm-dial-string-reservation+json	Dial-string-reservation successfully retrieved
304		Dial string reservation information has not changed since the last search. Note: The API client must provide the "plcm-dial-string-reservation" 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-dial-string-reservation" 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 dial-string-reservations on the server.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	DialStringReservation's dial-string-identifier is required.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	DialStringReservation's dial-string-type is required.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	DialStringReservation dial-string-identifier is invalid.

DELETE

Deletes dial-string-reservation by id and dial-string-type
Dial-string-reservation-identifier list can be get through get method of plcm-user.
[tags: RPRM]

Response

Status	Representation	Description
204		Dial-string-reservation is deleted successfully
404	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	DialStringReservation's dial-string-identifier is required.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	DialStringReservation's dial-string-type is required.