Feature | Version | |
---|---|---|
statistics | 6 |
Creates a subscription to the logged-in user's memo list.
Feature | Version | |
---|---|---|
statistics | 6 |
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.The memo list subscription was created.
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 identifier for a memo.Required
A memo.The location where the icon file associated with this memo can be downloaded. This URI will be of the form /SessionManagerFileTransfer/alerts/memo/icon/{sessionId}/{memoIconFileName}
.
Memo icon downloads require an active ICWS session as the sessionId. ICO and PNG are the only supported memo icon file formats. The desired file extension (*.ico or *.png respectively) should be appended to the URI prior to the request to control which format is returned. Requests without an extension will assume PNG.
Requests for PNG memo icons support an optional iconSize
parameter to control the size of the returned PNG. For example, to request a 16px by 16px PNG, the URL would end in /memoIconFilename.png?iconSize=16
. The default iconSize is 32 without this parameter.
Required
The identifier for a memo.Required
A memo.The location where the icon file associated with this memo can be downloaded. This URI will be of the form /SessionManagerFileTransfer/alerts/memo/icon/{sessionId}/{memoIconFileName}
.
Memo icon downloads require an active ICWS session as the sessionId. ICO and PNG are the only supported memo icon file formats. The desired file extension (*.ico or *.png respectively) should be appended to the URI prior to the request to control which format is returned. Requests without an extension will assume PNG.
Requests for PNG memo icons support an optional iconSize
parameter to control the size of the returned PNG. For example, to request a 16px by 16px PNG, the URL would end in /memoIconFilename.png?iconSize=16
. The default iconSize is 32 without this parameter.
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.Ends the subscription to the logged-in user's memo list.
Feature | Version | |
---|---|---|
statistics | 6 |
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.