API

Rental APIs

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

Updates a specific rental check-in item

HTTP method PUT
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 7123, version 3

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

This field is optional.

>
2
     <CheckInDate
CheckInDate

Date the rental unit was checked-in

This field is optional.

>{Date}</CheckInDate>
3
     <Location
Location

This field is optional.

>
4
          <LocationId
LocationId

Location identifier

Minimum value: 10000

This field is optional.

>{Integer}</LocationId>
5
     </Location>
6
     <StockLocation
StockLocation

This field is optional.

>
7
          <StockLocationId
StockLocationId

Stock location identifier

Minimum value: 100000

This field is optional.

>{Integer}</StockLocationId>
8
     </StockLocation>
9
</RentalCheckInItem>
1
{
2
     "rentalCheckInItem
RentalCheckInItem

This field is optional.

": {
3
          "checkInDate
CheckInDate

Date the rental unit was checked-in

This field is optional.

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

This field is optional.

": {
5
               "locationId
LocationId

Location identifier

Minimum value: 10000

This field is optional.

": "{Integer}"
6
          },
7
          "stockLocation
StockLocation

This field is optional.

": {
8
               "stockLocationId
StockLocationId

Stock location identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
9
          }
10
     }
11
}

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.

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 102738 HTTP 404 Price list not found
Error 100055 HTTP 403 You have only admittance to your own objects
Error 101294 HTTP 400 Location is not active (status 4)
Error 101327 HTTP 400 The stock location has to be active (status 4)
Error 110119 HTTP 400 Return date is not defined