List companies (paginated)
Returns a list of all the companies in the Booking Manager System that manages their resources availability in real time. This list provides the ids of the companies that are available for syncing.
Request
GET https://api.digital-nautic.com/v3/companies
Query parameters
| Parameter name | Value | Description | Additional |
|---|---|---|---|
| id | integer | the company id |
|
| cityId | integer | the city of the company head office |
|
| navigationAreaId | integer | the navigation area of the company head office |
|
| administrativeAreaLevel2Id | integer | the administrative area level 2 of the company head office (also known as department in some countries) |
|
| administrativeAreaLevel1Id | integer | the administrative area level 1 of the company head office (also known as region in some countries) |
|
| countryCode | string | the country of the company head office |
|
| page | integer | which page to display |
|
| perPage | integer | number of results, integer between 1 and 100 |
|
| partners | boolean | set to true to return only companies that agreed to your terms of services, set to false to get those who refused the terms of services |
|
| test | boolean | set to true to return test companies |
Response
The following HTTP status codes may be returned, optionally with a response resource.
| Status code | Description | Resource |
|---|---|---|
| 200 | OK the filtered company list |
Company[] |
| 400 | Bad Request bad input parameter |
|
| 401 | Unauthorized authorization information is missing or invalid. |