generate_custom_label

Similar to generate_label, except that whereas generate_label relies on an upgrade package building that is generated automatically by a call to calculate_package_building, this method instead allows the user to supply a second building that will be treated as the upgrade package building. For example, to generate a label that shows the energy efficiency gain from upgrading just a home's windows, a user could submit the home's current state, then create a second building representing the same home but with the windows upgraded. By passing the first home to base_building_id and the second as custom_building_id, a label would be generated showing the difference.

Parameters

Notes

base_building_id,

custom_building_id

building_id

These values are required together if either is entered

Required if above sequence is unentered

Response

Roles

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