API

Rental APIs

GET rental/contracts/{rentalContractId}/items/{itemId}/rental-units

Get list of rental assignments for specified rental contract item

HTTP method GET
URI https://api.rambase.net/rental/contracts/{rentalContractId}/items/{itemId}/rental-units
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {rentalContractId} Rental contract identifier
Integer, minimum 100000
- URI parameter {itemId} Rental contract item identifier
Integer, minimum 1
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 5987, version 26

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

EndDate Date End date of reservation. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
ProductId Integer Product identifier.
ProductName String Name of the product.
RentalAssignmentStatus Integer 3 = Future period, 4 = active period, 9 = ended period.
RentalUnitStatus String Status.
SerialNumber String Serial number.
StartDate Date Start date of reservation. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()

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

EndDate Date End date of reservation
ProductId Integer Product identifier
ProductName String Name of the product
RentalAssignmentStatus Integer 3 = Future period, 4 = active period, 9 = ended period
RentalUnitStatus String Status
SerialNumber String Serial number
StartDate Date Start date of reservation

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
<RentalUnitsForItem>
2
     <RentalUnitForItem>
3
          <RentalUnit>
4
               <RentalUnitId
RentalUnitId

Rental unit identifier

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

Status

Possible domain values can be found here

>{String}</Status>
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
               <Product>
11
                    <ProductId
ProductId

Product identifier

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

Name of the product

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

Type of product

Possible domain values can be found here

>{String}</Type>
14
                    <Description
Description

Description of the product

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

Product reference

>{String}</ProductLink>
16
               </Product>
17
               <ProductUnit
ProductUnit

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

>
18
                    <ProductUnitId
ProductUnitId

Product unit identifier

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

>{Integer}</ProductUnitId>
19
                    <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=RentalUnitForItem.RentalUnit.ProductUnit in your request URI to get this field

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

Serial number

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

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

Product unit reference

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

>{String}</ProductUnitLink>
22
               </ProductUnit>
23
               <RentalUnitLink
RentalUnitLink

Rental unit reference

>{String}</RentalUnitLink>
24
          </RentalUnit>
25
          <CurrentCalendarDay>
26
               <IsOnRent
IsOnRent

Is on-rent or is off-rent

>{Integer}</IsOnRent>
27
               <RecurringRate
RecurringRate

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

>
28
                    <RecurringRateId
RecurringRateId

Recurring rate identifier

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

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

Status of recurring rate

Possible domain values can be found here

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

>{Integer}</Status>
30
                    <Currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

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

>{String}</Currency>
31
                    <RateInterval
RateInterval

Interval of recurring rate

Possible domain values can be found here

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

>{Integer}</RateInterval>
32
                    <Type
Type

Type of recurring rate: 1 - Standard, 2 - Special

Possible domain values can be found here

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

>{Integer}</Type>
33
                    <RecurringRateLink
RecurringRateLink

Recurring rate reference

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

>{String}</RecurringRateLink>
34
               </RecurringRate>
35
               <CurrentRateStep
CurrentRateStep

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

>
36
                    <Currency
Currency

Three character code following the ISO 4217 standard

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

>{String}</Currency>
37
                    <Rate
Rate

Value of step rate

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

>{Decimal}</Rate>
38
               </CurrentRateStep>
39
          </CurrentCalendarDay>
40
          <RentalAssignment>
41
               <RentalAssignmentId
RentalAssignmentId

Rental assignment identifier

>{Integer}</RentalAssignmentId>
42
               <Status
Status

3 = Future period, 4 = active period, 9 = ended period

Possible domain values can be found here

>{Integer}</Status>
43
               <IsRentalUnitLocked
IsRentalUnitLocked

Set if RUTNO is locked at reservation

>{Boolean}</IsRentalUnitLocked>
44
               <IsProductLocked
IsProductLocked

Product is locked, but can be switched to another RUT with the same IT

>{Boolean}</IsProductLocked>
45
               <Period>
46
                    <StartDate
StartDate

Start date of reservation

>{Date}</StartDate>
47
                    <EndDate
EndDate

End date of reservation

>{Date}</EndDate>
48
               </Period>
49
               <CheckOut>
50
                    <Date
Date

Check-out date

>{Date}</Date>
51
                    <ExpectedDate
ExpectedDate

Expected check-out date

>{Date}</ExpectedDate>
52
                    <Location
Location

Check-out location

>
53
                         <LocationId
LocationId

Location identifier

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

Unique abbreviation/short name of the location

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

Location reference

>{String}</LocationLink>
56
                    </Location>
57
               </CheckOut>
58
               <CheckIn>
59
                    <Date
Date

Check-in date

>{Date}</Date>
60
                    <ExpectedDate
ExpectedDate

Expected check-in date

>{Date}</ExpectedDate>
61
                    <Location
Location

Check-in location

>
62
                         <LocationId
LocationId

Location identifier

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

Unique abbreviation/short name of the location

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

Location reference

>{String}</LocationLink>
65
                    </Location>
66
                    <GoodsReceptionItem>
67
                         <GoodsReceptionItemId
GoodsReceptionItemId

Item-/line-number of the goods reception

>{Integer}</GoodsReceptionItemId>
68
                         <Status
Status

Status code of the the goods reception item

Possible domain values can be found here

>{Integer}</Status>
69
                         <GoodsReception>
70
                              <GoodsReceptionId
GoodsReceptionId

Goods reception identifier

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

Goods reception identifier

>{String}</GoodsReceptionLink>
72
                         </GoodsReception>
73
                         <GoodsReceptionItemLink
GoodsReceptionItemLink

Goods reception item reference

>{String}</GoodsReceptionItemLink>
74
                    </GoodsReceptionItem>
75
               </CheckIn>
76
          </RentalAssignment>
77
          <Totals>
78
               <NumberOfOnRentDays
NumberOfOnRentDays

Number of on-rent days

>{Integer}</NumberOfOnRentDays>
79
          </Totals>
80
     </RentalUnitForItem>
81
     <Paging
Paging

Detailed paging information for this list.

>
82
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
85
          <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>
86
          <FirstPage
FirstPage

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

>{String}</FirstPage>
87
          <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>
88
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
89
          <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>
90
          <NextPage
NextPage

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

>{String}</NextPage>
91
          <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>
92
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
94
     </Paging>
95
</RentalUnitsForItem>
1
{
2
     "rentalUnitsForItem": [
3
          {
4
               "rentalUnit": {
5
                    "rentalUnitId
RentalUnitId

Rental unit identifier

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

Status

Possible domain values can be found here

": "{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
                    "product": {
12
                         "productId
ProductId

Product identifier

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

Name of the product

": "{String}",
14
                         "type
Type

Type of product

Possible domain values can be found here

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

Description of the product

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

Product reference

": "{String}"
17
                    },
18
                    "productUnit
ProductUnit

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

": {
19
                         "productUnitId
ProductUnitId

Product unit identifier

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

": "{Integer}",
20
                         "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=RentalUnitForItem.RentalUnit.ProductUnit in your request URI to get this field

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

Serial number

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

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

Product unit reference

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

": "{String}"
23
                    },
24
                    "rentalUnitLink
RentalUnitLink

Rental unit reference

": "{String}"
25
               },
26
               "currentCalendarDay": {
27
                    "isOnRent
IsOnRent

Is on-rent or is off-rent

": "{Integer}",
28
                    "recurringRate
RecurringRate

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

": {
29
                         "recurringRateId
RecurringRateId

Recurring rate identifier

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

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

Status of recurring rate

Possible domain values can be found here

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

": "{Integer}",
31
                         "currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

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

": "{String}",
32
                         "rateInterval
RateInterval

Interval of recurring rate

Possible domain values can be found here

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

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

Type of recurring rate: 1 - Standard, 2 - Special

Possible domain values can be found here

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

": "{Integer}",
34
                         "recurringRateLink
RecurringRateLink

Recurring rate reference

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

": "{String}"
35
                    },
36
                    "currentRateStep
CurrentRateStep

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

": {
37
                         "currency
Currency

Three character code following the ISO 4217 standard

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

": "{String}",
38
                         "rate
Rate

Value of step rate

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

": "{Decimal}"
39
                    }
40
               },
41
               "rentalAssignment": {
42
                    "rentalAssignmentId
RentalAssignmentId

Rental assignment identifier

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

3 = Future period, 4 = active period, 9 = ended period

Possible domain values can be found here

": "{Integer}",
44
                    "isRentalUnitLocked
IsRentalUnitLocked

Set if RUTNO is locked at reservation

": "{Boolean}",
45
                    "isProductLocked
IsProductLocked

Product is locked, but can be switched to another RUT with the same IT

": "{Boolean}",
46
                    "period": {
47
                         "startDate
StartDate

Start date of reservation

": "{Date}",
48
                         "endDate
EndDate

End date of reservation

": "{Date}"
49
                    },
50
                    "checkOut": {
51
                         "date
Date

Check-out date

": "{Date}",
52
                         "expectedDate
ExpectedDate

Expected check-out date

": "{Date}",
53
                         "location
Location

Check-out location

": {
54
                              "locationId
LocationId

Location identifier

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

Unique abbreviation/short name of the location

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

Location reference

": "{String}"
57
                         }
58
                    },
59
                    "checkIn": {
60
                         "date
Date

Check-in date

": "{Date}",
61
                         "expectedDate
ExpectedDate

Expected check-in date

": "{Date}",
62
                         "location
Location

Check-in location

": {
63
                              "locationId
LocationId

Location identifier

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

Unique abbreviation/short name of the location

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

Location reference

": "{String}"
66
                         },
67
                         "goodsReceptionItem": {
68
                              "goodsReceptionItemId
GoodsReceptionItemId

Item-/line-number of the goods reception

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

Status code of the the goods reception item

Possible domain values can be found here

": "{Integer}",
70
                              "goodsReception": {
71
                                   "goodsReceptionId
GoodsReceptionId

Goods reception identifier

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

Goods reception identifier

": "{String}"
73
                              },
74
                              "goodsReceptionItemLink
GoodsReceptionItemLink

Goods reception item reference

": "{String}"
75
                         }
76
                    }
77
               },
78
               "totals": {
79
                    "numberOfOnRentDays
NumberOfOnRentDays

Number of on-rent days

": "{Integer}"
80
               }
81
          }
82
     ],
83
     "paging
Paging

Detailed paging information for this list.

": {
84
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

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

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

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

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

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

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

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

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

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

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

": "{Integer}"
96
     }
97
}

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 100050 HTTP 403 No admittance as customer {0}
Error 101420 HTTP 404 Setting definition not found