POST api/orders/cancellation

Create a cancellation instruction for an order.

Request Information

URI Parameters

None.

Body Parameters

Cancellation creation object.

Name	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"
}

application/xml, text/xml

Sample:

<CancellationCreation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.Contracts.Services.Order">
  <CreatorID>98765</CreatorID>
  <OrderID>12345</OrderID>
  <PIN>1234</PIN>
</CancellationCreation>

Response Information

Resource Description

Cancellation creation result.

CancellationCreationResult

Name	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
}

application/xml, text/xml

Sample:

<CancellationCreationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.Contracts.Services.Order">
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <OrderID>1234</OrderID>
  <Success>true</Success>
</CancellationCreationResult>

Error Response Information

Resource Description

Cancellation creation result.

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>