PATCH api/bfg/v1/conditional-orders/{conditionalOrderId}

Update conditional orders

Request Information

URI Parameters

Name	Description	Type	Additional information
conditionalOrderId		integer	Required

Body Parameters

UpdateConditionalOrderRequest

Name	Type	Additional information
CreatorID	integer	Required
PIN	string	Required
ClientID	integer	Required
ActionType	enConditionalOrderActionType	Required
TriggerType	enOrderTriggerType	None.
TriggerSecurityCode	string	None.
TriggerOperator	enOrderTriggerOperator	None.
TriggerPrice	decimal number	None.
TriggerPercentage	decimal number	None.
ExpiryDate	date	None.
TriggerExpiryType	string	None.
TriggerVolume	integer	None.
TriggerStartTimeMinutes	integer	None.
TriggerFinishTimeMinutes	integer	None.
TriggerStartTime	string	None.
TriggerFinishTime	string	None.
OrderSecurityCode	string	None.
OrderBuySell	enBuySell	None.
OrderValidity	enOrderValidityType	None.
OrderPriceType	enOrderPriceType	None.
OrderPrice	decimal number	None.
OrderQuantity	integer	None.
OriginatingOrderID	integer	None.
LicenseeBrokerageScheduleID	integer	None.
IsAdviceFeeApply	boolean	None.
SecurityClassType	enSecurityClassType	None.
ClientBrokerageType	enClientBrokerageType	None.
BrokerageAmount	decimal number	None.
BrokeragePercentage	decimal number	None.

Request Formats

application/json, text/json

Sample:

{
  "CreatorID": 1,
  "PIN": "sample string 2",
  "ClientID": 3,
  "ActionType": 2,
  "TriggerType": 1,
  "TriggerSecurityCode": "sample string 4",
  "TriggerOperator": 1,
  "TriggerPrice": 1.0,
  "TriggerPercentage": 1.0,
  "ExpiryDate": "2026-09-16T19:41:35.7964256+10:00",
  "TriggerExpiryType": "sample string 5",
  "TriggerVolume": 1,
  "TriggerStartTimeMinutes": 1,
  "TriggerFinishTimeMinutes": 1,
  "TriggerStartTime": "sample string 6",
  "TriggerFinishTime": "sample string 7",
  "OrderSecurityCode": "sample string 8",
  "OrderBuySell": 1,
  "OrderValidity": 1,
  "OrderPriceType": 1,
  "OrderPrice": 1.0,
  "OrderQuantity": 1,
  "OriginatingOrderID": 1,
  "LicenseeBrokerageScheduleID": 1,
  "IsAdviceFeeApply": true,
  "SecurityClassType": 1,
  "ClientBrokerageType": 0,
  "BrokerageAmount": 1.0,
  "BrokeragePercentage": 1.0
}

application/xml, text/xml

Sample:

<UpdateConditionalOrderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contracts2.BFG.ConditionalOrder">
  <ActionType>Amendment</ActionType>
  <BrokerageAmount>1</BrokerageAmount>
  <BrokeragePercentage>1</BrokeragePercentage>
  <ClientBrokerageType>ClientDefault</ClientBrokerageType>
  <ClientID>3</ClientID>
  <CreatorID>1</CreatorID>
  <ExpiryDate>2026-09-16T19:41:35.7964256+10:00</ExpiryDate>
  <IsAdviceFeeApply>true</IsAdviceFeeApply>
  <LicenseeBrokerageScheduleID>1</LicenseeBrokerageScheduleID>
  <OrderBuySell>Buy</OrderBuySell>
  <OrderPrice>1</OrderPrice>
  <OrderPriceType>Limit</OrderPriceType>
  <OrderQuantity>1</OrderQuantity>
  <OrderSecurityCode>sample string 8</OrderSecurityCode>
  <OrderValidity>FillOrKill</OrderValidity>
  <OriginatingOrderID>1</OriginatingOrderID>
  <PIN>sample string 2</PIN>
  <SecurityClassType>ASXEquity</SecurityClassType>
  <TriggerExpiryType>sample string 5</TriggerExpiryType>
  <TriggerFinishTime>sample string 7</TriggerFinishTime>
  <TriggerFinishTimeMinutes>1</TriggerFinishTimeMinutes>
  <TriggerOperator>GreaterThanOrEqual</TriggerOperator>
  <TriggerPercentage>1</TriggerPercentage>
  <TriggerPrice>1</TriggerPrice>
  <TriggerSecurityCode>sample string 4</TriggerSecurityCode>
  <TriggerStartTime>sample string 6</TriggerStartTime>
  <TriggerStartTimeMinutes>1</TriggerStartTimeMinutes>
  <TriggerType>PriceLimit</TriggerType>
  <TriggerVolume>1</TriggerVolume>
</UpdateConditionalOrderRequest>

Response Information

Resource Description

List of orders

UpdateConditionalOrderResult

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

Response Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

<UpdateConditionalOrderResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contracts2.BFG.ConditionalOrder">
  <ConditionalOrderId>1</ConditionalOrderId>
  <CreatorId>2</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>
</UpdateConditionalOrderResult>

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>