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

commit_results

This method is run after the calculate_base_building method has been successfully run. It locks the inputs and returns the results of the building calculation. Before it is run the user should be shown a copy of the inputs and asked to verify that they are correct.

Parameters

NameDescriptionTypeLengthRequiredOptions
user_keyAPI key for accessstring32Yes
building_idID of building to commitint
Yes

Response

ElementDescription
label_resultSee the retrieve_label_results method for a description of this object


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 lockedThis method has already been run on this building.
Building #### has not been calculatedThis method can only be run after the calculate_base_building method has been successfully run.
Building #### inputs have been modified since last calculationThe inputs have been modified since the results were calculated. Run the calculate_base_building method again.