retrieve_inputs - Home Energy Score: Engineering Documentation

Home Energy Scoring‎ > ‎Application Program Interface Definitions‎ > ‎API Methods‎ > ‎

retrieve_inputs

Returns a full set of the building inputs.

XSD: Sandbox Production
XSD Documentation (the calculate xsd is used by all methods that use the root element building_info)
PHP Sample Code

Parameters

Name	Description	Type	Length	Required	Options
user_key	API key for access	string	32	Yes
building_id	ID of building to validate	int		Yes

Response

Name	Description
result	OK
message	Building #### inputs retrieved
about	Inputs about the building in general
zone	Inputs about the building envelope
systems	Inputs about the building systems

Notes

The method returns a complete set of the current building inputs in the same structure as the submit_inputs method.
Empty inputs are returned as Null.

Errors

Error Text	Meaning
API key is not authorized	You need to submit a valid API key
No building found for building_id #####	You need to submit a valid building_id