POST api/Auction/CancelAuction?authToken={authToken}&auctionId={auctionId}
Cancel the Auction
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| authToken |
The Authentication Token |
string |
Required |
| auctionId |
The Auction Id |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
ServiceResult| Name | Description | Type | Additional information |
|---|---|---|---|
| ErrorCode | ServiceErrorCode |
None. |
|
| ErrorMessage | Collection of string |
None. |
|
| Success | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{
"ErrorCode": 0,
"ErrorMessage": [
"sample string 1",
"sample string 2"
],
"Success": true
}
application/xml, text/xml
Sample:
<ServiceResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOP.Common.Infrastructure.ApiObjects.Results">
<ErrorCode>None</ErrorCode>
<ErrorMessage xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</ErrorMessage>
<Success>true</Success>
</ServiceResult>