API

Rental APIs

GET rental/assignments/{rentalAssignmentId}

Rental assignment details for the provided identifier

HTTP method GET
URI https://api.rambase.net/rental/assignments/{rentalAssignmentId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {rentalAssignmentId} Rental assignment identifier
Integer, minimum 100000
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 4791, version 42

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
$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.
$showCustomFields Boolean, optional Set to "true" to include custom fields. Default value is false.

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
<RentalAssignment>
2
     <RentalAssignmentId
RentalAssignmentId

Rental assignment identifier

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

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

Possible domain values can be found here

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

Set if RUTNO is locked at reservation

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

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

>{Boolean}</IsProductLocked>
6
     <CustomerRequest
CustomerRequest

Special request for reservation

>{String}</CustomerRequest>
7
     <PreparationDays
PreparationDays

Number of days of pre-rental maintenance days

>{Integer}</PreparationDays>
8
     <MaintenanceDays
MaintenanceDays

Number of days of post-rental maintenance days

>{Integer}</MaintenanceDays>
9
     <RentalContractItem>
10
          <RentalContractItemId
RentalContractItemId

Rental contract item identifier

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

Line- or sequence number of the item

>{Integer}</LineNumber>
12
          <Status
Status

Status with regard to the stage of the item

Possible domain values can be found here

>{String}</Status>
13
          <InitialRentalContractItem>
14
               <RentalContractItemId
RentalContractItemId

Rental contract item identifier

>{Integer}</RentalContractItemId>
15
          </InitialRentalContractItem>
16
          <Customer>
17
               <CustomerId
CustomerId

Customer identifier

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

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

>{String}</Name>
19
               <CustomerLink
CustomerLink

Customer reference

>{String}</CustomerLink>
20
          </Customer>
21
          <CustomersReferenceNumber
CustomersReferenceNumber

Customers item reference number. Typically to the customers internal system.

>{String}</CustomersReferenceNumber>
22
          <RecurringRate
RecurringRate

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

>
23
               <RecurringRateId
RecurringRateId

Recurring rate identifier

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

>{Integer}</RecurringRateId>
24
               <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=RentalContractItem.RecurringRate in your request URI to get this field

>{String}</Currency>
25
               <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=RentalContractItem.RecurringRate in your request URI to get this field

>{Integer}</RateInterval>
26
               <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=RentalContractItem.RecurringRate in your request URI to get this field

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

Recurring rate reference

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

>{String}</RecurringRateLink>
28
          </RecurringRate>
29
          <CurrentRateStep
CurrentRateStep

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

>
30
               <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=RentalContractItem.CurrentRateStep in your request URI to get this field

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

Value of step rate

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

>{Decimal}</Rate>
32
          </CurrentRateStep>
33
          <OnRentDays
OnRentDays

Number of on-rent days

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

>{Integer}</OnRentDays>
34
          <RentalContract>
35
               <RentalContractId
RentalContractId

Rental contract identifier

>{Integer}</RentalContractId>
36
               <Name
Name

Short description for the rental contract

>{String}</Name>
37
               <RentalContractLink
RentalContractLink

Rental contract reference

>{String}</RentalContractLink>
38
          </RentalContract>
39
          <RentalContractItemLink
RentalContractItemLink

Rental contract item reference

>{String}</RentalContractItemLink>
40
     </RentalContractItem>
41
     <Period>
42
          <StartDate
StartDate

Start date of reservation

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

End date of reservation

>{Date}</EndDate>
44
     </Period>
45
     <RentalUnit>
46
          <RentalUnitId
RentalUnitId

Rental unit identifier

>{Integer}</RentalUnitId>
47
          <BlockedForRental
BlockedForRental

Indicates if a rental unit is blocked for rental

>{Boolean}</BlockedForRental>
48
          <RentalUnitLink
RentalUnitLink

Rental unit reference

>{String}</RentalUnitLink>
49
     </RentalUnit>
50
     <ProductUnit
ProductUnit

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

>
51
          <ProductUnitId
ProductUnitId

Product unit identifier

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

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

Serial number

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

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

Product unit reference

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

>{String}</ProductUnitLink>
54
     </ProductUnit>
55
     <Product>
56
          <ProductId
ProductId

Product identifier

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

Name of the product

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

Description of the product

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

Product reference

>{String}</ProductLink>
60
     </Product>
61
     <ProductCollection>
62
          <ProductId
ProductId

Product identifier

>{Integer}</ProductId>
63
          <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
64
     </ProductCollection>
65
     <CheckOut>
66
          <Date
Date

Check-out date

>{Date}</Date>
67
          <ExpectedDate
ExpectedDate

Expected check-out date

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

Check-out location

>
69
               <LocationId
LocationId

Location identifier

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

Unique abbreviation/short name of the location

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

Location reference

>{String}</LocationLink>
72
          </Location>
73
     </CheckOut>
74
     <CheckIn>
75
          <Date
Date

Check-in date

>{Date}</Date>
76
          <ExpectedDate
ExpectedDate

Expected check-in date

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

Check-in location

>
78
               <LocationId
LocationId

Location identifier

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

Unique abbreviation/short name of the location

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

Location reference

>{String}</LocationLink>
81
          </Location>
82
          <GoodsReceptionItem>
83
               <GoodsReceptionItemId
GoodsReceptionItemId

Item-/line-number of the goods reception

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

Status code of the the goods reception item

Possible domain values can be found here

>{Integer}</Status>
85
               <GoodsReception>
86
                    <GoodsReceptionId
GoodsReceptionId

Goods reception identifier

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

Goods reception identifier

>{String}</GoodsReceptionLink>
88
               </GoodsReception>
89
               <GoodsReceptionItemLink
GoodsReceptionItemLink

Goods reception item reference

>{String}</GoodsReceptionItemLink>
90
          </GoodsReceptionItem>
91
     </CheckIn>
92
</RentalAssignment>
1
{
2
     "rentalAssignment": {
3
          "rentalAssignmentId
RentalAssignmentId

Rental assignment identifier

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

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

Possible domain values can be found here

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

Set if RUTNO is locked at reservation

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

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

": "{Boolean}",
7
          "customerRequest
CustomerRequest

Special request for reservation

": "{String}",
8
          "preparationDays
PreparationDays

Number of days of pre-rental maintenance days

": "{Integer}",
9
          "maintenanceDays
MaintenanceDays

Number of days of post-rental maintenance days

": "{Integer}",
10
          "rentalContractItem": {
11
               "rentalContractItemId
RentalContractItemId

Rental contract item identifier

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

Line- or sequence number of the item

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

Status with regard to the stage of the item

Possible domain values can be found here

": "{String}",
14
               "initialRentalContractItem": {
15
                    "rentalContractItemId
RentalContractItemId

Rental contract item identifier

": "{Integer}"
16
               },
17
               "customer": {
18
                    "customerId
CustomerId

Customer identifier

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

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

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

Customer reference

": "{String}"
21
               },
22
               "customersReferenceNumber
CustomersReferenceNumber

Customers item reference number. Typically to the customers internal system.

": "{String}",
23
               "recurringRate
RecurringRate

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

": {
24
                    "recurringRateId
RecurringRateId

Recurring rate identifier

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

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

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

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

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

Recurring rate reference

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

": "{String}"
29
               },
30
               "currentRateStep
CurrentRateStep

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

": {
31
                    "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=RentalContractItem.CurrentRateStep in your request URI to get this field

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

Value of step rate

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

": "{Decimal}"
33
               },
34
               "onRentDays
OnRentDays

Number of on-rent days

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

": "{Integer}",
35
               "rentalContract": {
36
                    "rentalContractId
RentalContractId

Rental contract identifier

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

Short description for the rental contract

": "{String}",
38
                    "rentalContractLink
RentalContractLink

Rental contract reference

": "{String}"
39
               },
40
               "rentalContractItemLink
RentalContractItemLink

Rental contract item reference

": "{String}"
41
          },
42
          "period": {
43
               "startDate
StartDate

Start date of reservation

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

End date of reservation

": "{Date}"
45
          },
46
          "rentalUnit": {
47
               "rentalUnitId
RentalUnitId

Rental unit identifier

": "{Integer}",
48
               "blockedForRental
BlockedForRental

Indicates if a rental unit is blocked for rental

": "{Boolean}",
49
               "rentalUnitLink
RentalUnitLink

Rental unit reference

": "{String}"
50
          },
51
          "productUnit
ProductUnit

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

": {
52
               "productUnitId
ProductUnitId

Product unit identifier

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

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

Serial number

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

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

Product unit reference

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

": "{String}"
55
          },
56
          "product": {
57
               "productId
ProductId

Product identifier

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

Name of the product

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

Description of the product

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

Product reference

": "{String}"
61
          },
62
          "productCollection": {
63
               "productId
ProductId

Product identifier

": "{Integer}",
64
               "productLink
ProductLink

Product reference

": "{String}"
65
          },
66
          "checkOut": {
67
               "date
Date

Check-out date

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

Expected check-out date

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

Check-out location

": {
70
                    "locationId
LocationId

Location identifier

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

Unique abbreviation/short name of the location

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

Location reference

": "{String}"
73
               }
74
          },
75
          "checkIn": {
76
               "date
Date

Check-in date

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

Expected check-in date

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

Check-in location

": {
79
                    "locationId
LocationId

Location identifier

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

Unique abbreviation/short name of the location

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

Location reference

": "{String}"
82
               },
83
               "goodsReceptionItem": {
84
                    "goodsReceptionItemId
GoodsReceptionItemId

Item-/line-number of the goods reception

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

Status code of the the goods reception item

Possible domain values can be found here

": "{Integer}",
86
                    "goodsReception": {
87
                         "goodsReceptionId
GoodsReceptionId

Goods reception identifier

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

Goods reception identifier

": "{String}"
89
                    },
90
                    "goodsReceptionItemLink
GoodsReceptionItemLink

Goods reception item reference

": "{String}"
91
               }
92
          }
93
     }
94
}

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