POST api/orders/cancellation/active

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 cancellation is for.	integer	Required
CreatorID	The person ID whom this cancellation is for. Required if you are submitting this instruction on behalf of a person.	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "OrderID": 1,
  "CreatorID": 1
}

application/xml, text/xml

Sample:

<CancellationActiveCreation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Order">
  <CreatorID>1</CreatorID>
  <OrderID>1</OrderID>
</CancellationActiveCreation>

Response Information

Resource Description

Cancellation creation result.

CancellationActiveCreationResult

Name	Description	Type	Additional information
OrderCancellationID	Order cancellation ID of cancellation instruction was for.	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "OrderCancellationID": 1
}

application/xml, text/xml

Sample:

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

Error Response Information

Resource Description

Cancellation creation result.

Collection of string

Error Response Formats

application/json, text/json

Sample:

[
  "sample string 1",
  "sample string 2"
]

application/xml, text/xml

Sample:

<ArrayOfstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <string>sample string 1</string>
  <string>sample string 2</string>
</ArrayOfstring>