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