Wiki

Case Status
Log In

Wiki

 
List of API Calls»API Call - Country - View Coun…
  • RSS Feed

Last modified on 4/17/2012 12:36 PM by User.

Tags:

API Call - Country - View Country

Description:

This call is designed to list the country information based on an input of the desired country's locode.

Parameters:
locode The country's unique locode.
format html, json, xml

Call Format:

/api/country/<locode>.<format>; or
/api/country/<locode>/info.<format>

The two calls return the same information.

<locode>.xml only applies to the xml format; there is no locode/info.xml call

Example 1: XML data describing a country

Input: http://www.findaport.com/api/country/es.xml
Output: An XML page showing the information for Spain (locode =es).

Example 2:

Input: http://www.findaport.com/api/country/es.html
Output: An HTML page of information about the country

Example 3:

Input: http://www.findaport.com/api/country/es/info.html
Output:  

Output Fields:

XML

Output fields Description Examples
locode Country UN/LOCODE ES
country Country name Spain
is_dependency_q Whether the country is a dependency or not. 0
dependency_of UN/LOCODE of country being dependent upon.  
when_dependency   Sp
geo_sort_order Value for geographic search. 2200
also_see_q    
land_locked Is country without a shore 0
version Version number of country record 68346

HTML

Output Fields Descriptions Examples
HTML Text "id" and "class" attributes can be used with a CSS to provide formatting to meet your own requirements  

Output example:

XML

Example Output

HTML

Example Output

 

 Previous API Call: Country - List Ports    Next API Call: Locale - List Locales                                    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.