Shading types
Energy Asset - ShadingType

Services relating to shading_types of the Energy Asset Tool

Supported Formats

json, xml
>>>

GET /api/v1/shading_types/:id
Retrieve the shading_type with the specific ID.

Also see Surfaces.

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

GET /api/v1/shading_types
Retrieve all shading_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":"No Shading","sort_order":1,"created_at":"2022-05-16T15:14:08.583Z","updated_at":"2022-05-16T15:14:08.583Z","service_name":""},{"id":2,"display_name":"External Overhangs","sort_order":2,"created_at":"2022-05-16T15:14:08.583Z","updated_at":"2022-05-16T15:14:08.583Z","service_name":""},{"id":3,"display_name":"Vertical Fins","sort_order":3,"created_at":"2022-05-16T15:14:08.583Z","updated_at":"2022-05-16T15:14:08.583Z","service_name":""},{"id":4,"display_name":"Light Shelves","sort_order":4,"created_at":"2022-05-16T15:14:08.583Z","updated_at":"2022-05-16T15:14:08.583Z","service_name":""}]
<?xml version="1.0" encoding="UTF-8"?>
<shading-types type="array">
  <shading-type>
    <id type="integer">1</id>
    <display-name>No Shading</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></service-name>
  </shading-type>
  <shading-type>
    <id type="integer">2</id>
    <display-name>External Overhangs</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></service-name>
  </shading-type>
  <shading-type>
    <id type="integer">3</id>
    <display-name>Vertical Fins</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></service-name>
  </shading-type>
  <shading-type>
    <id type="integer">4</id>
    <display-name>Light Shelves</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></service-name>
  </shading-type>
</shading-types>