PATCH api/bfg/v1/conditional-orders

Cancel all conditional orders

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CreatorID	integer	Required
PIN	string	Required
ClientID	integer	Required

Request Formats

application/json, text/json

Sample:

{
  "CreatorID": 1,
  "PIN": "sample string 2",
  "ClientID": 3
}

application/xml, text/xml

Sample:

<CancellAllConditionalOrderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contracts2.BFG.ConditionalOrder">
  <ClientID>3</ClientID>
  <CreatorID>1</CreatorID>
  <PIN>sample string 2</PIN>
</CancellAllConditionalOrderRequest>

Response Information

Resource Description

List of orders

CancelAllConditionalOrderResult

Name	Type	Additional information
CreatorId	integer	None.
Success	boolean	None.
Errors	Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "CreatorId": 1,
  "Success": true,
  "Errors": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<CancelAllConditionalOrderResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contracts2.BFG.ConditionalOrder">
  <CreatorId>1</CreatorId>
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Errors>
  <Success>true</Success>
</CancelAllConditionalOrderResult>

Error Response Information

Resource Description

List of orders

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>