Creates or updates the watch subscription to sessions for a list of stations.
The specified list of stations replaces any previous subscription to station sessions. A message will be generated when a session is added or removed for any of the stations in the list.
| Feature | Version | |
|---|---|---|
| session | 1 |
Required
The ININ session token necessary for all calls that require a security or user context.Required
The session cookie. With the exception of the connection request, all requests must provide a session cookie.Required
The ININ session ID necessary for all calls that require a security or user context.Required
The JSON type representing this option.Required
When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.
When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.
Required
The name of the application or program used to create the session. E.g., "Interaction Client .NET Edition".Required
The name of the machine or computer where the session was created, if captured at login. This field will be an empty string if there is no machine information.Required
The ID of the station for the session. This field will be an empty configuration ID for a stationless session.Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
Required
The unique identifier used to reference this configuration object.This property can be null.
Required
The ID of the user who created the session.Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
Required
The event that resulted in the session being added or removed.
connectionChange represents an explicit login or logout.configurationChange indicates that the session has been added to or removed from the client's view because of a configuration change.
For example, if station 123 has a session and is added to (or removed from) layout ABC, a client with a subscription to layout sessions would receive a message with a configurationChange reason.Property type documentation:
Represents the identifier of a resource. It includes the unique ID and a human readable display name.
Required
A message that describes the current error.Required
Indicates that the client needs to authenticate using a custom ICWS scheme, which supports a realm of type ICWS and a location which is the URL at which the client can authenticate. A typical example would be the following.
WWW-Authenticate: ICWS realm="ICWS" location="/ICWS/connection"
Required
A message that describes the current error.Required
A message that describes the current error.Required
A message that describes the current error.| Feature | Version | |
|---|---|---|
| session | 1 |
Required
The ININ session token necessary for all calls that require a security or user context.Required
The session cookie. With the exception of the connection request, all requests must provide a session cookie.Required
The ININ session ID necessary for all calls that require a security or user context.Required
A message that describes the current error.Required
Indicates that the client needs to authenticate using a custom ICWS scheme, which supports a realm of type ICWS and a location which is the URL at which the client can authenticate. A typical example would be the following.
WWW-Authenticate: ICWS realm="ICWS" location="/ICWS/connection"
Required
A message that describes the current error.Required
A message that describes the current error.Required
A message that describes the current error.