List resources (paginated)
Returns a list of all the resources available for rental in the Booking Manager System with details.
Request
GET https://api.digital-nautic.com/v3/resources
Query parameters
| Parameter name | Value | Description | Additional |
|---|---|---|---|
| id | string | the resource id |
|
| companyId | integer | the company which provide the resource |
|
| latitude | number | geographical latitude of the resource position |
|
| longitude | number | geographical longitude of the resource position |
|
| radius | number | scope circle area around the point defined by the latitude and longitude (in meters) |
|
| harbourId | integer | the harbour id |
|
| cityId | integer | the city id |
|
| navigationAreaId | integer | the navigation area id |
|
| administrativeAreaLevel2Id | integer | the administrative area level 2 id |
|
| administrativeAreaLevel1Id | integer | the administrative area level 1 id |
|
| countryCode | string | the country code |
|
| page | integer | which page to display |
|
| perPage | integer | number of results, integer between 1 and 100 |
|
| locale | string | which locale to return (accepted values are fr, en, it, es, de, nl or pt) |
|
| expandTranslations | boolean | whether to expand the translations |
|
| includeNonRentable | boolean | set to true to return non-rentable resources |
|
| test | boolean | set to true to return test resources |
Response
The following HTTP status codes may be returned, optionally with a response resource.
| Status code | Description | Resource |
|---|---|---|
| 200 | OK the filtered ressources list |
Resource[] |
| 400 | Bad Request bad input parameter |
|
| 401 | Unauthorized authorization information is missing or invalid. |