API

Rental APIs

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

Details of a specific item defined for rental check-in

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

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

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

Rental check-in item identifier

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

Date the rental unit was checked-in

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

Rental contract item identifier

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

Line- or sequence number of the item

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

Rental contract item identifier

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

Estimated number of days with active rental or subscription

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

Rental contract identifier

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

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

>
14
                    <CustomerId
CustomerId

Customer identifier

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

>{Integer}</CustomerId>
15
                    <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=RentalContractItem.RentalContract.Customer in your request URI to get this field

>{String}</Name>
16
                    <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=RentalContractItem.RentalContract.Customer in your request URI to get this field

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

Customer reference

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

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

Rental contract reference

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

Rental contract item reference

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

Location identifier

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

Name of warehouse location

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

Unique abbreviation/short name of the location

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

Location reference

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

Stock location identifier

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

Name of stock location

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

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

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

Stock location reference

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

Rental unit identifier

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

Product assigned to rental unit

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

>
38
               <ProductId
ProductId

Product identifier

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

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

Name of the product

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

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

Description of the product

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

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

Product reference

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

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

Product unit assigned to rental unit

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

>
44
               <ProductUnitId
ProductUnitId

Product unit identifier

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

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

Serial number

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

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

Product unit reference

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

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

Rental unit reference

>{String}</RentalUnitLink>
49
     </RentalUnit>
50
</RentalCheckInItem>
1
{
2
     "rentalCheckInItem": {
3
          "rentalCheckInItemId
RentalCheckInItemId

Rental check-in item identifier

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

Date the rental unit was checked-in

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

Rental contract item identifier

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

Line- or sequence number of the item

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

Rental contract item identifier

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

Estimated number of days with active rental or subscription

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

Rental contract identifier

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

This field is greyed out because it is an expandable field. You have to add $expand=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=RentalContractItem.RentalContract.Customer in your request URI to get this field

": "{Integer}",
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=RentalContractItem.RentalContract.Customer in your request URI to get this field

": "{String}",
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=RentalContractItem.RentalContract.Customer in your request URI to get this field

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

Customer reference

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

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

Rental contract reference

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

Rental contract item reference

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

Location identifier

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

Name of warehouse location

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

Unique abbreviation/short name of the location

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

Location reference

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

Stock location identifier

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

Name of stock location

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

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

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

Stock location reference

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

Rental unit identifier

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

Product assigned to rental unit

This field is greyed out because it is an expandable field. You have to add $expand=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=RentalUnit.Product in your request URI to get this field

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

Name of the product

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

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

Description of the product

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

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

Product reference

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

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

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

Serial number

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

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

Product unit reference

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

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

Rental unit reference

": "{String}"
50
          }
51
     }
52
}

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