Expand All Collapse All

/icws/{sessionId}/wfm/matching-tradeinfo

Feature Version
wfm 4

GET

/icws/{sessionId}/wfm/matching-tradeinfo

TODO: construct -> Gets list of trades matching a specific trade for a given date that the agent specified. Start and stop times of the matching trade for the times the agent is willing to give up time and take time is returned along with information of hours involved. Trades with both exact matches and close matches(non-equal trade hours) are returned.

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.

        Query
        startUtc
        Start time of the trade request to match.

          Query
          endUtc
          End time of the trade request to match.

            Query
            namedScheduleID
            NamedSchedule in which the trade happens.

              Query
              startTimes
              Comma separated strings that reperesent start time buckets in ascending order of UTC times for which the data is requested. The times passed would be the day start and end for which the matching trades are requested.

                Response

                200 - OK
                Gets list of trades matching a specific trade for a given date that the agent specified. Start and stop times of the matching trade for the times the agent is willing to give up time and take time is returned along with information of hours involved. Trades with both exact matches and other matches(non-equal trade hours and start/stop times) are returned.
                matchingShiftTradeInfoCollectionContainer
                Represents an object containing a collection of matching schedule info for the trade.
                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.
                403 - Forbidden
                You do not have rights to the 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.
                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 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.