plcm-subscription.xsd Documentation

Imported Namespaces

Target Namespace

Elements

plcm-subscription  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.


Complex Types

PlcmSubscription Fields

NameTypeDescriptionAttributes
atomLinkList List of linkSee Definition of link
plcm-error plcm-errorSee Definition of plcm-error
subscription-identifierxs:string The unique identifier of the subscription
consumer-urlxs:string The URL of the notification client to which the Polycom server will publish notifications Mandatory
subject-resource-urlxs:string The URL of the resource which is the subject of the subscription
usernamexs:string The username which the Polycom server will use when authenticating to the notification client
passwordxs:string The password which the Polycom server will use when authenticating to the notification client
time-to-livexs: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
subscriptionOwnerDomainxs:string The domain of the user that owns this subscription. (i.e for a conference subscription, it would be the conference room owner)
subscriptionOwnerUsernamexs: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-notificationsxs:boolean 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.
entity-tagEntityTag 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.
parameterList of Parameter List of parameters of this subscription.
calculated-expiration-datexs:dateTime

Parameter Fields

NameTypeDescriptionAttributes
nameName Name of the parameter. Mandatory
valuexs:string Value of the parameter.


Simple Types


NameTypeRestrictions
Namexs:string
Value must be one of:
  • CONFERENCE_ROOM_IDENTIFIER
  • CONFERENCE_IDENTIFIER
  • PARTICIPANT_IDENTIFIER
EntityTagxs:string
Length of value must be >=1
Length of value must be <=64
Passthruxs:string
Length of value must be >=1
Length of value must be <=512
Passbackxs:string
Length of value must be >=1
Length of value must be <=512