POST api/orders/ipo/cancel-allocation

Cancel IPO allocation

Request Information

URI Parameters

None.

Body Parameters

IPO Cancel Allocation details

Name	Description	Type	Additional information
PlacementAllocationID	Placement Allocation ID	integer	Required
Notes	Cancellation notes	string	None.

Request Formats

application/json, text/json

Sample:

{
  "PlacementAllocationID": 100267,
  "Notes": "Cancel Placement Allocation"
}

application/xml, text/xml

Sample:

<IPOCancelAllocation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Order">
  <Notes>Cancel Placement Allocation</Notes>
  <PlacementAllocationID>100267</PlacementAllocationID>
</IPOCancelAllocation>

Response Information

Resource Description

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

IPOCancelAllocationResult

Name	Description	Type	Additional information
PlacementAllocationID	Placement Allocation ID	integer	Required

IPOCancelAllocationErrorResult

Name	Description	Type	Additional information
PlacementAllocationID	Placement Allocation ID	integer	Required
Errors		Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "PlacementAllocationID": 100267
}

application/xml, text/xml

Sample:

<IPOCancelAllocationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Order">
  <PlacementAllocationID>100267</PlacementAllocationID>
</IPOCancelAllocationResult>

application/json, text/json

Sample:

{
  "PlacementAllocationID": 100267,
  "Errors": [
    "Invalid ID"
  ]
}

application/xml, text/xml

Sample:

<IPOCancelAllocationErrorResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Order">
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>Invalid ID</d2p1:string>
  </Errors>
  <PlacementAllocationID>100267</PlacementAllocationID>
</IPOCancelAllocationErrorResult>

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>