Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Panel
bgColor#FFFFFF
titleBGColor#C8D0E4
titlelistCurrentOrders
CurrentOrderSummaryReport listCurrentOrders ( Set<String>betIds,Set<String>marketIds, OrderProjection orderProjection, TimeRange placedDateRange, TimeRange dateRange, OrderBy orderBy, SortDir sortDir,intfromRecord,intrecordCount ) throws APINGException

Returns a list of your current orders. Optionally you can filter and sort your current orders using the various parameters, setting none of the parameters will return all of your current orders, up to a maximum of 1000 bets, ordered BY_BET and sorted EARLIEST_TO_LATEST. To retrieve more than 1000 orders, you need to make use of the fromRecord and recordCount parameters.

Parameter name

Type

Required

Description

betIds

Set<String>

 

Optionally restricts the results to the specified bet IDs.

marketIds

Set<String>

 

Optionally restricts the results to the specified market IDs.

orderProjection

OrderProjection

 

Optionally restricts the results to the specified order status.

placedDateRange

TimeRange

 

Deprecated use dateRange instead.  Optionally restricts the results to be from/to the specified placed 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.

dateRangeTimeRange Replacement for placedDateRange to allow filtering by other date fields rather than just placedDate. Optionally restricts the results to be from/to the specified date, these dates are contextual to the orders being returned and therefore the dates used to filter on will change to placed, matched, voided or settled dates depending on the orderBy. 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.

orderBy

OrderBy

 

Specifies how the results will be ordered. If no value is passed in, it defaults to BY_BET.  Also acts as a filter such that only orders with a valid value in the field being ordered by will be returned (i.e. BY_VOID_TIME returns only voided orders, BY_SETTLED_TIME returns only settled orders and BY_MATCH_TIME returns only orders with a matched date (voided, settled, matched orders)).

sortDir

SortDir

 

Specifies the direction the results will be sorted in. If no value is passed in, it defaults to EARLIEST_TO_LATEST.

fromRecord

int

 

Specifies the first record that will be returned. Records start at index zero, not at index one.

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