| URL path: | REST Request | SOAP Request | Base |
| http://api.bciaustralia.com/rest/countries.json | http://api.bciaustralia.com/countries.cfc?wsdl | http://api.bciaustralia.com/countries.cfc | |
| Serializable: | Yes | ||
| Properties: | |||
| Methods: | getByPK, getByQuery |
| 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.bciaustralia.com/countries.cfc?wsdl&method=getByPK&countryid={countryid}(&returnFormat=wddx / &returnFormat=json) REST: http://api.bciaustralia.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.bciaustralia.com/countries.cfc?wsdl&method=getByQuery(&returnFormat=wddx / &returnFormat=json) REST: http://api.bciaustralia.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 | ||||
|