submit_hpwes

Allows a set of HPwES (Home Performance With Energy Star) properties to be stored for a building.

Parameters

Note that parameters which are not required will be treated as if they were null if not passed, resulting in the field's value being removed.
Name Description Type Required Options
 session_token  Get from the get_session_token method string Yes  
user_key API key for access string Yes  
 building_id  The building to update  string Yes  
 improvement_installation_start_date  The date on which HPwES upgrade installation began, in YYYY-MM-DD format date No  
 improvement_installation_completion_date  The date on which HPwES upgrade installation was completed, in YYYY-MM-DD format date No  
 contractor_zip_code  Five-digit postal code of the contractor installing the HPwES upgrades string No  
 contractor_business_name  The name of the contracting business installing the HPwES upgrades string No
 is_income_eligible_program  Whether or not the HPwES upgrades were performed for a homeowner participating in an income-eligible program boolean No  true, false



Response

Element Description
 result  "OK"



Roles

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

Role Access
AssessorAccess allowed for the Assessor who created the building
Partner Access not allowed
 Admin  Access not allowed