GET api/v1/bid/{id}

Get the Bid

Requires authorization!

Requires scope BidsRead

Response Codes

  • 200 - Successfully fetched the Bid
  • 400 - No Bid id specified
  • 401 - User is not Authorized
  • 403 - Not allowed to get the Bid, because the bid is not owned by current user
  • 404 - Bid with specified ID is not found

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Bid identificator

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Get the Bid
Bid if it was found, null otherwise

ApiResultBid
NameDescriptionTypeAdditional information
Payload

The payload of the response. Type depends on the API request.

BidSummary

None.

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:
{
  "Payload": {
    "Id": "af77a539-8638-46d7-8cbf-a0aa602fd531",
    "AuctionId": "cc97dd9b-0962-47c3-a086-54ad3c24f1f5",
    "RequestedBidAmount": 3.0,
    "ActualBidAmount": 1.0,
    "RequestedBidMinimumLimit": 1.0,
    "BidRequestedDate": "2018-12-11T17:02:28.6272597+02:00",
    "BidProcessedDate": "2018-12-11T17:02:28.6272597+02:00",
    "IsRequestBeingProcessed": true,
    "StatusCode": 0,
    "FailureReason": 0
  },
  "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:
<ApiResultBid 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>
  <Payload>
    <ActualBidAmount>1</ActualBidAmount>
    <AuctionId>cc97dd9b-0962-47c3-a086-54ad3c24f1f5</AuctionId>
    <BidProcessedDate>2018-12-11T17:02:28.6272597+02:00</BidProcessedDate>
    <BidRequestedDate>2018-12-11T17:02:28.6272597+02:00</BidRequestedDate>
    <FailureReason>NotSet</FailureReason>
    <Id>af77a539-8638-46d7-8cbf-a0aa602fd531</Id>
    <IsRequestBeingProcessed>true</IsRequestBeingProcessed>
    <RequestedBidAmount>3</RequestedBidAmount>
    <RequestedBidMinimumLimit>1</RequestedBidMinimumLimit>
    <StatusCode>Pending</StatusCode>
  </Payload>
</ApiResultBid>