POST api/orders/institutionalTrade/block-allocations/v2

Create a task for child order client allocation(s) on existing Master allocation.

Request Information

URI Parameters

None.

Body Parameters

Order allocation(s) information required for creating a task for order allocation(s)

InstitutionalTradeBlockAllocationRequestV2
NameDescriptionTypeAdditional information
InstitutionalMasterAllocationID

Institutional Master Allocation ID

integer

Required
MasterReference

Omgeo’s unique identifier

string

Required

String length: inclusive between 0 and 16
AllocationDetails

List of Block Allocations to destined client(s)

Collection of BlockAllocation

None.

Request Formats

application/json, text/json

Sample: 
{
  "InstitutionalMasterAllocationID": 195,
  "MasterReference": "XCCMa3aR573uzw",
  "AllocationDetails": [
    {
      "ClientID": 1574444,
      "Quantity": 300,
      "Price": 1.0,
      "TradeValue": 300.0,
      "NetAmount": 312.65,
      "CustomBrokerageFee": 11.5,
      "GSTValue": 1.15,
      "AllocationReference": "1358233558943267",
      "NotesForClient": "Institutional Allocation as per email and meeting",
      "OtherFees": 0.0
    },
    {
      "ClientID": 987558,
      "Quantity": 100,
      "Price": 1.0,
      "TradeValue": 100.0,
      "NetAmount": 103.65,
      "CustomBrokerageFee": 3.65,
      "GSTValue": 0.0,
      "AllocationReference": "316358044331848E",
      "NotesForClient": "Institutional Allocation as per email and meeting",
      "OtherFees": 0.0
    }
  ]
}

application/xml, text/xml

Sample: 
<InstitutionalTradeBlockAllocationRequestV2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.Contracts.Services.Order">
  <AllocationDetails>
    <BlockAllocation>
      <AllocationReference>1358233558943267</AllocationReference>
      <ClientID>1574444</ClientID>
      <CustomBrokerageFee>11.50</CustomBrokerageFee>
      <GSTValue>1.15</GSTValue>
      <NetAmount>312.65</NetAmount>
      <NotesForClient>Institutional Allocation as per email and meeting</NotesForClient>
      <OtherFees>0</OtherFees>
      <Price>1</Price>
      <Quantity>300</Quantity>
      <TradeValue>300</TradeValue>
    </BlockAllocation>
    <BlockAllocation>
      <AllocationReference>316358044331848E</AllocationReference>
      <ClientID>987558</ClientID>
      <CustomBrokerageFee>3.65</CustomBrokerageFee>
      <GSTValue>0</GSTValue>
      <NetAmount>103.65</NetAmount>
      <NotesForClient>Institutional Allocation as per email and meeting</NotesForClient>
      <OtherFees>0</OtherFees>
      <Price>1</Price>
      <Quantity>100</Quantity>
      <TradeValue>100</TradeValue>
    </BlockAllocation>
  </AllocationDetails>
  <InstitutionalMasterAllocationID>195</InstitutionalMasterAllocationID>
  <MasterReference>XCCMa3aR573uzw</MasterReference>
</InstitutionalTradeBlockAllocationRequestV2>

Response Information

Resource Description

Return true if task successfully created else return bad request

boolean

Response Formats

application/json, text/json

Sample: 
true

application/xml, text/xml

Sample: 
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>

Error Response Information

Resource Description

Return true if task successfully created else return bad 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>