API

Rental APIs

GET rental/units/{rentalUnitId}

Rental unit details for the provided identifier

HTTP method GET
URI https://api.rambase.net/rental/units/{rentalUnitId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {rentalUnitId} Rental unit identifier
Integer, minimum 100000
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 4785, version 38

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

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
<RentalUnit>
2
     <RentalUnitId
RentalUnitId

Rental unit identifier

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

Status

Possible domain values can be found here

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

Description of rental unit

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

Indicates if a rental unit is blocked for rental

>{Boolean}</BlockedForRental>
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
     <MainImage>
11
          <FileId
FileId

File identifier

>{Integer}</FileId>
12
          <FileLink
FileLink

File reference

>{String}</FileLink>
13
     </MainImage>
14
     <ProductCollection
ProductCollection

Product collection

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

>
15
          <ProductId
ProductId

Product identifier

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

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

Name of the product

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

>{String}</Name>
17
          <Description
Description

Description of the product

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

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

Product reference

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

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

Product assigned to rental unit

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

>
21
          <ProductId
ProductId

Product identifier

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

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

Name of the product

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

>{String}</Name>
23
          <Description
Description

Description of the product

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

>{String}</Description>
24
          <ProductLink
ProductLink

Product reference

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

>{String}</ProductLink>
25
     </Product>
26
     <ProductUnit
ProductUnit

Product unit assigned to rental unit

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

>
27
          <ProductUnitId
ProductUnitId

Product unit identifier

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

>{Integer}</ProductUnitId>
28
          <Status
Status

Status of product unit

Possible domain values can be found here

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

>{Integer}</Status>
29
          <SerialNumber
SerialNumber

Serial number

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

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

Product unit reference

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

>{String}</ProductUnitLink>
31
     </ProductUnit>
32
     <CurrentLocation
CurrentLocation

Current location of rental unit

>
33
          <LocationId
LocationId

Location identifier

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

Unique abbreviation/short name of the location

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

Location reference

>{String}</LocationLink>
36
     </CurrentLocation>
37
     <FixedAsset
FixedAsset

Fixed asset assigned to rental unit

>
38
          <FixedAssetId
FixedAssetId

Fixed asset identifier

>{Integer}</FixedAssetId>
39
          <Status
Status

Status of fixed asset

Possible domain values can be found here

>{Integer}</Status>
40
          <Name
Name

Name of fixed asset

>{String}</Name>
41
          <Description
Description

Description of fixed asset

>{String}</Description>
42
     </FixedAsset>
43
     <InitialReceptionItem
InitialReceptionItem

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

>
44
          <GoodsReceptionItemId
GoodsReceptionItemId

Item-/line-number of the goods reception

>{Integer}</GoodsReceptionItemId>
45
          <GoodsReception>
46
               <GoodsReceptionId
GoodsReceptionId

Goods reception identifier

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

Goods reception identifier

>{String}</GoodsReceptionLink>
48
          </GoodsReception>
49
          <GoodsReceptionItemLink
GoodsReceptionItemLink

Goods reception item reference

>{String}</GoodsReceptionItemLink>
50
     </InitialReceptionItem>
51
     <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.

>
52
          <GoodsReceptionItemId
GoodsReceptionItemId

Item-/line-number of the goods reception

>{Integer}</GoodsReceptionItemId>
53
          <GoodsReception>
54
               <GoodsReceptionId
GoodsReceptionId

Goods reception identifier

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

Goods reception identifier

>{String}</GoodsReceptionLink>
56
          </GoodsReception>
57
          <GoodsReceptionItemLink
GoodsReceptionItemLink

Goods reception item reference

>{String}</GoodsReceptionItemLink>
58
     </CurrentReceptionItem>
59
     <Owner
Owner

Owner of the rental unit

>
60
          <ObjectType
ObjectType

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

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

Account code of owner

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

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

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

First name of the customer/supplier

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

Owner reference

>{String}</ObjectLink>
65
     </Owner>
66
     <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>
67
</RentalUnit>
1
{
2
     "rentalUnit": {
3
          "rentalUnitId
RentalUnitId

Rental unit identifier

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

Status

Possible domain values can be found here

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

Description of rental unit

": "{String}",
6
          "blockedForRental
BlockedForRental

Indicates if a rental unit is blocked for rental

": "{Boolean}",
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
          "mainImage": {
12
               "fileId
FileId

File identifier

": "{Integer}",
13
               "fileLink
FileLink

File reference

": "{String}"
14
          },
15
          "productCollection
ProductCollection

Product collection

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

": {
16
               "productId
ProductId

Product identifier

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

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

Name of the product

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

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

Description of the product

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

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

Product reference

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

": "{String}"
20
          },
21
          "product
Product

Product assigned to rental unit

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

": {
22
               "productId
ProductId

Product identifier

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

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

Name of the product

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

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

Description of the product

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

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

Product reference

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

": "{String}"
26
          },
27
          "productUnit
ProductUnit

Product unit assigned to rental unit

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

": {
28
               "productUnitId
ProductUnitId

Product unit identifier

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

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

Status of product unit

Possible domain values can be found here

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

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

Serial number

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

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

Product unit reference

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

": "{String}"
32
          },
33
          "currentLocation
CurrentLocation

Current location of rental unit

": {
34
               "locationId
LocationId

Location identifier

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

Unique abbreviation/short name of the location

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

Location reference

": "{String}"
37
          },
38
          "fixedAsset
FixedAsset

Fixed asset assigned to rental unit

": {
39
               "fixedAssetId
FixedAssetId

Fixed asset identifier

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

Status of fixed asset

Possible domain values can be found here

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

Name of fixed asset

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

Description of fixed asset

": "{String}"
43
          },
44
          "initialReceptionItem
InitialReceptionItem

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

": {
45
               "goodsReceptionItemId
GoodsReceptionItemId

Item-/line-number of the goods reception

": "{Integer}",
46
               "goodsReception": {
47
                    "goodsReceptionId
GoodsReceptionId

Goods reception identifier

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

Goods reception identifier

": "{String}"
49
               },
50
               "goodsReceptionItemLink
GoodsReceptionItemLink

Goods reception item reference

": "{String}"
51
          },
52
          "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.

": {
53
               "goodsReceptionItemId
GoodsReceptionItemId

Item-/line-number of the goods reception

": "{Integer}",
54
               "goodsReception": {
55
                    "goodsReceptionId
GoodsReceptionId

Goods reception identifier

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

Goods reception identifier

": "{String}"
57
               },
58
               "goodsReceptionItemLink
GoodsReceptionItemLink

Goods reception item reference

": "{String}"
59
          },
60
          "owner
Owner

Owner of the rental unit

": {
61
               "objectType
ObjectType

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

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

Account code of owner

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

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

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

First name of the customer/supplier

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

Owner reference

": "{String}"
66
          },
67
          "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}"
68
     }
69
}

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