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

calculate_package_building

Runs calculations for the upgrade package building, which generates a set of recommended upgrades to cost-effectively improve the energy efficiency of the base building.  This method may only be called on a building after calculate_base_building and commit_results have been called for that building.  After this method has been called, the retrieve_* methods are fully populated with all information about the building and all recommendations.


Parameters

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



Response

ElementDescription
resultFAIL or OK
 message If "result" is FAIL, contains an error message. If "result" is OK, then contains "Building #<building_id> results calculated successfully."



Roles

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

RoleAccess
AssessorMust be the assessor who created the building
PartnerMust be the partner associated with the assessor who created the building
 Admin Allowed to calculate any building