Interaction Center Web Services (ICWS)

/icws/{sessionId}/wfm/trade-requests

Feature	Version	Obsolete Version
wfm	4

POST

/icws/{sessionId}/wfm/trade-requests

Adds a new shift trade.

Feature	Version	Obsolete Version
wfm	4

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

shiftTradeRequest

Represents an agent's request to trade a schedule with another agent.

Expand All Collapse All

Property

Value

Comments

requestState

Enumeration: tradeRequestState

The current state of this shift trade.

UnMatched

Matched

Denied

Canceled

Expired

All

15015

minStartTimeGivenUtc

DateTime

Minimum schedule start time the agent is giving up in the trade, in UTC time.

minEndTimeGivenUtc

DateTime

Minimum schedule end time the agent is giving up in the trade, in UTC time.

maxStartTimeGivenUtc

DateTime

Maximum schedule start time the agent is giving up in the trade, in UTC time.

maxEndTimeGivenUtc

DateTime

Maximum schedule end time the agent is giving up in the trade, in UTC time.

startTimeAcceptedUtc

DateTime

Schedule start time the agent is taking up in the trade, in UTC time.

endTimeAcceptedUtc

DateTime

Schedule end time the agent is taking up in the trade, in UTC time.

startTimeOfferedUtc

DateTime

Schedule start time the agent is offering in the trade, in UTC time.

endTimeOfferedUtc

DateTime

Schedule end time the agent is offering in the trade, in UTC time.

acceptableTimesToTake

List [Unbounded]: Complex Type: acceptableStartTime

The collection of acceptable start times for the requesting agent.

Property type documentation:

Represents a collection of acceptable start times for a shift trade.

List item type documentation:

Represents an acceptable range of start times for a shift trade.

earliestStartUtc

DateTime

The earliest schedule start time that the requesting agent would accept, in UTC time.

latestStartUtc

DateTime

The earliest latest start time that the requesting agent would accept, in UTC time.

shiftTradeRequestId

String

The unique ID for this shift trade request.

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

requestExpirationUtc

DateTime

Time which the trade request expires.

canEditTradeRequest

Boolean

Indicates if the trade request can be edited.

canCancelTradeRequest

Boolean

Indicates if the trade request can be canceled.

matchState

Enumeration: tradeMatchState

The state of the match tied to the request.

PendingForAdminReview

Approved

Denied

Canceled

Expired

All

15015

Response

201 - Created

The update succeeded. Returns the added shift trade with its ID field populated.

Feature	Version	Obsolete Version
wfm	2

shiftTradeRequest

Represents an agent's request to trade a schedule with another agent.

Expand All Collapse All

Property

Value

Comments

requestState

Enumeration: tradeRequestState

The current state of this shift trade.

UnMatched

Matched

Denied

Canceled

Expired

All

15015

minStartTimeGivenUtc

DateTime

Minimum schedule start time the agent is giving up in the trade, in UTC time.

minEndTimeGivenUtc

DateTime

Minimum schedule end time the agent is giving up in the trade, in UTC time.

maxStartTimeGivenUtc

DateTime

Maximum schedule start time the agent is giving up in the trade, in UTC time.

maxEndTimeGivenUtc

DateTime

Maximum schedule end time the agent is giving up in the trade, in UTC time.

startTimeAcceptedUtc

DateTime

Schedule start time the agent is taking up in the trade, in UTC time.

endTimeAcceptedUtc

DateTime

Schedule end time the agent is taking up in the trade, in UTC time.

startTimeOfferedUtc

DateTime

Schedule start time the agent is offering in the trade, in UTC time.

endTimeOfferedUtc

DateTime

Schedule end time the agent is offering in the trade, in UTC time.

acceptableTimesToTake

List [Unbounded]: Complex Type: acceptableStartTime

The collection of acceptable start times for the requesting agent.

Property type documentation:

Represents a collection of acceptable start times for a shift trade.

List item type documentation:

Represents an acceptable range of start times for a shift trade.

earliestStartUtc

DateTime

The earliest schedule start time that the requesting agent would accept, in UTC time.

latestStartUtc

DateTime

The earliest latest start time that the requesting agent would accept, in UTC time.

shiftTradeRequestId

String

The unique ID for this shift trade request.

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

requestExpirationUtc

DateTime

Time which the trade request expires.

canEditTradeRequest

Boolean

Indicates if the trade request can be edited.

canCancelTradeRequest

Boolean

Indicates if the trade request can be canceled.

matchState

Enumeration: tradeMatchState

The state of the match tied to the request.

PendingForAdminReview

Approved

Denied

Canceled

Expired

All

15015

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 shift trade.

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.