API

Rental APIs

POST rental/contracts/{rentalContractId}/versions

Create a new snapshot (external version) of a rental contract

HTTP method POST
URI https://api.rambase.net/rental/contracts/{rentalContractId}/versions
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {rentalContractId} Rental contract identifier
Integer, minimum 100000
Successful HTTP status code 201
API resource identifier 6354, version 1

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
<RentalContractVersion>
2
     <Label
Label

Required/mandatory field

Label of the version

>{String}</Label>
3
</RentalContractVersion>
1
{
2
     "rentalContractVersion": {
3
          "label
Label

Required/mandatory field

Label of the version

": "{String}"
4
     }
5
}

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]

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
<RentalContractVersion>
2
     <RentalContractVersionId
RentalContractVersionId

Rental contract version identifier

>{Integer}</RentalContractVersionId>
3
     <CreatedAt
CreatedAt

Date of item creation

>{Datetime}</CreatedAt>
4
     <UpdatedAt
UpdatedAt

Date and time of update

>{Datetime}</UpdatedAt>
5
     <Status
Status

Status of the version

Possible domain values can be found here

>{Integer}</Status>
6
     <Revision
Revision

Revision of rental contract item

>{Integer}</Revision>
7
     <Version
Version

Rental contract item version

>{Integer}</Version>
8
     <Label
Label

Label of the version

>{String}</Label>
9
     <CreatedBy
CreatedBy

PID of the user who created the version

>
10
          <UserId
UserId

User identifier

>{Integer}</UserId>
11
          <Name
Name

Name of the user

>{String}</Name>
12
          <FirstName
FirstName

First name of the user

>{String}</FirstName>
13
          <UserLink
UserLink

User reference

>{String}</UserLink>
14
     </CreatedBy>
15
     <UpdatedBy
UpdatedBy

PID of the user who updated the version

>
16
          <UserId
UserId

User identifier

>{Integer}</UserId>
17
          <Name
Name

Name of the user

>{String}</Name>
18
          <FirstName
FirstName

First name of the user

>{String}</FirstName>
19
          <UserLink
UserLink

User reference

>{String}</UserLink>
20
     </UpdatedBy>
21
</RentalContractVersion>
1
{
2
     "rentalContractVersion": {
3
          "rentalContractVersionId
RentalContractVersionId

Rental contract version identifier

": "{Integer}",
4
          "createdAt
CreatedAt

Date of item creation

": "{Datetime}",
5
          "updatedAt
UpdatedAt

Date and time of update

": "{Datetime}",
6
          "status
Status

Status of the version

Possible domain values can be found here

": "{Integer}",
7
          "revision
Revision

Revision of rental contract item

": "{Integer}",
8
          "version
Version

Rental contract item version

": "{Integer}",
9
          "label
Label

Label of the version

": "{String}",
10
          "createdBy
CreatedBy

PID of the user who created the version

": {
11
               "userId
UserId

User identifier

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

Name of the user

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

First name of the user

": "{String}",
14
               "userLink
UserLink

User reference

": "{String}"
15
          },
16
          "updatedBy
UpdatedBy

PID of the user who updated the version

": {
17
               "userId
UserId

User identifier

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

Name of the user

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

First name of the user

": "{String}",
20
               "userLink
UserLink

User reference

": "{String}"
21
          }
22
     }
23
}

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 100051 HTTP 400 When logged in as supplier {0} you do not have access to this API resource
Error 100055 HTTP 403 You have only admittance to your own objects
Error 100001 HTTP 404 Address not found