API

Rental APIs

GET rental/units/calendar-days?startdate={startDate}&endDate={endDate}&productCollectionId={productCollectionId}&productId={productId}&rentalUnitId={rentalUnitId}&checkOutLocationId={checkOutLocationId}

Lists calendar data for rental units based on a given parameters

HTTP method GET
URI https://api.rambase.net/rental/units/calendar-days?startdate={startDate}&endDate={endDate}&productCollectionId={productCollectionId}&productId={productId}&rentalUnitId={rentalUnitId}&checkOutLocationId={checkOutLocationId}
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 200
API resource identifier 6754, version 14

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.

productId Integer, optional Product identifier

Minimum: 10000
startdate Date, optional Id of the collection grouping the products
endDate Date, optional End date of reservation
productCollectionId Integer, optional Start date of reservation

Minimum: 10000
rentalUnitId Integer, optional Rental unit identifier

Minimum: 100000
checkOutLocationId Integer, optional Check-out location identifier

Minimum: 10000
$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.

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
<CalendarDays>
2
     <CalendarDay>
3
          <Date
Date

Rental calendar date of day

>{Date}</Date>
4
          <OnRentCount
OnRentCount

Number of rental units on rent on a given day

>{Integer}</OnRentCount>
5
          <BlockedCount
BlockedCount

Number of rental units blocked for rent on a given day

>{Integer}</BlockedCount>
6
          <TotalAvailableCount
TotalAvailableCount

Number of rental units available for rent on a given day

>{Integer}</TotalAvailableCount>
7
          <QuoteAssignmentCount
QuoteAssignmentCount

Number of rental units assigned to a rental contract item in quote stage on a given day

>{Integer}</QuoteAssignmentCount>
8
          <OrderAssignmentCount
OrderAssignmentCount

Number of rental units assigned to a rental contract item in order stage on a given day

>{Integer}</OrderAssignmentCount>
9
          <ExpectedCheckInCount
ExpectedCheckInCount

Number of rental units expected to be returned on a given day

>{Integer}</ExpectedCheckInCount>
10
          <OperationalStatus
OperationalStatus

Assignment status of a given rental unit for current day

Possible domain values can be found here

>{Integer}</OperationalStatus>
11
          <LocationAvailability>
12
               <Count
Count

Number of rental units available for rent from given location on a given day

>{Integer}</Count>
13
               <CheckOutLocation
CheckOutLocation

Check-out location

>
14
                    <LocationId
LocationId

Location identifier

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

Unique abbreviation/short name of the location

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

Location reference

>{String}</LocationLink>
17
               </CheckOutLocation>
18
          </LocationAvailability>
19
          <LatestRentalContractItems
LatestRentalContractItems

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

>
20
               <RentalContractItem
RentalContractItem

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

>
21
                    <RentalContractItemId
RentalContractItemId

Rental contract item identifier

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

>{Integer}</RentalContractItemId>
22
                    <LineNumber
LineNumber

Line- or sequence number of the item

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

>{Integer}</LineNumber>
23
                    <InitialRentalContractItem
InitialRentalContractItem

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

>
24
                         <RentalContractItemId
RentalContractItemId

Rental contract item identifier

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

>{Integer}</RentalContractItemId>
25
                    </InitialRentalContractItem>
26
                    <RentalContract
RentalContract

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

>
27
                         <RentalContractId
RentalContractId

Rental contract identifier

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

>{Integer}</RentalContractId>
28
                    </RentalContract>
29
               </RentalContractItem>
30
          </LatestRentalContractItems>
31
     </CalendarDay>
32
     <Paging
Paging

Detailed paging information for this list.

>
33
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
36
          <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>
37
          <FirstPage
FirstPage

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

>{String}</FirstPage>
38
          <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>
39
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
40
          <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>
41
          <NextPage
NextPage

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

>{String}</NextPage>
42
          <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>
43
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
45
     </Paging>
46
</CalendarDays>
1
{
2
     "calendarDays": [
3
          {
4
               "date
Date

Rental calendar date of day

": "{Date}",
5
               "onRentCount
OnRentCount

Number of rental units on rent on a given day

": "{Integer}",
6
               "blockedCount
BlockedCount

Number of rental units blocked for rent on a given day

": "{Integer}",
7
               "totalAvailableCount
TotalAvailableCount

Number of rental units available for rent on a given day

": "{Integer}",
8
               "quoteAssignmentCount
QuoteAssignmentCount

Number of rental units assigned to a rental contract item in quote stage on a given day

": "{Integer}",
9
               "orderAssignmentCount
OrderAssignmentCount

Number of rental units assigned to a rental contract item in order stage on a given day

": "{Integer}",
10
               "expectedCheckInCount
ExpectedCheckInCount

Number of rental units expected to be returned on a given day

": "{Integer}",
11
               "operationalStatus
OperationalStatus

Assignment status of a given rental unit for current day

Possible domain values can be found here

": "{Integer}",
12
               "locationAvailability": {
13
                    "count
Count

Number of rental units available for rent from given location on a given day

": "{Integer}",
14
                    "checkOutLocation
CheckOutLocation

Check-out location

": {
15
                         "locationId
LocationId

Location identifier

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

Unique abbreviation/short name of the location

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

Location reference

": "{String}"
18
                    }
19
               },
20
               "latestRentalContractItems
LatestRentalContractItems

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

": [
21
                    {
22
                         "rentalContractItemId
RentalContractItemId

Rental contract item identifier

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

": "{Integer}",
23
                         "lineNumber
LineNumber

Line- or sequence number of the item

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

": "{Integer}",
24
                         "initialRentalContractItem
InitialRentalContractItem

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

": {
25
                              "rentalContractItemId
RentalContractItemId

Rental contract item identifier

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

": "{Integer}"
26
                         },
27
                         "rentalContract
RentalContract

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

": {
28
                              "rentalContractId
RentalContractId

Rental contract identifier

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

": "{Integer}"
29
                         }
30
                    }
31
               ]
32
          }
33
     ],
34
     "paging
Paging

Detailed paging information for this list.

": {
35
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

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

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

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

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

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

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

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

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

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

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

": "{Integer}"
47
     }
48
}

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 99946 HTTP 400 {0}: Missing mandatory arguments {1}
Error 100089 HTTP 404 Product {0} not found