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

Gets a conditional order (<c>SH_GetConditionalOrderByID</c>).

Request Information

URI Parameters

NameDescriptionTypeAdditional information
conditionalOrderId

integer

Required

Body Parameters

None.

Response Information

Resource Description

ConditionalOrderResponse
NameDescriptionTypeAdditional information
OrderTriggerID

integer

None.

DateTimeCreated

date

None.

TriggerExpiryDate

date

None.

DomesticFacilityID

integer

None.

TriggerSecurityCode

string

None.

TriggerType

byte

None.

TriggerOperator

byte

None.

TriggerPrice

decimal number

None.

TriggerPercentage

decimal number

None.

TriggerVolume

integer

None.

TriggerVolumeOperator

byte

None.

TriggerStartTimeMinutes

integer

None.

TriggerFinishTimeMinutes

integer

None.

OrderSecurityCode

string

None.

OrderBuySell

byte

None.

OrderPriceType

byte

None.

OrderPrice

decimal number

None.

OrderQuantity

integer

None.

OrderValidityType

byte

None.

Status

byte

None.

DateTimeTriggered

date

None.

CompletionReason

string

None.

DerivedTriggerPrice

decimal number

None.

DerivedTriggerDate

date

None.

LastUpdateReason

byte

None.

NotesForOperator

string

None.

NotesForClient

string

None.

OriginatingOrderID

string

None.

OrderSecurityLongName

string

None.

IsASXTriggerIndex

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "OrderTriggerID": 1,
  "DateTimeCreated": "2026-11-17T11:17:26.085391+11:00",
  "TriggerExpiryDate": "2026-11-17T11:17:26.085391+11:00",
  "DomesticFacilityID": 4,
  "TriggerSecurityCode": "sample string 5",
  "TriggerType": 64,
  "TriggerOperator": 64,
  "TriggerPrice": 1.0,
  "TriggerPercentage": 1.0,
  "TriggerVolume": 1,
  "TriggerVolumeOperator": 64,
  "TriggerStartTimeMinutes": 1,
  "TriggerFinishTimeMinutes": 1,
  "OrderSecurityCode": "sample string 8",
  "OrderBuySell": 64,
  "OrderPriceType": 64,
  "OrderPrice": 1.0,
  "OrderQuantity": 11,
  "OrderValidityType": 64,
  "Status": 64,
  "DateTimeTriggered": "2026-11-17T11:17:26.085391+11:00",
  "CompletionReason": "sample string 14",
  "DerivedTriggerPrice": 1.0,
  "DerivedTriggerDate": "2026-11-17T11:17:26.085391+11:00",
  "LastUpdateReason": 64,
  "NotesForOperator": "sample string 16",
  "NotesForClient": "sample string 17",
  "OriginatingOrderID": "sample string 18",
  "OrderSecurityLongName": "sample string 19",
  "IsASXTriggerIndex": true
}

application/xml, text/xml

Sample:
<ConditionalOrderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contracts2.BFG.ConditionalOrder">
  <CompletionReason>sample string 14</CompletionReason>
  <DateTimeCreated>2026-11-17T11:17:26.085391+11:00</DateTimeCreated>
  <DateTimeTriggered>2026-11-17T11:17:26.085391+11:00</DateTimeTriggered>
  <DerivedTriggerDate>2026-11-17T11:17:26.085391+11:00</DerivedTriggerDate>
  <DerivedTriggerPrice>1</DerivedTriggerPrice>
  <DomesticFacilityID>4</DomesticFacilityID>
  <IsASXTriggerIndex>true</IsASXTriggerIndex>
  <LastUpdateReason>64</LastUpdateReason>
  <NotesForClient>sample string 17</NotesForClient>
  <NotesForOperator>sample string 16</NotesForOperator>
  <OrderBuySell>64</OrderBuySell>
  <OrderPrice>1</OrderPrice>
  <OrderPriceType>64</OrderPriceType>
  <OrderQuantity>11</OrderQuantity>
  <OrderSecurityCode>sample string 8</OrderSecurityCode>
  <OrderSecurityLongName>sample string 19</OrderSecurityLongName>
  <OrderTriggerID>1</OrderTriggerID>
  <OrderValidityType>64</OrderValidityType>
  <OriginatingOrderID>sample string 18</OriginatingOrderID>
  <Status>64</Status>
  <TriggerExpiryDate>2026-11-17T11:17:26.085391+11:00</TriggerExpiryDate>
  <TriggerFinishTimeMinutes>1</TriggerFinishTimeMinutes>
  <TriggerOperator>64</TriggerOperator>
  <TriggerPercentage>1</TriggerPercentage>
  <TriggerPrice>1</TriggerPrice>
  <TriggerSecurityCode>sample string 5</TriggerSecurityCode>
  <TriggerStartTimeMinutes>1</TriggerStartTimeMinutes>
  <TriggerType>64</TriggerType>
  <TriggerVolume>1</TriggerVolume>
  <TriggerVolumeOperator>64</TriggerVolumeOperator>
</ConditionalOrderResponse>