BCI API Support Reference (version 1.0)


Master Data

Countries



URL path: REST Request SOAP Request Base
http://api.bciasia.com/rest/countries.json http://api.bciasia.com/countries.cfc?wsdl http://api.bciasia.com/countries.cfc
Serializable: Yes
Properties:
Methods: getByPK, getByQuery
Localization and translation:
(BCI Asia API only)
Refer to the Localization and translation page for details.


getByPK
remote Struct getByPK ( required numeric countryid, string fields="", required string token )

Get Country Name and Abbreviation by ID

Methods of access are:

SOAP: http://api.bciasia.com/countries.cfc?wsdl&method=getByPK&countryid={countryid}(&returnFormat=wddx / &returnFormat=json)

REST: http://api.bciasia.com/rest/countries/{countryid}(.json / .xml)

Output: Structure

Parameters:
   countryid: numeric, required - ID of the specific country of information requested
   fields: string, optional - passing valid field names for the return structure. Valid fields : COUNTRYID,COUNTRY_NAME
   token: string, required - allocated token for current login session

getByQuery
remote Array getByQuery ( string countryid, string country_name, string fields="", required string token )

Get Country by Query (By Country Name, list of IDs)

Methods of access are:

SOAP: http://api.bciasia.com/countries.cfc?wsdl&method=getByQuery(&returnFormat=wddx / &returnFormat=json)

REST: http://api.bciasia.com/rest/countries(.json / .xml)

Output: Array

Parameters:
   countryid: numeric, optional - ID or comma-seperated list of country IDs
   country_name: string, optional - Name or comma-separated list of country names being searched
   fields: string, optional - passing valid field names for the return structure. Valid fields : COUNTRYID,COUNTRY_NAME
   token: string, required - allocated token for current login session

Fields
Selectable fields for country information
COUNTRYIDLONG
COUNTRY_NAMESTRING(1000)
Translations
COUNTRY_NAME_ZHSTRING(1000)
COUNTRY_NAME_THSTRING(1000)
COUNTRY_NAME_IDSTRING(1000)
COUNTRY_NAME_VISTRING(1000)