A subscription to events happening on the Polycom server Content-Type: application/vnd.plcm.plcm-subscription+xml. All attributes are used in ETag calculation except for calculated-expiration-date, entity-tag and atom-link.
Name | Type | Description | Attributes |
---|---|---|---|
atomLinkList | Array of Link | See Definition of Link | |
plcmError | PlcmError | See Definition of PlcmError | |
subscriptionIdentifier | string | The unique identifier of the subscription | |
consumerUrl | string | The URL of the notification client to which the Polycom server will publish notifications | Mandatory |
subjectResourceUrl | string | The URL of the resource which is the subject of the subscription | |
username | string | The username which the Polycom server will use when authenticating to the notification client | |
password | string | The password which the Polycom server will use when authenticating to the notification client | |
timeToLive | 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 | string | The domain of the user that owns this subscription. (i.e for a conference subscription, it would be the conference room owner) | |
subscriptionOwnerUsername | string | The username of the user that owns this subscription. (i.e for a conference subscription, it would be the conference room owner) | |
sendUpdateNotifications | 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. | |
entityTag | 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. | |
parameter | Array of Parameter | List of parameters of this subscription. | |
calculatedExpirationDate | dateTime |
Name | Type | Description | Attributes |
---|---|---|---|
name | Name | Name of the parameter. | Mandatory |
value | string | Value of the parameter. |
Name | Type | Restrictions |
---|---|---|
Name | string | Value must be one of:
|
EntityTag | string | Length of value must be >=1 Length of value must be <=64 |
Passthru | string | Length of value must be >=1 Length of value must be <=512 |
Passback | string | Length of value must be >=1 Length of value must be <=512 |