POST api/bfg/v1/orders

Creates a batch of domestic orders for the supplied creator.

Request Information

URI Parameters

None.

Body Parameters

Batch of orders to create plus the single creator (Person) submitting them.

Name	Type	Additional information
PersonID	integer	Required
IpAddress	string	String length: inclusive between 0 and 45
Orders	Collection of CreateOrderRequest	Required

Request Formats

application/json, text/json

Sample:

{
  "PersonID": 1,
  "IpAddress": "sample string 2",
  "Orders": [
    {
      "ClientID": 1,
      "ClientOrderReferenceID": "sample string 2",
      "CreatorID": 1,
      "SecurityCode": "sample string 3",
      "BuySell": 1,
      "PriceType": 1,
      "Price": 1.0,
      "Quantity": 1.0,
      "TradeValue": 1.0,
      "ValidityType": 1,
      "ExpiryDate": "2026-09-16T19:41:38.12122+10:00",
      "Reference": "sample string 4",
      "MiscellaneousTags": [
        "sample string 1",
        "sample string 2"
      ],
      "SRN": "sample string 5"
    },
    {
      "ClientID": 1,
      "ClientOrderReferenceID": "sample string 2",
      "CreatorID": 1,
      "SecurityCode": "sample string 3",
      "BuySell": 1,
      "PriceType": 1,
      "Price": 1.0,
      "Quantity": 1.0,
      "TradeValue": 1.0,
      "ValidityType": 1,
      "ExpiryDate": "2026-09-16T19:41:38.12122+10:00",
      "Reference": "sample string 4",
      "MiscellaneousTags": [
        "sample string 1",
        "sample string 2"
      ],
      "SRN": "sample string 5"
    }
  ]
}

application/xml, text/xml

Sample:

<CreateOrdersRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contracts2.BFG.Order">
  <IpAddress>sample string 2</IpAddress>
  <Orders>
    <CreateOrderRequest>
      <BuySell>Buy</BuySell>
      <ClientID>1</ClientID>
      <ClientOrderReferenceID>sample string 2</ClientOrderReferenceID>
      <CreatorID>1</CreatorID>
      <ExpiryDate>2026-09-16T19:41:38.12122+10:00</ExpiryDate>
      <MiscellaneousTags xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </MiscellaneousTags>
      <Price>1</Price>
      <PriceType>Limit</PriceType>
      <Quantity>1</Quantity>
      <Reference>sample string 4</Reference>
      <SRN>sample string 5</SRN>
      <SecurityCode>sample string 3</SecurityCode>
      <TradeValue>1</TradeValue>
      <ValidityType>FillOrKill</ValidityType>
    </CreateOrderRequest>
    <CreateOrderRequest>
      <BuySell>Buy</BuySell>
      <ClientID>1</ClientID>
      <ClientOrderReferenceID>sample string 2</ClientOrderReferenceID>
      <CreatorID>1</CreatorID>
      <ExpiryDate>2026-09-16T19:41:38.12122+10:00</ExpiryDate>
      <MiscellaneousTags xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </MiscellaneousTags>
      <Price>1</Price>
      <PriceType>Limit</PriceType>
      <Quantity>1</Quantity>
      <Reference>sample string 4</Reference>
      <SRN>sample string 5</SRN>
      <SecurityCode>sample string 3</SecurityCode>
      <TradeValue>1</TradeValue>
      <ValidityType>FillOrKill</ValidityType>
    </CreateOrderRequest>
  </Orders>
  <PersonID>1</PersonID>
</CreateOrdersRequest>

Response Information

Resource Description

One <see cref="T:TPP.B2B.Webservices2.Contracts2.BFG.Order.CreateOrderResult" /> per input order, in the same order as the request.

Collection of CreateOrderResult

Name	Type	Additional information
Success	boolean	None.
ClientOrderReferenceID	string	None.
OrderID	integer	None.
Errors	Collection of string	None.
Warnings	Collection of string	None.
Valuation	OrderValuationResult+OrderValuation	None.
OrderDetails	CreateOrderResult+OrderDetailsData	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Success": true,
    "ClientOrderReferenceID": "sample string 2",
    "OrderID": 1,
    "Errors": [
      "sample string 1",
      "sample string 2"
    ],
    "Warnings": [
      "sample string 1",
      "sample string 2"
    ],
    "Valuation": {
      "Brokerage": 1.0,
      "GST": 2.0,
      "TotalValue": 3.0,
      "Fees": [
        {
          "FeeScheduleType": 1,
          "Amount": 1.0
        },
        {
          "FeeScheduleType": 1,
          "Amount": 1.0
        }
      ]
    },
    "OrderDetails": {
      "ClientID": 1,
      "SecurityCode": "sample string 2",
      "BuySell": 1,
      "Quantity": 1,
      "PriceType": 1,
      "Price": 1.0,
      "ValidityType": 1,
      "ExpiryDate": "2026-09-16T19:41:38.1402121+10:00",
      "Reference": "sample string 3"
    }
  },
  {
    "Success": true,
    "ClientOrderReferenceID": "sample string 2",
    "OrderID": 1,
    "Errors": [
      "sample string 1",
      "sample string 2"
    ],
    "Warnings": [
      "sample string 1",
      "sample string 2"
    ],
    "Valuation": {
      "Brokerage": 1.0,
      "GST": 2.0,
      "TotalValue": 3.0,
      "Fees": [
        {
          "FeeScheduleType": 1,
          "Amount": 1.0
        },
        {
          "FeeScheduleType": 1,
          "Amount": 1.0
        }
      ]
    },
    "OrderDetails": {
      "ClientID": 1,
      "SecurityCode": "sample string 2",
      "BuySell": 1,
      "Quantity": 1,
      "PriceType": 1,
      "Price": 1.0,
      "ValidityType": 1,
      "ExpiryDate": "2026-09-16T19:41:38.1402121+10:00",
      "Reference": "sample string 3"
    }
  }
]

application/xml, text/xml

Sample:

<ArrayOfCreateOrderResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contracts2.BFG.Order">
  <CreateOrderResult>
    <ClientOrderReferenceID>sample string 2</ClientOrderReferenceID>
    <Errors xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Errors>
    <OrderDetails>
      <BuySell>Buy</BuySell>
      <ClientID>1</ClientID>
      <ExpiryDate>2026-09-16T19:41:38.1402121+10:00</ExpiryDate>
      <Price>1</Price>
      <PriceType>Limit</PriceType>
      <Quantity>1</Quantity>
      <Reference>sample string 3</Reference>
      <SecurityCode>sample string 2</SecurityCode>
      <ValidityType>FillOrKill</ValidityType>
    </OrderDetails>
    <OrderID>1</OrderID>
    <Success>true</Success>
    <Valuation>
      <Brokerage>1</Brokerage>
      <Fees>
        <OrderValuationResult.FeeDetails>
          <Amount>1</Amount>
          <FeeScheduleType>ACHFee</FeeScheduleType>
        </OrderValuationResult.FeeDetails>
        <OrderValuationResult.FeeDetails>
          <Amount>1</Amount>
          <FeeScheduleType>ACHFee</FeeScheduleType>
        </OrderValuationResult.FeeDetails>
      </Fees>
      <GST>2</GST>
      <TotalValue>3</TotalValue>
    </Valuation>
    <Warnings xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Warnings>
  </CreateOrderResult>
  <CreateOrderResult>
    <ClientOrderReferenceID>sample string 2</ClientOrderReferenceID>
    <Errors xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Errors>
    <OrderDetails>
      <BuySell>Buy</BuySell>
      <ClientID>1</ClientID>
      <ExpiryDate>2026-09-16T19:41:38.1402121+10:00</ExpiryDate>
      <Price>1</Price>
      <PriceType>Limit</PriceType>
      <Quantity>1</Quantity>
      <Reference>sample string 3</Reference>
      <SecurityCode>sample string 2</SecurityCode>
      <ValidityType>FillOrKill</ValidityType>
    </OrderDetails>
    <OrderID>1</OrderID>
    <Success>true</Success>
    <Valuation>
      <Brokerage>1</Brokerage>
      <Fees>
        <OrderValuationResult.FeeDetails>
          <Amount>1</Amount>
          <FeeScheduleType>ACHFee</FeeScheduleType>
        </OrderValuationResult.FeeDetails>
        <OrderValuationResult.FeeDetails>
          <Amount>1</Amount>
          <FeeScheduleType>ACHFee</FeeScheduleType>
        </OrderValuationResult.FeeDetails>
      </Fees>
      <GST>2</GST>
      <TotalValue>3</TotalValue>
    </Valuation>
    <Warnings xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Warnings>
  </CreateOrderResult>
</ArrayOfCreateOrderResult>

Error Response Information

Resource Description

One <see cref="T:TPP.B2B.Webservices2.Contracts2.BFG.Order.CreateOrderResult" /> per input order, in the same order as the request.

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>