Interaction Center Web Services (ICWS)

/icws/{sessionId}/configuration/response-management-documents/{id}

GET

/icws/{sessionId}/configuration/response-management-documents/{id}

Returns a specific responseManagementDocument resource.

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.

Template

Required

The ID of the responseManagementDocument resource.

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 responseManagementDocument resource is included in the response.

responseManagementDocument

Represents the responseManagementDocument configuration object.

Expand All Collapse All

Property

Value

Comments

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 '|'.
Is a string with from 1 to 50 characters.

This property is required to be present in 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.

createdDate

DateTime

The date this configuration object was created.

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

This property can be null.

customAttributes

List [Unbounded]: Complex Type: customAttribute

The custom attributes for the configuration object.

This property can be null.

List item type documentation:

Represents a Custom Attribute value for a configuration object.

name

String

Required

The key identifying this pair.

value

String

Required

The value of this pair.

This property can be null.

description

String

The description of this configuration object.

This property can be null.

documentDateLastModified

DateTime

The date this configuration object's file was last modified.

This property can be null.

lastModifiedDate

DateTime

The date this configuration object was last modified.

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

This property can be null.

notes

String

The notes for this configuration object.

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.getObject

Type: urn:inin.com:configuration:getObjectError

One or more of the properties in the 'rightsFilter' or 'select' query parameters are 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: 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 responseManagementDocument 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.

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.

DELETE

/icws/{sessionId}/configuration/response-management-documents/{id}

Deletes a specific responseManagementDocument resource.

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.

Template

Required

The ID of the responseManagementDocument resource.

Response

204 - No Content

The request to delete the responseManagementDocument was acknowledged and will be completed soon.

403 - Forbidden

Not authorized to delete 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 responseManagementDocument 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.

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.

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


								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

403 - Forbidden

Parameters

404 - Not Found

Parameters

500 - Internal Server Error

Parameters

Error Responses

401 - Unauthorized

Parameters

410 - Gone

Parameters

Parameters

Representations

204 - No Content

Parameters

403 - Forbidden

Parameters

404 - Not Found

Parameters

500 - Internal Server Error

Parameters

Error Responses

400 - Bad Request

Parameters

401 - Unauthorized

Parameters

410 - Gone

Parameters