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 bids401
– 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.
ApiResultBidsName | 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.
|
boolean |
Required |
Errors |
Error(s) accociated with the API request. |
Collection of ApiError |
None. |
Response Formats
application/json, text/json
{ "PageSize": 1, "PageNr": 2, "TotalCount": 3, "Count": 4, "Payload": [ { "Id": "01b8ca89-e22e-480c-9aa6-688560145d2c", "AuctionId": "c66b75a4-ad9c-4594-9fb4-c695e9cdefbb", "RequestedBidAmount": 3.0, "ActualBidAmount": 1.0, "RequestedBidMinimumLimit": 1.0, "BidRequestedDate": "2024-10-31T15:35:53.4813309+02:00", "BidProcessedDate": "2024-10-31T15:35:53.4813309+02:00", "IsRequestBeingProcessed": true, "StatusCode": 0, "FailureReason": 0 }, { "Id": "01b8ca89-e22e-480c-9aa6-688560145d2c", "AuctionId": "c66b75a4-ad9c-4594-9fb4-c695e9cdefbb", "RequestedBidAmount": 3.0, "ActualBidAmount": 1.0, "RequestedBidMinimumLimit": 1.0, "BidRequestedDate": "2024-10-31T15:35:53.4813309+02:00", "BidProcessedDate": "2024-10-31T15:35:53.4813309+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
<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>c66b75a4-ad9c-4594-9fb4-c695e9cdefbb</AuctionId> <BidProcessedDate>2024-10-31T15:35:53.4813309+02:00</BidProcessedDate> <BidRequestedDate>2024-10-31T15:35:53.4813309+02:00</BidRequestedDate> <FailureReason>NotSet</FailureReason> <Id>01b8ca89-e22e-480c-9aa6-688560145d2c</Id> <IsRequestBeingProcessed>true</IsRequestBeingProcessed> <RequestedBidAmount>3</RequestedBidAmount> <RequestedBidMinimumLimit>1</RequestedBidMinimumLimit> <StatusCode>Pending</StatusCode> </BidSummary> <BidSummary> <ActualBidAmount>1</ActualBidAmount> <AuctionId>c66b75a4-ad9c-4594-9fb4-c695e9cdefbb</AuctionId> <BidProcessedDate>2024-10-31T15:35:53.4813309+02:00</BidProcessedDate> <BidRequestedDate>2024-10-31T15:35:53.4813309+02:00</BidRequestedDate> <FailureReason>NotSet</FailureReason> <Id>01b8ca89-e22e-480c-9aa6-688560145d2c</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>