API

Rental APIs

GET rental/units

List of rental units

HTTP method GET
URI https://api.rambase.net/rental/units
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 4781, version 43

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
$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"
$showCustomFields Boolean, optional Set to "true" to include custom fields. Default value is false.
$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.

ActiveAndDraftUnits() Named filter Active and draft rental units
ActiveRentalUnits() Named filter Active rental units
AvailableFromDate Date Date from which the rental unit is available. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
CurrentReceptionId Integer Goods reception identifier.
CurrentReceptionItemId Integer Item-/line-number of the goods reception.
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()
ProductCollectionId Integer Product collection.
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

AvailableFromDate Date Date from which the rental unit is available
CurrentReceptionId Integer Goods reception identifier
CurrentReceptionItemId Integer Item-/line-number of the goods reception
Description String Description of rental unit
EndOfLifeDate Date Date to which the rental unit is available
ProductCollectionId Integer Product collection
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.

Format:
1
<RentalUnits>
2
     <RentalUnit>
3
          <RentalUnitId
RentalUnitId

Rental unit identifier

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

Status

Possible domain values can be found here

>{String}</Status>
5
          <Description
Description

Description of rental unit

>{String}</Description>
6
          <Availability>
7
               <AvailableFromDate
AvailableFromDate

Date from which the rental unit is available

>{Date}</AvailableFromDate>
8
               <EndOfLifeDate
EndOfLifeDate

Date to which the rental unit is available

>{Date}</EndOfLifeDate>
9
          </Availability>
10
          <ProductCollection
ProductCollection

Product collection

>
11
               <ProductId
ProductId

Product identifier

>{Integer}</ProductId>
12
               <Name
Name

Name of the product

>{String}</Name>
13
               <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
14
          </ProductCollection>
15
          <Product
Product

Product assigned to rental unit

>
16
               <ProductId
ProductId

Product identifier

>{Integer}</ProductId>
17
               <Name
Name

Name of the product

>{String}</Name>
18
               <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
19
          </Product>
20
          <ProductUnit
ProductUnit

Product unit assigned to rental unit

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

>
21
               <ProductUnitId
ProductUnitId

Product unit identifier

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

>{Integer}</ProductUnitId>
22
               <SerialNumber
SerialNumber

Serial number

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

>{String}</SerialNumber>
23
               <ProductUnitLink
ProductUnitLink

Product unit reference

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

>{String}</ProductUnitLink>
24
          </ProductUnit>
25
          <CurrentLocation
CurrentLocation

Current location of rental unit

>
26
               <LocationId
LocationId

Location identifier

>{Integer}</LocationId>
27
               <ShortName
ShortName

Unique abbreviation/short name of the location

>{String}</ShortName>
28
               <LocationLink
LocationLink

Location reference

>{String}</LocationLink>
29
          </CurrentLocation>
30
          <FixedAsset
FixedAsset

Fixed asset assigned to rental unit

>
31
               <FixedAssetId
FixedAssetId

Fixed asset identifier

>{Integer}</FixedAssetId>
32
          </FixedAsset>
33
          <InitialReceptionItem
InitialReceptionItem

Initial goods reception that was used when moving a product from sales to the rental fleet

>
34
               <GoodsReceptionItemId
GoodsReceptionItemId

Item-/line-number of the goods reception

>{Integer}</GoodsReceptionItemId>
35
               <GoodsReception>
36
                    <GoodsReceptionId
GoodsReceptionId

Goods reception identifier

>{Integer}</GoodsReceptionId>
37
                    <GoodsReceptionLink
GoodsReceptionLink

Goods reception identifier

>{String}</GoodsReceptionLink>
38
               </GoodsReception>
39
               <GoodsReceptionItemLink
GoodsReceptionItemLink

Goods reception item reference

>{String}</GoodsReceptionItemLink>
40
          </InitialReceptionItem>
41
          <Owner
Owner

Owner of the rental unit

>
42
               <ObjectType
ObjectType

ObjectType of the owner, can be either a customer (CUS) or a supplier (SUP).

>{String}</ObjectType>
43
               <ObjectId
ObjectId

Account code of owner

>{Integer}</ObjectId>
44
               <Name
Name

Name of the customer/supplier, or last name if it is a person.

>{String}</Name>
45
               <FirstName
FirstName

First name of the customer/supplier

>{String}</FirstName>
46
               <ObjectLink
ObjectLink

Owner reference

>{String}</ObjectLink>
47
          </Owner>
48
          <Total
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>
49
          <RentalUnitLink
RentalUnitLink

Rental unit reference

>{String}</RentalUnitLink>
50
     </RentalUnit>
51
     <Paging
Paging

Detailed paging information for this list.

>
52
          <PageSize
PageSize

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

>{Integer}</PageSize>
53
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
54
          <Page
Page

Page index

>{Integer}</Page>
55
          <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>
56
          <FirstPage
FirstPage

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

>{String}</FirstPage>
57
          <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>
58
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
59
          <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>
60
          <NextPage
NextPage

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

>{String}</NextPage>
61
          <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>
62
          <LastPage
LastPage

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

>{String}</LastPage>
63
          <Size
Size

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

>{Integer}</Size>
64
     </Paging>
65
</RentalUnits>
1
{
2
     "rentalUnits": [
3
          {
4
               "rentalUnitId
RentalUnitId

Rental unit identifier

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

Status

Possible domain values can be found here

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

Description of rental unit

": "{String}",
7
               "availability": {
8
                    "availableFromDate
AvailableFromDate

Date from which the rental unit is available

": "{Date}",
9
                    "endOfLifeDate
EndOfLifeDate

Date to which the rental unit is available

": "{Date}"
10
               },
11
               "productCollection
ProductCollection

Product collection

": {
12
                    "productId
ProductId

Product identifier

": "{Integer}",
13
                    "name
Name

Name of the product

": "{String}",
14
                    "productLink
ProductLink

Product reference

": "{String}"
15
               },
16
               "product
Product

Product assigned to rental unit

": {
17
                    "productId
ProductId

Product identifier

": "{Integer}",
18
                    "name
Name

Name of the product

": "{String}",
19
                    "productLink
ProductLink

Product reference

": "{String}"
20
               },
21
               "productUnit
ProductUnit

Product unit assigned to rental unit

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

": {
22
                    "productUnitId
ProductUnitId

Product unit identifier

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

": "{Integer}",
23
                    "serialNumber
SerialNumber

Serial number

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

": "{String}",
24
                    "productUnitLink
ProductUnitLink

Product unit reference

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

": "{String}"
25
               },
26
               "currentLocation
CurrentLocation

Current location of rental unit

": {
27
                    "locationId
LocationId

Location identifier

": "{Integer}",
28
                    "shortName
ShortName

Unique abbreviation/short name of the location

": "{String}",
29
                    "locationLink
LocationLink

Location reference

": "{String}"
30
               },
31
               "fixedAsset
FixedAsset

Fixed asset assigned to rental unit

": {
32
                    "fixedAssetId
FixedAssetId

Fixed asset identifier

": "{Integer}"
33
               },
34
               "initialReceptionItem
InitialReceptionItem

Initial goods reception that was used when moving a product from sales to the rental fleet

": {
35
                    "goodsReceptionItemId
GoodsReceptionItemId

Item-/line-number of the goods reception

": "{Integer}",
36
                    "goodsReception": {
37
                         "goodsReceptionId
GoodsReceptionId

Goods reception identifier

": "{Integer}",
38
                         "goodsReceptionLink
GoodsReceptionLink

Goods reception identifier

": "{String}"
39
                    },
40
                    "goodsReceptionItemLink
GoodsReceptionItemLink

Goods reception item reference

": "{String}"
41
               },
42
               "owner
Owner

Owner of the rental unit

": {
43
                    "objectType
ObjectType

ObjectType of the owner, can be either a customer (CUS) or a supplier (SUP).

": "{String}",
44
                    "objectId
ObjectId

Account code of owner

": "{Integer}",
45
                    "name
Name

Name of the customer/supplier, or last name if it is a person.

": "{String}",
46
                    "firstName
FirstName

First name of the customer/supplier

": "{String}",
47
                    "objectLink
ObjectLink

Owner reference

": "{String}"
48
               },
49
               "total
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}",
50
               "rentalUnitLink
RentalUnitLink

Rental unit reference

": "{String}"
51
          }
52
     ],
53
     "paging
Paging

Detailed paging information for this list.

": {
54
          "pageSize
PageSize

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

": "{Integer}",
55
          "position
Position

Position of the first element in the list

": "{Integer}",
56
          "page
Page

Page index

": "{Integer}",
57
          "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}",
58
          "firstPage
FirstPage

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

": "{String}",
59
          "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}",
60
          "previousPage
PreviousPage

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

": "{String}",
61
          "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}",
62
          "nextPage
NextPage

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

": "{String}",
63
          "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}",
64
          "lastPage
LastPage

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

": "{String}",
65
          "size
Size

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

": "{Integer}"
66
     }
67
}

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 102738 HTTP 404 Price list not found
Error 100055 HTTP 403 You have only admittance to your own objects