Interaction Center Web Services (ICWS)

/icws/{sessionId}/configuration/access-control-groups/{id}/{objectType}/assign-membership

POST

/icws/{sessionId}/configuration/access-control-groups/{id}/{objectType}/assign-membership

Assigned one or more objects to an Access Control Group.

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 Access Control Group.

Template

objectType

Required

The object type that needs to be assigned to an Access Control Group. The value shall be one of the following:

account-code
client-configuration-template
managed-phone-registration-group
managed-phone-ring-set
keyword-set
location
Show More
password-policy
role
schedule
skill
skill-category
station
interaction-processor-table
user
workgroup
wrap-up-code
wrap-up-category
image-resource
layout
Show Less

Header

ININ-ICWS-Transaction-Id

The transaction ID for grouping the server-side rights calculation for several configuration requests.

Feature	Version	Obsolete Version
configuration	11

Representations

assignMembershipArgument

Represents an argument for assignMembership.

Expand All Collapse All

Property

Value

Comments

objects

List [Unbounded]: Complex Type: configurationId

Required

Property type documentation:

Represents a collection of configurationId's.

List item 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.

Response

200 - OK

The assignMembershipResult resource is included in the response.

assignMembershipResult

Represent a result object returned by assignMembership function.

Expand All Collapse All

Property

Value

Comments

String

Required

The assigned ACD ID.

400 - Bad Request

Invalid request was provided.

Error Responses

Error Identifier

Error Type

Error Description

error.request.invalidRepresentation.missingRequired

Type: urn:inin.com:common:missingPropertyError

The request representation object was missing a required property.

Feature	Version	Obsolete Version
configuration	2

error.request.invalidRepresentation.malformed

Type: urn:inin.com:common:error

The request representation object was malformed.

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

Provides details about errors related to a missing required property.

__type

"urn:inin.com:common:missingPropertyError"

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.

propertyName

String

The name of the missing required property.

403 - Forbidden

Not authorized to create these resources.

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.