Feature | Version | |
---|---|---|
interactions | 9 |
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 assistance ID for the assistance request.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 assistance ID for this assistance request.Property type documentation:
Represents a list of message text items for the assistance request.
List item type documentation:
Represents a message text entry for an assistance request.
Required
The message text.Required
The user ID of the participant that added the message text.Required
The date and time the message text was added.Property type documentation:
Represents a list of assistance participants.
List item type documentation:
Describes a participant associated with an assistance item.
Required
The user ID of the participant.Required
The display name of the participant.Required
The action of the participant.Property type documentation:
Represents a list of assistance participants.
List item type documentation:
Describes a participant associated with an assistance item.
Feature | Version | |
---|---|---|
interactions | 10 |
Feature | Version | |
---|---|---|
interactions | 10 |
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 subscription's state.Property type documentation:
Provides additional detail for an error.
Required
A message that describes the current error.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 | |
---|---|---|
interactions | 9 |
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 assistance ID for the assistance request.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.