A subscription to events happening on the Polycom server Content-Type: application/vnd.plcm.plcm-subscription-v2+xml. All attributes are used in ETag calculation except for calculated-expiration-date, entity-tag and atom-link.
| Name | Type | Description | Attributes |
|---|---|---|---|
| atomLinkList | List of link | See Definition of link | |
| plcm-subscription-parameter-list | plcm-subscription-parameter-list | See Definition of plcm-subscription-parameter-list | |
| plcm-error | plcm-error | See Definition of plcm-error | |
| subscription-identifier | xs:string | The unique identifier of the subscription | |
| consumer-url | xs:string | The URL of the notification client to which the Polycom server will publish notifications | Mandatory |
| subject-resource-url | xs:string | The URL of the resource which is the subject of the subscription | |
| username | xs:string | The username which the Polycom server will use when authenticating to the notification client | |
| password | xs:string | The password which the Polycom server will use when authenticating to the notification client | |
| time-to-live | xs:int | The duration in seconds after which this subscription will expire. The max value is 26 hours, or 93600 seconds. If a value is entered greater than this, it will default back to 93600. A value of 0 will also set time-to-live to 93600 seconds. | Mandatory |
| subscriptionOwnerDomain | xs:string | The domain of the user that owns this subscription. (i.e for a conference subscription, it would be the conference room owner) | |
| subscriptionOwnerUsername | xs:string | The username of the user that owns this subscription. (i.e for a conference subscription, it would be the conference room owner) | |
| send-update-notifications | xs:boolean | Indicates whether this subscription will provide update notifications in addition to ADD and DELETE notifications | |
| passback | Passback | User defined value for that is opaque to the system | |
| passthru | Passthru | User defined value that that is opaque to the system. | |
| entity-tag | EntityTag | The unique value generated from the server object instance. This value is the same value that MUST be applied to the HTTP Entity Tag (ETag) header for a single instance of this object. Client modification of this field is not allowed for this instance. | |
| accept-media-type | xs:string | The notification media type accepted by the consumer notification client. For example, when subscribing for conference notifications, set this value to application/vnd.plcm.plcm-conference-notification+xml. When subscribing for participant notification, use application/vnd.plcm.plcm-participant-notifiation+xml | Mandatory |
| calculated-expiration-date | xs:dateTime |
| Name | Type | Restrictions |
|---|---|---|
| EntityTag | xs:string | Length of value must be >=1 Length of value must be <=64 |
| Passthru | xs:string | Length of value must be >=1 Length of value must be <=512 |
| Passback | xs:string | Length of value must be >=1 Length of value must be <=512 |