Rental APIs
Create step for the recurring rate
| HTTP method | POST |
| URI | https://api.rambase.net/rental/recurring-rates/{recurringRateId}/rate-steps |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {recurringRateId} |
Recurring rate identifier
Integer, minimum 100000 |
| Successful HTTP status code | 201 |
| API resource identifier | 5956, version 5 |
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.
Rate
Required/mandatory field
Value of step rate
Minimum value: 0
>{Decimal}</Rate>FromStep
Minimum number of intervals or qty triggering rate step
Minimum value: 1
This field is optional.
>{Integer}</FromStep>Rate
Required/mandatory field
Value of step rate
Minimum value: 0
": "{Decimal}",FromStep
Minimum number of intervals or qty triggering rate step
Minimum value: 1
This field is optional.
": "{Integer}"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.
RateStepId
Rate step identifier
>{Integer}</RateStepId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Rate
Value of step rate
>{Decimal}</Rate>FromStep
Minimum number of intervals or qty triggering rate step
>{Integer}</FromStep>RateStepId
Rate step identifier
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Rate
Value of step rate
": "{Decimal}",FromStep
Minimum number of intervals or qty triggering rate step
": "{Integer}"
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 105769 HTTP 400 | Step price should not be a negative. |
| Error 108736 HTTP 400 | The rate step is missing rate value |
| Error 108831 HTTP 400 | The rate step is missing step value |
| Error 108832 HTTP 400 | A rate already exists for this step |