API

Rental APIs

GET rental/assignments/available-rental-units?startDate={startDate}&endDate={endDate}&productCollectionId={productCollectionId}&productId={productId}&customerId={customerId}

Lists available rental units within given time

HTTP method GET
URI https://api.rambase.net/rental/assignments/available-rental-units?startDate={startDate}&endDate={endDate}&productCollectionId={productCollectionId}&productId={productId}&customerId={customerId}
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 5247, version 22

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.

startDate Date, required Start date of reservation
endDate Date, optional End date of reservation
productId Integer, optional Product assigned to rental unit

Minimum: 100000
customerId Integer, optional Account code of owner

Minimum: 100000
productCollectionId Integer, optional Product collection

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

AvailableRentalUnits() Named filter Show only available rental units
CurrentLocation String Check-out location.
Description String Description of rental unit.
ManufacturerShortName String Shortname/code of the manufacturer.
OwnerId Integer Account code of owner.
OwnerType String ObjectType of the owner, can be either a customer (CUS) or a supplier (SUP).
ProductCollectionId Integer Product collection.
ProductId Integer Product identifier.
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

CurrentLocation String Check-out location
Description String Description of rental unit
ManufacturerShortName String Shortname/code of the manufacturer
OwnerId Integer Account code of owner
OwnerType String ObjectType of the owner, can be either a customer (CUS) or a supplier (SUP).
ProductCollectionId Integer Product collection
ProductId Integer Product identifier
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
<RentalUnitAvailabilities>
2
     <RentalUnitAvailability>
3
          <Available
Available

Availability for selected period

>{Boolean}</Available>
4
          <OperationalStatus
OperationalStatus

Assignment status of a given rental unit for current day

Possible domain values can be found here

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

>{Integer}</OperationalStatus>
5
          <CurrentRentalContractItem>
6
               <RentalContractItemId
RentalContractItemId

Rental contract item identifier

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

Line- or sequence number of the item

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

Original item identifier

>
9
                    <RentalContractItemId
RentalContractItemId

Rental contract item identifier

>{Integer}</RentalContractItemId>
10
               </InitialRentalContractItem>
11
               <RentalContract>
12
                    <RentalContractId
RentalContractId

Rental contract identifier

>{Integer}</RentalContractId>
13
               </RentalContract>
14
          </CurrentRentalContractItem>
15
          <RentalUnit>
16
               <RentalUnitId
RentalUnitId

Rental unit identifier

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

Status

Possible domain values can be found here

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

Description of rental unit

>{String}</Description>
19
               <CurrentLocation
CurrentLocation

Current location of rental unit

>
20
                    <LocationId
LocationId

Location identifier

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

Unique abbreviation/short name of the location

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

Location reference

>{String}</LocationLink>
23
               </CurrentLocation>
24
               <ProductCollection
ProductCollection

Product collection

>
25
                    <ProductId
ProductId

Product identifier

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

Name of the product

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

Product reference

>{String}</ProductLink>
28
               </ProductCollection>
29
               <Product
Product

Product assigned to rental unit

>
30
                    <ProductId
ProductId

Product identifier

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

Name of the product

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

Product reference

>{String}</ProductLink>
33
               </Product>
34
               <ProductUnit
ProductUnit

Product unit assigned to rental unit

>
35
                    <ProductUnitId
ProductUnitId

Product unit identifier

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

Serial number

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

Product unit reference

>{String}</ProductUnitLink>
38
               </ProductUnit>
39
               <Owner
Owner

Owner of the rental unit

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

>
40
                    <ObjectType
ObjectType

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

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

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

Account code of owner

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

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

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

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

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

First name of the customer/supplier

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

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

Owner reference

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

>{String}</ObjectLink>
45
               </Owner>
46
          </RentalUnit>
47
     </RentalUnitAvailability>
48
     <Paging
Paging

Detailed paging information for this list.

>
49
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
52
          <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>
53
          <FirstPage
FirstPage

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

>{String}</FirstPage>
54
          <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>
55
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
56
          <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>
57
          <NextPage
NextPage

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

>{String}</NextPage>
58
          <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>
59
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
61
     </Paging>
62
</RentalUnitAvailabilities>
1
{
2
     "rentalUnitAvailabilities": [
3
          {
4
               "available
Available

Availability for selected period

": "{Boolean}",
5
               "operationalStatus
OperationalStatus

Assignment status of a given rental unit for current day

Possible domain values can be found here

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

": "{Integer}",
6
               "currentRentalContractItem": {
7
                    "rentalContractItemId
RentalContractItemId

Rental contract item identifier

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

Line- or sequence number of the item

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

Original item identifier

": {
10
                         "rentalContractItemId
RentalContractItemId

Rental contract item identifier

": "{Integer}"
11
                    },
12
                    "rentalContract": {
13
                         "rentalContractId
RentalContractId

Rental contract identifier

": "{Integer}"
14
                    }
15
               },
16
               "rentalUnit": {
17
                    "rentalUnitId
RentalUnitId

Rental unit identifier

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

Status

Possible domain values can be found here

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

Description of rental unit

": "{String}",
20
                    "currentLocation
CurrentLocation

Current location of rental unit

": {
21
                         "locationId
LocationId

Location identifier

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

Unique abbreviation/short name of the location

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

Location reference

": "{String}"
24
                    },
25
                    "productCollection
ProductCollection

Product collection

": {
26
                         "productId
ProductId

Product identifier

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

Name of the product

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

Product reference

": "{String}"
29
                    },
30
                    "product
Product

Product assigned to rental unit

": {
31
                         "productId
ProductId

Product identifier

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

Name of the product

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

Product reference

": "{String}"
34
                    },
35
                    "productUnit
ProductUnit

Product unit assigned to rental unit

": {
36
                         "productUnitId
ProductUnitId

Product unit identifier

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

Serial number

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

Product unit reference

": "{String}"
39
                    },
40
                    "owner
Owner

Owner of the rental unit

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

": {
41
                         "objectType
ObjectType

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

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

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

Account code of owner

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

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

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

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

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

First name of the customer/supplier

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

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

Owner reference

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

": "{String}"
46
                    }
47
               }
48
          }
49
     ],
50
     "paging
Paging

Detailed paging information for this list.

": {
51
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

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

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

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

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

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

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

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

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

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

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

": "{Integer}"
63
     }
64
}

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