API

RamBase REST APIs

GET auction/auctions/{auctionId}

Auction details for the provided identifier

HTTP method GET
URI https://api.rambase.net/auction/auctions/{auctionId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {auctionId} Auction identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 414, version 11

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.

Format:
1
1

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.
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable 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.

Format:
1
<Auction>
2
     <AuctionId
AuctionId

Auction identifier

>{Integer}</AuctionId>
3
     <Status
Status

Status of auction

Possible domain values can be found here

>{Integer}</Status>
4
     <Type
Type

Type of auction

Possible domain values can be found here

>{String}</Type>
5
     <Title
Title

Title of auction

>{String}</Title>
6
     <TranslatedTitle
TranslatedTitle

Title of auction

This field is greyed out because it is an expandable field. You have to add $expand=TranslatedTitle in your request URI to get this field

>{String}</TranslatedTitle>
7
     <Description
Description

Description of auction

>{String}</Description>
8
     <TranslatedDescription
TranslatedDescription

Description of auction

This field is greyed out because it is an expandable field. You have to add $expand=TranslatedDescription in your request URI to get this field

>{String}</TranslatedDescription>
9
     <IsAvailableExternal
IsAvailableExternal

Tells whether the auciton is visible public (ex. online) or not.

>{Boolean}</IsAvailableExternal>
10
     <PodiumAuction
PodiumAuction

This field is greyed out because it is an expandable field. You have to add $expand=PodiumAuction in your request URI to get this field

>
11
          <ScheduledStartAt
ScheduledStartAt

Scheduled start of podium auction

This field is greyed out because it is an expandable field. You have to add $expand=PodiumAuction in your request URI to get this field

>{Datetime}</ScheduledStartAt>
12
          <Auctioneer
Auctioneer

The auctioneer of the podium auction

This field is greyed out because it is an expandable field. You have to add $expand=PodiumAuction in your request URI to get this field

>
13
               <EmpoyeeId
EmpoyeeId

Employee identifier

This field is greyed out because it is an expandable field. You have to add $expand=PodiumAuction in your request URI to get this field

>{Integer}</EmpoyeeId>
14
               <EmployeeLink
EmployeeLink

Employee reference

This field is greyed out because it is an expandable field. You have to add $expand=PodiumAuction in your request URI to get this field

>{String}</EmployeeLink>
15
          </Auctioneer>
16
          <CurrentLot
CurrentLot

The current lot shown by the auctioneer

This field is greyed out because it is an expandable field. You have to add $expand=PodiumAuction in your request URI to get this field

>
17
               <LotId
LotId

Lot identifier

This field is greyed out because it is an expandable field. You have to add $expand=PodiumAuction in your request URI to get this field

>{Integer}</LotId>
18
               <LotNumber
LotNumber

Lot number in auction catalog

This field is greyed out because it is an expandable field. You have to add $expand=PodiumAuction in your request URI to get this field

>{Integer}</LotNumber>
19
               <LotLink
LotLink

Lot reference

This field is greyed out because it is an expandable field. You have to add $expand=PodiumAuction in your request URI to get this field

>{String}</LotLink>
20
          </CurrentLot>
21
     </PodiumAuction>
22
</Auction>
1
{
2
     "auction": {
3
          "auctionId
AuctionId

Auction identifier

": "{Integer}",
4
          "status
Status

Status of auction

Possible domain values can be found here

": "{Integer}",
5
          "type
Type

Type of auction

Possible domain values can be found here

": "{String}",
6
          "title
Title

Title of auction

": "{String}",
7
          "translatedTitle
TranslatedTitle

Title of auction

This field is greyed out because it is an expandable field. You have to add $expand=TranslatedTitle in your request URI to get this field

": "{String}",
8
          "description
Description

Description of auction

": "{String}",
9
          "translatedDescription
TranslatedDescription

Description of auction

This field is greyed out because it is an expandable field. You have to add $expand=TranslatedDescription in your request URI to get this field

": "{String}",
10
          "isAvailableExternal
IsAvailableExternal

Tells whether the auciton is visible public (ex. online) or not.

": "{Boolean}",
11
          "podiumAuction
PodiumAuction

This field is greyed out because it is an expandable field. You have to add $expand=PodiumAuction in your request URI to get this field

": {
12
               "scheduledStartAt
ScheduledStartAt

Scheduled start of podium auction

This field is greyed out because it is an expandable field. You have to add $expand=PodiumAuction in your request URI to get this field

": "{Datetime}",
13
               "auctioneer
Auctioneer

The auctioneer of the podium auction

This field is greyed out because it is an expandable field. You have to add $expand=PodiumAuction in your request URI to get this field

": {
14
                    "empoyeeId
EmpoyeeId

Employee identifier

This field is greyed out because it is an expandable field. You have to add $expand=PodiumAuction in your request URI to get this field

": "{Integer}",
15
                    "employeeLink
EmployeeLink

Employee reference

This field is greyed out because it is an expandable field. You have to add $expand=PodiumAuction in your request URI to get this field

": "{String}"
16
               },
17
               "currentLot
CurrentLot

The current lot shown by the auctioneer

This field is greyed out because it is an expandable field. You have to add $expand=PodiumAuction in your request URI to get this field

": {
18
                    "lotId
LotId

Lot identifier

This field is greyed out because it is an expandable field. You have to add $expand=PodiumAuction in your request URI to get this field

": "{Integer}",
19
                    "lotNumber
LotNumber

Lot number in auction catalog

This field is greyed out because it is an expandable field. You have to add $expand=PodiumAuction in your request URI to get this field

": "{Integer}",
20
                    "lotLink
LotLink

Lot reference

This field is greyed out because it is an expandable field. You have to add $expand=PodiumAuction in your request URI to get this field

": "{String}"
21
               }
22
          }
23
     }
24
}

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 100567 HTTP 400 The company does not have the module {0}
Error 101420 HTTP 404 Setting definition not found
Error 101087 HTTP 400 Description argument/result mismatch