Zone equipments
Energy Asset - ZoneEquipments

Services relating to zone_equipments of the Energy Asset Tool

Supported Formats

json, xml
>>>

GET /api/v1/zone_equipments/:id", "Retrieve the zone_equipment with the specific 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,"cooling_capacity":22.2,"cooling_efficiency":4.4,"cooling_pieces_of_equipment":3,"cooling_plant_id":null,"cooling_vintage":2003,"cooling_zone_equipment_type_id":6,"created_at":"2015-01-12T17:43:42Z","fuel_type_id":1,"heating_capacity":33.3,"heating_efficiency":3.3,"heating_pieces_of_equipment":2,"heating_plant_id":null,"heating_vintage":2002,"heating_zone_equipment_type_id":3,"id":1,"name":"Zone Equipment 1","updated_at":"2015-01-12T17:43:42Z"}
<zone-equipment>
  <building-id type="integer">1</building-id>
  <cooling-capacity type="float">22.2</cooling-capacity>
  <cooling-efficiency type="float">4.4</cooling-efficiency>
  <cooling-pieces-of-equipment type="integer">3</cooling-pieces-of-equipment>
  <cooling-plant-id type="integer" nil="true"/>
  <cooling-vintage type="integer">2003</cooling-vintage>
  <cooling-zone-equipment-type-id type="integer">6</cooling-zone-equipment-type-id>
  <created-at type="datetime">2015-01-12T17:45:45Z</created-at>
  <fuel-type-id type="integer">1</fuel-type-id>
  <heating-capacity type="float">33.3</heating-capacity>
  <heating-efficiency type="float">3.3</heating-efficiency>
  <heating-pieces-of-equipment type="integer">2</heating-pieces-of-equipment>
  <heating-plant-id type="integer" nil="true"/>
  <heating-vintage type="integer">2002</heating-vintage>
  <heating-zone-equipment-type-id type="integer">3</heating-zone-equipment-type-id>
  <id type="integer">2</id>
  <name type="string">ze1</name>
  <updated-at type="datetime">2015-01-12T17:45:45Z</updated-at>
</zone-equipment>
>>>

GET /api/v1/buildings/:building_id/zone_equipments", "Retrieve all zone_equipments 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/zone_equipments
Create a new zone_equipment. This will associate the zone_equipment with the building and return a ZoneEquipment object with unique ID assigned.

Also see zone_equipment_types: List of heating/cooling types. and fuel_types: List of fuel types..

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":"Zone Equipment 1","heating_zone_equipment_type_id":3,"cooling_zone_equipment_type_id":6,"heating_plant_id":null,"cooling_plant_id":null,"heating_vintage":2002,"cooling_vintage":2003,"heating_pieces_of_equipment":2,"cooling_pieces_of_equipment":3,"heating_efficiency":3.3,"cooling_efficiency":4.4,"heating_capacity":33.3,"cooling_capacity":22.2,"fuel_type_id":1,"building_id":1}
<zone_equipment>
  <name type="string">Zone Equipment 3</name>
  <heating-zone-equipment-type-id type="integer">3</heating-zone-equipment-type-id>
  <cooling-zone-equipment-type-id type="integer">6</cooling-zone-equipment-type-id>
  <heating-plant-id nil="true"/>
  <cooling-plant-id nil="true"/>
  <heating-vintage type="integer">2002</heating-vintage>
  <cooling-vintage type="integer">2003</cooling-vintage>
  <heating-pieces-of-equipment type="integer">2</heating-pieces-of-equipment>
  <cooling-pieces-of-equipment type="integer">3</cooling-pieces-of-equipment>
  <heating-efficiency type="float">3.3</heating-efficiency>
  <cooling-efficiency type="float">4.4</cooling-efficiency>
  <heating-capacity type="float">33.3</heating-capacity>
  <cooling-capacity type="float">22.2</cooling-capacity>
  <fuel-type-id type="integer">1</fuel-type-id>
  <building-id type="integer">1</building-id>
</zone_equipment>

Params

Param name Description
heating_zone_equipment_type_id
required

Specifies type of heating.

Validations:

  • Must be a Integer
cooling_zone_equipment_type_id
required

Specifies type of cooling.

Validations:

  • Must be a Integer
heating_plant_id
optional

Type of plant for heating (see /plant_types).

Validations:

  • Must be a Integer
cooling_plant_id
optional

Type of plant for cooling (see /plant_types).

Validations:

  • Must be a Integer
heating_vintage
optional

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

Validations:

  • Must be a Integer
cooling_vintage
optional

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

Validations:

  • Must be a Integer
cooling_efficiency
optional

Efficiency for cooling. Must be between 1.0-8.0 (COP units)

Validations:

  • Must be a Float
heating_efficiency
optional

Efficiency for heating. Must be between 1.0-8.0 (COP units) or 1-100 (Percentage) if heating_zone_equipment_type_id is 2 (Single Zone Central Furnace).

Validations:

  • Must be a Float
heating_capacity
optional

Average output capacity (tons).

Validations:

  • Must be a Float
cooling_capacity
optional

Average output capacity (tons).

Validations:

  • Must be a Float
fuel_type_id
optional

Specifies type of fuel. Required if heating_zone_equipment_type_id is Single Zone Central Furnace(2) or Heat Pump(3)

Validations:

  • Must be a Integer
>>>

PUT /api/v1/zone_equipments/:id
Update an existing zone_equipment. Nothing is returned.

Also see zone_equipment_types: List of heating/cooling types. and fuel_types: List of fuel types..

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
heating_zone_equipment_type_id
required

Specifies type of heating.

Validations:

  • Must be a Integer
cooling_zone_equipment_type_id
required

Specifies type of cooling.

Validations:

  • Must be a Integer
heating_plant_id
optional

Type of plant for heating (see /plant_types).

Validations:

  • Must be a Integer
cooling_plant_id
optional

Type of plant for cooling (see /plant_types).

Validations:

  • Must be a Integer
heating_vintage
optional

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

Validations:

  • Must be a Integer
cooling_vintage
optional

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

Validations:

  • Must be a Integer
cooling_efficiency
optional

Efficiency for cooling. Must be between 1.0-8.0 (COP units)

Validations:

  • Must be a Float
heating_efficiency
optional

Efficiency for heating. Must be between 1.0-8.0 (COP units) or 1-100 (Percentage) if heating_zone_equipment_type_id is 2 (Single Zone Central Furnace).

Validations:

  • Must be a Float
heating_capacity
optional

Average output capacity (tons).

Validations:

  • Must be a Float
cooling_capacity
optional

Average output capacity (tons).

Validations:

  • Must be a Float
fuel_type_id
optional

Specifies type of fuel. Required if heating_zone_equipment_type_id is Single Zone Central Furnace(2) or Heat Pump(3)

Validations:

  • Must be a Integer
>>>

DELETE /api/v1/zone_equipments/:id
Delete the zone_equipment 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.