Rental APIs

GET system/reports/117375/result-set

List all active rental units with deitaled information about availabillity etc.

Report name	Rental Units by Depot
Report identifier	117375
HTTP method	GET
URI	https://api.rambase.net/system/reports/117375/result-set
Supported formats	Xml, Html, Json (ex. $format=json)
Maximum page size ($top)	80
Successful HTTP status code	200
API resource identifier	6915, version 6

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:

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
$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.

AvailableFromDate Date	Date from which the rental unit is available. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
BlockedForRental Boolean	Indicates if a rental unit is blocked for rental.
CurrentLocationShortName String	Unique abbreviation/short name of the location.
Description String	Description of rental unit.
EndOfLifeDate Date	Date to which the rental unit is available. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
HomeLocationShortName String	Unique abbreviation/short name of the location.
ProductCollectionId Integer	Product identifier.
ProductDescription String	Description of the product.
ProductId Integer	Product identifier.
ProductName String	Name of the product.
RentalUnitId Integer	Rental unit identifier.
SerialNumber String	Serial number.
Total Decimal	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.

Read more about filters and sorting on how to use sortable parameters

AvailableFromDate Date	Date from which the rental unit is available
BlockedForRental Boolean	Indicates if a rental unit is blocked for rental
CurrentLocationShortName String	Unique abbreviation/short name of the location
Description String	Description of rental unit
EndOfLifeDate Date	Date to which the rental unit is available
HomeLocationShortName String	Unique abbreviation/short name of the location
ProductCollectionId Integer	Product identifier
ProductDescription String	Description of the product
ProductId Integer	Product identifier
ProductName String	Name of the product
RentalUnitId Integer	Rental unit identifier
SerialNumber String	Serial number
Total Decimal	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

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:

                                        <Report>
                                    

                                             <Rows>
                                    

                                                  <Row>
                                    

<Status

Status

Status

Possible domain values can be found here

>{String}</Status>

<RentalUnitId

RentalUnitId

Rental unit identifier

>{Integer}</RentalUnitId>

<Description

Description

Description of rental unit

>{String}</Description>

<OperationalStatus

OperationalStatus

Assignment status of a given rental unit for current day

>{String}</OperationalStatus>

<Product

Product

Product of the unit

<ProductId

ProductId

Product identifier

>{Integer}</ProductId>

<Name

Name

Name of the product

>{String}</Name>

<Description

Description

Description of the product

>{String}</Description>

<Type

Type

Type of product

Possible domain values can be found here

>{String}</Type>

<ProductLink

ProductLink

Product reference

>{String}</ProductLink>

                                                       </Product>
                                    

<Availability

Availability

Availability for selected period

<AvailableFromDate

AvailableFromDate

Date from which the rental unit is available

>{Date}</AvailableFromDate>

<EndOfLifeDate

EndOfLifeDate

Date to which the rental unit is available

>{Date}</EndOfLifeDate>

<BlockedForRental

BlockedForRental

Indicates if a rental unit is blocked for rental

>{Boolean}</BlockedForRental>

                                                       </Availability>
                                    

<ProductCollection

ProductCollection

Reference to product collection

<ProductId

ProductId

Product identifier

>{Integer}</ProductId>

<Name

Name

Name of the product

>{String}</Name>

<Description

Description

Description of the product

>{String}</Description>

<ProductCollectionLink

ProductCollectionLink

Product reference

>{String}</ProductCollectionLink>

                                                       </ProductCollection>
                                    

<ProductUnit

ProductUnit

Product unit of the unit

<ProductUnitId

ProductUnitId

Product unit identifier

>{Integer}</ProductUnitId>

<SerialNumber

SerialNumber

Serial number

>{String}</SerialNumber>

<ProductUnitLink

ProductUnitLink

Product unit reference

>{String}</ProductUnitLink>

                                                       </ProductUnit>
                                    

<CurrentLocation

CurrentLocation

Reference to current location of the unit

<ShortName

ShortName

Unique abbreviation/short name of the location

>{String}</ShortName>

<LocationLink

LocationLink

Location reference

>{String}</LocationLink>

                                                       </CurrentLocation>
                                    

<HomeLocation

HomeLocation

Reference to home location of the rental unit

<LocationId

LocationId

Location identifier

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

>{Integer}</LocationId>

<ShortName

ShortName

Unique abbreviation/short name of the location

>{String}</ShortName>

<LocationLink

LocationLink

Location reference

>{String}</LocationLink>

                                                       </HomeLocation>
                                    

<Total

Total

Total ({SYSCUR})

>{Decimal}</Total>

<CurrentReceptionItem

CurrentReceptionItem

The current goods reception that the rental unit is located on. This will get a new value each time the rental unit is returned from rent.

<GoodsReceptionItemId

GoodsReceptionItemId

Item-/line-number of the goods reception

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

>{Integer}</GoodsReceptionItemId>

<GoodsReception

GoodsReception

Goods reception reference

<GoodsReceptionId

GoodsReceptionId

Goods reception identifier

>{Integer}</GoodsReceptionId>

<GoodsReceptionLink

GoodsReceptionLink

Goods reception identifier

>{String}</GoodsReceptionLink>

                                                            </GoodsReception>
                                    

<GoodsReceptionItemLink

GoodsReceptionItemLink

Goods reception item reference

>{String}</GoodsReceptionItemLink>

                                                       </CurrentReceptionItem>
                                    

<StockLocation

StockLocation

Reference to stock location

<StockLocationId

StockLocationId

Stock location identifier

>{Integer}</StockLocationId>

<Name

Name

Name of stock location

>{String}</Name>

<StockLocationLink

StockLocationLink

Stock location reference

>{String}</StockLocationLink>

                                                       </StockLocation>
                                    

<RentalContractItem

RentalContractItem

Rental contract item

<RentalContract

RentalContract

Rental contract

<RentalContractId

RentalContractId

Rental contract identifier

>{Integer}</RentalContractId>

                                                            </RentalContract>
                                    

<RentalContractItemId

RentalContractItemId

Rental contract item identifier

>{Integer}</RentalContractItemId>

<RentalContractItmLink

RentalContractItmLink

Rental contract reference

>{String}</RentalContractItmLink>

                                                       </RentalContractItem>
                                    

                                                       <Inspect>
                                    

<TargetApplication

TargetApplication

Application reference when inspecting a line in a report.

>{String}</TargetApplication>

                                                       </Inspect>
                                    

                                                  </Row>
                                    

                                             </Rows>
                                    

<ColumnParameters

ColumnParameters

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

<ColumnParameter

ColumnParameter

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

<Key

Key

Key that is used in description to lookup value from COS. The key is referenced by encapsulating it in curly braces.

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

>{String}</Key>

<Value

Value

The value of the column parameter from COS that will be shown in the column headers referencing the column parameter key.

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

>{String}</Value>

                                                  </ColumnParameter>
                                    

                                             </ColumnParameters>
                                    

<Paging

Paging

Detailed paging information for this list.

<PageSize

PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>

<Position

Position

Position of the first element in the list

>{Integer}</Position>

<Page

Page

Page index

>{Integer}</Page>

<FirstPageKey

FirstPageKey

Page key to use for navigating to the first page in the list

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

>{String}</FirstPageKey>

<FirstPage

FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>

<PreviousPageKey

PreviousPageKey

Page key to use for navigating to previous page in the list

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

>{String}</PreviousPageKey>

<PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>

<NextPageKey

NextPageKey

Page key to use for navigating to next page in the list

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

>{String}</NextPageKey>

<NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>

<LastPageKey

LastPageKey

Page key to use for navigating to last page in the list

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

>{String}</LastPageKey>

<LastPage

LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>

<Size

Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>

                                             </Paging>
                                    

                                        </Report>
                                    

{

                                             "report": {
                                    

                                                  "rows": [
                                    

{

"status

Status

Status

Possible domain values can be found here

": "{String}",

"rentalUnitId

RentalUnitId

Rental unit identifier

": "{Integer}",

"description

Description

Description of rental unit

": "{String}",

"operationalStatus

OperationalStatus

Assignment status of a given rental unit for current day

": "{String}",

"product

Product

Product of the unit

": {

"productId

ProductId

Product identifier

": "{Integer}",

"name

Name

Name of the product

": "{String}",

"description

Description

Description of the product

": "{String}",

"type

Type

Type of product

Possible domain values can be found here

": "{String}",

"productLink

ProductLink

Product reference

": "{String}"

},

"availability

Availability

Availability for selected period

": {

"availableFromDate

AvailableFromDate

Date from which the rental unit is available

": "{Date}",

"endOfLifeDate

EndOfLifeDate

Date to which the rental unit is available

": "{Date}",

"blockedForRental

BlockedForRental

Indicates if a rental unit is blocked for rental

": "{Boolean}"

},

"productCollection

ProductCollection

Reference to product collection

": {

"productId

ProductId

Product identifier

": "{Integer}",

"name

Name

Name of the product

": "{String}",

"description

Description

Description of the product

": "{String}",

"productCollectionLink

ProductCollectionLink

Product reference

": "{String}"

},

"productUnit

ProductUnit

Product unit of the unit

": {

"productUnitId

ProductUnitId

Product unit identifier

": "{Integer}",

"serialNumber

SerialNumber

Serial number

": "{String}",

"productUnitLink

ProductUnitLink

Product unit reference

": "{String}"

},

"currentLocation

CurrentLocation

Reference to current location of the unit

": {

"shortName

ShortName

Unique abbreviation/short name of the location

": "{String}",

"locationLink

LocationLink

Location reference

": "{String}"

},

"homeLocation

HomeLocation

Reference to home location of the rental unit

": {

"locationId

LocationId

Location identifier

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

": "{Integer}",

"shortName

ShortName

Unique abbreviation/short name of the location

": "{String}",

"locationLink

LocationLink

Location reference

": "{String}"

},

"total

Total

Total ({SYSCUR})

": "{Decimal}",

"currentReceptionItem

CurrentReceptionItem

The current goods reception that the rental unit is located on. This will get a new value each time the rental unit is returned from rent.

": {

"goodsReceptionItemId

GoodsReceptionItemId

Item-/line-number of the goods reception

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

": "{Integer}",

"goodsReception

GoodsReception

Goods reception reference

": {

"goodsReceptionId

GoodsReceptionId

Goods reception identifier

": "{Integer}",

"goodsReceptionLink

GoodsReceptionLink

Goods reception identifier

": "{String}"

},

"goodsReceptionItemLink

GoodsReceptionItemLink

Goods reception item reference

": "{String}"

},

"stockLocation

StockLocation

Reference to stock location

": {

"stockLocationId

StockLocationId

Stock location identifier

": "{Integer}",

"name

Name

Name of stock location

": "{String}",

"stockLocationLink

StockLocationLink

Stock location reference

": "{String}"

},

"rentalContractItem

RentalContractItem

Rental contract item

": {

"rentalContract

RentalContract

Rental contract

": {

"rentalContractId

RentalContractId

Rental contract identifier

": "{Integer}"

},

"rentalContractItemId

RentalContractItemId

Rental contract item identifier

": "{Integer}",

"rentalContractItmLink

RentalContractItmLink

Rental contract reference

": "{String}"

},

                                                            "inspect": {
                                    

"targetApplication

TargetApplication

Application reference when inspecting a line in a report.

": "{String}"

}

}

],

"columnParameters

ColumnParameters

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

": [

{

"key

Key

Key that is used in description to lookup value from COS. The key is referenced by encapsulating it in curly braces.

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

": "{String}",

"value

Value

The value of the column parameter from COS that will be shown in the column headers referencing the column parameter key.

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

": "{String}"

}

]

}

}

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