Expand All Collapse All

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

Feature Version
wfm 4

POST

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

Send a request to do shift trade.
Feature 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
    Cookie

    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
        performTradeRequest
        Represents an object containing details of trade that should be performed.
        Expand AllCollapse All
        Property
        Value
        Comments
        timeTradedAwayStartUTC
        DateTime
        Start time the agent is willing to give up for the trade, in UTC time.
        timeTradedAwayEndUTC
        DateTime
        End time the agent is willing to give up for the trade, in UTC time.
        timeGainedStartUTC
        DateTime
        Start time the agent is willing to take up for the trade, in UTC time.
        timeGainedEndUTC
        DateTime
        End time the agent is willing to take up for the trade, in UTC time.
        namedScheduleID
        String
        NamedSchedule in which the trade happens.

        Response

        201 - Created
        The trade operation was completed. Returns the status of the trade along with messages indicating a decription of failure.
        performTradeResponse
        Represents an object containing result of trade that was performed.
        Expand AllCollapse All
        Property
        Value
        Comments
        Success
        0
        Failed
        1
        PutInAdminReview
        2
        failureReason
        String
        A string indicating the reason for failure during performing a trade.
        400 - Bad Request
        The request was malformed or contained invalid data.
        error
        Provides additional detail for an error.
        Expand AllCollapse 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 perform shift trade.
        error
        Provides additional detail for an error.
        Expand AllCollapse 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.
        error
        Provides additional detail for an error.
        Expand AllCollapse 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 AllCollapse 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 AllCollapse 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 AllCollapse All
          Property
          Value
          Comments
          errorId
          String
          The error identifier that describes the current error.
          message
          String

          Required

          A message that describes the current error.