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., and terminal_units: List of Terminal Units..

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
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.