POST api/orders/institutionalTrade/block-allocations

Create a set of child order client allocation(s) on existing Master/Parent order client allocation.

Request Information

URI Parameters

None.

Body Parameters

Order allocation(s) information required for creating a set of child order allocation(s)

InstitutionalTradeBlockAllocation

Name	Description	Type	Additional information
OrderClientAllocationID	Order ClientAllocation ID for the Master allocation	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.

Name

Description

Type

Additional information

OrderClientAllocationID

Order ClientAllocation ID for the Master allocation

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:

{
  "OrderClientAllocationID": 195,
  "MasterReference": "XCCMa3aR573uzw",
  "AllocationDetails": [
    {
      "ClientID": 1574444,
      "Quantity": 25,
      "Price": 6.75,
      "TradeValue": 168.75,
      "NetAmount": 159.47,
      "CustomBrokerageFee": 8.44,
      "GSTValue": 0.84,
      "AllocationReference": "1358233558943267",
      "NotesForClient": "Institutional Allocation as per email and meeting",
      "OtherFees": 0.0
    },
    {
      "ClientID": 987558,
      "Quantity": 75,
      "Price": 6.75,
      "TradeValue": 506.25,
      "NetAmount": 478.41,
      "CustomBrokerageFee": 25.31,
      "GSTValue": 2.53,
      "AllocationReference": "316358044331848E",
      "NotesForClient": "Institutional Allocation as per email and meeting",
      "OtherFees": 0.0
    }
  ]
}

application/xml, text/xml

Sample:

<InstitutionalTradeBlockAllocation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Order">
  <AllocationDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/TPP.Contracts.Services.Order">
    <d2p1:BlockAllocation>
      <d2p1:AllocationReference>1358233558943267</d2p1:AllocationReference>
      <d2p1:ClientID>1574444</d2p1:ClientID>
      <d2p1:CustomBrokerageFee>8.44</d2p1:CustomBrokerageFee>
      <d2p1:GSTValue>0.84</d2p1:GSTValue>
      <d2p1:NetAmount>159.47</d2p1:NetAmount>
      <d2p1:NotesForClient>Institutional Allocation as per email and meeting</d2p1:NotesForClient>
      <d2p1:OtherFees>0</d2p1:OtherFees>
      <d2p1:Price>6.75</d2p1:Price>
      <d2p1:Quantity>25</d2p1:Quantity>
      <d2p1:TradeValue>168.75</d2p1:TradeValue>
    </d2p1:BlockAllocation>
    <d2p1:BlockAllocation>
      <d2p1:AllocationReference>316358044331848E</d2p1:AllocationReference>
      <d2p1:ClientID>987558</d2p1:ClientID>
      <d2p1:CustomBrokerageFee>25.31</d2p1:CustomBrokerageFee>
      <d2p1:GSTValue>2.53</d2p1:GSTValue>
      <d2p1:NetAmount>478.41</d2p1:NetAmount>
      <d2p1:NotesForClient>Institutional Allocation as per email and meeting</d2p1:NotesForClient>
      <d2p1:OtherFees>0</d2p1:OtherFees>
      <d2p1:Price>6.75</d2p1:Price>
      <d2p1:Quantity>75</d2p1:Quantity>
      <d2p1:TradeValue>506.25</d2p1:TradeValue>
    </d2p1:BlockAllocation>
  </AllocationDetails>
  <MasterReference>XCCMa3aR573uzw</MasterReference>
  <OrderClientAllocationID>195</OrderClientAllocationID>
</InstitutionalTradeBlockAllocation>

Response Information

Resource Description

List of InstitutionalTradeBlockAllocationResult if successful otherwise returns list of InstitutionalTradeBlockAllocationErrorResult if there are any invalid order allocations

Collection of InstitutionalTradeBlockAllocationResult

Name	Description	Type	Additional information
MasterReference	Omgeo’s unique identifier	string	None.
AllocationReference	Omgeo allocation Reference	string	None.
OrderClientAllocationID	Child Order Client Allocation ID created	integer	None.
OrderID	Order ID created	integer	None.
NettingOrderID	Root Netting Order ID for entire allocation(s)	integer	None.
DatetimeCreated	Order Client Allocation created date	date	None.

Collection of InstitutionalTradeBlockAllocationErrorResult

Name	Description	Type	Additional information
BlockAllocation	Block Allocation detail from request	BlockAllocation	None.
Errors	Collection of errors	Collection of string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "MasterReference": "XCCMa3aR573uzw",
    "AllocationReference": "1358233558943267",
    "OrderClientAllocationID": 12587,
    "OrderID": 106666682,
    "NettingOrderID": 8766647,
    "DatetimeCreated": "2022-12-15T00:00:00"
  },
  {
    "MasterReference": "XCCMa3aR573uzw",
    "AllocationReference": "1358233558943234565",
    "OrderClientAllocationID": 12588,
    "OrderID": 106666683,
    "NettingOrderID": 8766648,
    "DatetimeCreated": "2022-12-15T00:00:00"
  }
]

application/xml, text/xml

Sample:

<ArrayOfInstitutionalTradeBlockAllocationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Order">
  <InstitutionalTradeBlockAllocationResult>
    <AllocationReference>1358233558943267</AllocationReference>
    <DatetimeCreated>2022-12-15T00:00:00</DatetimeCreated>
    <MasterReference>XCCMa3aR573uzw</MasterReference>
    <NettingOrderID>8766647</NettingOrderID>
    <OrderClientAllocationID>12587</OrderClientAllocationID>
    <OrderID>106666682</OrderID>
  </InstitutionalTradeBlockAllocationResult>
  <InstitutionalTradeBlockAllocationResult>
    <AllocationReference>1358233558943234565</AllocationReference>
    <DatetimeCreated>2022-12-15T00:00:00</DatetimeCreated>
    <MasterReference>XCCMa3aR573uzw</MasterReference>
    <NettingOrderID>8766648</NettingOrderID>
    <OrderClientAllocationID>12588</OrderClientAllocationID>
    <OrderID>106666683</OrderID>
  </InstitutionalTradeBlockAllocationResult>
</ArrayOfInstitutionalTradeBlockAllocationResult>

application/json, text/json

Sample:

[
  {
    "BlockAllocation": {
      "ClientID": 1574444,
      "Quantity": 25,
      "Price": 6.75,
      "TradeValue": 168.75,
      "NetAmount": 159.47,
      "CustomBrokerageFee": 8.44,
      "GSTValue": 0.84,
      "AllocationReference": "1358233558943267",
      "NotesForClient": "Institutional Allocation as per email and meeting",
      "OtherFees": 0.0
    },
    "Errors": [
      "Invalid client:1574444"
    ]
  },
  {
    "BlockAllocation": {
      "ClientID": 987558,
      "Quantity": 75,
      "Price": 6.75,
      "TradeValue": 506.25,
      "NetAmount": 478.41,
      "CustomBrokerageFee": 25.31,
      "GSTValue": 2.53,
      "AllocationReference": "316358044331848E",
      "NotesForClient": "Institutional Allocation as per email and meeting",
      "OtherFees": 0.0
    },
    "Errors": [
      "Not authorised to create order allocation for this client #987558"
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfInstitutionalTradeBlockAllocationErrorResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Order">
  <InstitutionalTradeBlockAllocationErrorResult>
    <BlockAllocation xmlns:d3p1="http://schemas.datacontract.org/2004/07/TPP.Contracts.Services.Order">
      <d3p1:AllocationReference>1358233558943267</d3p1:AllocationReference>
      <d3p1:ClientID>1574444</d3p1:ClientID>
      <d3p1:CustomBrokerageFee>8.44</d3p1:CustomBrokerageFee>
      <d3p1:GSTValue>0.84</d3p1:GSTValue>
      <d3p1:NetAmount>159.47</d3p1:NetAmount>
      <d3p1:NotesForClient>Institutional Allocation as per email and meeting</d3p1:NotesForClient>
      <d3p1:OtherFees>0</d3p1:OtherFees>
      <d3p1:Price>6.75</d3p1:Price>
      <d3p1:Quantity>25</d3p1:Quantity>
      <d3p1:TradeValue>168.75</d3p1:TradeValue>
    </BlockAllocation>
    <Errors xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>Invalid client:1574444</d3p1:string>
    </Errors>
  </InstitutionalTradeBlockAllocationErrorResult>
  <InstitutionalTradeBlockAllocationErrorResult>
    <BlockAllocation xmlns:d3p1="http://schemas.datacontract.org/2004/07/TPP.Contracts.Services.Order">
      <d3p1:AllocationReference>316358044331848E</d3p1:AllocationReference>
      <d3p1:ClientID>987558</d3p1:ClientID>
      <d3p1:CustomBrokerageFee>25.31</d3p1:CustomBrokerageFee>
      <d3p1:GSTValue>2.53</d3p1:GSTValue>
      <d3p1:NetAmount>478.41</d3p1:NetAmount>
      <d3p1:NotesForClient>Institutional Allocation as per email and meeting</d3p1:NotesForClient>
      <d3p1:OtherFees>0</d3p1:OtherFees>
      <d3p1:Price>6.75</d3p1:Price>
      <d3p1:Quantity>75</d3p1:Quantity>
      <d3p1:TradeValue>506.25</d3p1:TradeValue>
    </BlockAllocation>
    <Errors xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>Not authorised to create order allocation for this client #987558</d3p1:string>
    </Errors>
  </InstitutionalTradeBlockAllocationErrorResult>
</ArrayOfInstitutionalTradeBlockAllocationErrorResult>

Error Response Information

Resource Description

List of InstitutionalTradeBlockAllocationResult if successful otherwise returns list of InstitutionalTradeBlockAllocationErrorResult if there are any invalid order allocations

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>