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

Feature Version
wfm 4

GET

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

TODO: construct -> Gets list of matching trade counts for request day and all days of the week the request day falls on if specified . For each of those dates exact and close match count of schedules are presented. If the request date happens to be in middle of the week, for the past days in current week counts will be zero.

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 will have to be start time of days in the week and last entry will have to be the end time of last day for which the counts are requested.

                Response

                200 - OK
                Gets list of matching trade counts for request day and all days of the week the request day falls on if specified . For each of those dates exact and close match count of schedules are presented. If the request date happens to be in middle of the week, for the past days in current week counts will be zero.
                matchingShiftTradeCountsCollectionContainer
                Represents an object containing a collection of matching shift trade counts.
                Property
                Value
                Comments
                matchDateUTC
                DateTime
                Date on which the match exists, in UTC time.
                exactMatchesCount
                Int
                Number of trades available for request date with exact start and end times.
                otherMatchesCount
                Int
                Number of trades available for request date with different start and(or) end times.
                403 - Forbidden
                You do not have rights to the data.
                error
                Provides additional detail for an error.
                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.
                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.
                  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.
                  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.
                  Property
                  Value
                  Comments
                  errorId
                  String
                  The error identifier that describes the current error.
                  message
                  String

                  Required

                  A message that describes the current error.