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 |
CurrentOrderSummaryReport |
|
Throws |
Description |
APINGException |
Generic exception that is thrown if this operation |
|
fails for any reason. |
Since 1.0.0 |
|
listClearedOrders
Operation
listClearedOrders
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. To retrieve more than 1000 records, you need to make use of the fromRecord and recordCount parameters. The fields available at each roll-up are available here
Parameter name |
Type |
Required |
Description |
betStatus |
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 |
Side |
Optionally restricts the |
|
|
results to the specified |
|
|
side. |
settledDateRange |
TimeRange |
Optionally restricts the |
|
|
results to be from/to the |
|
|
specified settled date. |
|
|
This date is inclusive, |
|
|
i.e. if an order was |
|
|
cleared 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 |
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 |
ClearedOrderSummaryReport |
|
Throws |
Description |
APINGException |
Generic exception that is thrown if this operation |
|
fails for any reason. |
Since 1.0.0 |
|
listClearedOrders - Roll-up Fields Available
The below table indicates fields will be available at each roll-up when making requests to listClearedOrders
Rollup level: |
BET |
SIDE |
MARKET |
EVENT |
EVENT_TYP |
EXCHANGE |
|
|
|
|
|
E |
|
Settled As |
Y |
Y |
Y |
Y |
Y |
Y |
Settled Date |
Y |
MAX |
MAX |
MAX |
MAX |
MAX |
Bet Count |
Y |
Y |
Y |
Y |
Y |
Y |
Profit |
Y |
SUM |
SUM |
SUM |
SUM |
SUM |
Exchange Id |
Y |
Y |
Y |
Y |
Y |
Y |
Event Type Id |
Y |
Y |
Y |
Y |
Y |
N |