POST api/orders/allocation/cancellation

Procces Institutional block trade cancellation from Omgeo

Request Information

URI Parameters

None.

Body Parameters

Order Client AllocationID and Cancellation Notes

InstitutionalAllocationCancellationRequest

Name	Description	Type	Additional information
OrderClientAllocationID	Omgeo block SourceID	integer	Required
Notes	Cancellation Notes	string	Required

Request Formats

application/json, text/json

Sample:

{
  "OrderClientAllocationID": 1111,
  "Notes": "Reason for cancellation"
}

application/xml, text/xml

Sample:

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

Response Information

Resource Description

List of InstitutionalAllocationCancellationResult

InstitutionalAllocationCancellationResult

Name	Description	Type	Additional information
OrderClientAllocationID	Omgeo block SourceID	integer	None.
AllocationCancellationDetails	Allocation Cancellation Result	Collection of InstitutionalAllocationCancellationDetail	None.

Response Formats

application/json, text/json

Sample:

{
  "OrderClientAllocationID": 1234,
  "AllocationCancellationDetails": [
    {
      "AllocationReference": "allocationRef1",
      "OrderClientAllocationID": 13363,
      "OrderID": 1212,
      "ContractNoteID": 4545,
      "CancelContractTaskID": 66,
      "CancelledContractNoteID": 4547,
      "Error": "error1"
    },
    {
      "AllocationReference": "allocationRef2",
      "OrderClientAllocationID": 13364,
      "OrderID": 1213,
      "ContractNoteID": 4546,
      "CancelContractTaskID": 67,
      "CancelledContractNoteID": 4548,
      "Error": "error2"
    }
  ]
}

application/xml, text/xml

Sample:

<InstitutionalAllocationCancellationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Order">
  <AllocationCancellationDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/TPP.Contracts.Services.Order">
    <d2p1:InstitutionalAllocationCancellationDetail>
      <d2p1:AllocationReference>allocationRef1</d2p1:AllocationReference>
      <d2p1:CancelContractTaskID>66</d2p1:CancelContractTaskID>
      <d2p1:CancelledContractNoteID>4547</d2p1:CancelledContractNoteID>
      <d2p1:ContractNoteID>4545</d2p1:ContractNoteID>
      <d2p1:Error>error1</d2p1:Error>
      <d2p1:OrderClientAllocationID>13363</d2p1:OrderClientAllocationID>
      <d2p1:OrderID>1212</d2p1:OrderID>
    </d2p1:InstitutionalAllocationCancellationDetail>
    <d2p1:InstitutionalAllocationCancellationDetail>
      <d2p1:AllocationReference>allocationRef2</d2p1:AllocationReference>
      <d2p1:CancelContractTaskID>67</d2p1:CancelContractTaskID>
      <d2p1:CancelledContractNoteID>4548</d2p1:CancelledContractNoteID>
      <d2p1:ContractNoteID>4546</d2p1:ContractNoteID>
      <d2p1:Error>error2</d2p1:Error>
      <d2p1:OrderClientAllocationID>13364</d2p1:OrderClientAllocationID>
      <d2p1:OrderID>1213</d2p1:OrderID>
    </d2p1:InstitutionalAllocationCancellationDetail>
  </AllocationCancellationDetails>
  <OrderClientAllocationID>1234</OrderClientAllocationID>
</InstitutionalAllocationCancellationResult>

Error Response Information

Resource Description

List of InstitutionalAllocationCancellationResult

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>