GET api/v1/bids

Gets list of bids the investor has made.

Requires authorization!

Requires scope BidsRead

Response Codes

200 – Successfully got list of user's bids
401 – User is not Authorized

Request Information

URI Parameters

Name	Description	Type	Additional information
BidStatusCode	Bid status code	ApiAuctionBidRequestStatus	None.
StartDate	Start date	date	None.
EndDate	End date	date	None.
PageSize	Max items in result, up to 20000	integer	Range: inclusive between 1 and 20000
PageNr	Result page nr	integer	Range: inclusive between 1 and 2147483647

Body Parameters

None.

Response Information

Resource Description

Gets list of bids the investor has made.

ApiResultBids

Name	Description	Type	Additional information
PageSize	Requested Max items in result	integer	Range: inclusive between 0 and 2147483647
PageNr	Requested page nr	integer	Range: inclusive between 1 and 2147483647
TotalCount	Total number of items found	integer	Required Range: inclusive between 0 and 2147483647
Count	Number of items returned	integer	Required Range: inclusive between 0 and 2147483647
Payload	The payload of the response. Type depends on the API request.	Collection of 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:

{
  "PageSize": 1,
  "PageNr": 2,
  "TotalCount": 3,
  "Count": 4,
  "Payload": [
    {
      "Id": "1886ab75-c491-4023-94f7-8e54e9f0f00c",
      "AuctionId": "a5e3c841-5a46-4219-9963-c190f8ec1c86",
      "RequestedBidAmount": 3.0,
      "ActualBidAmount": 1.0,
      "RequestedBidMinimumLimit": 1.0,
      "BidRequestedDate": "2024-04-18T15:00:51.4651433+03:00",
      "BidProcessedDate": "2024-04-18T15:00:51.4651433+03:00",
      "IsRequestBeingProcessed": true,
      "StatusCode": 0,
      "FailureReason": 0
    },
    {
      "Id": "1886ab75-c491-4023-94f7-8e54e9f0f00c",
      "AuctionId": "a5e3c841-5a46-4219-9963-c190f8ec1c86",
      "RequestedBidAmount": 3.0,
      "ActualBidAmount": 1.0,
      "RequestedBidMinimumLimit": 1.0,
      "BidRequestedDate": "2024-04-18T15:00:51.4651433+03:00",
      "BidProcessedDate": "2024-04-18T15:00:51.4651433+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:

<ApiResultBids 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>
    <BidSummary>
      <ActualBidAmount>1</ActualBidAmount>
      <AuctionId>a5e3c841-5a46-4219-9963-c190f8ec1c86</AuctionId>
      <BidProcessedDate>2024-04-18T15:00:51.4651433+03:00</BidProcessedDate>
      <BidRequestedDate>2024-04-18T15:00:51.4651433+03:00</BidRequestedDate>
      <FailureReason>NotSet</FailureReason>
      <Id>1886ab75-c491-4023-94f7-8e54e9f0f00c</Id>
      <IsRequestBeingProcessed>true</IsRequestBeingProcessed>
      <RequestedBidAmount>3</RequestedBidAmount>
      <RequestedBidMinimumLimit>1</RequestedBidMinimumLimit>
      <StatusCode>Pending</StatusCode>
    </BidSummary>
    <BidSummary>
      <ActualBidAmount>1</ActualBidAmount>
      <AuctionId>a5e3c841-5a46-4219-9963-c190f8ec1c86</AuctionId>
      <BidProcessedDate>2024-04-18T15:00:51.4651433+03:00</BidProcessedDate>
      <BidRequestedDate>2024-04-18T15:00:51.4651433+03:00</BidRequestedDate>
      <FailureReason>NotSet</FailureReason>
      <Id>1886ab75-c491-4023-94f7-8e54e9f0f00c</Id>
      <IsRequestBeingProcessed>true</IsRequestBeingProcessed>
      <RequestedBidAmount>3</RequestedBidAmount>
      <RequestedBidMinimumLimit>1</RequestedBidMinimumLimit>
      <StatusCode>Pending</StatusCode>
    </BidSummary>
  </Payload>
  <Count>4</Count>
  <PageNr>2</PageNr>
  <PageSize>1</PageSize>
  <TotalCount>3</TotalCount>
</ApiResultBids>