POST api/role/auction/{id}/removefromauction

Add a property auction role to an existing auction Processes this auction role API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

the id of the role

integer

Required

Body Parameters

The remove from auction data contract supplied with the request.

RemoveFromAuctionDataContract
NameDescriptionTypeAdditional information
AuctionId

The unique identifier of the related auction resource.

integer

None.

Status

The status value.

EnumDataContract

None.

ConvertToSalesRole

Indicates whether convert to sales role is true.

boolean

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:
{
  "AuctionId": 1,
  "Status": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "ConvertToSalesRole": true
}

Response Information

Resource Description

The response returned after the operation completes.

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

The version value.

Version

None.

Content

The content value.

HttpContent

None.

StatusCode

The status code classification.

HttpStatusCode

None.

ReasonPhrase

The reason phrase value.

string

None.

Headers

The collection of headers.

Collection of Object

None.

RequestMessage

The request message value.

HttpRequestMessage

None.

IsSuccessStatusCode

Indicates whether this item is success status code.

boolean

None.