PlcmSubscription

PlcmSubscription

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.


PlcmSubscription Fields

NameTypeDescriptionAttributes
atomLinkList Array of LinkSee Definition of Link
plcmError PlcmErrorSee Definition of PlcmError
subscriptionIdentifierstring The unique identifier of the subscription
consumerUrlstring The URL of the notification client to which the Polycom server will publish notifications Mandatory
subjectResourceUrlstring The URL of the resource which is the subject of the subscription
usernamestring The username which the Polycom server will use when authenticating to the notification client
passwordstring The password which the Polycom server will use when authenticating to the notification client
timeToLiveint 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
subscriptionOwnerDomainstring The domain of the user that owns this subscription. (i.e for a conference subscription, it would be the conference room owner)
subscriptionOwnerUsernamestring The username of the user that owns this subscription. (i.e for a conference subscription, it would be the conference room owner)
sendUpdateNotificationsboolean Indicates whether this subscription will provide update notifications in addition to ADD and DELETE notifications
passbackPassback User defined value for that is opaque to the system
passthruPassthru User defined value that that is opaque to the system.
entityTagEntityTag 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.
parameterArray of Parameter List of parameters of this subscription.
calculatedExpirationDatedateTime

Parameter Fields

NameTypeDescriptionAttributes
nameName Name of the parameter. Mandatory
valuestring Value of the parameter.


Nested Types/Restrictions


NameTypeRestrictions
Namestring
Value must be one of:
  • CONFERENCE_ROOM_IDENTIFIER
  • CONFERENCE_IDENTIFIER
  • PARTICIPANT_IDENTIFIER
EntityTagstring
Length of value must be >=1
Length of value must be <=64
Passthrustring
Length of value must be >=1
Length of value must be <=512
Passbackstring
Length of value must be >=1
Length of value must be <=512