Interaction Center Web Services (ICWS)

/icws/{sessionId}/wfm/time-off

Feature	Version	Obsolete Version
wfm	1

POST

/icws/{sessionId}/wfm/time-off

Adds a new time-off request.

Feature	Version	Obsolete Version
wfm	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.

Representations

timeOffRequest

Represents an agent's request for time off for a contigious range of days.

Expand All Collapse All

Property

Value

Comments

requestType

Enumeration: timeOffRequestType

The type of this request.

FullDay

PartialDay

All

requestState

Enumeration: timeOffRequestState

The current state of this request.

Pending

Approved

Denied

Canceled

All

1365

lengthInMinutes

Int

The length in minutes for this time off request.

description

String

The description of this time off request.

This property can be null.

startUtc

DateTime

When the requested time off starts, in UTC time.

endUtc

DateTime

When the requested time off ends, in UTC time.

activityCodeId

String

The activity code ID for this time off request.

timeOffRequestId

String

The unique ID for this time off request.

This read only property is used to identify a time off request when updating it via a PUT operation.

cicUserName

String

The user name associated with this time off request.

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

isPaidTime

Boolean

Whether this time off request represents paid time.

This value is set to the isPaidTime value of the activity code during a POST operation. It is treated as a read only property with a PUT operation.

submittedUserId

String

The ID of the user who submitted this request. Note that this isn't always the same as the cicUserName, as a supervisor could submit the request on behalf of the agent.

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

submittedDateTimeUtc

DateTime

When this request was submitted in UTC time.

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

reviewerUserId

String

The ID of the user who reviewed this time off request.

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

reviewedDateTimeUtc

DateTime

When the time off request was reviewed.

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

waitlistReason

Enumeration: waitlistReason

If this request has requestState of "Pending", the reason this time off request is pending.

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

NotWaitlisted

Unknown

ActivityCodeNotPartOfAccrualPlan

AutoApproveDisabled

NotEnoughAccruedHours

NotEnoughAvailableAllotments

UserDoesNotBelongToSchedulingUnit

UserDoesNotBelongToCoverageGroup

NoAllotmentDataExists

InvalidatesApprovedRequestsInFuture

denyReason

Enumeration: denyReason

If this request has requestState of "Denied", the reason this time off request has been denied.

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

NotDenied

Unknown

RequestExceedsWaitlistCap

RequestOnBlackoutDay

RequestOutsideActiveTimeOffPlan

RequestOverlapsWithExistingTOR

Response

201 - Created

The update succeeded. Returns the added time-off request with its ID field populated.

Feature	Version	Obsolete Version
wfm	2

timeOffRequest

Represents an agent's request for time off for a contigious range of days.

Expand All Collapse All

Property

Value

Comments

requestType

Enumeration: timeOffRequestType

The type of this request.

FullDay

PartialDay

All

requestState

Enumeration: timeOffRequestState

The current state of this request.

Pending

Approved

Denied

Canceled

All

1365

lengthInMinutes

Int

The length in minutes for this time off request.

description

String

The description of this time off request.

This property can be null.

startUtc

DateTime

When the requested time off starts, in UTC time.

endUtc

DateTime

When the requested time off ends, in UTC time.

activityCodeId

String

The activity code ID for this time off request.

timeOffRequestId

String

The unique ID for this time off request.

This read only property is used to identify a time off request when updating it via a PUT operation.

cicUserName

String

The user name associated with this time off request.

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

isPaidTime

Boolean

Whether this time off request represents paid time.

This value is set to the isPaidTime value of the activity code during a POST operation. It is treated as a read only property with a PUT operation.

submittedUserId

String

The ID of the user who submitted this request. Note that this isn't always the same as the cicUserName, as a supervisor could submit the request on behalf of the agent.

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

submittedDateTimeUtc

DateTime

When this request was submitted in UTC time.

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

reviewerUserId

String

The ID of the user who reviewed this time off request.

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

reviewedDateTimeUtc

DateTime

When the time off request was reviewed.

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

waitlistReason

Enumeration: waitlistReason

If this request has requestState of "Pending", the reason this time off request is pending.

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

NotWaitlisted

Unknown

ActivityCodeNotPartOfAccrualPlan

AutoApproveDisabled

NotEnoughAccruedHours

NotEnoughAvailableAllotments

UserDoesNotBelongToSchedulingUnit

UserDoesNotBelongToCoverageGroup

NoAllotmentDataExists

InvalidatesApprovedRequestsInFuture

denyReason

Enumeration: denyReason

If this request has requestState of "Denied", the reason this time off request has been denied.

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

NotDenied

Unknown

RequestExceedsWaitlistCap

RequestOnBlackoutDay

RequestOutsideActiveTimeOffPlan

RequestOverlapsWithExistingTOR

400 - Bad Request

The request was malformed or contained invalid data.

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.

403 - Forbidden

You do not have rights to add a time-off request.

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.

409 - Conflict

A data conflict has occurred. Your request has not been submitted.

Feature	Version	Obsolete Version
wfm	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.

500 - Internal Server Error

An unexpected error occurred while processing the request.

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.