• Asset Score v2

Resources

Building sync
BuildingSync

Resource	Description
GET /api/v2/building_sync/download/rp/buildings/:id	Export the building with the given ID. Response for a successful request is a BuildingSync XML document.
GET /api/v2/building_sync/download/rp/nyc/properties/:id	Export the NYC property with the given ID. Response for a successful request is a BuildingSync XML document.
POST /api/v2/building_sync/upload	Import Buildings. Response for a successful request is an object with the assigned unique IDs for the new buildings.

Buildings
Buildings

Resource	Description
GET /api/v2/buildings/:id	Find building with the given ID (owned by the current user or shared with the current user).
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).
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).
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).
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).
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).
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).
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).
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).
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).
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).
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).
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).
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).
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).
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).
GET /api/v2/rp/buildings	All Buildings.

Cities
Cities

Resource	Description
POST /api/v2/rp/cities/:id/users	Register a user account.
POST /api/v2/rp/cities/:id/users/assign	Assign a user to the city's organization.
GET /api/v2/rp/cities	All cities
GET /api/v2/rp/cities/:id	All submissions for city.

Cities reports
Reports

Resource	Description
GET /api/v2/rp/cities/:city_id/reports	All reports
GET /api/v2/rp/cities/:city_id/reports/:id	One report.

Simple buildings
Simple Buildings

Resource	Description
POST /api/v2/simple_buildings	Create a new Quick Building Assessment Tool (QBAT) building. The response for a successful request is the assigned unique ID of the new building.

Simulations
Energy Asset - Simulations

Resource	Description
GET /api/v2/buildings/:building_id/simulations(:.format)	Retrieve all simulation runs belonging to the building.
GET /api/v2/buildings/:building_id/simulations/:id(:.format)	Retrieve one simulation run that belongs to the building.
POST /api/v2/buildings/:building_id/simulations(:.format)	Enqueue one simulation run that belongs to the building.

Submissions
Submissions

Resource	Description
GET /api/v2/rp/submissions/:id	One submission.
POST /api/v2/rp/submissions/:id/mark_as_compliant	Mark submission as compliant.
POST /api/v2/rp/submissions/:id/mark_as_pending	Mark submission as pending.
POST /api/v2/rp/submissions/:id/mark_as_received	Mark submission as received.
POST /api/v2/rp/submissions/:id/mark_as_rejected	Mark submission as rejected.

Table downloads
Table Exports

Resource	Description
GET /api/v2/table/exports	All Table Exports.
GET /api/v2/table/exports/:id	One Table Export.
GET /api/v2/table/exports/:id/download	Download File for Table Export.
POST /api/v2/table/exports	New Table Export.

Table uploads
Table Imports

Resource	Description
GET /api/v2/table/imports	All Table Imports.
GET /api/v2/table/imports/:id	One Table Import.
GET /api/v2/table/imports/:id/download	Download File for Table Import.
POST /api/v2/table/imports	New Table Import.

Users
Energy Asset - Users

Resource	Description
GET /api/v2/users	Retrieve a list of users. NOTE: Users are only allowed to view their own account.This call always returns a 404.
POST /api/v2/users/authenticate	Authenticate user to get API token. Response for a successful request will be an object including a token to be used with future API requests.
GET /api/v2/users/:id	Retrieve the user with the given ID. NOTE: Users are only allowed to view their own account.
POST /api/v2/users	Create a new user account. Response for a successful request is a complete User object with the assigned unique ID of the new user.Password must contain uppercase, lowercase, digit and a special character.
PUT /api/v2/users/:id	Update user account with given ID. Nothing is returned. NOTE: Users can only update their own account. Users NOT allowed to change role or organization.