API

Rental APIs

POST rental/check-ins

Creates a new rental check-in

HTTP method POST
URI https://api.rambase.net/rental/check-ins
Supported formats Xml, Html, Json (ex. $format=json)
Custom fields Custom fields supported
Successful HTTP status code 201
API resource identifier 7111, 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
<RentalCheckIn
RentalCheckIn

This field is optional.

>
2
     <AssignedTo
AssignedTo

Reference to the employee assigned to rental check-in

This field is optional.

>
3
          <EmployeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

>{Integer}</EmployeeId>
4
     </AssignedTo>
5
</RentalCheckIn>
1
{
2
     "rentalCheckIn
RentalCheckIn

This field is optional.

": {
3
          "assignedTo
AssignedTo

Reference to the employee assigned to rental check-in

This field is optional.

": {
4
               "employeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

": "{Integer}"
5
          }
6
     }
7
}

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

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<RentalCheckIn>
2
     <RentalCheckInId
RentalCheckInId

Rental check-in identifier

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

Status

Possible domain values can be found here

>{String}</Status>
4
     <AssignedTo
AssignedTo

Reference to the employee assigned to rental check-in

>
5
          <EmployeeId
EmployeeId

Employee identifier

>{Integer}</EmployeeId>
6
          <LastName
LastName

Last name of employee

>{String}</LastName>
7
          <FirstName
FirstName

First name of employee

>{String}</FirstName>
8
          <EmployeeLink
EmployeeLink

Employee reference

>{String}</EmployeeLink>
9
     </AssignedTo>
10
</RentalCheckIn>
1
{
2
     "rentalCheckIn": {
3
          "rentalCheckInId
RentalCheckInId

Rental check-in identifier

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

Status

Possible domain values can be found here

": "{String}",
5
          "assignedTo
AssignedTo

Reference to the employee assigned to rental check-in

": {
6
               "employeeId
EmployeeId

Employee identifier

": "{Integer}",
7
               "lastName
LastName

Last name of employee

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

First name of employee

": "{String}",
9
               "employeeLink
EmployeeLink

Employee reference

": "{String}"
10
          }
11
     }
12
}

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 110116 HTTP 400 Not allowed for already processed rental check-ins (status 9)
Error 102552 HTTP 400 Employee is not activated