Rental APIs
This report will list all rental units currently available for allocation, showing their product details, location, and availability status.
| Report name | Available Rental Units |
| Report identifier | 117393 |
| HTTP method | GET |
| URI | https://api.rambase.net/system/reports/117393/result-set?productName={productName}&availableFromDate={availableFromDate} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Maximum page size ($top) | 80 |
| Successful HTTP status code | 200 |
| API resource identifier | 6921, version 4 |
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.
| productName String, optional | Name of the product |
| availableFromDate Date, optional | Date from which the rental unit is available |
| $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 |
| $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. |
| $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. |
| $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. |
| $format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
| $top String, optional | Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10. |
| $pageKey String, optional | Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response. |
| $filter String, optional | Use to filter the result list, see the Filtering and sorting page for more information. |
| $orderby String, optional | Use to order the result list, see the Filtering and sorting page for more information. |
| $inlinecount String, optional | Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none" |
Read more about filters and sorting on how to use filter parameters and named filters.
| CurrentLocation String | Unique abbreviation/short name of the location. |
| CurrentLocationId Integer | Location identifier. |
| HomeLocation String | Unique abbreviation/short name of the location. |
| HomeLocationId Integer | Location identifier. |
| ProductCollectionId Integer | Product collection. |
| ProductCollectionName String | Name of the product. |
| ProductDescription String | Description of the product. |
| ProductId Integer | Product identifier. |
| ProductName String | Name of the product. |
| ProductUnitId Integer | Product unit assigned to rental unit. |
| RentalUnitId Integer | Rental unit identifier. |
| SerialNumber String | Serial number. |
| Status String | Status. |
Read more about filters and sorting on how to use sortable parameters
| CurrentLocation String | Unique abbreviation/short name of the location |
| CurrentLocationId Integer | Location identifier |
| HomeLocation String | Unique abbreviation/short name of the location |
| HomeLocationId Integer | Location identifier |
| ProductCollectionId Integer | Product collection |
| ProductCollectionName String | Name of the product |
| ProductDescription String | Description of the product |
| ProductId Integer | Product identifier |
| ProductName String | Name of the product |
| ProductUnitId Integer | Product unit assigned to rental unit |
| RentalUnitId Integer | Rental unit identifier |
| SerialNumber String | Serial number |
| Status String | Status |
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.
RentalUnit
Rental unit
>RentalUnitId
Rental unit identifier
>{Integer}</RentalUnitId>Description
Description of rental unit
>{String}</Description>AvailableFromDate
Date from which the rental unit is available
>{Date}</AvailableFromDate>EndOfLifeDate
Date to which the rental unit is available
>{Date}</EndOfLifeDate>BlockedForRental
Indicates if a rental unit is blocked for rental
>{Boolean}</BlockedForRental>RentalUnitLink
Rental unit reference
>{String}</RentalUnitLink>ProductCollection
Product collection
>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>ProductLink
Product reference
>{String}</ProductLink>Product
Product reference
>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>Description
Description of the product
>{String}</Description>ProductLink
Product reference
>{String}</ProductLink>SerialNumber
Serial number
>{String}</SerialNumber>ProductUnit
Product unit reference
>ProductUnitId
Product unit identifier
>{Integer}</ProductUnitId>ProductUnitLink
Product unit reference
>{String}</ProductUnitLink>CurrentLocation
Current location of rental unit
>LocationId
Location identifier
>{Integer}</LocationId>ShortName
Unique abbreviation/short name of the location
>{String}</ShortName>LocationLink
Location reference
>{String}</LocationLink>HomeLocation
Home location of rental unit
>LocationId
Location identifier
>{Integer}</LocationId>ShortName
Unique abbreviation/short name of the location
>{String}</ShortName>LocationLink
Location reference
>{String}</LocationLink>StockLocation
Stock location reference
>StockLocationId
Stock location identifier
>{Integer}</StockLocationId>Name
Name of current- and parent stock locations, including seperator for location
>{String}</Name>StockLocationLink
Stock location reference
>{String}</StockLocationLink>Total
The total price in company currency from the goods reception, or Balance from the fixed asset if the rental unit is tied to a fixed asset
>{Decimal}</Total>Paging
Detailed paging information for this list.
>PageSize
Number of elements in the list, as defined in $top. Default is 10.
>{Integer}</PageSize>Position
Position of the first element in the list
>{Integer}</Position>Page
Page index
>{Integer}</Page>FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
>{String}</FirstPage>PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
>{String}</PreviousPage>NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
>{String}</NextPage>LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
>{String}</LastPage>Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
>{Integer}</Size>Status
Status
Possible domain values can be found here
": "{String}",RentalUnit
Rental unit
": {RentalUnitId
Rental unit identifier
": "{Integer}",Description
Description of rental unit
": "{String}",AvailableFromDate
Date from which the rental unit is available
": "{Date}",EndOfLifeDate
Date to which the rental unit is available
": "{Date}",BlockedForRental
Indicates if a rental unit is blocked for rental
": "{Boolean}",RentalUnitLink
Rental unit reference
": "{String}"ProductCollection
Product collection
": {ProductId
Product identifier
": "{Integer}",Name
Name of the product
": "{String}",ProductLink
Product reference
": "{String}"Product
Product reference
": {ProductId
Product identifier
": "{Integer}",Name
Name of the product
": "{String}",Description
Description of the product
": "{String}",Type
Type of product
Possible domain values can be found here
": "{String}",ProductLink
Product reference
": "{String}"SerialNumber
Serial number
": "{String}",ProductUnit
Product unit reference
": {ProductUnitId
Product unit identifier
": "{Integer}",ProductUnitLink
Product unit reference
": "{String}"CurrentLocation
Current location of rental unit
": {LocationId
Location identifier
": "{Integer}",ShortName
Unique abbreviation/short name of the location
": "{String}",LocationLink
Location reference
": "{String}"HomeLocation
Home location of rental unit
": {LocationId
Location identifier
": "{Integer}",ShortName
Unique abbreviation/short name of the location
": "{String}",LocationLink
Location reference
": "{String}"StockLocation
Stock location reference
": {StockLocationId
Stock location identifier
": "{Integer}",Name
Name of current- and parent stock locations, including seperator for location
": "{String}",StockLocationLink
Stock location reference
": "{String}"Total
The total price in company currency from the goods reception, or Balance from the fixed asset if the rental unit is tied to a fixed asset
": "{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 104920 HTTP 400 | Log text is required |
| Error 104921 HTTP 400 | Invalid log category |
| Error 101281 HTTP 400 | Too many {0} parameters. Maximum is {1}. |
| Error 100175 HTTP 400 | To date must be equal to, or later than from date. |
| Error 105710 HTTP 400 | Invalid output type |