BCI API Reference - MasterData - Green Building Ratings

BCI API Support Reference (version 1.0)

Master Data

Green Building Ratings

URL path:	REST Request	SOAP Request	Base
	http://api.bciaustralia.com/rest/greenbuildingratings.json	http://api.bciaustralia.com/greenbuildingratings.cfc?wsdl	http://api.bciaustralia.com/greenbuildingratings.cfc
Serializable:	Yes
Properties:
Methods:	getByQuery

getByQuery
`remote Array getByQuery ( numeric ref_item_id, string green_star_value_type, string green_star_value, string fields="", required string token )` Get Alias by Query (list of IDs) Methods of access are: SOAP: http://api.bciaustralia.com/greenbuildingratings.cfc?wsdl&method=getByQuery(&returnFormat=wddx / &returnFormat=json) REST: http://api.bciaustralia.com/rest/greenbuildingratings(.json / .xml) Output: Array Parameters: ref_item_id: numeric, optional - ID or comma-seperated list of IDs green_star_value_type: string, required - green_star_value_type (possible value: GREEN_BUILDING_RATING_STATUS,GREEN_BUILDING_RATING_LEVEL,GREEN_BUILDING_RATING_SCHEME) green_star_value: string, required - green_star_value fields: string, optional - passing valid field names for the return structure. Valid fields : ref_item_id token: string, required - allocated token for current login session

getByQuery


	
		remote
	
		Array
	
	getByQuery
	
	(
 	
		
		numeric
		
		ref_item_id,
		
		string
		
		green_star_value_type, 		
		
		string
		
		green_star_value, 		
		
		string
		
		fields="", 
		
		required string
		
		token 
	)

Get Alias by Query (list of IDs)

Methods of access are:

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

REST: http://api.bciaustralia.com/rest/greenbuildingratings(.json / .xml)

Output: Array

Parameters:
   ref_item_id: numeric, optional - ID or comma-seperated list of IDs
   green_star_value_type: string, required - green_star_value_type (possible value: GREEN_BUILDING_RATING_STATUS,GREEN_BUILDING_RATING_LEVEL,GREEN_BUILDING_RATING_SCHEME)
   green_star_value: string, required - green_star_value
   fields: string, optional - passing valid field names for the return structure. Valid fields : ref_item_id
   token: string, required - allocated token for current login session

Fields

Selectable fields for green star information

REF_ITEM_ID This identifier links back to GREEN_STAR_SCHEME_ID, GREEN_STAR_LEVEL_ID, GREEN_STAR_STATUS_ID as listed on the projects endpoint https://api.bciaustralia.com/doc/Projects.htm	LONG
GREEN_STAR_VALUE	STRING(1000)
GREEN_STAR_VALUE_TYPE	STRING(1000)