POST api/AuctionReferral
Adds a job to the queue to manually refer to auction provider Processes this auction referral API request. The parameter and response sections describe the data exchanged with the API.
Request Information
URI Parameters
None.
Body Parameters
The auction referral command data contract supplied with the request.
AuctionReferralCommandDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| SaleRoleIds |
The unique identifiers of the related sale role resources. |
Collection of integer |
None. |
Request Formats
application/x-www-form-urlencoded
Sample:
Sample not available.
application/json, text/json
Sample:
{
"SaleRoleIds": [
1,
2
]
}
Response Information
Resource Description
The response returned after the operation completes.
JobStatusDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| JobReference |
The job reference globally unique identifier. |
globally unique identifier |
None. |
| JobStatus |
The job status classification. |
JobStatus |
None. |
| JobPercentageCompleted |
The job percentage completed value. |
integer |
None. |
| JobStatusText |
The job status text value. |
string |
None. |
| UsageToken |
The usage token globally unique identifier. |
globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
{
"JobReference": "3f35fc6f-e2ee-4d6e-9253-c6804b482142",
"JobStatus": 0,
"JobPercentageCompleted": 2,
"JobStatusText": "sample string 3",
"UsageToken": "e4595b0c-2830-4ee8-a4d3-c1312c3aab7a"
}