registration-share

An API for transmission/sharing of endpoint/registration data (CommObject). While this API may have some
usfulness in general it is mainly used between DMA servers to communicate endpoint registrations via REST.
[tags: INTERNAL]

Resource Root

https://localhost:8443/api/rest/registration-share

Summary

Resources	Methods
https://localhost:8443/api/rest/registration-share	GET Retrieves the registration share list. PUT Updates the registration share records.
https://localhost:8443/api/rest/registration-share/{registration-share-identifier}	GET Retrieves a single registration share record. PUT Updates an existing registration share. DELETE Deletes the registration share.
https://localhost:8443/api/rest/registration-share/lite	GET Retrieves the registration share list. PUT Updates the matching registration share records with the lite updates.
https://localhost:8443/api/rest/registration-share/lite/{registration-share-identifier}	GET Retrieves a single lite registration share record. PUT Updates an existing registration share with a lite update.

Resources

https://localhost:8443/api/rest/registration-share

Methods

GET

Retrieves the registration share list. [tags: DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-registration-share-list+xml application/vnd.plcm.plcm-registration-share-list+json	Registration share records successfully retrieved.
304		Registration share records have not changed since the last get. Note: The API client must provide the "plcm-registration-share-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-registration-share-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 registration share on the server.
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	User is not authorized to view the registration share records
403	application/vnd.plcm.plcm-error+xml	User has insufficient permissions to perform the operation.

PUT

Updates the registration share records. [tags: DMA]

Request

Representations

application/vnd.plcm.plcm-registration-share-list+xml

application/vnd.plcm.plcm-registration-share-list+json

Response

Status	Representation	Description
204		Registration share records successfully accepted. Note: The response will contain the ETag value and link that reflects the server's registration share resource in the HTTP response header.
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	User is not authorized to update the registration share records
403	application/vnd.plcm.plcm-error+xml	User has insufficient permissions to perform the operation.
406	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Not Acceptable

https://localhost:8443/api/rest/registration-share/{registration-share-identifier}

Template Parameters

Name	Type	Description
registration-share-identifier	xs:string	The unique identifier of the registration share

Methods

GET

Retrieves a single registration share record.
[tags: DMA]

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-registration-share+xml application/vnd.plcm.plcm-registration-share+json	Registration share information successfully retrieved
304		Registration share information has not changed since the last retrieval. Note: The API client must provide the "plcm-registration-share" 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-registration-share" 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 registration policies on the server.
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	User is not authorized to view the registration share records
403	application/vnd.plcm.plcm-error+xml	User has insufficient permissions to perform the operation.
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	No such registration share

PUT

Updates an existing registration share.
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-registration-share+xml

application/vnd.plcm.plcm-registration-share+json

Response

Status	Representation	Description
204		Registration share information successfully updated. Note: The response will only contain both an ETag value and link to the updated registration share resource.
304		Registration share information has not changed since the last retrieval. Note: The API client must provide the "plcm-registration-share" 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 registration share retrieval in the "If-None-Match" header, then the HTTP response will contain the registration share representation in the message body. The "plcm-registration-share" 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 registration share on the server.
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	User is not authorized to update the registration share records
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	User has insufficient permissions to perform the operation.
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	No such registration share
412	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The registration share resource has changed on the server. Note: The response will contain the ETag value and link that reflects the server's registration share resource in the HTTP response header. The API client must supply the ETag in the message body that is bounded by the "entity-tag" XML tag. Refer to the "plcm-registration-share.xsd" for details. If the message body does not contain the ETag value, the server will look for the ETag in the "If-Match" header.
428	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The API client must supply the ETag in the message body that is bounded by the "entity-tag" XML tag. Refer to the "plcm-registration-share.xsd" for details. If the message body does not contain the ETag value, the server will look for the ETag in the "If-Match" header.

DELETE

Deletes the registration share.
[tags: DMA]

Response

Status	Representation	Description
204		Registration share successfully deleted
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	User has insufficient permissions to perform the operation.
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	No such registration share.

https://localhost:8443/api/rest/registration-share/lite

Methods

GET

Retrieves the registration share list. [tags: DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-registration-share-lite-list+xml application/vnd.plcm.plcm-registration-share-lite-list+json	Registration share records successfully retrieved.
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	User is not authorized to view the registration share records
403	application/vnd.plcm.plcm-error+xml	User has insufficient permissions to perform the operation.

PUT

Updates the matching registration share records with the lite updates. [tags: DMA]

Request

Representations

application/vnd.plcm.plcm-registration-share-lite-list+xml

application/vnd.plcm.plcm-registration-share-lite-list+json

Response

Status	Representation	Description
204		Registration share records successfully accepted.
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	User is not authorized to update the registration share records
403	application/vnd.plcm.plcm-error+xml	User has insufficient permissions to perform the operation.
406	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Not Acceptable

https://localhost:8443/api/rest/registration-share/lite/{registration-share-identifier}

Template Parameters

Name	Type	Description
registration-share-identifier	xs:string	The unique identifier of the registration share

Methods

GET

Retrieves a single lite registration share record.
[tags: DMA]

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-registration-share-lite+xml application/vnd.plcm.plcm-registration-share-lite+json	Registration share information successfully retrieved
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	User is not authorized to view the registration share records
403	application/vnd.plcm.plcm-error+xml	User has insufficient permissions to perform the operation.
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	No such registration share

PUT

Updates an existing registration share with a lite update.
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-registration-share-lite+xml

application/vnd.plcm.plcm-registration-share-lite+json

Response

Status	Representation	Description
204		Registration share information successfully updated.
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	User is not authorized to update the registration share records
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	User has insufficient permissions to perform the operation.
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	No such registration share