API

Rental APIs

POST rental/contracts/{rentalContractId}/quotes

Creates new rental contract quote

HTTP method POST
URI https://api.rambase.net/rental/contracts/{rentalContractId}/quotes
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 5991, version 6

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
<RentalContractQuote>
2
     <Name
Name

Required/mandatory field

Name of rental quote

>
{String}</Name>
3
     <ExpirationDate
ExpirationDate

Required/mandatory field

Date of quote expiry

>
{Date}</ExpirationDate>
4
     <Description
Description

Description of quote and notes for printout

This field is optional.

>
{String}</Description>
5
</RentalContractQuote>
1
{
2
     "rentalContractQuote": {
3
          "name
Name

Required/mandatory field

Name of rental quote

":
"{String}",
4
          "expirationDate
ExpirationDate

Required/mandatory field

Date of quote expiry

":
"{Date}",
5
          "description
Description

Description of quote and notes for printout

This field is optional.

":
"{String}"
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.
$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
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 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 108399 HTTP 400 Name of the quote must be unique
Error 109309 HTTP 400 Expiration date cannot be in the past
Error 108685 HTTP 400 Expiration date cannot be later than the expiration date of the contract