Auction APIs
Details for auction the provided supplier is participating in
| HTTP method | GET |
| URI | https://api.rambase.net/procurement/suppliers/{supplierId}/auctions/{auctionId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {supplierId} |
RamBase supplier identifier
Integer, minimum 100 |
| - URI parameter {auctionId} |
Lot identifier
Integer, minimum 100000 |
| Successful HTTP status code | 200 |
| API resource identifier | 2855, version 3 |
The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.
The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.
| $showDomainDescriptions Boolean, optional | Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false. |
| $lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
| $access_token String, optional | After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time. |
| $db String, optional | Set the database/company for the request |
| $format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
| $useMinimumVersion Integer, optional | Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information. |
| $select String, optional | Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information. |
Read more about filters and sorting on how to use filter parameters and named filters.
Read more about filters and sorting on how to use sortable parameters
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
AuctionId
Auction identifier
>{Integer}</AuctionId>Title
Title of auction
>{String}</Title>Description
Description of auction
>{String}</Description>AuctionLink
Auction reference
>{String}</AuctionLink>Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
>{String}</Currency>NumberOfLots
Total number of lots the provided supplier is selling in this auction
>{Integer}</NumberOfLots>SumOfCurrentBidPrice
Sum of curent bid prices for all lots the provided supplier is selling in this auction
>{Decimal}</SumOfCurrentBidPrice>SumOfStartingBidPrice
Sum of starting bid prices for all lots the provided supplier is selling in this auction
>{Decimal}</SumOfStartingBidPrice>SumOfEstimatedPrice
Sum of all lots estimated prices for provided supplier in this auction
>{Decimal}</SumOfEstimatedPrice>LotStatus
Status of lot.
1: Draft,
2: Prepared for auction, but not scheduled,
3: Scheduled for auction,
4: Available for bidding,
5: Sold,
6: Not sold, needs attention,
7: Sold and confirmed,
9: Completed. Either sold and paid, returned to supplier or moved to a different auction
Possible domain values can be found here
>{Integer}</LotStatus>Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
>{String}</Currency>NumberOfLots
Total number of lots the provided supplier is selling in this auction
>{Integer}</NumberOfLots>SumOfCurrentBidPrice
Sum of curent bid prices for all lots the provided supplier is selling in this auction
>{Decimal}</SumOfCurrentBidPrice>SumOfStartingBidPrice
Sum of starting bid prices for all lots the provided supplier is selling in this auction
>{Decimal}</SumOfStartingBidPrice>SumOfEstimatedPrice
Sum of all lots estimated prices for provided supplier in this auction
>{Decimal}</SumOfEstimatedPrice>AuctionId
Auction identifier
": "{Integer}",Status
Status of auction
Possible domain values can be found here
": "{Integer}",Type
Type of auction
Possible domain values can be found here
": "{String}",Title
Title of auction
": "{String}",Description
Description of auction
": "{String}",AuctionLink
Auction reference
": "{String}"Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
": "{String}",NumberOfLots
Total number of lots the provided supplier is selling in this auction
": "{Integer}",SumOfCurrentBidPrice
Sum of curent bid prices for all lots the provided supplier is selling in this auction
": "{Decimal}",SumOfStartingBidPrice
Sum of starting bid prices for all lots the provided supplier is selling in this auction
": "{Decimal}",SumOfEstimatedPrice
Sum of all lots estimated prices for provided supplier in this auction
": "{Decimal}"LotStatus
Status of lot.
1: Draft,
2: Prepared for auction, but not scheduled,
3: Scheduled for auction,
4: Available for bidding,
5: Sold,
6: Not sold, needs attention,
7: Sold and confirmed,
9: Completed. Either sold and paid, returned to supplier or moved to a different auction
Possible domain values can be found here
": "{Integer}",Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
": "{String}",NumberOfLots
Total number of lots the provided supplier is selling in this auction
": "{Integer}",SumOfCurrentBidPrice
Sum of curent bid prices for all lots the provided supplier is selling in this auction
": "{Decimal}",SumOfStartingBidPrice
Sum of starting bid prices for all lots the provided supplier is selling in this auction
": "{Decimal}",SumOfEstimatedPrice
Sum of all lots estimated prices for provided supplier in this auction
": "{Decimal}"
List of available operations/actions for this resource.
See the operations documentation for more information about API operations.
Possible error codes the response might return:
| Error 100209 HTTP 400 | Illegal document Id {0} |
| Error 101086 HTTP 400 | Missing required argument {0} for description |
| Error 101087 HTTP 400 | Description argument/result mismatch |