Services relating to fuel_types of the Energy Asset Tool

Supported Formats

json, xml

GET /api/v1/fuel_types/:id
Retrieve the fuel_type with the specific ID.

Also see Plants.

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

{"id":1,"display_name":"Natural Gas","sort_order":1,"created_at":"2022-05-16T15:14:02.513Z","updated_at":"2022-05-16T15:14:02.513Z","service_name":"natural-gas","district_heating":false,"district_cooling":false,"boiler":true,"furnace":true,"heat_pump":false,"hot_water":true}
<?xml version="1.0" encoding="UTF-8"?>
<fuel-type>
  <id type="integer">1</id>
  <display-name>Natural Gas</display-name>
  <sort-order type="integer">1</sort-order>
  <created-at type="dateTime">2022-05-16T15:14:02Z</created-at>
  <updated-at type="dateTime">2022-05-16T15:14:02Z</updated-at>
  <service-name>natural-gas</service-name>
  <district-heating type="boolean">false</district-heating>
  <district-cooling type="boolean">false</district-cooling>
  <boiler type="boolean">true</boiler>
  <furnace type="boolean">true</furnace>
  <heat-pump type="boolean">false</heat-pump>
  <hot-water type="boolean">true</hot-water>
</fuel-type>

GET /api/v1/fuel_types
Retrieve all 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

[{"id":1,"display_name":"Natural Gas","sort_order":1,"created_at":"2022-05-16T15:14:02.513Z","updated_at":"2022-05-16T15:14:02.513Z","service_name":"natural-gas","district_heating":false,"district_cooling":false,"boiler":true,"furnace":true,"heat_pump":false,"hot_water":true},{"id":2,"display_name":"Electricity","sort_order":2,"created_at":"2022-05-16T15:14:02.513Z","updated_at":"2022-05-16T15:14:02.513Z","service_name":"electricity","district_heating":false,"district_cooling":false,"boiler":true,"furnace":true,"heat_pump":true,"hot_water":true},{"id":3,"display_name":"District Hot Water","sort_order":3,"created_at":"2022-05-16T15:14:02.513Z","updated_at":"2022-05-16T15:14:02.513Z","service_name":"purchased-hot-water","district_heating":true,"district_cooling":false,"boiler":false,"furnace":false,"heat_pump":false,"hot_water":false},{"id":4,"display_name":"District Steam","sort_order":4,"created_at":"2022-05-16T15:14:02.516Z","updated_at":"2022-05-16T15:14:02.516Z","service_name":"purchased-steam","district_heating":true,"district_cooling":false,"boiler":false,"furnace":false,"heat_pump":false,"hot_water":false},{"id":5,"display_name":"Fuel Oil","sort_order":5,"created_at":"2022-05-16T15:14:02.516Z","updated_at":"2022-05-16T15:14:02.516Z","service_name":"distillate-oil","district_heating":false,"district_cooling":false,"boiler":true,"furnace":true,"heat_pump":false,"hot_water":false},{"id":6,"display_name":"Propane","sort_order":6,"created_at":"2022-05-16T15:14:02.516Z","updated_at":"2022-05-16T15:14:02.516Z","service_name":"propane","district_heating":false,"district_cooling":false,"boiler":true,"furnace":true,"heat_pump":false,"hot_water":false},{"id":7,"display_name":"District Chilled Water","sort_order":7,"created_at":"2022-05-16T15:14:02.523Z","updated_at":"2022-05-16T15:14:02.523Z","service_name":"purchased-chilled-water","district_heating":false,"district_cooling":true,"boiler":false,"furnace":false,"heat_pump":false,"hot_water":false}]
<?xml version="1.0" encoding="UTF-8"?>
<fuel-types type="array">
  <fuel-type>
    <id type="integer">1</id>
    <display-name>Natural Gas</display-name>
    <sort-order type="integer">1</sort-order>
    <created-at type="dateTime">2022-05-16T15:14:02Z</created-at>
    <updated-at type="dateTime">2022-05-16T15:14:02Z</updated-at>
    <service-name>natural-gas</service-name>
    <district-heating type="boolean">false</district-heating>
    <district-cooling type="boolean">false</district-cooling>
    <boiler type="boolean">true</boiler>
    <furnace type="boolean">true</furnace>
    <heat-pump type="boolean">false</heat-pump>
    <hot-water type="boolean">true</hot-water>
  </fuel-type>
  <fuel-type>
    <id type="integer">2</id>
    <display-name>Electricity</display-name>
    <sort-order type="integer">2</sort-order>
    <created-at type="dateTime">2022-05-16T15:14:02Z</created-at>
    <updated-at type="dateTime">2022-05-16T15:14:02Z</updated-at>
    <service-name>electricity</service-name>
    <district-heating type="boolean">false</district-heating>
    <district-cooling type="boolean">false</district-cooling>
    <boiler type="boolean">true</boiler>
    <furnace type="boolean">true</furnace>
    <heat-pump type="boolean">true</heat-pump>
    <hot-water type="boolean">true</hot-water>
  </fuel-type>
  <fuel-type>
    <id type="integer">3</id>
    <display-name>District Hot Water</display-name>
    <sort-order type="integer">3</sort-order>
    <created-at type="dateTime">2022-05-16T15:14:02Z</created-at>
    <updated-at type="dateTime">2022-05-16T15:14:02Z</updated-at>
    <service-name>purchased-hot-water</service-name>
    <district-heating type="boolean">true</district-heating>
    <district-cooling type="boolean">false</district-cooling>
    <boiler type="boolean">false</boiler>
    <furnace type="boolean">false</furnace>
    <heat-pump type="boolean">false</heat-pump>
    <hot-water type="boolean">false</hot-water>
  </fuel-type>
  <fuel-type>
    <id type="integer">4</id>
    <display-name>District Steam</display-name>
    <sort-order type="integer">4</sort-order>
    <created-at type="dateTime">2022-05-16T15:14:02Z</created-at>
    <updated-at type="dateTime">2022-05-16T15:14:02Z</updated-at>
    <service-name>purchased-steam</service-name>
    <district-heating type="boolean">true</district-heating>
    <district-cooling type="boolean">false</district-cooling>
    <boiler type="boolean">false</boiler>
    <furnace type="boolean">false</furnace>
    <heat-pump type="boolean">false</heat-pump>
    <hot-water type="boolean">false</hot-water>
  </fuel-type>
  <fuel-type>
    <id type="integer">5</id>
    <display-name>Fuel Oil</display-name>
    <sort-order type="integer">5</sort-order>
    <created-at type="dateTime">2022-05-16T15:14:02Z</created-at>
    <updated-at type="dateTime">2022-05-16T15:14:02Z</updated-at>
    <service-name>distillate-oil</service-name>
    <district-heating type="boolean">false</district-heating>
    <district-cooling type="boolean">false</district-cooling>
    <boiler type="boolean">true</boiler>
    <furnace type="boolean">true</furnace>
    <heat-pump type="boolean">false</heat-pump>
    <hot-water type="boolean">false</hot-water>
  </fuel-type>
  <fuel-type>
    <id type="integer">6</id>
    <display-name>Propane</display-name>
    <sort-order type="integer">6</sort-order>
    <created-at type="dateTime">2022-05-16T15:14:02Z</created-at>
    <updated-at type="dateTime">2022-05-16T15:14:02Z</updated-at>
    <service-name>propane</service-name>
    <district-heating type="boolean">false</district-heating>
    <district-cooling type="boolean">false</district-cooling>
    <boiler type="boolean">true</boiler>
    <furnace type="boolean">true</furnace>
    <heat-pump type="boolean">false</heat-pump>
    <hot-water type="boolean">false</hot-water>
  </fuel-type>
  <fuel-type>
    <id type="integer">7</id>
    <display-name>District Chilled Water</display-name>
    <sort-order type="integer">7</sort-order>
    <created-at type="dateTime">2022-05-16T15:14:02Z</created-at>
    <updated-at type="dateTime">2022-05-16T15:14:02Z</updated-at>
    <service-name>purchased-chilled-water</service-name>
    <district-heating type="boolean">false</district-heating>
    <district-cooling type="boolean">true</district-cooling>
    <boiler type="boolean">false</boiler>
    <furnace type="boolean">false</furnace>
    <heat-pump type="boolean">false</heat-pump>
    <hot-water type="boolean">false</hot-water>
  </fuel-type>
</fuel-types>