API

Rental APIs

GET rental/check-ins/{checkinId}/items

List of items defined for a specific rental check-in

HTTP method GET
URI https://api.rambase.net/rental/check-ins/{checkinId}/items
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {checkinId} Rental check-in identifier
Integer, minimum 100000
Maximum page size ($top) 200
Successful HTTP status code 200
API resource identifier 7116, version 8

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.

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

CheckInDate Date Date the rental unit was checked-in. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
CustomerId Integer Customer identifier.
CustomerName String Name of customer (name of company or surname/familyname/lastname of a person).
InitialRentalContractItemId Integer Rental contract item identifier.
LocationId Integer Location identifier.
LocationName String Name of warehouse location.
LocationShortName String Unique abbreviation/short name of the location.
ProductId Integer Product identifier.
ProductName String Name of the product.
ProductUnitId Integer Product unit identifier.
RentalCheckInItemId Integer Rental check-in item identifier.
RentalContractId Integer Rental contract identifier.
RentalContractItemId Integer Rental contract item identifier.
RentalContractLineNumber Integer Line- or sequence number of the item.
RentalUnitId Integer Rental unit identifier.
SerialNumber String Serial number.
StockLocationId Integer Stock location identifier.
StockLocationName String Name of stock location.

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

CheckInDate Date Date the rental unit was checked-in
CustomerId Integer Customer identifier
CustomerName String Name of customer (name of company or surname/familyname/lastname of a person)
InitialRentalContractItemId Integer Rental contract item identifier
LocationId Integer Location identifier
LocationName String Name of warehouse location
LocationShortName String Unique abbreviation/short name of the location
ProductId Integer Product identifier
ProductName String Name of the product
ProductUnitId Integer Product unit identifier
RentalCheckInItemId Integer Rental check-in item identifier
RentalContractId Integer Rental contract identifier
RentalContractItemId Integer Rental contract item identifier
RentalContractLineNumber Integer Line- or sequence number of the item
RentalUnitId Integer Rental unit identifier
SerialNumber String Serial number
StockLocationId Integer Stock location identifier
StockLocationName String Name of stock location

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
<RentalCheckInItems>
2
     <RentalCheckInItem>
3
          <RentalCheckInItemId
RentalCheckInItemId

Rental check-in item identifier

>{Integer}</RentalCheckInItemId>
4
          <CheckInDate
CheckInDate

Date the rental unit was checked-in

>{Date}</CheckInDate>
5
          <RentalContractItem>
6
               <RentalContractItemId
RentalContractItemId

Rental contract item identifier

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

Line- or sequence number of the item

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

Rental contract item identifier

>{Integer}</RentalContractItemId>
10
               </InitialRentalContractItem>
11
               <OnRentDays
OnRentDays

Estimated number of days with active rental or subscription

>{Integer}</OnRentDays>
12
               <RentalContract>
13
                    <RentalContractId
RentalContractId

Rental contract identifier

>{Integer}</RentalContractId>
14
                    <Customer
Customer

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

>
15
                         <CustomerId
CustomerId

Customer identifier

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

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

Name of customer (name of company or surname/familyname/lastname of a person)

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

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

Secondary name of a company or firstname of a person

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

>{String}</FirstName>
18
                         <CustomerLink
CustomerLink

Customer reference

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

>{String}</CustomerLink>
19
                    </Customer>
20
                    <RentalContractLink
RentalContractLink

Rental contract reference

>{String}</RentalContractLink>
21
               </RentalContract>
22
               <RentalContractItemLink
RentalContractItemLink

Rental contract item reference

>{String}</RentalContractItemLink>
23
          </RentalContractItem>
24
          <Location>
25
               <LocationId
LocationId

Location identifier

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

Name of warehouse location

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

Unique abbreviation/short name of the location

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

Location reference

>{String}</LocationLink>
29
          </Location>
30
          <StockLocation>
31
               <StockLocationId
StockLocationId

Stock location identifier

>{Integer}</StockLocationId>
32
               <Name
Name

Name of stock location

>{String}</Name>
33
               <Label
Label

Name of current- and parent stock locations, including seperator for location

>{String}</Label>
34
               <StockLocationLink
StockLocationLink

Stock location reference

>{String}</StockLocationLink>
35
          </StockLocation>
36
          <RentalUnit>
37
               <RentalUnitId
RentalUnitId

Rental unit identifier

>{Integer}</RentalUnitId>
38
               <Product
Product

Product assigned to rental unit

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

>
39
                    <ProductId
ProductId

Product identifier

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

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

Name of the product

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

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

Description of the product

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

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

Product reference

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

>{String}</ProductLink>
43
               </Product>
44
               <ProductUnit
ProductUnit

Product unit assigned to rental unit

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

>
45
                    <ProductUnitId
ProductUnitId

Product unit identifier

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

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

Serial number

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

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

Product unit reference

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

>{String}</ProductUnitLink>
48
               </ProductUnit>
49
               <RentalUnitLink
RentalUnitLink

Rental unit reference

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

Rental check-in item reference

>{String}</RentalCheckInItemLink>
52
     </RentalCheckInItem>
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}</PageSize>
55
          <Position
Position

Position of the first element in the list

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

Page index

>{Integer}</Page>
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}</FirstPageKey>
58
          <FirstPage
FirstPage

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

>{String}</FirstPage>
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}</PreviousPageKey>
60
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
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}</NextPageKey>
62
          <NextPage
NextPage

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

>{String}</NextPage>
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}</LastPageKey>
64
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
66
     </Paging>
67
</RentalCheckInItems>
1
{
2
     "rentalCheckInItems": [
3
          {
4
               "rentalCheckInItemId
RentalCheckInItemId

Rental check-in item identifier

": "{Integer}",
5
               "checkInDate
CheckInDate

Date the rental unit was checked-in

": "{Date}",
6
               "rentalContractItem": {
7
                    "rentalContractItemId
RentalContractItemId

Rental contract item identifier

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

Line- or sequence number of the item

": "{Integer}",
9
                    "initialRentalContractItem": {
10
                         "rentalContractItemId
RentalContractItemId

Rental contract item identifier

": "{Integer}"
11
                    },
12
                    "onRentDays
OnRentDays

Estimated number of days with active rental or subscription

": "{Integer}",
13
                    "rentalContract": {
14
                         "rentalContractId
RentalContractId

Rental contract identifier

": "{Integer}",
15
                         "customer
Customer

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

": {
16
                              "customerId
CustomerId

Customer identifier

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

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

Name of customer (name of company or surname/familyname/lastname of a person)

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

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

Secondary name of a company or firstname of a person

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

": "{String}",
19
                              "customerLink
CustomerLink

Customer reference

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

": "{String}"
20
                         },
21
                         "rentalContractLink
RentalContractLink

Rental contract reference

": "{String}"
22
                    },
23
                    "rentalContractItemLink
RentalContractItemLink

Rental contract item reference

": "{String}"
24
               },
25
               "location": {
26
                    "locationId
LocationId

Location identifier

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

Name of warehouse location

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

Unique abbreviation/short name of the location

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

Location reference

": "{String}"
30
               },
31
               "stockLocation": {
32
                    "stockLocationId
StockLocationId

Stock location identifier

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

Name of stock location

": "{String}",
34
                    "label
Label

Name of current- and parent stock locations, including seperator for location

": "{String}",
35
                    "stockLocationLink
StockLocationLink

Stock location reference

": "{String}"
36
               },
37
               "rentalUnit": {
38
                    "rentalUnitId
RentalUnitId

Rental unit identifier

": "{Integer}",
39
                    "product
Product

Product assigned to rental unit

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

": {
40
                         "productId
ProductId

Product identifier

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

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

Name of the product

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

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

Description of the product

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

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

Product reference

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

": "{String}"
44
                    },
45
                    "productUnit
ProductUnit

Product unit assigned to rental unit

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

": {
46
                         "productUnitId
ProductUnitId

Product unit identifier

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

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

Serial number

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

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

Product unit reference

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

": "{String}"
49
                    },
50
                    "rentalUnitLink
RentalUnitLink

Rental unit reference

": "{String}"
51
               },
52
               "rentalCheckInItemLink
RentalCheckInItemLink

Rental check-in item reference

": "{String}"
53
          }
54
     ],
55
     "paging
Paging

Detailed paging information for this list.

": {
56
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

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

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

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

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

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

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

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

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

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

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

": "{Integer}"
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 107999 HTTP 400 Rental contract not found
Error 108012 HTTP 400 Rental contract item not found