Rental APIs
Lists rental units statistics across entire fleet
| HTTP method | GET |
| URI | https://api.rambase.net/rental/units/location-availability/totals?productId={productId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Successful HTTP status code | 200 |
| API resource identifier | 6843, 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.
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.
| productId Integer, optional |
Product identifier
Minimum: 10000 |
| $lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
| $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 |
| $format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
| $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. |
| $select String, optional | Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select 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.
TotalCount
Number of rental units from given location on a given day
>{Integer}</TotalCount>TotalAvailableCount
Number of rental units available for rent from given location on a given day
>{Integer}</TotalAvailableCount>OnRentCount
Number of rental units on rent on a given day
>{Integer}</OnRentCount>BlockedCount
Number of rental units blocked for rent on a given day
>{Integer}</BlockedCount>QuotedUnitsCount
Number of rental units assigned to a rental contract item in quote stage on a given day
>{Integer}</QuotedUnitsCount>OrderedUnitsCount
Number of rental units assigned to a rental contract item in order stage on a given day
>{Integer}</OrderedUnitsCount>CrossHireCount
Number of rental units owned by supplier on a given day
>{Integer}</CrossHireCount>CustomerOwnedCount
Number of rental units owned by a customer on a given day
>{Integer}</CustomerOwnedCount>OvercapacityCount
Number of missing rental units needed for fulfillment of future contract items on a given day
>{Integer}</OvercapacityCount>TotalCount
Number of rental units from given location on a given day
": "{Integer}",TotalAvailableCount
Number of rental units available for rent from given location on a given day
": "{Integer}",OnRentCount
Number of rental units on rent on a given day
": "{Integer}",BlockedCount
Number of rental units blocked for rent on a given day
": "{Integer}",QuotedUnitsCount
Number of rental units assigned to a rental contract item in quote stage on a given day
": "{Integer}",OrderedUnitsCount
Number of rental units assigned to a rental contract item in order stage on a given day
": "{Integer}",CrossHireCount
Number of rental units owned by supplier on a given day
": "{Integer}",CustomerOwnedCount
Number of rental units owned by a customer on a given day
": "{Integer}",OvercapacityCount
Number of missing rental units needed for fulfillment of future contract items on a given day
": "{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: