| URL path: | REST Request | SOAP Request | Base |
| http://api.bciaustralia.com/rest/regions.json | http://api.bciaustralia.com/regions.cfc?wsdl | http://api.bciaustralia.com/regions.cfc | |
| Serializable: | Yes | ||
| Properties: | |||
| Methods: | getByPK, getByQuery |
| getByPK |
|---|
remote
Struct
getByPK
(
required numeric
bciregionid,
string
fields="",
required string
token
)
Get Country Name and Abbreviation by ID Methods of access are: SOAP: http://api.bciaustralia.com/regions.cfc?wsdl&method=getByPK&bciregionid={bciregionid}(&returnFormat=wddx / &returnFormat=json) REST: http://api.bciaustralia.com/rest/regions/{bciregionid}(.json / .xml) Output: Structure Parameters: bciregionid: numeric, required - ID of the specific BCI Region of information requested fields: string, optional - passing valid field names for the return structure. Valid fields : BCIREGIONID, BCIREGION_NAME, COUNTRYID, STATE token: string, required - allocated token for current login session |
| getByQuery |
remote
Array
getByQuery
(
string
bciregionid,
string
bciregion_name,
string
state,
string
countryid,
string
fields="",
required string
token
)
Get Country by Query (By Country Name, list of IDs) Methods of access are: SOAP: http://api.bciaustralia.com/regions.cfc?wsdl&method=getByQuery(&returnFormat=wddx / &returnFormat=json) REST: http://api.bciaustralia.com/rest/regions(.json / .xml) Output: Array Parameters: bciregionid: numeric, optional - ID or comma-seperated list of BCI Region IDs bciregion_name: string, optional - Name or comma-separated list of BCI region names being searched countryid: numeric, optional - ID or comma-seperated list of country IDs state: numeric, optional - ID or comma-seperated list of state IDs fields: string, optional - passing valid field names for the return structure. Valid fields : BCIREGIONID, BCIREGION_NAME, COUNTRYID, STATE token: string, required - allocated token for current login session |
| Fields | ||||||||
|---|---|---|---|---|---|---|---|---|
| Selectable fields for region information | ||||||||
|