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

Name	Description	Type	Additional 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

Name	Description	Type	Additional 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": "216b081b-6704-48d2-a7c3-32989bbbfb1c",
    "AuctionId": "9d3c07b4-a31c-4995-b974-5d14f851d549",
    "RequestedBidAmount": 3.0,
    "ActualBidAmount": 1.0,
    "RequestedBidMinimumLimit": 1.0,
    "BidRequestedDate": "2023-06-02T14:00:53.0754958+03:00",
    "BidProcessedDate": "2023-06-02T14:00:53.0754958+03: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>9d3c07b4-a31c-4995-b974-5d14f851d549</AuctionId>
    <BidProcessedDate>2023-06-02T14:00:53.0754958+03:00</BidProcessedDate>
    <BidRequestedDate>2023-06-02T14:00:53.0754958+03:00</BidRequestedDate>
    <FailureReason>NotSet</FailureReason>
    <Id>216b081b-6704-48d2-a7c3-32989bbbfb1c</Id>
    <IsRequestBeingProcessed>true</IsRequestBeingProcessed>
    <RequestedBidAmount>3</RequestedBidAmount>
    <RequestedBidMinimumLimit>1</RequestedBidMinimumLimit>
    <StatusCode>Pending</StatusCode>
  </Payload>
</ApiResultBid>