POST api/orders/cancellations
Create cancellation instructions for multiple orders.
Request Information
URI Parameters
None.
Body Parameters
List of cancellation instructions.
Collection of CancellationCreationName | Description | Type | Additional information |
---|---|---|---|
OrderID |
Order ID that this amendment is for. |
integer |
Required |
CreatorID |
The person ID whom this amendment is for. Required if you are submitting this instruction on behalf of a person. |
integer |
None. |
PIN |
User PIN. Use this if PIN validation is required. |
string |
None. |
Request Formats
application/json, text/json
Sample:
[ { "OrderID": 12345, "CreatorID": 98765, "PIN": "1234" }, { "OrderID": 54321, "CreatorID": 98765, "PIN": "1111" } ]
application/xml, text/xml
Sample:
<ArrayOfCancellationCreation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.Contracts.Services.Order"> <CancellationCreation> <CreatorID>98765</CreatorID> <OrderID>12345</OrderID> <PIN>1234</PIN> </CancellationCreation> <CancellationCreation> <CreatorID>98765</CreatorID> <OrderID>54321</OrderID> <PIN>1111</PIN> </CancellationCreation> </ArrayOfCancellationCreation>
Response Information
Resource Description
List of cancellation creation results.
Collection of CancellationCreationResultName | Description | Type | Additional information |
---|---|---|---|
OrderID |
Order ID the cancellation instruction was for. |
integer |
None. |
Success |
Status of the cancellation. |
boolean |
None. |
Errors |
List of errors if the cancellation failed. |
Collection of string |
None. |
Response Formats
application/json, text/json
Sample:
[ { "OrderID": 1234, "Success": true, "Errors": null }, { "OrderID": 2200, "Success": false, "Errors": [ "Order is not active." ] } ]
application/xml, text/xml
Sample:
<ArrayOfCancellationCreationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.Contracts.Services.Order"> <CancellationCreationResult> <Errors xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" /> <OrderID>1234</OrderID> <Success>true</Success> </CancellationCreationResult> <CancellationCreationResult> <Errors xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>Order is not active.</d3p1:string> </Errors> <OrderID>2200</OrderID> <Success>false</Success> </CancellationCreationResult> </ArrayOfCancellationCreationResult>
Error Response Information
Resource Description
List of cancellation creation results.
stringError 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>