Services relating to plants of the Energy Asset Tool

Supported Formats

json, xml

GET /api/v1/plants/:id
Retrieve the plant with the specific ID.
NOTE: draft_type_id refers to resources from the boiler_types endpoint.

Also see To retrieve a list of valid draft_type_id values (draft_type_id ==> boiler_type_id).

Supported Formats

json, xml

Errors

Code Description
401 Unauthorized - ensure token is being passed with each service call.
404 Unsupported operation
500 Unspecified error on server.

Examples

{"building_id":1,"capacity":1.0,"compressor_type_id":1,"condenser_type_id":1,"created_at":"2013-07-26T16:07:07Z","draft_type_id":1,"efficiency":7.15,"fuel_type_id":1,"id":1,"is_heating":true,"name":"Plant 1","pieces_of_equipment":3,"plant_type_id":1,"updated_at":"2013-07-26T16:07:07Z","vintage":2003}
<plant>
<building-id type="integer">8</building-id>
<capacity type="float" nil="true"/>
<compressor-type-id type="integer">1</compressor-type-id>
<condenser-type-id type="integer">1</condenser-type-id>
<created-at type="datetime">2013-06-28T19:28:57Z</created-at>
<draft-type-id type="integer">1</draft-type-id>
<efficiency type="float" nil="true"/>
<fuel-type-id type="integer">2</fuel-type-id>
<id type="integer">10</id>
<is-heating type="boolean">true</is-heating>
<name type="string">plt1</name>
<pieces-of-equipment type="integer" nil="true"/>
<plant-type-id type="integer">3</plant-type-id>
<updated-at type="datetime">2013-07-01T18:16:21Z</updated-at>
<vintage type="integer" nil="true"/>
</plant>

GET /api/v1/buildings/:building_id/plants
Retrieve all plants belonging to the building.

Supported Formats

json, xml

Errors

Code Description
401 Unauthorized - ensure token is being passed with each service call.
404 Unsupported operation
500 Unspecified error on server.

POST /api/v1/buildings/:building_id/plants
Create a new plant. This will associate the plant with the building and return a Plant object with unique ID assigned.
NOTE: draft_type_id refers to resources from the boiler_types endpoint.

Also see List of valid draft_type_id values (draft_type_id ==> boiler_type_id)., List of plant types., List of condenser types (required with Chiller)., List of compressor types (required with Chiller), List of chiller pump control types (optional with Chiller)., List of condenser pump control types (optional with Chiller)., and List of cooling tower fan control types (optional with Chiller)..

Supported Formats

json, xml

Errors

Code Description
401 Unauthorized - ensure token is being passed with each service call.
404 Unsupported operation
500 Unspecified error on server.

Examples

{"name":"Plant 1","plant_type_id":1,"is_heating":false,"vintage":2003,"pieces_of_equipment":3,"efficiency":7.15,"capacity":1,"condenser_type_id":1,"compressor_type_id":1,"fuel_type_id":1,"draft_type_id":1,"chiller_pump_control_type_id":1,"condenser_pump_control_type_id":1,"chilled_water_reset":true,"cooling_tower_fan_control_type_id":1}
<plant>
  <name type="string">Plant 4</name>
  <plant-type-id type="integer">1</plant-type-id>
  <is-heating type="boolean">false</is-heating>
  <vintage type="integer">2003</vintage>
  <pieces-of-equipment type="integer">3</pieces-of-equipment>
  <efficiency type="float">7.15</efficiency>
  <capacity type="integer">1</capacity>
  <condenser-type-id type="integer">1</condenser-type-id>
  <compressor-type-id type="integer">1</compressor-type-id>
  <fuel-type-id type="integer">1</fuel-type-id>
  <draft-type-id type="integer">1</draft-type-id>
  <chiller-pump-control-type-id type="integer">1</chiller-pump-control-type-id>
  <condenser-pump-control-type-id type="integer">1</condenser-pump-control-type-id>
  <chilled-water-reset type="boolean">true</chilled-water-reset>
  <cooling-tower-fan-control-type-id type="integer">1</cooling-tower-fan-control-type-id>
</plant>

Params

Param name Description
plant_type_id
required

Specifies type of plant.

Validations:

  • Must be a Integer

is_heating
optional

Specifies if this is heating (true) or cooling (false).

Validations:

  • Must be one of: true, false.

vintage
optional

Year of manufacture. Must be between 1800-current year.

Validations:

  • Must be a Integer

pieces_of_equipment
optional

Number of pieces of equipment

Validations:

  • Must be a Integer

efficiency
optional

Efficiency for heating/cooling. Must be between 1.0-8.0 (COP units) or 1-100 (Percentage).

Validations:

  • Must be a Float

capacity
optional

Average output capacity (KBTU/HR)

Validations:

  • Must be a Float

condenser_type_id
optional

Specifies type of condenser. Required if chiller.

Validations:

  • Must be a Integer

compressor_type_id
optional

Specifies type of compressor. Required if chiller.

Validations:

  • Must be a Integer

fuel_type_id
optional

Specifies type of fuel. Required if boiler.

Validations:

  • Must be a Integer

draft_type_id
optional

Specifies type of boiler. Required if boiler.

Validations:

  • Must be a Integer

chiller_pump_control_type_id
optional

Specifies type of chiller pump.

Validations:

  • Must be a Integer

condenser_pump_control_type_id
optional

Specifies type of condenser pump if condenser_type is water.

Validations:

  • Must be a Integer

chilled_water_reset
optional

Specifies chilled water reset. Must be set if plant type is Chiller.

Validations:

  • Must be one of: true, false.

cooling_tower_fan_control_type_id
optional

Specifies type of cooling tower fan control if condenser_type is water.

Validations:

  • Must be a Integer


PUT /api/v1/plants/:id
Update an existing plant. Nothing is returned.

Supported Formats

json, xml

Errors

Code Description
401 Unauthorized - ensure token is being passed with each service call.
404 Unsupported operation
500 Unspecified error on server.

Params

Param name Description
plant_type_id
required

Specifies type of plant.

Validations:

  • Must be a Integer

is_heating
optional

Specifies if this is heating (true) or cooling (false).

Validations:

  • Must be one of: true, false.

vintage
optional

Year of manufacture. Must be between 1800-current year.

Validations:

  • Must be a Integer

pieces_of_equipment
optional

Number of pieces of equipment

Validations:

  • Must be a Integer

efficiency
optional

Efficiency for heating/cooling. Must be between 1.0-8.0 (COP units) or 1-100 (Percentage).

Validations:

  • Must be a Float

capacity
optional

Average output capacity (KBTU/HR)

Validations:

  • Must be a Float

condenser_type_id
optional

Specifies type of condenser. Required if chiller.

Validations:

  • Must be a Integer

compressor_type_id
optional

Specifies type of compressor. Required if chiller.

Validations:

  • Must be a Integer

fuel_type_id
optional

Specifies type of fuel. Required if boiler.

Validations:

  • Must be a Integer

draft_type_id
optional

Specifies type of boiler. Required if boiler.

Validations:

  • Must be a Integer

chiller_pump_control_type_id
optional

Specifies type of chiller pump.

Validations:

  • Must be a Integer

condenser_pump_control_type_id
optional

Specifies type of condenser pump if condenser_type is water.

Validations:

  • Must be a Integer

chilled_water_reset
optional

Specifies chilled water reset. Must be set if plant type is Chiller.

Validations:

  • Must be one of: true, false.

cooling_tower_fan_control_type_id
optional

Specifies type of cooling tower fan control if condenser_type is water.

Validations:

  • Must be a Integer


DELETE /api/v1/plants/:id
Delete the plant and disassociate it from the building. Nothing is returned.

Supported Formats

json, xml

Errors

Code Description
401 Unauthorized - ensure token is being passed with each service call.
404 Unsupported operation
500 Unspecified error on server.