Home Energy Scoring‎ > ‎API Definitions‎ > ‎API Methods‎ > ‎< 2017.1‎ > ‎

calculate_package_building

Runs calculations for the package building. This method can take up to 60 seconds to return. If a connection cannot be reliably maintained then the is_polling input should be set to True.

Parameters

Name Description Type Length Required Options
user_key API key for access string 32 Yes
building_id ID of building to calculate int Yes
log_type Debugging flags string No Comma separate list. See notes below
is_polling Flag to return response immediately boolean No True, False. Default is False

Notes:
  • If is_polling is set to True the method will return immediately and the status of the calculations may be checked by using the calculate_package_building_poll method.
  • The log_type is a developer input used for logging additional data for help with debugging. The input is a comma separate list of flags including any of the following:
    • LOG_XML - save the submitted and returned xml
    • LOG_INTERMEDIATE - save intermediate data to the intermediate_vars_log table
    • LOG_HOURLY - save hourly data files
    • LOG_BDL_SHOW - set the ##show BDL parameter
    • LOG_BDL_SHOW_DETAIL - set the ##showdetail BDL parameter
    • LOG_BDL_LIST - set the ##list BDL parameter
    • LOG_BDL_TRACEBACK - set the ##traceback BDL parameter
    • LOG_BDL_WRITE - set the ##write BDL parameter
    • LOG_BDL_SYMBOLTABLE - set the ##symboltable BDL parameter

Response

Element Description
result OK, FAIL
message Building ##### results calculated successfully (if is_polling set to False)
Calculating results for building #### (if is_polling set to True)


Errors

TextMeaning
API key is not authorizedYou need to submit a valid API key
No building found for building_id #####You need to submit a valid building_id
Building #### is not lockedThe commit_results method must be run first
calculate_package_building has already been run for building #####The calculate_package_building method can only be run once
FAIL doebdl failed with errors for run ####, see output fileAn error occurred in the simulation run. Please contact support with the returned run #.