POST api/orders/blockTrade/block-allocations

Create a set of child Block Trade allocation(s) on existing Master/Parent Block Trade allocation.

Request Information

URI Parameters

None.

Body Parameters

Block Trade allocation(s) information required for creating a set of child Block Trade allocation(s)

BlockTradeBlockAllocation

Name	Description	Type	Additional information
BlockTradeAllocationID	Block Trade Allocation 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

BlockTradeAllocationID

Block Trade Allocation 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:

{
  "BlockTradeAllocationID": 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": "Block 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": "Block Allocation as per email and meeting",
      "OtherFees": 0.0
    }
  ]
}

application/xml, text/xml

Sample:

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

Response Information

Resource Description

List of BlockTradeBlockAllocationResult if successful otherwise returns list of BlockTradeBlockAllocationErrorResult if there are any invalid block trade allocations

Collection of BlockTradeBlockAllocationResult

Name	Description	Type	Additional information
MasterReference	Omgeo’s unique identifier	string	None.
AllocationReference	Omgeo allocation Reference	string	None.
BlockTradeAllocationID	Child Block Trade Allocation ID created	integer	None.
ParentBlockTradeAllocationID	Parent Block Trade Allocation ID, Master Block Trade Allocation ID	integer	None.
ClientID	Allocation Client ID	integer	None.
OrderID	Order ID created	integer	None.
DatetimeCreated	Order Client Allocation created date	date	None.

Collection of BlockTradeBlockAllocationErrorResult

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",
    "BlockTradeAllocationID": 12587,
    "ParentBlockTradeAllocationID": 8766647,
    "ClientID": 9985887,
    "OrderID": 106666682,
    "DatetimeCreated": "2022-12-15T00:00:00"
  },
  {
    "MasterReference": "XCCMa3aR573uzw",
    "AllocationReference": "1358233558943234565",
    "BlockTradeAllocationID": 12588,
    "ParentBlockTradeAllocationID": 8766647,
    "ClientID": 9925487,
    "OrderID": 106666683,
    "DatetimeCreated": "2022-12-15T00:00:00"
  }
]

application/xml, text/xml

Sample:

<ArrayOfBlockTradeBlockAllocationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Order">
  <BlockTradeBlockAllocationResult>
    <AllocationReference>1358233558943267</AllocationReference>
    <BlockTradeAllocationID>12587</BlockTradeAllocationID>
    <ClientID>9985887</ClientID>
    <DatetimeCreated>2022-12-15T00:00:00</DatetimeCreated>
    <MasterReference>XCCMa3aR573uzw</MasterReference>
    <OrderID>106666682</OrderID>
    <ParentBlockTradeAllocationID>8766647</ParentBlockTradeAllocationID>
  </BlockTradeBlockAllocationResult>
  <BlockTradeBlockAllocationResult>
    <AllocationReference>1358233558943234565</AllocationReference>
    <BlockTradeAllocationID>12588</BlockTradeAllocationID>
    <ClientID>9925487</ClientID>
    <DatetimeCreated>2022-12-15T00:00:00</DatetimeCreated>
    <MasterReference>XCCMa3aR573uzw</MasterReference>
    <OrderID>106666683</OrderID>
    <ParentBlockTradeAllocationID>8766647</ParentBlockTradeAllocationID>
  </BlockTradeBlockAllocationResult>
</ArrayOfBlockTradeBlockAllocationResult>

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": "Block 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": "Block 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:

<ArrayOfBlockTradeBlockAllocationErrorResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Order">
  <BlockTradeBlockAllocationErrorResult>
    <BlockAllocation>
      <AllocationReference>1358233558943267</AllocationReference>
      <ClientID>1574444</ClientID>
      <CustomBrokerageFee>8.44</CustomBrokerageFee>
      <GSTValue>0.84</GSTValue>
      <NetAmount>159.47</NetAmount>
      <NotesForClient>Block Allocation as per email and meeting</NotesForClient>
      <OtherFees>0</OtherFees>
      <Price>6.75</Price>
      <Quantity>25</Quantity>
      <TradeValue>168.75</TradeValue>
    </BlockAllocation>
    <Errors xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>Invalid client:1574444</d3p1:string>
    </Errors>
  </BlockTradeBlockAllocationErrorResult>
  <BlockTradeBlockAllocationErrorResult>
    <BlockAllocation>
      <AllocationReference>316358044331848E</AllocationReference>
      <ClientID>987558</ClientID>
      <CustomBrokerageFee>25.31</CustomBrokerageFee>
      <GSTValue>2.53</GSTValue>
      <NetAmount>478.41</NetAmount>
      <NotesForClient>Block Allocation as per email and meeting</NotesForClient>
      <OtherFees>0</OtherFees>
      <Price>6.75</Price>
      <Quantity>75</Quantity>
      <TradeValue>506.25</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>
  </BlockTradeBlockAllocationErrorResult>
</ArrayOfBlockTradeBlockAllocationErrorResult>

Error Response Information

Resource Description

List of BlockTradeBlockAllocationResult if successful otherwise returns list of BlockTradeBlockAllocationErrorResult if there are any invalid block trade 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>