Wiki

Case Status
Log In

Wiki

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

Last modified on 12/5/2019 3:32 PM by User.

Tags:

API Call - Port - List/View Plans

Description:

This call is designed to list and return port plans or photos based on an input of the desired port's ID.

Parameters:
format (for listing port plans) json, xml, html, kml
format (for viewing port plans) json, xml, html, rss, kml, gif, jpg
port_id The port's unique ID.
plan_id The port plan's unique ID to the associated port.

Call Format:

For a list of port plans: 
            /api/port/<port_id>/plans.<format>
            /api/port/<port_id>/photos.<format>

For viewing port plans: 
            /api/port/<port_id>/plan/<plan_id>.<format>
            /api/port/<port_id>/plan/<photo_id>.<format>

Example 1:

Input: http://www.findaport.com/api/port/540/plans.html
Output: An HTML page showing a list of links to the port plans and thumbnails available for the port of Copenhagen (port ID = 540).

Example 2:

Input:
Output: An image of North Harbour in Copenhagen (port plan ID = 630).

Plan List Output Fields:

Output Fields Descriptions Examples
piuid Port identifier 540
port Port name Copenhegan
plan_id Plan identifier  627
title Plan title Layout
subtitle Plan subtitle Ocean Pier
plan_type_id Plan Type ID 8
rotation Plan rotation 121.92
north Coordinate value 55.72737
south Coordinate value 55.66529
east Coordinate value 12.64977
west Coordinate value 12.5752
date_georeferenced Date when port plan was geo-referenced. Fri Aug 31 11:08:00 +0000 2007
version Version 14283

Plan Output Fields

 

Output Fields Descriptions Examples
id Plan identifier 627
piuid  Port identifier 540
sort_order Sort Order 3
title Plan title Layout
subtitle Plan subtitle Ocean Pier
plan_type_id Plan Type ID 8
land_port Land Port True/False
colour Colour image True/False
link * URL to image http://www.findaport.com/port/<piuid>/plan/<plan_id>.gif?key=<api_key>
rotation Plan rotation 121.92
north Coordinate value 55.72737
south Coordinate value 55.66529
east Coordinate value 12.64977
west Coordinate value 12.5752
version Version 14283

* Note: the URL link to the image requires an API key, although the URL doesn't include the "/api/" section

Interpreting Plan_type_ids

An XML file, plantypes.xml, can be downloaded from here.

plan_type_id Title Description Filetype
1 BerthDiagrams These plans show a close up of the berth with regard to the surrounding attributes. .gif
2 BerthEquipment This style covers a real multitude of types, but the basics are, Crane Arrangement, Chicksan Arrangements, Hose Arrangements, Buoy Arrangements, Ship Loaders.  .gif
3 BerthLocations Usually shows a general layout of the port. .gif
4 Country Country plan,  should also show all ports listed for that country and if possible the major airports.  .gif
5 Miscellaneous In theory there should be no miscellaneous plans but on occasion one appears that cannot be fitted in under the above headings .gif
6 MooringDiagrams Showing the vessel alongside the berth with lines Forward and Aft, giving the idea of the vessels tie-up .gif
7 NotAllocated Those plans which have not yet been allocated a plan type. Default. .gif
8 PortLocation These plans should show a general guideline to the location of the port with relation to any salient points or features, (Lighthouses, Bays, Peninsulas, etc).  .gif
9 SMR Shipmaster reports .gif
10 Photographs This style is self-explanatory. See also type 20 .jpg
11 Flag The national or state flag for a region .gif
12 Limits Anchorages, Port Limits and Exclusion Zones .gif
20 Photos New style (cdr) photos, which should be included in any general retrieval of photographs  .jpg

Output example:

Example Output - Plans List

 

Example Output - Plan

Previous API Call: Port - List/View ACE Reports        Next API Call: Port - List Sections      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.