POST api/orders/order/active

Create a single active order.

Request Information

URI Parameters

None.

Body Parameters

Order instruction

Name	Description	Type	Additional information
ClientID	Client ID.	integer	None.
SecurityCode	Security code for the order.	string	Required
BuySell	Buy / sell indicator.	enBuySell	Required
PriceType	Order price type.	enOrderPriceType	Required
Price		decimal number	None.
Quantity	Quantity of the order (either quantity or trade value is required).	integer	Required
ValidityType	Order validity type.	enOrderValidityType	Required
ClientBrokerageSchedule	Client Brokerage Schedule	integer	None.
LicenseePlusFee	Licenseee Plus Fee. ie. 101.50	decimal number	None.
CustomBrokerageFee	Custom Brokerage Fee. ie. 50.50	decimal number	None.
CustomBrokeragePercent	Custom Brokerage Percent. ie. 0.5 = 50%	decimal number	None.
ExternalOrderNumber	External Order Number/ Refernce	string	None.
MarketReference	Market Refernce	string	None.
NotesForClient	Notes for client	string	None.
OrderGiver	Order Giver	string	String length: inclusive between 0 and 500
RegistrationType	Order registration type.	enOrderSettlementType	None.
RegistrationDetail	Order registration detail.	string	None.

Request Formats

application/json, text/json

Sample:

{
  "ClientID": 12345,
  "SecurityCode": "BHP",
  "BuySell": 1,
  "PriceType": 1,
  "Price": 1.25,
  "Quantity": 500,
  "ValidityType": 3,
  "ClientBrokerageSchedule": 12345,
  "LicenseePlusFee": 100.0,
  "CustomBrokerageFee": 100.0,
  "CustomBrokeragePercent": 0.5,
  "ExternalOrderNumber": "12345",
  "MarketReference": "456780",
  "NotesForClient": "ABCDE",
  "OrderGiver": "USER 1",
  "RegistrationType": 2,
  "RegistrationDetail": "I1234567890"
}

application/xml, text/xml

Sample:

<OrderActiveCreation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.Contracts.Services.Order">
  <BuySell>Buy</BuySell>
  <ClientBrokerageSchedule>12345</ClientBrokerageSchedule>
  <ClientID>12345</ClientID>
  <CustomBrokerageFee>100</CustomBrokerageFee>
  <CustomBrokeragePercent>0.5</CustomBrokeragePercent>
  <ExternalOrderNumber>12345</ExternalOrderNumber>
  <LicenseePlusFee>100</LicenseePlusFee>
  <MarketReference>456780</MarketReference>
  <NotesForClient>ABCDE</NotesForClient>
  <OrderGiver>USER 1</OrderGiver>
  <Price>1.25</Price>
  <PriceType>Limit</PriceType>
  <Quantity>500</Quantity>
  <RegistrationDetail>I1234567890</RegistrationDetail>
  <RegistrationType>IssuerSponsored</RegistrationType>
  <SecurityCode>BHP</SecurityCode>
  <ValidityType>DayOnly</ValidityType>
</OrderActiveCreation>

Response Information

Resource Description

Order creation result

OrderActiveCreationResult

Name	Description	Type	Additional information
orderID	Unique order identifier.	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "orderID": 12345
}

application/xml, text/xml

Sample:

<OrderActiveCreationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <orderID>12345</orderID>
</OrderActiveCreationResult>

Error Response Information

Resource Description

Order creation result

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>