Interaction Center Web Services (ICWS)

/icws/{sessionId}/configuration/license-allocations

GET

/icws/{sessionId}/configuration/license-allocations

Retrieves a list of licenseAllocations. The results can be filtered by specifying a query. All list-based configuration object resources will have a complex property that will serve as its identity. This property is called the configurationId and consists of a {id, displayName, uri}.

The following result limits are enforced by the server regardless of the value of the Range header field:

If no properties are included (see select parameter), then all of the items will be returned.
If any properties are included (see select parameter), then a maximum of 200 items will be returned in the result.

Feature	Version	Obsolete Version
configuration	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.

Header

Range

Specifies the range of results to be returned.

Example: Range: items=10-20.

Query

select

A comma-delimited list of fields to include in the query. If no fields are specified, then only the ID of the items is returned.

Example: select=extension,defaultWorkstation

One can also specify that all of the properties should be returned by using the '*' wildcard value. This is a shortcut for specifying all of the properties' names in the parameter.

The selected properties with a NULL value will not be returned to conserve the Interaction Center server's resources.

Query

where

A comma-delimited list of conditions to filter the results of the query. Only items that satisfy all conditions will be returned.

The following operators can be used:

eq - equals
sw - starts with
ct - contains

Example: where=configurationId.id sw Value

It is supported for the following properties:

appliedStationCount
appliedUserCount
assignableAllowedCount
assignableConfiguredCount
concurrentAllowedCount
concurrentConfiguredCount
Show More
concurrentInUseCount
configurationId.displayName
configurationId.id
totalAppliedCount
totalCount
Show Less

Query

orderBy

The name of the field to sort the results by and an optional sort direction. The default is to sort by configurationId.displayName in ascending order. A query can only be sorted by one field and only supports one (optional) direction indicator: asc (ascending) or desc (descending).

To sort in descending order use: orderBy=configurationId.id desc

To sort in ascending order use: orderBy=configurationId.id (or orderBy=configurationId.id asc)

It is supported for the following properties:

configurationId.displayName
configurationId.id

Default value: configurationId.displayName

Query

rightsFilter

The security right to use when filtering the results.

Default value: admin

Options:

view
admin

Query

licenseAppliesTo

Each of the dynamic licenses supported by an Interaction Center server can be applied to stations, users, or both of them. To control which set of dynamic licenses to return, set this parameter to the desired value.

It has the following valid values:

0 - Returns the dynamic licenses that can be applied to both stations and users.
1 - Returns the dynamic licenses that can be applied to stations.
2 - Returns the dynamic licenses that can be applied to users.
3 - Returns all dynamic licenses.

Default value: 0

Response

200 - OK

The result set of the query is included in the response.

Parameters

Type

Name

Comments

Header

Content-Range

Required

Specifies the range of items being returned in the result along with the total number of items.

Example: Content-Range: items 5-10/200

licenseAllocations

Represents a list of licenseAllocation configuration objects.

Expand All Collapse All

Property

Value

Comments

items

List [Unbounded]: Complex Type: licenseAllocation

Required

The list of licenseAllocation configuration objects.

List item type documentation:

Represents the licenseAllocation configuration object.

appliedStationCount

Int

This is the number of assignable licenses that are assigned to stations and enabled by them.

This is a read only property and can not be changed with PUT or POST operations.

This property can be null.

appliedUserCount

Int

This is the number of assignable licenses that are assigned to users and enabled by them.

This is a read only property and can not be changed with PUT or POST operations.

This property can be null.

assignableAllowedCount

Int

This is the number of purchased assignable licenses.

This is a read only property and can not be changed with PUT or POST operations.

This property can be null.

assignableConfiguredCount

Int

This is the number of assignable licenses that are assigned to users and stations and enabled by them.

This is a read only property and can not be changed with PUT or POST operations.

This property can be null.

concurrentAllowedCount

Int

This is the number of purchased concurrent licenses.

This is a read only property and can not be changed with PUT or POST operations.

This property can be null.

concurrentConfiguredCount

Int

This is the number of concurrent licenses that are assigned.

This is a read only property and can not be changed with PUT or POST operations.

This property can be null.

concurrentInUseCount

Int

This is the number of concurrent licenses that are currently in use.

This is a read only property and can not be changed with PUT or POST operations.

This property can be null.

configurationId

Complex Type: configurationId

The unique identifier. The value must conform to all of these criteria:

Is a value containing none of the characters '\', '"', or '|'.

This property is required to be present in POST operations.

This is a read only property and can not be changed with PUT or POST operations.

Property type documentation:

Represents the identifier of a resource. It includes the unique ID and a human readable display name.

String

Required

The unique identifier used to reference this configuration object.

displayName

String

The display name of this configuration object.

This property can be null.

uri

Uri

A URI used to access this configuration object.

totalAppliedCount

Int

This is the number of assignable and concurrent licenses that are assigned to users and stations and enabled by them.

This is a read only property and can not be changed with PUT or POST operations.

This property can be null.

totalCount

Int

This is the number of purchased assignable and concurrent licenses.

This is a read only property and can not be changed with PUT or POST operations.

This property can be null.

400 - Bad Request

Invalid parameter value was specified.

Error Responses

Error Identifier

Error Type

Error Description

error.request.invalidRepresentation.malformed

Type: urn:inin.com:common:error

The request representation object was malformed.

Feature	Version	Obsolete Version
configuration	2

error.request.configuration.get.selectAll

Type: urn:inin.com:common:error

Combining the wildcard (*) and one or more specific properties in one request is not supported.

Feature	Version	Obsolete Version
configuration	2

error.request.configuration.getObjectList

Type: urn:inin.com:configuration:getObjectListError

One or more of the properties in the 'rightsFilter', 'select', 'where', or 'orderBy' query parameters are not supported.

Feature	Version	Obsolete Version
configuration	2

error.request.configuration.getObjectList.invalidSortDirection

Type: urn:inin.com:common:error

The sort direction in the 'orderBy' query parameter is not supported.

Feature	Version	Obsolete Version
configuration	2

error.request.configuration.getObjectList.invalidWhereOperator

Type: urn:inin.com:common:error

The operator in the 'where' query parameter is not supported.

Feature	Version	Obsolete Version
configuration	2

error

Provides additional detail for an error.

Expand All Collapse All

Property

Value

Comments

Multiple options:

The value can be assigned any of the following options.

[option]

Complex Type: error

Provides additional detail for an error.

errorId

String

The error identifier that describes the current error.

message

String

Required

A message that describes the current error.

[option]

Complex Type: getObjectListError

Provides details about errors with a GET configuration object list operation.

__type

"urn:inin.com:configuration:getObjectListError"

Required

The JSON type representing this option.

errorId

String

The error identifier that describes the current error.

message

String

Required

A message that describes the current error.

select

List [Unbounded]: String

The properties in the select query parameter that are not supported by the object type.

Property type documentation:

Represents a collection of strings.

rightsFilter

String

The properties in the rightsFilter query parameter that are not supported by the object type.

where

List [Unbounded]: String

The properties in the where query parameter that are not supported by the object type.

Property type documentation:

Represents a collection of strings.

orderBy

String

The property in the orderBy query parameter is not supported by the object type.

500 - Internal Server Error

An unexpected error occurred while processing the request.

Error Responses

Error Identifier

Error Type

Error Description

error.request.internalServerError

Type: urn:inin.com:common:error

The server encountered an unexpected, internal error.

Feature	Version	Obsolete Version
configuration	2

error.request.timeout

Type: urn:inin.com:common:error

The request timed out.

Feature	Version	Obsolete Version
configuration	2

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.

Parameters

Representations

200 - OK

Parameters

400 - Bad Request

Parameters

Error Responses

500 - Internal Server Error

Parameters

Error Responses

401 - Unauthorized

Parameters

410 - Gone

Parameters