POST api/orders/allocation/cancellation/v2

Process Institutional block trade cancellation V2 from Omgeo

Request Information

URI Parameters

None.

Body Parameters

Master Allocation ID and Cancellation Notes

InstitutionalAllocationCancellationRequestV2
NameDescriptionTypeAdditional information
MasterAllocationID

Master Allocation ID

integer

Required
CancellationNotes

Cancellation Notes

string

Required

String length: inclusive between 0 and 255

Request Formats

application/json, text/json

Sample: 
{
  "MasterAllocationID": 1111,
  "CancellationNotes": "Reason for cancellation"
}

application/xml, text/xml

Sample: 
<InstitutionalAllocationCancellationRequestV2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.Contracts.Services.Order">
  <CancellationNotes>Reason for cancellation</CancellationNotes>
  <MasterAllocationID>1111</MasterAllocationID>
</InstitutionalAllocationCancellationRequestV2>

Response Information

Resource Description

List of InstitutionalAllocationCancellationResultV2

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

List of InstitutionalAllocationCancellationResultV2

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>