Wiki

Case Status
Log In

Wiki

 
Findaport API Documentati…  Reference Data»API XML/JSON Objects
  
Page Collections
Attributes
Hierarchy
  • RSS Feed

Last modified on 02/09/2022 10:06 by User.

Tags:

API XML/JSON Objects

 

Table of Contents
  1. Object: Port
  2. Object: Plan
  3. Object: Country
  4. Object: ACE Report
  5. Object: Locale
  6. Object: Weather
  7. Object: RSS

Object: Port

Available for:

Outputs: 

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
wx_id Weather identifier 4004
wx_name Name of nearest location where the weather information is available, when it is not available for the port location itself. Abenra
header Header XHTML  

[Back to top]

Object: Plan

Available for:

Outputs: 

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
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
id Plan identifier 84
sort_order Tradition order of plans within the port. 6
plan_type_id Plan type identifier 5
land_port Orientation of the plan (landscape/portrait) Landscape=true
colour Whether image has colour true
link link to image  
point Centre coordinates of image  

[Back to top]

 

Object: Country

Available for:

Outputs: 

Output Fields Descriptions Examples
locode Country UN/LOCODE AS
country Country name American Samoa
is_dependency_q Whether the country is a dependency or not. 0
dependency_of UN/LOCODE of country being dependent upon.  US
geo_sort_order Value for geographic search. 6160
land_locked Whether the country is landlocked.  

[Back to top]

 

Object: ACE Report

Available for:

Outputs: 

Output Fields Descriptions Examples
ace_id ACE report identifier 71597
piuid Port identifier 193
rep_date Date reported Wed Jan 01 00:00:00 +0000 1986
author_id Author identifier 14677
heading ACE report heading Shipmaster's Report
report The ACE report content New port of Shahid Rejaie is now in operation. 24 hours day working except reefer vessels which work from 0700–1100 and 1400–2300 hrs.

[Back to top]

 

Object: Locale

Available for:

Outputs: 

Output fields Descriptions Examples
id Unique identifier 603
locode Country UN/LOCODE AU
state State code Qld
island Island name Phillip Is
zone Zone name West of Thursday Island
full_name Location's full name Qld, Australia - [West of Thursday Island]
parent_id Parent location identifier 10000

[Back to top]

 

Object: Weather

Available for:

Outputs: 

Output fields Descriptions Examples
id Weather identifier for the requested port.  255
lc Location name Jeddah
cy Country name Saudi Arabia
ct Continent  Asia
tp Location type City
hr The hour of the displayed weather information. 0600
day The day of the displayed weather information. Wed
dayn The date number of the displayed weather information. 11
mon The month of the displayed weather information. 05
yr The year of the displayed weather information. 2011
no Day number of the weather forecast. 1
mx Maximum temperature in degree celsius. 36
mn Minimum temperature in degree celsius. 24
wx Weather symbol identifier. 1

[Back to top]

 

Object: RSS

Available for:

Outputs: 

Output Fields Descriptions Examples
title News title Info for the newly constructed port Ngqura, South Africa, updated
link Link to the full news article.  http://www.findaport.com/news/250
description News description <p>Information amendments are available under charts, max. size, approaches, pilotage, berths and container facilities.</p>
pubDate Published date Wed, 11 May 2011 12:43:23 GMT
guid   http://www.findaport.com/news/250
author Author info@findaport.com (Findaport)

[Back to top]

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.