PortCalls Info (NOTN)

If you wish to use the api outlined below, please see the data user documentation here. If wish to become a data provider, please create a support ticket.

Introduction

PortCalls Info (NOTN) provides track and trace of a vessel calling at the specified port (port call). The response represents a port call at the port and contains relevant event data.

Api Request

Base Urls

A data consumer accesses the provider system through the NxtPort NOTN system.

• Base URL for Acceptance: https://api-uat.nxtport.eu/ipcsa-trackandtrace/v4

• Base URL for Production: https://api.nxtport.eu/ipcsa-trackandtrace/v4

HTTP verb: GET

Endpoint: {{BaseUrl}}/portcalls_info

Headers

Parameters

The parameter names are case sensitive

In addition to the specified mandatory fields in the above list, the request should also contain the optional parameters in the following way (possible combinations):

• IdPortCall: The service will search the port call by the supplied ID.

• or IMO Vessel + ETA: The service will search the port call of the related vessel in the submitted arrival date (estimated date, so there can be a margin of 6 days; three days before and three days after).

• or VesselName + ETA: The service will return the port call of the related vessel (based on exact name search, but not case sensitive). The estimated date will be managed like the previous parameter combination.

Response

• 200: Successful. Vessel data (see content specification) is added in json format.

• 204: Successful but no content

• 400: Bad request. Mandatory parameters have not been received or date format is not correct. Ensure that the parameters are sent correctly (Caps sensitive), the required fields are included and the date format is correct.

• 403: Forbidden. You don’t have an active digital handshake with the data provider from which you are requesting data

• 404: not found. The port you entered is not known to the NoTN platform. Ensure that the port is known. If you think something may be wrong, please create a support ticket.

• 500: Internal server error, please create a support ticket.

Content specification:

PortCall type:

Example Response

{
  "version": "4.3",
  "list": [
      {
        "version": "4.3",
        "IdPortCall": "37521",
        "Port": "ESBCN",
        "IMOVessel": "9152258", 
        "VesselName": "ABU DHABI", 
        "Carrier": "UASC",
        "CallSign": "A6OG",
        "ETA": "2013-02-05T22:00:00CET", 
        "ATA": "2013-02-05T22:12:00CET", 
        "ETD": "2013-02-06T04:00:00CET", 
        "ATD": "2013-02-06T08:03:00CET"
      } 
  ]
}