Home Energy Scoring‎ > ‎API Definitions‎ > ‎API Methods‎ > ‎2017.2‎ > ‎

retrieve_inputs

Retrieves all inputs that were used to create a building.

Parameters

NameDescriptionTypeRequired
 session_token Get from the get_session_token methodstringYes
user_keyAPI key for accessstringYes
 building_id ID of building to retrieve intYes



Response

Except for the "result" and "message" fields, the response is identical to the input of the submit_inputs method.

ElementDescription
result"OK"
 message "Building #<building_id> inputs retrieved"
 about See the documentation of the "about" section in submit_inputs
 zone See the documentation of the "zone" section in submit_inputs
 systems See the documentation of the "systems" section in submit_inputs



Roles

Method access is limited by the roles assigned the user to whom the session token was assigned

RoleAccess
AssessorMay only call for buildings created by the Assessor
PartnerMay only call for buildings created by an Assessor associated with the same Partner
 Admin May call for any building