List rentals (paginated)
Returns a list of all the rentals created in the Booking Manager System with details.
Request
GET https://api.digital-nautic.com/v3/rentals
Query parameters
| Parameter name | Value | Description | Additional |
|---|---|---|---|
| id | integer | the rental id |
|
| customerId | integer | the customer of the rental |
|
| resourceId | string | the resource related to the rental |
|
| companyId | integer | the company that owns the resource |
|
| creationMinDate | date | the minimum creation date |
|
| creationMaxDate | date | the maximum creation date |
|
| departureMinDate | date | the minimum departure date |
|
| departureMaxDate | date | the maximum departure date |
|
| arrivalMinDate | date | the minimum arrival date |
|
| arrivalMaxDate | date | the maximum arrival date |
|
| status | string | the rental status (accepted values are PENDING, VALIDATED, CANCELED) |
|
| order | string | sort on specific criteria (accepted values are creationDateAsc, creationDateDesc) |
|
| page | integer | which page to display |
|
| perPage | integer | number of results, integer between 1 and 100 |
Response
The following HTTP status codes may be returned, optionally with a response resource.
| Status code | Description | Resource |
|---|---|---|
| 200 | OK the filtered rentals list |
Rental[] |
| 400 | Bad Request bad input parameter |
|
| 401 | Unauthorized authorization information is missing or invalid. |