Buildings offline
Buildings

Services relating to buildings

Supported Formats

json
>>>

GET /api/api/v2/rp/buildings_offline
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
recent_updates
optional

Specifies the number of recently updated buildings to fetch.

Validations:

  • Must be a Integer
>>>

GET /api/api/v2/rp/buildings_offline/:id/facilities
Get all facilities for a building

POST /api/api/v2/rp/buildings_offline/:id/facilities
Add or edit a facility

Supported Formats

json

Errors

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

Params

Param name Description
token
required

The token for user authentication.

Validations:

  • Must be a String
heating_plants
optional

Heating plant attributes (see model for full list)

Validations:

  • Must be an array of Hash
cooling_plants
optional

Cooling plant attributes (see model for full list)

Validations:

  • Must be an array of Hash
condenser_plants
optional

Condenser plant attributes (see model for full list)

Validations:

  • Must be an array of Hash
hvac_systems
optional

HVAC system attributes (see model for full list)

Validations:

  • Must be an array of Hash
pump_systems
optional

Pump system attributes (see model for full list)

Validations:

  • Must be an array of Hash
>>>

GET /api/v2/rp/buildings_offline/:id
One Building

Supported Formats

json

Errors

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

Params

Param name Description
token
required

The token for user authentication.

Validations:

  • Must be a String