Services relating to distribution_types of the Energy Asset Tool

Supported Formats

json, xml

GET /api/v1/distribution_types/:id
Retrieve the distribution_type with the specific ID.

Also see Air Handlers.

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":3,"display_name":"Multiple Zone","for_heating":true,"for_cooling":true,"sort_order":4,"created_at":"2022-05-16T15:14:00.186Z","updated_at":"2022-05-16T15:14:00.186Z","for_water_heater":false,"service_name":"multi-zone ahu"}
<?xml version="1.0" encoding="UTF-8"?>
<distribution-type>
  <id type="integer">3</id>
  <display-name>Multiple Zone</display-name>
  <for-heating type="boolean">true</for-heating>
  <for-cooling type="boolean">true</for-cooling>
  <sort-order type="integer">4</sort-order>
  <created-at type="dateTime">2022-05-16T15:14:00Z</created-at>
  <updated-at type="dateTime">2022-05-16T15:14:00Z</updated-at>
  <for-water-heater type="boolean">false</for-water-heater>
  <service-name>multi-zone ahu</service-name>
</distribution-type>

GET /api/v1/distribution_types
Retrieve all distribution_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":2,"display_name":"Single Zone","for_heating":true,"for_cooling":true,"sort_order":3,"created_at":"2022-05-16T15:14:00.180Z","updated_at":"2022-05-16T15:14:00.180Z","for_water_heater":false,"service_name":"single-zone ahu"},{"id":3,"display_name":"Multiple Zone","for_heating":true,"for_cooling":true,"sort_order":4,"created_at":"2022-05-16T15:14:00.186Z","updated_at":"2022-05-16T15:14:00.186Z","for_water_heater":false,"service_name":"multi-zone ahu"},{"id":4,"display_name":"Distributed","for_heating":false,"for_cooling":false,"sort_order":5,"created_at":"2022-05-16T15:14:00.186Z","updated_at":"2022-05-16T15:14:00.186Z","for_water_heater":true,"service_name":"distributed"},{"id":5,"display_name":"Looped","for_heating":false,"for_cooling":false,"sort_order":6,"created_at":"2022-05-16T15:14:00.186Z","updated_at":"2022-05-16T15:14:00.186Z","for_water_heater":true,"service_name":"looped"}]
<?xml version="1.0" encoding="UTF-8"?>
<distribution-types type="array">
  <distribution-type>
    <id type="integer">2</id>
    <display-name>Single Zone</display-name>
    <for-heating type="boolean">true</for-heating>
    <for-cooling type="boolean">true</for-cooling>
    <sort-order type="integer">3</sort-order>
    <created-at type="dateTime">2022-05-16T15:14:00Z</created-at>
    <updated-at type="dateTime">2022-05-16T15:14:00Z</updated-at>
    <for-water-heater type="boolean">false</for-water-heater>
    <service-name>single-zone ahu</service-name>
  </distribution-type>
  <distribution-type>
    <id type="integer">3</id>
    <display-name>Multiple Zone</display-name>
    <for-heating type="boolean">true</for-heating>
    <for-cooling type="boolean">true</for-cooling>
    <sort-order type="integer">4</sort-order>
    <created-at type="dateTime">2022-05-16T15:14:00Z</created-at>
    <updated-at type="dateTime">2022-05-16T15:14:00Z</updated-at>
    <for-water-heater type="boolean">false</for-water-heater>
    <service-name>multi-zone ahu</service-name>
  </distribution-type>
  <distribution-type>
    <id type="integer">4</id>
    <display-name>Distributed</display-name>
    <for-heating type="boolean">false</for-heating>
    <for-cooling type="boolean">false</for-cooling>
    <sort-order type="integer">5</sort-order>
    <created-at type="dateTime">2022-05-16T15:14:00Z</created-at>
    <updated-at type="dateTime">2022-05-16T15:14:00Z</updated-at>
    <for-water-heater type="boolean">true</for-water-heater>
    <service-name>distributed</service-name>
  </distribution-type>
  <distribution-type>
    <id type="integer">5</id>
    <display-name>Looped</display-name>
    <for-heating type="boolean">false</for-heating>
    <for-cooling type="boolean">false</for-cooling>
    <sort-order type="integer">6</sort-order>
    <created-at type="dateTime">2022-05-16T15:14:00Z</created-at>
    <updated-at type="dateTime">2022-05-16T15:14:00Z</updated-at>
    <for-water-heater type="boolean">true</for-water-heater>
    <service-name>looped</service-name>
  </distribution-type>
</distribution-types>