Also see air_handler_types: List of Air Handler Types., fuel_types: List of Fuel Types., distribution_types: List of Distribution types., sink_source_types: List of Sink Sources., fan_controls: List of Fan Controls., terminal_units: List of Terminal Units., and plant_types: List of Plant 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":"Air Handler 1","fuel_type_id":1,"sink_source_type_id":1,"heating_vintage":2002,"cooling_vintage":2001,"heating_pieces_of_equipment":2,"cooling_pieces_of_equipment":2,"heating_efficiency":6.1,"cooling_efficiency":3.1,"heating_capacity":3,"cooling_capacity":7,"heating_air_handler_type_id":2,"cooling_air_handler_type_id":6,"heating_plant_id":null,"cooling_plant_id":null,"fan_motor_efficiency":2.2,"fan_efficiency":30,"has_economizer":null,"has_dcv":null,"fan_control_id":1,"terminal_unit_id":1,"distribution_type_id":2,"fan_static_pressure_reset":"true","supply_air_temp_type_id":":2"}
<?xml version="1.0" encoding="UTF-8"?>
<air_handler>
  <name type="string">Air Handler 3</name>
  <fuel-type-id type="integer">1</fuel-type-id>
  <sink-source-type-id type="integer">1</sink-source-type-id>
  <heating-vintage type="integer">2002</heating-vintage>
  <cooling-vintage type="integer">2001</cooling-vintage>
  <heating-pieces-of-equipment type="integer">2</heating-pieces-of-equipment>
  <cooling-pieces-of-equipment type="integer">2</cooling-pieces-of-equipment>
  <heating-efficiency type="float">6.1</heating-efficiency>
  <cooling-efficiency type="float">3.1</cooling-efficiency>
  <heating-capacity type="integer">3</heating-capacity>
  <cooling-capacity type="integer">7</cooling-capacity>
  <heating-air-handler-type-id type="integer">2</heating-air-handler-type-id>
  <cooling-air-handler-type-id type="integer">6</cooling-air-handler-type-id>
  <heating-plant-id nil="true"/>
  <cooling-plant-id nil="true"/>
  <fan-motor-efficiency type="float">2.2</fan-motor-efficiency>
  <fan-efficiency type="integer">30</fan-efficiency>
  <has-economizer nil="true"/>
  <has-dcv nil="true"/>
  <fan-control-id type="integer">1</fan-control-id>
  <terminal-unit-id type="integer">1</terminal-unit-id>
  <distribution-type-id type="integer">2</distribution-type-id>
  <fan-static-pressure-reset>true</fan-static-pressure-reset>
  <supply-air-temp-type-id>2</supply-air-temp-type-id>
</air_handler>

Params

Param name Description
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

sink_source_type_id
optional

Specifies sink source. Required if heating_zone_equipment_type_id is Heat Pump(3).

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

heating_pieces_of_equipment
optional

Number pieces of equipment for heating.

Validations:

  • Must be a Integer

cooling_pieces_of_equipment
optional

Number pieces of equipment for cooling.

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

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

fan_motor_efficiency
optional

Efficiency of fan motor (percentage).

Validations:

  • Must be a Float

fan_efficiency
optional

Efficiency of fan (percentage).

Validations:

  • Must be a Float

has_economizer
optional

True if has economizer, false otherwise.

Validations:

  • Must be one of: true, false.

fan_control_id
optional

Type of fan control (see /fan_controls).

Validations:

  • Must be a Integer

terminal_unit_id
optional

Type of terminal unit if distribution is Multiple Zone (see /terminal_units).

Validations:

  • Must be a Integer

heating_air_handler_type_id
required

Specifies type of heating.

Validations:

  • Must be a Integer

cooling_air_handler_type_id
required

Specifies type of cooling.

Validations:

  • Must be a Integer

distribution_type_id
optional

Distribution type for Multiple Zone (see /distribution_types).

Validations:

  • Must be a Integer

fan_static_pressure_reset
optional

fan_static_pressure_reset must be set if distribution_type is multi_zone and fan_control is variable

Validations:

  • Must be one of: true, false.

supply_air_temp_type_id
optional

sat_reset must be set if this has heating and cooling.

Validations:

  • Must be a Integer

has_dcv
optional

Can only be specified if Fan Control of Variable Air Volume is used.

Validations:

  • Must be one of: true, false.