Menu
Home Template Basics Find Vessels

Find Vessels

To use this GET request you will need to following information

  • a-api-key provided by Gatehouse
  • token retrieved from /authentication/login

Request

Retrieving vessels only requires the above properties to be used correctly. After obtaining them you can retrieve all the vessels by appending this /vessels to the endpoint URL

Response

Correct usage results in 200 response (created) in the format shown below

The request has succeeded. The meaning of the success depends on the HTTP method:
– GET: The resource has been fetched and is transmitted in the message body.

[
  {
    "id": integer,
    "name": string
  },
  ...
]

Example – List of locodes

[
  {
    "id": 1, 
    "name": "HMM Algeciras"
  },
  ...
]
Updated on 05 May, 2021