POST api/v1/bid/{id}/cancel

Cancel the Bid

Requires authorization!

Requires scope BidsEdit

Response Codes

  • 202 - Successfully accepted the cancellation request for the Bid
  • 400 - No Bid id specified
  • 401 - User is not Authorized
  • 403 - The user has no rights to cancel the Bid
  • 404 - Bid with specified ID is not found
  • 409 - Can not cancel Bid.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Bid identificator

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Cancel the Bid
Success as true if Bid was found and successfully canceled, false otherwise

ApiResult
NameDescriptionTypeAdditional information
Success

Indicates if the request was successfull or not. true if the request was handled successfully, false otherwise.

boolean

Required

Errors

Error(s) accociated with the API request.

Collection of ApiError

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Errors": [
    {
      "Code": 1,
      "Message": "sample string-2",
      "Details": "sample string-3"
    },
    {
      "Code": 1,
      "Message": "sample string-2",
      "Details": "sample string-3"
    }
  ]
}

application/xml, text/xml

Sample:
<ApiResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Sobralaen.Api.Models">
  <Errors>
    <ApiError>
      <Code>1</Code>
      <Details>sample string-3</Details>
      <Message>sample string-2</Message>
    </ApiError>
    <ApiError>
      <Code>1</Code>
      <Details>sample string-3</Details>
      <Message>sample string-2</Message>
    </ApiError>
  </Errors>
  <Success>true</Success>
</ApiResult>