Services relating to zone_layout of the Energy Asset Tool

Supported Formats

json, xml

GET /api/v1/zone_layouts/:id
Retrieve the zone_layout with the specific ID.

Also see Blocks.

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":"Single zone","sort_order":1,"created_at":"2022-05-16T15:14:16.396Z","updated_at":"2022-05-16T15:14:16.396Z","service_name":"Single zone","is_default":true}
<?xml version="1.0" encoding="UTF-8"?>
<zone-layout>
  <id type="integer">1</id>
  <display-name>Single zone</display-name>
  <sort-order type="integer">1</sort-order>
  <created-at type="dateTime">2022-05-16T15:14:16Z</created-at>
  <updated-at type="dateTime">2022-05-16T15:14:16Z</updated-at>
  <service-name>Single zone</service-name>
  <is-default type="boolean">true</is-default>
</zone-layout>

GET /api/v1/zone_layouts", "Retrieve all zone_layout.

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":"Single zone","sort_order":1,"created_at":"2022-05-16T15:14:16.396Z","updated_at":"2022-05-16T15:14:16.396Z","service_name":"Single zone","is_default":true},{"id":2,"display_name":"Perimeter and core","sort_order":2,"created_at":"2022-05-16T15:14:16.396Z","updated_at":"2022-05-16T15:14:16.396Z","service_name":"Perimeter and core","is_default":false}]
<?xml version="1.0" encoding="UTF-8"?>
<zone-layouts type="array">
  <zone-layout>
    <id type="integer">1</id>
    <display-name>Single zone</display-name>
    <sort-order type="integer">1</sort-order>
    <created-at type="dateTime">2022-05-16T15:14:16Z</created-at>
    <updated-at type="dateTime">2022-05-16T15:14:16Z</updated-at>
    <service-name>Single zone</service-name>
    <is-default type="boolean">true</is-default>
  </zone-layout>
  <zone-layout>
    <id type="integer">2</id>
    <display-name>Perimeter and core</display-name>
    <sort-order type="integer">2</sort-order>
    <created-at type="dateTime">2022-05-16T15:14:16Z</created-at>
    <updated-at type="dateTime">2022-05-16T15:14:16Z</updated-at>
    <service-name>Perimeter and core</service-name>
    <is-default type="boolean">false</is-default>
  </zone-layout>
</zone-layouts>