| URL path: | REST Request | SOAP Request | Base |
| http://api.bciaustralia.com/rest/greenstars.json | http://api.bciaustralia.com/greenstars.cfc?wsdl | http://api.bciaustralia.com/greenstars.cfc | |
| Serializable: | Yes | ||
| Properties: | |||
| Methods: | getByPK, getByQuery |
| getByPK |
|---|
remote
Struct
getByPK
(
required numeric
green_star_id,
string
fields="",
required string
token
)
Get Green Star question and value by ID Methods of access are: SOAP: http://api.bciaustralia.com/greenstars.cfc?wsdl&method=getByPK&green_star_id={green_star_id}(&returnFormat=wddx / &returnFormat=json) REST: http://api.bciaustralia.com/rest/greenstars/{green_star_id}(.json / .xml) Output: Structure Parameters: green_star_id: numeric, required - ID of the specific green star id of information requested fields: string, optional - passing valid field names for the return structure. Valid fields : GREEN_STAR_ID token: string, required - allocated token for current login session |
| getByQuery |
remote
Array
getByQuery
(
string
green_star_id,
string
fields="",
required string
token
)
Get Green Star by Query (list of IDs) Methods of access are: SOAP: http://api.bciaustralia.com/greenstars.cfc?wsdl&method=getByQuery(&returnFormat=wddx / &returnFormat=json) REST: http://api.bciaustralia.com/rest/greenstars(.json / .xml) Output: Array Parameters: green_star_id: numeric, optional - ID or comma-seperated list of IDs fields: string, optional - passing valid field names for the return structure. Valid fields : green_star_id token: string, required - allocated token for current login session |
| Fields | ||||||
|---|---|---|---|---|---|---|
| Selectable fields for green star information | ||||||
|