Interaction Center Web Services (ICWS)

/icws/{sessionId}/messaging/subscriptions/configuration/client-templates/{subscriptionId}

PUT

/icws/{sessionId}/messaging/subscriptions/configuration/client-templates/{subscriptionId}

Creates or updates the message subscription to clientTemplates.

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

subscriptionId

Required

The ID of the subscription.

Representations

configObjectSubscription

Subscription on a collection of configuration objects.

Expand All Collapse All

Property

Value

Comments

configurationIds

List [Unbounded]: String

Required

List of configuration ID's that are to be watched. When the wildcard character '*' is used, a subscription on all configuration objects is started. The wildcard in configurationIds cannot be combined with a wildcard in properties.

properties

List [Unbounded]: String

Required

The list of object properties to include in the watch. When the wildcard character '*' is used as a property, a subscription on all properties for the specified configuration object(s) is started. The wildcard in configurationIds cannot be combined with a wildcard in properties. Properties with a NULL value will not be returned on the initial subscription response to conserve the Interaction Center server's resources. After the initial message, properties set to NULL will be in the subsequent messages to tell consumers that they have been cleared out.

rightsFilter

String

Required

The Security Right to use with the watch. The values that can be used with this are found on the rightsFilter query parameter of the GET operation for this object type.

Response

200 - OK

The message subscription to clientTemplates has been created or updated.

Associated Message

The clientTemplate list changed.

clientTemplatesMessage

Represents a message containing updated clientTemplate configuration objects.

Expand All Collapse All

Property

Value

Comments

__type

"urn:inin.com:configuration.people:clientTemplatesMessage"

Required

The JSON type representing this option.

isDelta

Boolean

Required

When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

subscriptionId

String

The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.

added

List [1,*]: Complex Type: clientTemplate

List item type documentation:

Represents the clientTemplate configuration object.

applicationId

String

The value must conform to all of these criteria:

Is a string with from 0 to 7000 characters.

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

fileDateLastModified

DateTime

This property can be null.

isPermanent

Boolean

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

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

Default value: false

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.

changed

List [1,*]: Complex Type: clientTemplate

List item type documentation:

Represents the clientTemplate configuration object.

removed

List [1,*]: String

404 - Not Found

A clientTemplate does not exist for a specified ID. The entity-body will contain the ID which caused the error.

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

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}/messaging/subscriptions/configuration/client-templates/{subscriptionId}

Removes the message subscription to clientTemplates.

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

subscriptionId

Required

The ID of the subscription.

Response

204 - No Content

The clientTemplates message subscription was deleted.

404 - Not Found

The message subscription 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.