API

Rental APIs

PUT rental/units/{rentalUnitId}/sub-renting-periods/{subRentingPeriodId}

Update selected sub renting period

HTTP method PUT
URI https://api.rambase.net/rental/units/{rentalUnitId}/sub-renting-periods/{subRentingPeriodId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {rentalUnitId} Rental unit identifier
Integer, minimum 100000
- URI parameter {subRentingPeriodId} Rental assignment identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 6688, version 4

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

This field is optional.

>
2
     <Period
Period

This field is optional.

>
3
          <StartDate
StartDate

Start date of reservation

This field is optional.

>{Date}</StartDate>
4
          <EndDate
EndDate

End date of reservation

This field is optional.

>{Date}</EndDate>
5
     </Period>
6
</SubRentingPeriod>
1
{
2
     "subRentingPeriod
SubRentingPeriod

This field is optional.

": {
3
          "period
Period

This field is optional.

": {
4
               "startDate
StartDate

Start date of reservation

This field is optional.

": "{Date}",
5
               "endDate
EndDate

End date of reservation

This field is optional.

": "{Date}"
6
          }
7
     }
8
}

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 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
Error 109535 HTTP 400 The rental unit cannot be changed to the selected one because the location does not match
Error 106927 HTTP 400 The new rental unit is not available for the selected period
Error 108349 HTTP 400 Cannot change rental unit because of conflicting assignments