POST api/bfg/v1/orders/amendments

Cancelling multiple orders

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
ClientId		integer	None.
SecurityClassTypes		Collection of enSecurityClassType	None.

Request Formats

application/json, text/json

Sample:

{
  "ClientId": 1,
  "SecurityClassTypes": [
    1,
    1
  ]
}

application/xml, text/xml

Sample:

<CancelOrdersRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contracts2.BFG.Order">
  <ClientId>1</ClientId>
  <SecurityClassTypes xmlns:d2p1="http://schemas.datacontract.org/2004/07/TPP.Utilities">
    <d2p1:enSecurityClassType>ASXEquity</d2p1:enSecurityClassType>
    <d2p1:enSecurityClassType>ASXEquity</d2p1:enSecurityClassType>
  </SecurityClassTypes>
</CancelOrdersRequest>

Response Information

Resource Description

List of success, failed cancelled order

CancelOrdersResult

Name	Type	Additional information
Message	string	None.
TotalOrders	integer	None.
SuccessCount	integer	None.
FailureCount	integer	None.
Results	Collection of CreateOrderCancellationResult	None.

Response Formats

application/json, text/json

Sample:

{
  "Message": "sample string 1",
  "TotalOrders": 2,
  "SuccessCount": 3,
  "FailureCount": 4,
  "Results": [
    {
      "OrderID": 1,
      "Success": true,
      "Errors": [
        "sample string 1",
        "sample string 2"
      ]
    },
    {
      "OrderID": 1,
      "Success": true,
      "Errors": [
        "sample string 1",
        "sample string 2"
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<CancelOrdersResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contracts2.BFG.Order">
  <FailureCount>4</FailureCount>
  <Message>sample string 1</Message>
  <Results>
    <CreateOrderCancellationResult>
      <Errors xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Errors>
      <OrderID>1</OrderID>
      <Success>true</Success>
    </CreateOrderCancellationResult>
    <CreateOrderCancellationResult>
      <Errors xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Errors>
      <OrderID>1</OrderID>
      <Success>true</Success>
    </CreateOrderCancellationResult>
  </Results>
  <SuccessCount>3</SuccessCount>
  <TotalOrders>2</TotalOrders>
</CancelOrdersResult>

Error Response Information

Resource Description

List of success, failed cancelled order

string

Error Response Formats

application/json, text/json

Sample:

"sample string 1"

application/xml, text/xml

Sample:

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>