Wiki

Case Status
Log In

Wiki

 
List of API Calls»API Call - Port - View Port
  • RSS Feed

Last modified on 11/26/2015 10:44 AM by User.

Tags:

API Call - Port - View Port

Description:

This call is designed to list different types of port information based on an input of the port's ID.

Parameters:
format json, xml, html, rss
port_id The port's unique ID.
type Type of information requested (brief (""), summary ("/summary"), full ("/info"))

Call Format:

/api/port/<port_id>[<type>].<format>

Example 1:

Input: http://www.findaport.com/api/port/20.html
Output: An HTML page showing brief information for the port of Adelaide (port ID = 20); including the port name, coordinates and a short comment.

Example 2:

Input:
Output: A JSON file showing the port summary for the port of Algiers (port ID = 65).

Example 3:

Input:
Output: A RSS file showing the detailed port information for the port of Xinyu (port ID = 4118).

Output Fields:

For brief port information.

Output Fields Descriptions Examples
piuid Port identifier 1
port Port name Aabenraa
locode Country UN/LOCODE  DK
type Type of entry Port
port_lvl Port level 4
locale_id Locale identifier 99
unctad_port_code   AAB
symbol_id Port image symbol ID 807
lat Latitude of port 55.033333
lng Longitude of port 9.433333
parent_id PIUID of the port which contains the information about this port. 1
web Web address http://www.aabenraaport.dk
has_detail Whether port has detailed information (1 or 0). 1
has_summary Whether port has summary information (1 or 0). 1
plans_count Number of plans and photos available. 3
reports_count Number of ACE reports available. 2
wx_id Weather identifier (No longer used) 4004
wx_name Name of nearest location where the weather information is available, when it is not available for the port location itself. Abenra
verified_date Date of entry when last verified 2008-04-21
version Version 69316
header Header in HTML <div id="hdr"> ... </div>

Output example:

Example Output - <port_id>.xml

 

Example Output - Summary (unstructured HTML)

 

Example Output - Information (unstructured HTML)

Previous API Call: Port - View Section              Next API Call: Port - View Table of Contents                     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.