Services relating to framing_types of the Energy Asset Tool

Supported Formats

json, xml

GET /api/v1/framing_types/:id
Retrieve the framing_type with the specific ID.

Also see Windows.

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","sort_order":1,"created_at":"2022-05-16T15:14:02.443Z","updated_at":"2022-05-16T15:14:02.443Z","service_name":"metal-frame"}
<?xml version="1.0" encoding="UTF-8"?>
<framing-type>
  <id type="integer">1</id>
  <display-name>Metal</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>metal-frame</service-name>
</framing-type>

GET /api/v1/framing_types
Retrieve all framing_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","sort_order":1,"created_at":"2022-05-16T15:14:02.443Z","updated_at":"2022-05-16T15:14:02.443Z","service_name":"metal-frame"},{"id":2,"display_name":"Metal w/ Thermal Breaks","sort_order":2,"created_at":"2022-05-16T15:14:02.443Z","updated_at":"2022-05-16T15:14:02.443Z","service_name":"metal-break-frame"},{"id":3,"display_name":"Wood/Vinyl/Fiberglass","sort_order":3,"created_at":"2022-05-16T15:14:02.446Z","updated_at":"2022-05-16T15:14:02.446Z","service_name":"wood-frame"}]
<?xml version="1.0" encoding="UTF-8"?>
<framing-types type="array">
  <framing-type>
    <id type="integer">1</id>
    <display-name>Metal</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>metal-frame</service-name>
  </framing-type>
  <framing-type>
    <id type="integer">2</id>
    <display-name>Metal w/ Thermal Breaks</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>metal-break-frame</service-name>
  </framing-type>
  <framing-type>
    <id type="integer">3</id>
    <display-name>Wood/Vinyl/Fiberglass</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>wood-frame</service-name>
  </framing-type>
</framing-types>