Versions Compared

Key

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

Operation
Anchor
replaceOrders
replaceOrders

Panel
bgColor#FFFFFF
titleBGColor#C8D0E4
titlereplaceOrders

ReplaceExecutionReport

replaceOrders

replaceOrders#replaceOrders ( StringmarketId , List< ReplaceInstruction >instructions ,StringcustomerRef, MarketVersion marketVersion,  boolean async ) throws APINGException

This operation is logically a bulk cancel followed by a bulk place. The cancel is completed first then the new orders are placed. The new orders will be placed atomically in that they will all be placed or none will be placed. In the case where the new orders cannot be placed the cancellations will not be rolled back. See ReplaceInstruction.

Parameter name

Type

Required

Description

marketId

String

(tick)

The market id these orders are to be placed on

instructions

List< ReplaceInstruction >

(tick)

The number of replace instructions.  The limit of replace instructions per request is 60.

customerRef

String

 

Optional parameter allowing the client to pass a unique string (up to 32 chars) that is used to de-dupe mistaken re-submissions.

marketVersion

MarketVersion

 

Optional parameter allowing the client to specify which version of the market the 
orders should be placed on. If the current market version is higher than that sent on an order, 
the bet will be lapsed.

async

boolean

 

An optional flag (not setting equates to false) which specifies if the orders should be replaced asynchronously. 
Orders can be tracked via the Exchange Stream API or the API-NG by providing a customerOrderRef for each replace order. 
Not available for MOC or LOC bets.

Return type

Description

ReplaceExecutionReport

 

Throws

Description

APINGException

Generic exception that is thrown if this operation fails for any reason.

Since 1.0.0