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.
>>>

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.
>>>

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