Services relating to roof_types of the Energy Asset Tool

Supported Formats

json, xml

GET /api/v1/roof_types/:id
Retrieve the roof_type with the specific ID.

Also see Roofs.

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":"Metal surfacing","sort_order":1,"created_at":"2022-05-16T15:14:08.190Z","updated_at":"2022-05-16T15:14:08.190Z","service_name":"metal roof"}
<?xml version="1.0" encoding="UTF-8"?>
<roof-type>
  <id type="integer">1</id>
  <display-name>Metal surfacing</display-name>
  <sort-order type="integer">1</sort-order>
  <created-at type="dateTime">2022-05-16T15:14:08Z</created-at>
  <updated-at type="dateTime">2022-05-16T15:14:08Z</updated-at>
  <service-name>metal roof</service-name>
</roof-type>

GET /api/v1/roof_types
Retrieve all roof_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":"Metal surfacing","sort_order":1,"created_at":"2022-05-16T15:14:08.190Z","updated_at":"2022-05-16T15:14:08.190Z","service_name":"metal roof"},{"id":2,"display_name":"Shingles/Shakes","sort_order":2,"created_at":"2022-05-16T15:14:08.190Z","updated_at":"2022-05-16T15:14:08.190Z","service_name":"shingle roof"},{"id":3,"display_name":"Built-up w/ metal deck","sort_order":3,"created_at":"2022-05-16T15:14:08.190Z","updated_at":"2022-05-16T15:14:08.190Z","service_name":"built-up metal-deck"},{"id":4,"display_name":"Built-up w/ concrete deck","sort_order":4,"created_at":"2022-05-16T15:14:08.190Z","updated_at":"2022-05-16T15:14:08.190Z","service_name":"built-up concrete-deck"},{"id":5,"display_name":"Built-up w/ wood deck","sort_order":5,"created_at":"2022-05-16T15:14:08.190Z","updated_at":"2022-05-16T15:14:08.190Z","service_name":"built-up wood-deck"}]
<?xml version="1.0" encoding="UTF-8"?>
<roof-types type="array">
  <roof-type>
    <id type="integer">1</id>
    <display-name>Metal surfacing</display-name>
    <sort-order type="integer">1</sort-order>
    <created-at type="dateTime">2022-05-16T15:14:08Z</created-at>
    <updated-at type="dateTime">2022-05-16T15:14:08Z</updated-at>
    <service-name>metal roof</service-name>
  </roof-type>
  <roof-type>
    <id type="integer">2</id>
    <display-name>Shingles/Shakes</display-name>
    <sort-order type="integer">2</sort-order>
    <created-at type="dateTime">2022-05-16T15:14:08Z</created-at>
    <updated-at type="dateTime">2022-05-16T15:14:08Z</updated-at>
    <service-name>shingle roof</service-name>
  </roof-type>
  <roof-type>
    <id type="integer">3</id>
    <display-name>Built-up w/ metal deck</display-name>
    <sort-order type="integer">3</sort-order>
    <created-at type="dateTime">2022-05-16T15:14:08Z</created-at>
    <updated-at type="dateTime">2022-05-16T15:14:08Z</updated-at>
    <service-name>built-up metal-deck</service-name>
  </roof-type>
  <roof-type>
    <id type="integer">4</id>
    <display-name>Built-up w/ concrete deck</display-name>
    <sort-order type="integer">4</sort-order>
    <created-at type="dateTime">2022-05-16T15:14:08Z</created-at>
    <updated-at type="dateTime">2022-05-16T15:14:08Z</updated-at>
    <service-name>built-up concrete-deck</service-name>
  </roof-type>
  <roof-type>
    <id type="integer">5</id>
    <display-name>Built-up w/ wood deck</display-name>
    <sort-order type="integer">5</sort-order>
    <created-at type="dateTime">2022-05-16T15:14:08Z</created-at>
    <updated-at type="dateTime">2022-05-16T15:14:08Z</updated-at>
    <service-name>built-up wood-deck</service-name>
  </roof-type>
</roof-types>