Simulations
Energy Asset - Simulations

Simulations relating to building simulation runs.

Supported Formats

json
>>>

GET /api/v2/buildings/:building_id/simulations(:.format)
Retrieve all simulation runs belonging to the building.

Supported Formats

json

Errors

Code Description
401 Unauthorized - The "token" parameter MUST be provided for each service call. The user MUST be the owner of the building or the building MUST be shared with the user.
404 Not Found - The specified building is not available.
422 Unprocessable Entity - The form data contains errors.

Params

Param name Description
token
required

The token for user authentication.

Validations:

  • Must be a String

Returns

Code: 200

Description:

OK

Param name Description
id
required

The ID for the simulation run.

Validations:

  • Must be a Integer
rating
optional

The rating for the simulation run.

Validations:

  • Must be a Float
simulation_started_at
optional

The timestamp for when the simulation run was started.

Validations:

  • Must be a DateTime
simulation_completed_at
optional

The timestamp for when the simulation run was completed.

Validations:

  • Must be a DateTime
simulation_completion_type
optional

Validations:

  • Must be one of: failure because a full building simulation is not allowed, failure due to error, failure due to invalid building, success, success with alternate calculation method.
measures
required

The measure recommendations for the simulation run.

Validations:

  • Must be an Array of nested elements
measures[recommendation_id]
required

The unique identifier for the measure recommendation.

Validations:

  • Must be a String
measures[recommendation]
required

The description of the measure recommendation.

Validations:

  • Must be a String
measures[cost]
required

The qualitative cost of the measure recommendation.

Validations:

  • Must be a String
measures[end_use]
required

The end use for the measure recommendation.

Validations:

  • Must be a String
measures[end_use_subcategory]
optional

The end use subcategory for the measure recommendation.

Validations:

  • Must be a String
measures[energy_savings]
required

The qualitative energy savings for the measure recommendation.

Validations:

  • Must be a String
measures[upgrade_guide]
required

The URL for the “Learn more” upgrade guide for the measure recommendation.

Validations:

  • Must be a String
>>>

GET /api/v2/buildings/:building_id/simulations/:id(:.format)
Retrieve one simulation run that belongs to the building.

Supported Formats

json

Errors

Code Description
401 Unauthorized - The "token" parameter MUST be provided for each service call. The user MUST be the owner of the building or the building MUST be shared with the user.
404 Not Found - The specified building is not available.
422 Unprocessable Entity - The form data contains errors.

Params

Param name Description
token
required

The token for user authentication.

Validations:

  • Must be a String

Returns

Code: 200

Description:

OK

Param name Description
id
required

The ID for the simulation run.

Validations:

  • Must be a Integer
rating
optional

The rating for the simulation run.

Validations:

  • Must be a Float
simulation_started_at
optional

The timestamp for when the simulation run was started.

Validations:

  • Must be a DateTime
simulation_completed_at
optional

The timestamp for when the simulation run was completed.

Validations:

  • Must be a DateTime
simulation_completion_type
optional

Validations:

  • Must be one of: failure because a full building simulation is not allowed, failure due to error, failure due to invalid building, success, success with alternate calculation method.
measures
required

The measure recommendations for the simulation run.

Validations:

  • Must be an Array of nested elements
measures[recommendation_id]
required

The unique identifier for the measure recommendation.

Validations:

  • Must be a String
measures[recommendation]
required

The description of the measure recommendation.

Validations:

  • Must be a String
measures[cost]
required

The qualitative cost of the measure recommendation.

Validations:

  • Must be a String
measures[end_use]
required

The end use for the measure recommendation.

Validations:

  • Must be a String
measures[end_use_subcategory]
optional

The end use subcategory for the measure recommendation.

Validations:

  • Must be a String
measures[energy_savings]
required

The qualitative energy savings for the measure recommendation.

Validations:

  • Must be a String
measures[upgrade_guide]
required

The URL for the “Learn more” upgrade guide for the measure recommendation.

Validations:

  • Must be a String
>>>

POST /api/v2/buildings/:building_id/simulations(:.format)
Enqueue one simulation run that belongs to the building.

Supported Formats

json

Errors

Code Description
401 Unauthorized - The "token" parameter MUST be provided for each service call. The user MUST be the owner of the building or the building MUST be shared with the user.
404 Not Found - The specified building is not available.
422 Unprocessable Entity

Params

Param name Description
token
required

The token for user authentication.

Validations:

  • Must be a String
recommendation_ids
optional

The unique IDs for the recommendations to be applied to the building.

Validations:

  • Must be an array of String

Returns

Code: 200

Description:

OK

Param name Description
id
required

The ID for the simulation run.

Validations:

  • Must be a Integer
rating
optional

The rating for the simulation run.

Validations:

  • Must be a Float
simulation_started_at
optional

The timestamp for when the simulation run was started.

Validations:

  • Must be a DateTime
simulation_completed_at
optional

The timestamp for when the simulation run was completed.

Validations:

  • Must be a DateTime
simulation_completion_type
optional

Validations:

  • Must be one of: failure because a full building simulation is not allowed, failure due to error, failure due to invalid building, success, success with alternate calculation method.
measures
required

The measure recommendations for the simulation run.

Validations:

  • Must be an Array of nested elements
measures[recommendation_id]
required

The unique identifier for the measure recommendation.

Validations:

  • Must be a String
measures[recommendation]
required

The description of the measure recommendation.

Validations:

  • Must be a String
measures[cost]
required

The qualitative cost of the measure recommendation.

Validations:

  • Must be a String
measures[end_use]
required

The end use for the measure recommendation.

Validations:

  • Must be a String
measures[end_use_subcategory]
optional

The end use subcategory for the measure recommendation.

Validations:

  • Must be a String
measures[energy_savings]
required

The qualitative energy savings for the measure recommendation.

Validations:

  • Must be a String
measures[upgrade_guide]
required

The URL for the “Learn more” upgrade guide for the measure recommendation.

Validations:

  • Must be a String

Code: 422

Description:

Unprocessable Entity

Param name Description
building_id
optional

Validations:

  • Must be an array of String
recommendation_ids
optional

Validations:

  • Must be an array of String