Interaction Center Web Services (ICWS)

/icws/{sessionId}/licenses/license-stages

POST

/icws/{sessionId}/licenses/license-stages

Acquire a set of licenses in stages. If the licenses were already acquired, there is no effect. There is no effect on any other licenses that have been previously acquired in this session.

Stages permit the client to specify what should happen with subsequent stages if a stage fails. For example, the client may need to acquire licenses A and B and, contingent on the success of that, acquire licenses C and D. In this case, define two stages and specify the failure action on the first stage to be abort.

Feature	Version	Obsolete Version
licenses	1

Request

Parameters

Type

Name

Comments

Header

ININ-ICWS-CSRF-Token

Required

The ININ session token necessary for all calls that require a security or user context.

Header

Required

The session cookie. With the exception of the connection request, all requests must provide a session cookie.

Template

sessionId

Required

The ININ session ID necessary for all calls that require a security or user context.

Representations

licenseStageOperations

Expand All Collapse All

Property

Value

Comments

licenseStageOperationList

List [1,*]: Complex Type: licenseStageOperation

Required

Property type documentation:

Represents a list of license stages.

List item type documentation:

Represents a license stage.

stageName

String

Required

stageFailureAction

Enumeration: stageFailureAction

Required

Property type documentation:

Action to be taken in the case that a license operation stage fails.

continue

Continue with the next stage of license operations.

abort

Abort subsequent stages of license operations.

licenseList

List [1,*]: String

Required

Response

200 - OK

The request was successful. The licenseStageOperationResults representation is returned in the body of the response. For more information, see the licenseStageOperationResults 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.

licenseStageOperationResults

Represents a list of licenseStageResult representations.

Expand All Collapse All

Property

Value

Comments

licenseStageOperationResultList

List [Unbounded]: Complex Type: licenseStageOperationResult

Required

List item type documentation:

Represents a license stage.

stageName

String

Required

result

List [Unbounded]: Complex Type: licenseOperationResult

Required

List item type documentation:

Represents the results of a license operation.

errorDetails

String

Required

isAvailable

Boolean

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.

licenseName

String

Required

licenseStatus

Enumeration: licenseStatus

Required

unknownError

Indicates that an error occurred while checking the license.

none

Represents no status.

available

Represents a license that is available.

notAssigned

Represents a license that has not been assigned.

licenseUnavailable

Represents a license that assigned but unavailable because all concurrent licenses are in use, or insufficient licenses are installed.

userOnAnotherStation

Represents a license that is unavailable because the user is logged onto another station.

stationAlreadyInUseOnAnotherMachine

Represents a license that is unavailable because the station is already in use on another machine.

stationAlreadyInUseByAnotherUser

Represents a license that is unavailable because the station is being used by another user.

otherApplicationUsingLicense

Represents a license that is unavailable because the license is in use by another application.

licenseUnknown

Represents a license name that is unknown to the IC System.

Feature	Version	Obsolete Version
licenses	2

400 - Bad Request

The request was invalid. This can occur when the message body is malformed or missing required items. This will also occur if a required header or query string parameter is missing or invalid.

error

Provides additional detail for an error.

Expand All Collapse All

Property

Value

Comments

errorId

String

The error identifier that describes the current error.

message

String

Required

A message that describes the current error.

401 - Unauthorized

The specified session token is missing, invalid, or has expired.

Parameters

Type

Name

Comments

Header

WWW-Authenticate

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"

error

Provides additional detail for an error.

Expand All Collapse All

Property

Value

Comments

errorId

String

The error identifier that describes the current error.

message

String

Required

A message that describes the current error.

410 - Gone

This resource has been deprecated and removed from the API.

error

Provides additional detail for an error.

Expand All Collapse All

Property

Value

Comments

errorId

String

The error identifier that describes the current error.

message

String

Required

A message that describes the current error.

500 - Internal Server Error

An unexpected error occurred while processing the request.

error

Provides additional detail for an error.

Expand All Collapse All

Property

Value

Comments

errorId

String

The error identifier that describes the current error.

message

String

Required

A message that describes the current error.