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