Feature | Version | |
---|---|---|
licenses | 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
Represents a list of license strings. Some examples of valid license strings are I3_LICENSE_BASIC_STATION
and I3_ACCESS_CLIENT
.
The complete list can be found in the Interaction Center documentation.
The request was successful.
For more information, see the licenseOperationResults
representation in the body of the response.
If the client requests a license that does not exist, the only information provided is that it will not have been acquired. The API does not discern between valid and invalid license strings.
Required
List item type documentation:
Represents the results of a license operation.
Required
Required
If true
, the license was successfully acquired for the user. Otherwise, check the errorDetails
and licenseStatus
for more information on why it was not acquired.
Required
Required
Feature | Version | |
---|---|---|
licenses | 2 |
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.
Acquires a set of new licenses and releases a previous set of licenses. Any licenses previously acquired during the session will be released.
For example, licenses A, B and C are already acquired a PUT
requests B, C and D. After the PUT
, A will no longer be acquired and the complete set of acquired licenses will be B, C and D.
Feature | Version | |
---|---|---|
licenses | 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
Represents a list of license strings. Some examples of valid license strings are I3_LICENSE_BASIC_STATION
and I3_ACCESS_CLIENT
.
The complete list can be found in the Interaction Center documentation.
The request was successful. Any licenses acquired before this request have been released.
For more information, see the licenseOperationResults
representation in the body of the response.
If the client requests a license that does not exist, the only information provided is that it will not have been acquired. The API does not discern between valid and invalid license strings.
Required
List item type documentation:
Represents the results of a license operation.
Required
Required
If true
, the license was successfully acquired for the user. Otherwise, check the errorDetails
and licenseStatus
for more information on why it was not acquired.
Required
Required
Feature | Version | |
---|---|---|
licenses | 2 |
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 | |
---|---|---|
licenses | 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.