POST api/orders/ipo/block-allocations

Create a set of order allocations.

Request Information

URI Parameters

None.

Body Parameters

List of order allocations

IPOBlockAllocation

Name	Description	Type	Additional information
PlacementAllocationID	Placement 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.

Name

Description

Type

Additional information

PlacementAllocationID

Placement 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:

{
  "PlacementAllocationID": 123456,
  "MasterReference": "Master Reference",
  "AllocationDetails": [
    {
      "ClientID": 111111,
      "Quantity": 100,
      "Price": 19.04,
      "TradeValue": 234.56,
      "NetAmount": 123.45,
      "CustomBrokerageFee": 0.0,
      "GSTValue": 12.34,
      "AllocationReference": "AR123",
      "NotesForClient": "Order Allocation 1",
      "OtherFees": 0.0
    }
  ]
}

application/xml, text/xml

Sample:

<IPOBlockAllocation 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>AR123</d2p1:AllocationReference>
      <d2p1:ClientID>111111</d2p1:ClientID>
      <d2p1:CustomBrokerageFee>0</d2p1:CustomBrokerageFee>
      <d2p1:GSTValue>12.34</d2p1:GSTValue>
      <d2p1:NetAmount>123.45</d2p1:NetAmount>
      <d2p1:NotesForClient>Order Allocation 1</d2p1:NotesForClient>
      <d2p1:OtherFees>0</d2p1:OtherFees>
      <d2p1:Price>19.04</d2p1:Price>
      <d2p1:Quantity>100</d2p1:Quantity>
      <d2p1:TradeValue>234.56</d2p1:TradeValue>
    </d2p1:BlockAllocation>
  </AllocationDetails>
  <MasterReference>Master Reference</MasterReference>
  <PlacementAllocationID>123456</PlacementAllocationID>
</IPOBlockAllocation>

Response Information

Resource Description

List of OrderAllocationResult if successful otherwise returns list of OrderAllocationErrorResult if there are any invalid order allocations

Collection of IPOBlockAllocationResult

Name	Description	Type	Additional information
MasterReference	Omgeo’s unique identifier	string	None.
AllocationReference	Omgeo allocation Reference	string	None.
PlacementAllocationID	Placement allocation ID created	integer	None.
ParentPlacementAllocationID	Placement allocation's parent ID	integer	None.
ClientID	Placement allocation's client ID	integer	None.
DatetimeCreated	Placement allocation's created date	date	None.

Collection of IPOBlockAllocationErrorResult

Name	Description	Type	Additional information
BlockAllocation	Block allocation details	BlockAllocation	None.
Errors	Collection of errors	Collection of string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "MasterReference": "Master Reference",
    "AllocationReference": "Allocation Reference",
    "PlacementAllocationID": 123456,
    "ParentPlacementAllocationID": 6544443,
    "ClientID": 100000,
    "DatetimeCreated": "2022-12-15T00:00:00"
  }
]

application/xml, text/xml

Sample:

<ArrayOfIPOBlockAllocationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Order">
  <IPOBlockAllocationResult>
    <AllocationReference>Allocation Reference</AllocationReference>
    <ClientID>100000</ClientID>
    <DatetimeCreated>2022-12-15T00:00:00</DatetimeCreated>
    <MasterReference>Master Reference</MasterReference>
    <ParentPlacementAllocationID>6544443</ParentPlacementAllocationID>
    <PlacementAllocationID>123456</PlacementAllocationID>
  </IPOBlockAllocationResult>
</ArrayOfIPOBlockAllocationResult>

application/json, text/json

Sample:

[
  {
    "BlockAllocation": {
      "ClientID": 111111,
      "Quantity": 100,
      "Price": 19.04,
      "TradeValue": 234.56,
      "NetAmount": 123.45,
      "CustomBrokerageFee": 0.0,
      "GSTValue": 12.34,
      "AllocationReference": "AR123",
      "NotesForClient": "Order Allocation 1",
      "OtherFees": 10.0
    },
    "Errors": [
      "Invalid Client ID"
    ]
  },
  {
    "BlockAllocation": {
      "ClientID": 12355,
      "Quantity": 100,
      "Price": 12.0,
      "TradeValue": 1200.0,
      "NetAmount": 0.0,
      "CustomBrokerageFee": 0.0,
      "GSTValue": 0.0,
      "AllocationReference": "Allocation Reference",
      "NotesForClient": "Notes",
      "OtherFees": 0.0
    },
    "Errors": [
      "Invalid Registration Type"
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfIPOBlockAllocationErrorResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Order">
  <IPOBlockAllocationErrorResult>
    <BlockAllocation xmlns:d3p1="http://schemas.datacontract.org/2004/07/TPP.Contracts.Services.Order">
      <d3p1:AllocationReference>AR123</d3p1:AllocationReference>
      <d3p1:ClientID>111111</d3p1:ClientID>
      <d3p1:CustomBrokerageFee>0</d3p1:CustomBrokerageFee>
      <d3p1:GSTValue>12.34</d3p1:GSTValue>
      <d3p1:NetAmount>123.45</d3p1:NetAmount>
      <d3p1:NotesForClient>Order Allocation 1</d3p1:NotesForClient>
      <d3p1:OtherFees>10.0</d3p1:OtherFees>
      <d3p1:Price>19.04</d3p1:Price>
      <d3p1:Quantity>100</d3p1:Quantity>
      <d3p1:TradeValue>234.56</d3p1:TradeValue>
    </BlockAllocation>
    <Errors xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>Invalid Client ID</d3p1:string>
    </Errors>
  </IPOBlockAllocationErrorResult>
  <IPOBlockAllocationErrorResult>
    <BlockAllocation xmlns:d3p1="http://schemas.datacontract.org/2004/07/TPP.Contracts.Services.Order">
      <d3p1:AllocationReference>Allocation Reference</d3p1:AllocationReference>
      <d3p1:ClientID>12355</d3p1:ClientID>
      <d3p1:CustomBrokerageFee>0</d3p1:CustomBrokerageFee>
      <d3p1:GSTValue>0</d3p1:GSTValue>
      <d3p1:NetAmount>0</d3p1:NetAmount>
      <d3p1:NotesForClient>Notes</d3p1:NotesForClient>
      <d3p1:OtherFees>0</d3p1:OtherFees>
      <d3p1:Price>12</d3p1:Price>
      <d3p1:Quantity>100</d3p1:Quantity>
      <d3p1:TradeValue>1200</d3p1:TradeValue>
    </BlockAllocation>
    <Errors xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>Invalid Registration Type</d3p1:string>
    </Errors>
  </IPOBlockAllocationErrorResult>
</ArrayOfIPOBlockAllocationErrorResult>

Error Response Information

Resource Description

List of OrderAllocationResult if successful otherwise returns list of OrderAllocationErrorResult 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>