Wiki

Case Status
Log In

Wiki

 
List of API Calls»API Call - Port - Section - Li…
  • RSS Feed

Last modified on 19/01/2023 10:29 by User.

Tags:

API Call - Port - Section - List Sections

Description:

This call is designed to produce a list of section headings available for a port based on an input of the port's ID.

Parameters:
format json, xml
port_id The port's unique ID.

Call Format:

/api/port/<port_id>/sections.<format>

Example 1:

Input: https://www.findaport.com/api/port/216/sections.xml
Output:

An XML output listing all the sections available for the port of Barcelona (port ID = 216).
The listing of all possible section headings is available here.

Output Fields and Categories:

The API call returns the following fields:

  • port_id
  • name (port name)
  • locode

It also extracts the following section categories where applicable for the nominated port:

  • Pre Arrival
  • Arrival
  • Communications
  • Berthing Ops
  • Cargo
  • Pollution
  • Facilities
  • Security
  • Local info
  • Shore
  • Crew
  • Misc
  • Report

Output example:

Example Output

Also see

Previous API Call: Port - List/View Plans                 Next API Call: Port - View Section                        Return to API Call Summary

 


Need an API Key? Click here here for more details.

 

If you would like to find out more about Findaport.com or our Findaport API service, please contact us at info@portinfo.co.uk. Shipping Guides Ltd are recognised industry specialists in publishing port and harbour information for your various port entry requirements. For more information on our products, please visit www.portinfo.co.uk.