POST api/bfg/v1/conditional-orders/valuations

Previews validation and valuation for a conditional-order create or amendment without persisting it.

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CreatorID	integer	Required
PIN	string	Required
ClientID	integer	Required
OperationType	enConditionalOrderValuationOperation	Required
ConditionalOrderId	integer	None.
ConditionalOrderDetails	ConditionalOrderValuationRequest	Required

Request Formats

application/json, text/json

Sample:

{
  "CreatorID": 1,
  "PIN": "sample string 2",
  "ClientID": 3,
  "OperationType": 0,
  "ConditionalOrderId": 1,
  "ConditionalOrderDetails": {
    "TriggerSecurityCode": "sample string 1",
    "TriggerType": 1,
    "TriggerOperator": 1,
    "TriggerPrice": 1.0,
    "TriggerPercentage": 1.0,
    "TriggerExpiryDate": "2026-10-07T18:20:38.4723816+11:00",
    "TriggerExpiryType": "sample string 2",
    "TriggerVolume": 1,
    "TriggerStartTime": "sample string 3",
    "TriggerFinishTime": "sample string 4",
    "OrderSecurityCode": "sample string 5",
    "OrderBuySell": 1,
    "OrderPriceType": 1,
    "OrderPrice": 1.0,
    "OrderQuantity": 6,
    "OrderValidityType": 1,
    "SecurityClassType": 1,
    "OriginatingOrderID": 1,
    "IsAdviceFeeApply": true,
    "LicenseeBrokerageScheduleID": 1,
    "ClientBrokerageType": 0,
    "BrokerageAmount": 1.0,
    "BrokeragePercentage": 1.0
  }
}

application/xml, text/xml

Sample:

<ValuateConditionalOrderRequest 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>
  <ConditionalOrderDetails>
    <BrokerageAmount>1</BrokerageAmount>
    <BrokeragePercentage>1</BrokeragePercentage>
    <ClientBrokerageType>ClientDefault</ClientBrokerageType>
    <IsAdviceFeeApply>true</IsAdviceFeeApply>
    <LicenseeBrokerageScheduleID>1</LicenseeBrokerageScheduleID>
    <OrderBuySell>Buy</OrderBuySell>
    <OrderPrice>1</OrderPrice>
    <OrderPriceType>Limit</OrderPriceType>
    <OrderQuantity>6</OrderQuantity>
    <OrderSecurityCode>sample string 5</OrderSecurityCode>
    <OrderValidityType>FillOrKill</OrderValidityType>
    <OriginatingOrderID>1</OriginatingOrderID>
    <SecurityClassType>ASXEquity</SecurityClassType>
    <TriggerExpiryDate>2026-10-07T18:20:38.4723816+11:00</TriggerExpiryDate>
    <TriggerExpiryType>sample string 2</TriggerExpiryType>
    <TriggerFinishTime>sample string 4</TriggerFinishTime>
    <TriggerOperator>GreaterThanOrEqual</TriggerOperator>
    <TriggerPercentage>1</TriggerPercentage>
    <TriggerPrice>1</TriggerPrice>
    <TriggerSecurityCode>sample string 1</TriggerSecurityCode>
    <TriggerStartTime>sample string 3</TriggerStartTime>
    <TriggerType>PriceLimit</TriggerType>
    <TriggerVolume>1</TriggerVolume>
  </ConditionalOrderDetails>
  <ConditionalOrderId>1</ConditionalOrderId>
  <CreatorID>1</CreatorID>
  <OperationType>Unknown</OperationType>
  <PIN>sample string 2</PIN>
</ValuateConditionalOrderRequest>

Response Information

Resource Description

ConditionalOrderValuationResponse

Name	Type	Additional information
Success	boolean	None.
CoData	ConditionalOrderValuationRequest	None.
Warnings	Collection of string	None.
Errors	Collection of string	None.
Information	Collection of string	None.
WarningsConcatenated	string	None.
ErrorsConcatenated	string	None.
InformationConcatenated	string	None.
Valuation	decimal number	None.
CoValuation	OrderValuationResult+OrderValuation	None.
ShortDescription	string	None.
SecurityDescription	string	None.
AckText	string	None.
ValidPIN	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "CoData": {
    "TriggerSecurityCode": "sample string 1",
    "TriggerType": 1,
    "TriggerOperator": 1,
    "TriggerPrice": 1.0,
    "TriggerPercentage": 1.0,
    "TriggerExpiryDate": "2026-10-07T18:20:38.492669+11:00",
    "TriggerExpiryType": "sample string 2",
    "TriggerVolume": 1,
    "TriggerStartTime": "sample string 3",
    "TriggerFinishTime": "sample string 4",
    "OrderSecurityCode": "sample string 5",
    "OrderBuySell": 1,
    "OrderPriceType": 1,
    "OrderPrice": 1.0,
    "OrderQuantity": 6,
    "OrderValidityType": 1,
    "SecurityClassType": 1,
    "OriginatingOrderID": 1,
    "IsAdviceFeeApply": true,
    "LicenseeBrokerageScheduleID": 1,
    "ClientBrokerageType": 0,
    "BrokerageAmount": 1.0,
    "BrokeragePercentage": 1.0
  },
  "Warnings": [
    "sample string 1",
    "sample string 2"
  ],
  "Errors": [
    "sample string 1",
    "sample string 2"
  ],
  "Information": [
    "sample string 1",
    "sample string 2"
  ],
  "WarningsConcatenated": "• sample string 1<br />• sample string 2",
  "ErrorsConcatenated": "• sample string 1<br />• sample string 2",
  "InformationConcatenated": "• sample string 1<br />• sample string 2",
  "Valuation": 1.0,
  "CoValuation": {
    "Brokerage": 1.0,
    "GST": 2.0,
    "TotalValue": 3.0,
    "Fees": [
      {
        "FeeScheduleType": 1,
        "Amount": 1.0
      },
      {
        "FeeScheduleType": 1,
        "Amount": 1.0
      }
    ]
  },
  "ShortDescription": "sample string 2",
  "SecurityDescription": "sample string 3",
  "AckText": "sample string 4",
  "ValidPIN": true
}

application/xml, text/xml

Sample:

<ConditionalOrderValuationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contracts2.BFG.ConditionalOrder">
  <AckText>sample string 4</AckText>
  <CoData>
    <BrokerageAmount>1</BrokerageAmount>
    <BrokeragePercentage>1</BrokeragePercentage>
    <ClientBrokerageType>ClientDefault</ClientBrokerageType>
    <IsAdviceFeeApply>true</IsAdviceFeeApply>
    <LicenseeBrokerageScheduleID>1</LicenseeBrokerageScheduleID>
    <OrderBuySell>Buy</OrderBuySell>
    <OrderPrice>1</OrderPrice>
    <OrderPriceType>Limit</OrderPriceType>
    <OrderQuantity>6</OrderQuantity>
    <OrderSecurityCode>sample string 5</OrderSecurityCode>
    <OrderValidityType>FillOrKill</OrderValidityType>
    <OriginatingOrderID>1</OriginatingOrderID>
    <SecurityClassType>ASXEquity</SecurityClassType>
    <TriggerExpiryDate>2026-10-07T18:20:38.492669+11:00</TriggerExpiryDate>
    <TriggerExpiryType>sample string 2</TriggerExpiryType>
    <TriggerFinishTime>sample string 4</TriggerFinishTime>
    <TriggerOperator>GreaterThanOrEqual</TriggerOperator>
    <TriggerPercentage>1</TriggerPercentage>
    <TriggerPrice>1</TriggerPrice>
    <TriggerSecurityCode>sample string 1</TriggerSecurityCode>
    <TriggerStartTime>sample string 3</TriggerStartTime>
    <TriggerType>PriceLimit</TriggerType>
    <TriggerVolume>1</TriggerVolume>
  </CoData>
  <CoValuation xmlns:d2p1="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contracts2.BFG.Order">
    <d2p1:Brokerage>1</d2p1:Brokerage>
    <d2p1:Fees>
      <d2p1:OrderValuationResult.FeeDetails>
        <d2p1:Amount>1</d2p1:Amount>
        <d2p1:FeeScheduleType>ACHFee</d2p1:FeeScheduleType>
      </d2p1:OrderValuationResult.FeeDetails>
      <d2p1:OrderValuationResult.FeeDetails>
        <d2p1:Amount>1</d2p1:Amount>
        <d2p1:FeeScheduleType>ACHFee</d2p1:FeeScheduleType>
      </d2p1:OrderValuationResult.FeeDetails>
    </d2p1:Fees>
    <d2p1:GST>2</d2p1:GST>
    <d2p1:TotalValue>3</d2p1:TotalValue>
  </CoValuation>
  <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>
  <Information xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Information>
  <SecurityDescription>sample string 3</SecurityDescription>
  <ShortDescription>sample string 2</ShortDescription>
  <Success>true</Success>
  <ValidPIN>true</ValidPIN>
  <Valuation>1</Valuation>
  <Warnings xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Warnings>
</ConditionalOrderValuationResponse>

Error Response Information

Resource Description

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>