Presence Config

[tags: DMA,RPRM]

Resource Root

https://localhost:8443/api/rest/config/presence-config

Resources	Methods
https://localhost:8443/api/rest/config/presence-config	GET Retrieves Presence Config. PUT Updates the Presence Config.
https://localhost:8443/api/rest/config/presence-config/default	GET Retrieves Presence default configuration settings.
https://localhost:8443/api/rest/config/presence-config/conference-contacts/{domain}	DELETE Removes conference contacts from integrated Active Directory.

Retrieves Presence Config. [tags: DMA]

Status	Representation	Description
200	application/vnd.plcm.plcm-presence-config+xml application/vnd.plcm.plcm-presence-config+json	Information successfully retrieved
304		Presence Config information has not changed since the last search. Note: The API client must provide the "plcm-presence-config" 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.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. DMA roles required: administrator, provisioner

Updates the Presence Config. [tags: DMA]

Status	Representation	Description
204		Presence Config updated successfully. The ETag returned in the HTTP header represents the current version of the Presence Config.
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	Unauthorized. DMA role required: administrator
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The ID supplied for the External SIP Peer is not valid.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The External SIP Peer is not configured for publishing.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	A Contact SIP Domain is required if publishing is enabled.
412	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The ETag supplied in the header and/or body does not match that on the server. This usually means that the template upon which the update is based has changed since the last time you accessed it.
428	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The ETag is missing and required.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The ETag in the header does not match that in the body Only one of these is required but if they are both supplied they must match.

Retrieves Presence default configuration settings. [tags: DMA]

Status	Representation	Description
200	application/vnd.plcm.plcm-presence-config+xml application/vnd.plcm.plcm-presence-config+json	Information successfully retrieved
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	User has insufficient permissions to perform the operation. DMA roles required:administrator, provisioner

Name	Type	Description
domain	xs:string	Specifies the SIP domain-name for which conference contacts will be removed from integrated Active Directory. Note 1: The URL form is https://{host}:{port}/api/rest/config/presence-config/conference-contacts/{domain} Note 2: Parameter "domain" is mandatory otherwise contacts can not be removed. Note 3: A fixed parameter value "*" will match all domain names and all contacts will be removed.

Removes conference contacts from integrated Active Directory.
[tags: DMA]

Status	Representation	Description
204		Request to remove conference contacts sent successfully.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Current user does not have the required permission. DMA roles required: administrator
404		Parameter domain is null.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Domain name is invalid.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Active Directory is not integrated with the system.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Publish presence for conference contacts is enabled.