Operation
ClearedOrderSummaryReport listClearedOrders ( BetStatus betStatus, Set<EventTypeId> eventTypeIds, Set<EventId> eventIds, Set<MarketId> marketIds, Set<RunnerId> runnerIds, Set<BetId> betIds, Side side, TimeRange settledDateRange, GroupBy groupBy, boolean includeItemDescription, String locale, int fromRecord, int recordCount ) throws APINGException
Returns a list of settled bets based on the bet status, ordered by settled date.
Parameter name | Type | Required | Description |
---|---|---|---|
betStatus | Restricts the results to the specified status. | ||
eventTypeIds | Set<EventTypeId> | Optionally restricts the results to the specified Event Type IDs. | |
eventIds | Set<EventId> | Optionally restricts the results to the specified Event IDs. | |
marketIds | Set<Market Id> | Optionally restricts the results to the specified market IDs. | |
runnerIds | Set<RunnerId> | Optionally restricts the results to the specified Runners. | |
betIds | Set<BetId> | Optionally restricts the results to the specified bet IDs. | |
side | Optionally restricts the results to the specified side. | ||
settledDateRange | Optionally restricts the results to be from/to the specified settled date. This date is inclusive, i.e. if an order was placed on exactly this date (to the millisecond) then it will be included in the results. If the from is later than the to, no results will be returned. | ||
groupBy | How to aggregate the lines, if not supplied then the lowest level is returned, i.e. bet by bet This is only applicable to SETTLED BetStatus. | ||
includeItemDescription | boolean | If true then an ItemDescription object is included in the response. | |
locale | String | The language used for the itemDescription. If not specified, the customer account default is returned. | |
fromRecord | int | Specifies the first record that will be returned. Records start at index zero. | |
recordCount | int | Specifies how many records will be returned, from the index position 'fromRecord'. Note that there is a page size limit of 1000. A value of zero indicates that you would like all records (including and from 'fromRecord') up to the limit. |
Return type | Description |
---|---|
Throws | Description |
---|---|
Generic exception that is thrown if this operation fails for any reason. |
Since 1.0.0