retrieve_label_results

Retrieves a set of values describing the results of a label's simulation run. Note that if this is called before calculate_package_building has been called, all fields relating to the package building will be empty

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

ElementDescription
addressStreet address
 city City
 stateState code (AK, CA, etc.)
 zip_code USPS Zip Code
 conditioned_floor_area Conditioned floor area
 year_built Year building was constructed
 cooling_present Does the building have air conditioning (1=Yes, 0=No)
 base_score Score of the base building (1-10)
 package_score Score of the package building (1-10)
 cost_savings Difference in utility costs between the base and package buildings ($)
 assessment_type Type of assessment
 assessment_date Date assessment was done
 label_number Label number
 qualified_assessor_id ID of the assessor who performed the assessment
 hescore_version Version of HEScore API used to calculate the score
 utility_electric Electricity use for the base building (kWh)
 utility_natural_gas Natural gas use for the base building (therms)
 utility_fuel_oil Fuel oil use for the base building (gallons)
 utility_lpg LPG use for the base building (gallons)
 utility_cord_wood Cord wood use for the base building (cords)
 utility_pellet_wood Pellet wood use for the base building (pounds)
 utility_generated Electricity generated by the base building (kWh)
 source_energy_total Total source energy use of the base building (MBtu)
 source_energy_asset Asset source energy use of the base building (MBtu)




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