POST api/orders/blocktrade/cancel-allocation

Cancel Master Block Trade allocation and it's child allocation(s).

Request Information

URI Parameters

None.

Body Parameters

Block Trade Cancel Allocation details

Name	Description	Type	Additional information
BlockTradeAllocationID	Block Trade Allocation ID to be cancel	integer	Required
Notes	Cancellation notes	string	String length: inclusive between 0 and 255

Request Formats

application/json, text/json

Sample:

{
  "BlockTradeAllocationID": 4001587,
  "Notes": "Cancel Master Block Trade Allocation"
}

application/xml, text/xml

Sample:

<BlockTradeCancelAllocation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.Contracts.Services.Order">
  <BlockTradeAllocationID>4001587</BlockTradeAllocationID>
  <Notes>Cancel Master Block Trade Allocation</Notes>
</BlockTradeCancelAllocation>

Response Information

Resource Description

Cancelled BlockTradeAllocationID if successful otherwise returns BlockTradeCancelAllocationErrorResult if there is any error(s) occurs

BlockTradeCancelAllocationResult

Name	Description	Type	Additional information
BlockTradeAllocationID	Block Trade Allocation ID	integer	Required

Response Formats

application/json, text/json

Sample:

{
  "BlockTradeAllocationID": 4001587
}

application/xml, text/xml

Sample:

<BlockTradeCancelAllocationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Order">
  <BlockTradeAllocationID>4001587</BlockTradeAllocationID>
</BlockTradeCancelAllocationResult>

Error Response Information

Resource Description

Cancelled BlockTradeAllocationID if successful otherwise returns BlockTradeCancelAllocationErrorResult if there is any error(s) occurs

BlockTradeCancelAllocationErrorResult

Name	Description	Type	Additional information
BlockTradeAllocationID	Block Trade Allocation ID	integer	Required
Errors	List of error(s)	Collection of string	None.

Error Response Formats

application/json, text/json

Sample:

{
  "BlockTradeAllocationID": 4001587,
  "Errors": [
    "Invalid Block Trade Allocation ID"
  ]
}

application/xml, text/xml

Sample:

<BlockTradeCancelAllocationErrorResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Order">
  <BlockTradeAllocationID>4001587</BlockTradeAllocationID>
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>Invalid Block Trade Allocation ID</d2p1:string>
  </Errors>
</BlockTradeCancelAllocationErrorResult>