Buildings
Buildings

Services relating to buildings

Supported Formats

json
>>>

GET /api/v2/buildings/:id
Find building with the given ID (owned by the current user or shared with the current user).

Supported Formats

json

Errors

Code Description
401 Unauthorized - The "token" parameter MUST be provided for each service call.
422 Unprocessable Entity - The specified parameters MUST be valid for each service call.

Returns

Code: 200

Description:

OK

Param name Description
id
required

The ID of the building.

Validations:

  • Must be a Integer
name
required

The name of the building.

Validations:

  • Must be a String
owner
required

The user that owns the building.

Validations:

  • Must be a Hash
owner[id]
required

The ID of the user that owns the building.

Validations:

  • Must be a Integer
owner[email]
required

The email address of the user that owns the building.

Validations:

  • Must be a String
owner[first_name]
required

The first name of the user that owns the building.

Validations:

  • Must be a String
owner[last_name]
required

The last name of the user that owns the building.

Validations:

  • Must be a String
owner[organization]
optional

The organization to which the user that owns the building is assigned.

Validations:

  • Must be a Hash
owner[organization][id]
required

The ID of the organization to which the user that owns the building is assigned.

Validations:

  • Must be a Integer
owner[organization][name]
required

The name of the organization to which the user that owns the building is assigned.

Validations:

  • Must be a String
owner[site_admin]
required

Set to “true” if the user that owns the building is a site administrator.

Validations:

  • Must be one of: true, false.
owner[type]
required

The type of the user. Always: “User”

Validations:

  • Must be one of: User.
status
required

The status of the building.

Validations:

  • Must be one of: Editing, Running, Rated.
created_at
required

The timestamp for when the building was created.

Validations:

  • Must be a DateTime
updated_at
required

The timestamp for when the building was last modified.

Validations:

  • Must be a DateTime
html_url
required

The URL for the building in the Asset Score tool.

Validations:

  • Must be a String
>>>

GET /api/v2/buildings/:id/recommendations
Find all measures that are applicable for the building wth the given ID (owned by the current user or shared with the current user).

Supported Formats

json

Errors

Code Description
401 Unauthorized - The "token" parameter MUST be provided for each service call.
422 Unprocessable Entity - The specified parameters MUST be valid for each service call.

Returns

Code: 200

Description:

OK

Param name Description
recommendation_id
required

The unique identifier for the measure recommendation.

Validations:

  • Must be a String
recommendation
required

The description of the measure recommendation.

Validations:

  • Must be a String
cost
required

The qualitative cost of the measure recommendation.

Validations:

  • Must be a String
end_use
required

The end use for the measure recommendation.

Validations:

  • Must be a String
end_use_subcategory
optional

The end use subcategory for the measure recommendation.

Validations:

  • Must be a String
energy_savings
required

The qualitative energy savings for the measure recommendation.

Validations:

  • Must be a String
upgrade_guide
required

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

Validations:

  • Must be a String
>>>

GET /api/v2/buildings/:id/envelope
Download the envelope evaluation JSON file for the building with the given ID (owned by the current user or shared with the current user).

Supported Formats

json

Errors

Code Description
401 Unauthorized - The "token" parameter MUST be provided for each service call.
422 Unprocessable Entity - The specified parameters MUST be valid for each service call.
>>>

GET /api/v2/buildings/:id/model_one_eio
Download the current/proposed Energy Plus model for the building with the given ID (owned by the current user or shared with the current user).

Supported Formats

json

Errors

Code Description
401 Unauthorized - The "token" parameter MUST be provided for each service call.
422 Unprocessable Entity - The specified parameters MUST be valid for each service call.
>>>

GET /api/v2/buildings/:id/model_one_html
Download the current/proposed Energy Plus model summary for the building with the given ID (owned by the current user or shared with the current user).

Supported Formats

json

Errors

Code Description
401 Unauthorized - The "token" parameter MUST be provided for each service call.
422 Unprocessable Entity - The specified parameters MUST be valid for each service call.
>>>

GET /api/v2/buildings/:id/model_one_idf
Download the current/proposed IDF file for the building with the given ID (owned by the current user or shared with the current user).

Supported Formats

json

Errors

Code Description
401 Unauthorized - The "token" parameter MUST be provided for each service call.
422 Unprocessable Entity - The specified parameters MUST be valid for each service call.
>>>

GET /api/v2/buildings/:id/model_one_osm
Download the current/proposed Open Studio model for the building with the given ID (owned by the current user or shared with the current user).

Supported Formats

json

Errors

Code Description
401 Unauthorized - The "token" parameter MUST be provided for each service call.
422 Unprocessable Entity - The specified parameters MUST be valid for each service call.
>>>

GET /api/v2/buildings/:id/model_one_xml
Download the current/proposed Open Studio model summary for the building with the given ID (owned by the current user or shared with the current user).

Supported Formats

json

Errors

Code Description
401 Unauthorized - The "token" parameter MUST be provided for each service call.
422 Unprocessable Entity - The specified parameters MUST be valid for each service call.
>>>

GET /api/v2/buildings/:id/model_one_zip
Download the ZIP archive of the current/proposed Energy Plus model for the building with the given ID (owned by the current user or shared with the current user).

Supported Formats

json

Errors

Code Description
401 Unauthorized - The "token" parameter MUST be provided for each service call.
422 Unprocessable Entity - The specified parameters MUST be valid for each service call.
>>>

GET /api/v2/buildings/:id/model_two_eio
Download the recommended/baseline Energy Plus model for the building with the given ID (owned by the current user or shared with the current user).

Supported Formats

json

Errors

Code Description
401 Unauthorized - The "token" parameter MUST be provided for each service call.
422 Unprocessable Entity - The specified parameters MUST be valid for each service call.
>>>

GET /api/v2/buildings/:id/model_two_html
Download the recommended/baseline Energy Plus model summary for the building with the given ID (owned by the current user or shared with the current user).

Supported Formats

json

Errors

Code Description
401 Unauthorized - The "token" parameter MUST be provided for each service call.
422 Unprocessable Entity - The specified parameters MUST be valid for each service call.
>>>

GET /api/v2/buildings/:id/model_two_idf
Download the recommended/baseline IDF file for the building with the given ID (owned by the current user or shared with the current user).

Supported Formats

json

Errors

Code Description
401 Unauthorized - The "token" parameter MUST be provided for each service call.
422 Unprocessable Entity - The specified parameters MUST be valid for each service call.
>>>

GET /api/v2/buildings/:id/model_two_osm
Download the recommended/baseline Open Studio model for the building with the given ID (owned by the current user or shared with the current user).

Supported Formats

json

Errors

Code Description
401 Unauthorized - The "token" parameter MUST be provided for each service call.
422 Unprocessable Entity - The specified parameters MUST be valid for each service call.
>>>

GET /api/v2/buildings/:id/model_two_xml
Download the recommended/baseline Open Studio model summary for the building with the given ID (owned by the current user or shared with the current user).

Supported Formats

json

Errors

Code Description
401 Unauthorized - The "token" parameter MUST be provided for each service call.
422 Unprocessable Entity - The specified parameters MUST be valid for each service call.
>>>

GET /api/v2/buildings/:id/model_two_zip
Download the ZIP archive of the recommended/baseline Energy Plus model for the building with the given ID (owned by the current user or shared with the current user).

Supported Formats

json

Errors

Code Description
401 Unauthorized - The "token" parameter MUST be provided for each service call.
422 Unprocessable Entity - The specified parameters MUST be valid for each service call.
>>>

GET /api/v2/buildings/:id/report
Download the PDF report for the building with the given ID (owned by the current user or shared with the current user).

Supported Formats

json

Errors

Code Description
401 Unauthorized - The "token" parameter MUST be provided for each service call.
422 Unprocessable Entity - The specified parameters MUST be valid for each service call.
>>>

GET /api/v2/rp/buildings
All Buildings.

Supported Formats

json

Errors

Code Description
401 Unauthorized
422 Unprocessable Entity

Params

Param name Description
token
required

The token for user authentication.

Validations:

  • Must be a String
per_page
optional

The number of results per page (max 100). Default: 50

Validations:

  • Must be a Integer
page
optional

Page number of the results to fetch. Default: 1

Validations:

  • Must be a Integer
report_type
optional

Specifies the audit report type for the results.

Validations:

  • Must be a Integer
status
optional

Specifies the submission status for the results. Can be one of: “Editing”, “Submitted”

Validations:

  • Must be a Integer
ownership
optional

Specifies the ownership for the results you want returned. Can be one of: “Mine”, “Shared”

Validations:

  • Must be a Integer