Interaction Center Web Services (ICWS)

/icws/{sessionId}/configuration/update-service

GET

/icws/{sessionId}/configuration/update-service

Returns the global updateService settings.

Feature	Version	Obsolete Version
configuration	8

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.

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

rightsFilter

The security right to use when filtering the results.

Default value: admin

Options:

view
admin

Response

200 - OK

The updateService resource is included in the response.

updateService

Represents the updateService configuration object.

Expand All Collapse All

Property

Value

Comments

updateProviderIsAvailable

Boolean

Property to enable the update service.

Setting this property to null will set it to its default value.

Default value: false

updateProviderOverrideURI

String

The update service provider tries to set its Uri automatically. In some cases this Uri needs to be overridden through this property.

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.

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.

error.request.configuration.getObject

Type: urn:inin.com:configuration:getObjectError

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

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: getObjectError

Provides details about errors with a GET configuration object operation.

Feature	Version	Obsolete Version
configuration	2

__type

"urn:inin.com:configuration:getObjectError"

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.

403 - Forbidden

Not authorized to retrieve this resource.

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.

404 - Not Found

The updateService does not exist.

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 Responses

Error Identifier

Error Type

Error Description

error.request.internalServerError

Type: urn:inin.com:common:error

The server encountered an unexpected, internal error.

error.request.timeout

Type: urn:inin.com:common:error

The request timed out.

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.

PUT

/icws/{sessionId}/configuration/update-service

Updates the global updateService settings.

Feature	Version	Obsolete Version
configuration	8

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

updateService

Represents the updateService configuration object.

Expand All Collapse All

Property

Value

Comments

updateProviderIsAvailable

Boolean

Property to enable the update service.

Setting this property to null will set it to its default value.

Default value: false

updateProviderOverrideURI

String

The update service provider tries to set its Uri automatically. In some cases this Uri needs to be overridden through this property.

This property can be null.

Response

200 - OK

The updateService has been updated.

updateOperationResult

Represents the result from a put or post operation.

Expand All Collapse All

Property

Value

Comments

String

Required

The unique identifier used to reference this configuration object.

uri

Uri

A URI used to access this configuration object.

licenseProblems

List [1,*]: Complex Type: licenseError

List item type documentation:

Represents a license warning or error that occurred during a commit.

licenseErrorType

Enumeration: licenseErrorType

Required

Property type documentation:

Represents a license warning or error in a request to modify a configuration object.

setOK

Setting the license succeeded. This value is never sent.

setWarningExceedsThreshold

Indicates that a dynamic license was found with an assignment count that exceeds it's assignable and or concurrent thresholds. As this is only a warning to indicate problems, the license in the request was set successfully.

setErrorExceedsThreshold

Indicates that a dynamic license being set exceed it's assignable or concurrent thresholds and was not set as a result. This can be returned for any license assigned to a user or station as part of setting it's licenses because they are all checked for problems as part of the operation.

setWarningMissingQualifiers

Indicates that the ACD media level in the request did not have a corresponding set of ACD media types and the default value(s) for the level were set as a result.

license

Complex Type: configurationId

Required

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.

400 - Bad Request

Invalid request was provided. If validation errors exist, they will be returned in the response.

Error Responses

Error Identifier

Error Type

Error Description

error.request.invalidRepresentation.malformed

Type: urn:inin.com:common:error

The request representation object was malformed.

error.request.configuration.update

Type: urn:inin.com:configuration:configurationError

The request has one or more license or validation errors in it.

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: configurationError

Represents a validation or licensing error that occurred during a commit. It contains a list of the errors that were encountered.

__type

"urn:inin.com:configuration:configurationError"

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.

validationErrors

List [1,*]: Complex Type: validationError

List item type documentation:

Represents a validation error that occurred during a commit.

validationErrorType

Enumeration: validationErrorType

Required

Property type documentation:

Represents an error in a request to modify a configuration object.

unknownValidator

Unknown validator.

uniqueInstanceId

The value must be unique across objects of this type.

existingInstanceId

The value must represent a valid ID for a configured instance.

existingAttributeValue

The value must match a configured instance.

requiredValue

The value must be specified.

range

The value must be in the correct range.

stringLength

The value must have the correct number of characters.

regex

The value must be formatted correctly.

validValues

The value is not from the allowed set.

collectionCount

The value must have the correct number of items.

collectionItemValidator

One or more items failed to validate successfully.

validatorGroup

The value is not from the allowed set.

validFormat

The value is not in a valid format.

uniqueAttributeValue

The value must be unique across attributes of this type.

requiredAttribute

The attribute must be specified.

acgTreeValidator

The Acg Tree either could not be verified or found, or the Acg Tree depth is not supported.

pronunciationValidator

The value is not a valid pronunciation format.

wordValidator

The value must be a valid word.

rangeFloat

The value must be in the correct range.

existingAttendantProfile

The value must match a configured attendant profile instance.

extension

The value must not be an existing extension.

workstationsSharedAppearanceID

Unknown validator.

multipleOf

The value is not a valid multiple value.

invalidCharacters

The value contains invalid characters.

existingExtension

The value must be an existing extension.

existingInstanceIdWithAttributeValue

The value must represent a valid ID for a configured instance.

characterDelimitedValue

The value contains invalid characters.

analyzerKeywordCount

The number of keywords assigned to the keyword set makes the configuration exceed the maximum number of supported keywords.

workgroupAnalyzerKeywordCount

The number of keywords assigned to the workgroup is greater than the maximum number of supported keywords.

endDateTimeValidator

The end date or time of a schedule must be greater than or equal to the start date or time.

propertyNotApplicable

This property is not applicable with the current configuration.

invalidMailboxFolder

The value is not a valid mailbox.

unsupportedManufacturer

The provided phone manufacturer is unsupported.

unsupportedModel

The provided phone model is unsupported.

audioProtocol

An Audio protocol value of SRTP is only supported when the Registration Group for the configuration object has one or more registered lines with a Transport Protocol of TLS.

recorderPolicyAnalyzerKeywordCount

The number of keywords assigned to the keyword set makes at least one Recorder Policy exceed the maximum number of supported keywords.

referenceCount

The number of reference to this object is exceeding the maximum limit.

Feature	Version	Obsolete Version
configuration	8

wrapUpStatusTimeout

The values of WrapUpStatus or WrapUpTimeout are not valid.

Feature	Version	Obsolete Version
configuration	8

attributeExistence

One or more required attributes was not specified and/or one or more required absent attributes was specifed.

Feature	Version	Obsolete Version
configuration	8

otherAttributeValue

The otherAttributeValue property is expected to have (or not have) a value.

Feature	Version	Obsolete Version
configuration	8

networkAdapter

The network adapter is invalid.

Feature	Version	Obsolete Version
configuration	8

integerComparisonValidator

The integer comparison failed validation based on the comparison type selected.

Feature	Version	Obsolete Version
configuration	8

timeZoneValidator

The time zone is invalid.

Feature	Version	Obsolete Version
configuration	8

existingLanguageValues

The values provided must be languages supported by PureConnect.

Feature	Version	Obsolete Version
configuration	8

characterDelimitedKVPairs

The character delimited key-value pairs are invalid.

Feature	Version	Obsolete Version
configuration	8

objectValidationErrorMutuallyExclusive

Two configuration values are mutually exclusive.

Feature	Version	Obsolete Version
configuration	10

propertyName

String

Required

propertyValue

String

Required

licenseErrors

List [1,*]: Complex Type: licenseError

List item type documentation:

Represents a license warning or error that occurred during a commit.

licenseErrorType

Enumeration: licenseErrorType

Required

Property type documentation:

Represents a license warning or error in a request to modify a configuration object.

setOK

Setting the license succeeded. This value is never sent.

setWarningExceedsThreshold

setErrorExceedsThreshold

setWarningMissingQualifiers

Indicates that the ACD media level in the request did not have a corresponding set of ACD media types and the default value(s) for the level were set as a result.

license

Complex Type: configurationId

Required

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.

403 - Forbidden

Not authorized to update this resource.

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.

404 - Not Found

The updateService does not exist.

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 Responses

Error Identifier

Error Type

Error Description

error.request.internalServerError

Type: urn:inin.com:common:error

The server encountered an unexpected, internal error.

error.request.timeout

Type: urn:inin.com:common:error

The request timed out.

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


								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.