Interaction Center Web Services (ICWS)

/icws/{sessionId}/configuration/defaults/schedule

GET

/icws/{sessionId}/configuration/defaults/schedule

Returns an initialized schedule object with default values.

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.

Response

200 - OK

An initialized schedule object with defaults is in the response.

schedule

Represents the schedule 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.

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.

accessControlGroupAssignment

Complex Type: configurationId

The access control group assignment for this configuration object. The value of this is required only when access control groups are in use. The reason for this is because most users will not have the necessary rights to assign an object to the root access control group, which is the default assignment for a newly created object. If access control groups are not in use, then this property is optional because the server will assign it to the root access control group which always exists. The value must conform to all of these criteria:

An instance of the Access Control Group object type.

Property type documentation:

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

description

String

This property can be null.

isActive

Boolean

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

Default value: true

keywords

List [Unbounded]: String

Is a collection of items that each conform to all of these criteria:

Is a value not containing the character ','.

This property can be null.

Property type documentation:

Represents a collection of strings.

scheduleRecurrences

List [Unbounded]: Complex Type: scheduleRecurrence

This property can be null.

Property type documentation:

Represents a list of scheduleRecurrence configuration objects.

List item type documentation:

Represents the scheduleRecurrence configuration object.

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.

Feature	Version	Obsolete Version
configuration	7

Property type documentation:

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

dates

List [Unbounded]: Int

The dates when the schedule is recurring. This property is valid for monthly and yearly schedule pattern. Is a collection of items that each conform to all of these criteria:

Is a value from 1 to 31.

This property can be null.

Property type documentation:

Represents a collection of integers.

days

List [Unbounded]: Int

The days the weekly schedule spans. When the pattern is a weekly day span, the value of this is expected to be a pair of days that consist of the day the schedule starts and the day the schedule ends. When the pattern is a weekly day list, the value of this is expected to have up to 7 values in it. The valid values for the days are [1..7] for [Sunday..Saturday]. This property is valid for weekly schedule patterns only. Is a collection of items that each conform to all of these criteria:

Is a value from 1 to 7.

This property can be null.

Property type documentation:

Represents a collection of integers.

endDate

Date

The end date of the schedule. The date is in the extended ISO8601 format, for example 2016-01-31, but a POST also accepts the basic ISO8601 format like 20160131. When there is no end date, the value is 0001-01-01.

This property is required to be present in POST operations.

endTime

Time

The end time of the schedule. The time is in the extended ISO8601 format, for example 22:05:00, but the POST also accepts the basic ISO8601 format like T220500.

This property is required to be present in POST operations.

isAllDay

Boolean

This can be used for weekly schedule pattern when the schedule spans multiple days.

This property can be null.

isDaySpan

Boolean

This can be used for weekly schedule pattern when the schedule spans multiple days.

This property can be null.

isRelative

Boolean

This can be used for yearly and monthly schedule pattern to indicate the relative day within the schedule.

This property can be null.

month

Int

The month when the schedule is recurring. The value is [1..12] for [January..December]. The value is This can only be used for yearly schedule pattern. The value must conform to all of these criteria:

Is a value from 1 to 12.

This property can be null.

patternType

Enumeration: patternType

The required attributes for each pattern type are:

Pattern Weekly Day List:
- isDaySpan
- days
Pattern Weekly Day Span:
- isDaySpan
- days
- weeklyStartTime
- weeklyEndTime
Pattern Monthly Day List:
- isRelative
- dates
Pattern Monthly Relative:
- isRelative
- relativeDay
- relativeMonthlyInstance
Pattern Yearly Day List:
- isRelative
- dates
- month
Pattern Yearly Relative:
- isRelative
- relativeDay
- relativeMonthlyInstance
- month

This property is required to be present in POST operations.

oneTime

repeatDaily

repeatWeekly

repeatMonthly

repeatYearly

relativeDay

Enumeration: relativeDayType

The relative day when the schedule is recurring. The value is [0..7] for [Day,Sunday..Saturday]. This property is valid for monthly and yearly relative schedule pattern.

This property can be null.

day

sunday

monday

tuesday

wednesday

thursday

friday

saturday

relativeMonthlyInstance

Enumeration: relativeMonthlyInstanceType

The relative day in the month. This will be used in conjunction with the relative day. This property is valid for monthly and yearly relative schedule pattern.

This property can be null.

first

second

third

fourth

last

startDate

Date

The start date of the schedule. The date is in the extended ISO8601 format, for example 2016-01-31, but a POST also accepts the basic ISO8601 format like 20160131.

This property is required to be present in POST operations.

startTime

Time

The start time of the schedule. The time is in the extended ISO8601 format, for example 22:05:00, but the POST also accepts the basic ISO8601 format like T220500.

This property is required to be present in POST operations.

weeklyEndTime

Time

Time when the schedule ends if the schedule spans multiple days in weekly schedule. The time is in extended ISO8601 24 hour format of hh:mm:ss. The value must conform to all of these criteria:

Is a value matching the regular expression '(^(([0-1][0-9])|(2[0-3])):([0-5][0-9]):([0-5][0-9])$)'.

This property can be null.

weeklyStartTime

Time

Time when the schedule starts if the schedule spans multiple days in weekly schedule. The time is in extended ISO8601 24 hour format of hh:mm:ss. The value must conform to all of these criteria:

Is a value matching the regular expression '(^(([0-1][0-9])|(2[0-3])):([0-5][0-9]):([0-5][0-9])$)'.

This property can be null.

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.

Parameters

Representations

200 - OK

Parameters

500 - Internal Server Error

Parameters

Error Responses

400 - Bad Request

Parameters

401 - Unauthorized

Parameters

410 - Gone

Parameters