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":"Water Heater 1","fuel_type_id":1,"distribution_type_id":1,"uses_heat_pump":"f","water_heater_efficiency":8.2,"tank_insulation_thickness":2.2,"tank_insulation_r_value":16.0,"tank_volume":100}
<water_heater>
  <name type="string">Water Heater 2</name>
  <fuel-type-id type="integer">1</fuel-type-id>
  <distribution-type-id type="integer">1</distribution-type-id>
  <uses-heat-pump>f</uses-heat-pump>
  <water-heater-efficiency type="float">8.2</water-heater-efficiency>
  <tank-insulation-thickness type="float">2.2</tank-insulation-thickness>
  <tank-insulation-r-value type="float">16.0</tank-insulation-r-value>
  <tank-volume type="integer">100</tank-volume>
</water_heater>

Params

Param name Description
fuel_type_id
required

Fuel Type

Validations:

  • Must be a Integer

distribution_type_id
required

Distribution Type

Validations:

  • Must be a Integer

water_heater_efficiency
optional

Water heater efficiency (percentage)

Validations:

  • Must be a Float

tank_insulation_thickness
optional

Tank insulation thickness (inches)

Validations:

  • Must be a Float

tank_insulation_r_value
optional

Tank insulation R-value (F*ft2*h/Btu)

Validations:

  • Must be a Float

tank_volume
optional

Tank volume (gallons)

Validations:

  • Must be a Float