POST api/bfg/v1/conditional-orders

Create a conditional order.

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CreatorID	integer	Required
PIN	string	Required
ClientID	integer	Required
TriggerSecurityCode	string	Required
TriggerType	enOrderTriggerType	Required
TriggerOperator	enOrderTriggerOperator	Required
TriggerPrice	decimal number	None.
TriggerPercentage	decimal number	None.
TriggerExpiryDate	date	None.
TriggerExpiryType	string	None.
TriggerVolume	integer	None.
TriggerStartTime	string	None.
TriggerFinishTime	string	None.
OrderSecurityCode	string	Required
OrderBuySell	enBuySell	Required
OrderPriceType	enOrderPriceType	Required
OrderPrice	decimal number	None.
OrderQuantity	integer	Required
OrderValidityType	enOrderValidityType	Required
SecurityClassType	enSecurityClassType	Required
OriginatingOrderID	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "CreatorID": 1,
  "PIN": "sample string 2",
  "ClientID": 3,
  "TriggerSecurityCode": "sample string 4",
  "TriggerType": 1,
  "TriggerOperator": 1,
  "TriggerPrice": 1.0,
  "TriggerPercentage": 1.0,
  "TriggerExpiryDate": "2026-09-16T19:41:36.297274+10:00",
  "TriggerExpiryType": "sample string 5",
  "TriggerVolume": 1,
  "TriggerStartTime": "sample string 6",
  "TriggerFinishTime": "sample string 7",
  "OrderSecurityCode": "sample string 8",
  "OrderBuySell": 1,
  "OrderPriceType": 1,
  "OrderPrice": 1.0,
  "OrderQuantity": 9,
  "OrderValidityType": 1,
  "SecurityClassType": 1,
  "OriginatingOrderID": 1
}

application/xml, text/xml

Sample:

<CreateConditionalOrderRequest 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>
  <OrderBuySell>Buy</OrderBuySell>
  <OrderPrice>1</OrderPrice>
  <OrderPriceType>Limit</OrderPriceType>
  <OrderQuantity>9</OrderQuantity>
  <OrderSecurityCode>sample string 8</OrderSecurityCode>
  <OrderValidityType>FillOrKill</OrderValidityType>
  <OriginatingOrderID>1</OriginatingOrderID>
  <PIN>sample string 2</PIN>
  <SecurityClassType>ASXEquity</SecurityClassType>
  <TriggerExpiryDate>2026-09-16T19:41:36.297274+10:00</TriggerExpiryDate>
  <TriggerExpiryType>sample string 5</TriggerExpiryType>
  <TriggerFinishTime>sample string 7</TriggerFinishTime>
  <TriggerOperator>GreaterThanOrEqual</TriggerOperator>
  <TriggerPercentage>1</TriggerPercentage>
  <TriggerPrice>1</TriggerPrice>
  <TriggerSecurityCode>sample string 4</TriggerSecurityCode>
  <TriggerStartTime>sample string 6</TriggerStartTime>
  <TriggerType>PriceLimit</TriggerType>
  <TriggerVolume>1</TriggerVolume>
</CreateConditionalOrderRequest>

Response Information

Resource Description

CreateConditionalOrderResult

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:

<CreateConditionalOrderResult 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>
</CreateConditionalOrderResult>

Error Response Information

Resource Description

CreateConditionalOrderResult

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

Error 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:

<CreateConditionalOrderResult 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>
</CreateConditionalOrderResult>