API

Rental APIs

PUT rental/units/{rentalUnitId}

Update provided rental unit

HTTP method PUT
URI https://api.rambase.net/rental/units/{rentalUnitId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {rentalUnitId} Rental unit identifier
Integer, minimum 100000
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 4787, version 15

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
<RentalUnit
RentalUnit

This field is optional.

>
2
     <Description
Description

Description of rental unit

This field is optional.

>{String}</Description>
3
     <Availability
Availability

This field is optional.

>
4
          <AvailableFromDate
AvailableFromDate

Date from which the rental unit is available

This field is optional.

>{Date}</AvailableFromDate>
5
          <EndOfLifeDate
EndOfLifeDate

Date to which the rental unit is available

This field is optional.

>{Date}</EndOfLifeDate>
6
     </Availability>
7
     <ProductCollection
ProductCollection

Product collection

This field is optional.

>
8
          <ProductId
ProductId

Product identifier

Minimum value: 10000

This field is optional.

>{Integer}</ProductId>
9
     </ProductCollection>
10
     <Product
Product

Product assigned to rental unit

This field is optional.

>
11
          <ProductId
ProductId

Product identifier

Minimum value: 10000

This field is optional.

>{Integer}</ProductId>
12
     </Product>
13
     <ProductUnit
ProductUnit

Product unit assigned to rental unit

This field is optional.

>
14
          <ProductUnitId
ProductUnitId

Product unit identifier

Minimum value: 100000

This field is optional.

>{Integer}</ProductUnitId>
15
     </ProductUnit>
16
     <FixedAsset
FixedAsset

Fixed asset assigned to rental unit

This field is optional.

>
17
          <FixedAssetId
FixedAssetId

Fixed asset identifier

Minimum value: 100000

This field is optional.

>{Integer}</FixedAssetId>
18
     </FixedAsset>
19
</RentalUnit>
1
{
2
     "rentalUnit
RentalUnit

This field is optional.

": {
3
          "description
Description

Description of rental unit

This field is optional.

": "{String}",
4
          "availability
Availability

This field is optional.

": {
5
               "availableFromDate
AvailableFromDate

Date from which the rental unit is available

This field is optional.

": "{Date}",
6
               "endOfLifeDate
EndOfLifeDate

Date to which the rental unit is available

This field is optional.

": "{Date}"
7
          },
8
          "productCollection
ProductCollection

Product collection

This field is optional.

": {
9
               "productId
ProductId

Product identifier

Minimum value: 10000

This field is optional.

": "{Integer}"
10
          },
11
          "product
Product

Product assigned to rental unit

This field is optional.

": {
12
               "productId
ProductId

Product identifier

Minimum value: 10000

This field is optional.

": "{Integer}"
13
          },
14
          "productUnit
ProductUnit

Product unit assigned to rental unit

This field is optional.

": {
15
               "productUnitId
ProductUnitId

Product unit identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
16
          },
17
          "fixedAsset
FixedAsset

Fixed asset assigned to rental unit

This field is optional.

": {
18
               "fixedAssetId
FixedAssetId

Fixed asset identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
19
          }
20
     }
21
}

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.

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

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 100053 HTTP 403 You have only admittance to your own suppliers
Error 101420 HTTP 404 Setting definition not found
Error 107317 HTTP 400 End of life date cannot be earlier than available from date
Error 106886 HTTP 400 The date cannot be changed because there are ongoing assignments.
Error 107320 HTTP 400 Already exists rental unit with selected serial number.
Error 109035 HTTP 400 Only active fixed assets are allowed (ST=3 or ST=4 or ST=8)
Error 109170 HTTP 400 The selected fixed asset is already assigned to a rental unit. You cannot assign the same fixed asset multiple times.
Error 101235 HTTP 404 Goods reception item not found
Error 107276 HTTP 400 Serial number of registered rental unit cannot be modified