Retrieves a set of values describing the results of a label's simulation run.
Many of the values returned by this method will not be populated unless generate_label has been called for the building, because the values are not calculated until a label is generated. Alternatively, you can call generate_custom_label before calling this method. This requires much less processing time, but because generate_custom_label does not trigger the simulation of an upgrade package (this is the reason the call is much faster), the result set will contain base values but no upgrade package values. | Name | Description | Type | Required | | session_token | Get from the get_session_token method | string | Yes | | user_key | API key for access | string | Yes | | building_id | ID of building to retrieve | int | Yes |
Response
| Element | Description | | address | Street address | | city | City | | state | State 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 | Role | Access | | Assessor | May only call for buildings created by the Assessor | | Partner | May only call for buildings created by an Assessor associated with the same Partner | | Admin | May call for any building |
| 