Services relating to skylights of the Energy Asset Tool

Supported Formats

json, xml

GET /api/v1/skylights/:id
Retrieve the skylight with the specific ID.

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

{"building_id":1,"created_at":"2013-07-26T16:47:13Z","id":1,"shgc":0.8,"skylight_type_id":1,"ufactor":0.16,"updated_at":"2013-07-26T16:47:13Z","vt":0.133}
<skylight>
<building-id type="integer">132</building-id>
<created-at type="datetime">2013-07-18T17:42:15Z</created-at>
<id type="integer">11</id>
<shgc type="float" nil="true"/>
<skylight-type-id type="integer">1</skylight-type-id>
<ufactor type="float" nil="true"/>
<updated-at type="datetime">2013-07-18T17:42:15Z</updated-at>
<vt type="float" nil="true"/>
</skylight>

GET /api/v1/buildings/:building_id/skylights
Retrieve all skylights belonging to the building.

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.

POST /api/v1/buildings/:building_id/skylights
Create a new skylight. This will associate the skylight with the building and return a Skylight object with unique ID assigned.

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

{"ufactor":0.16,"shgc":0.8,"vt":0.133,"skylight_type_id":1}
<skylight>
  <ufactor type="float">0.16</ufactor>
  <shgc type="float">0.8</shgc>
  <vt type="float">0.133</vt>
  <skylight-type-id type="integer">1</skylight-type-id>
</skylight>

Params

Param name Description
skylight_type_id
required

Skylight Type ID. Specifies type of Skylight to create.

Validations:

  • Must be a Integer

ufactor
optional

Skylight U-Factor. Must be between 0.12-1.22

Validations:

  • Must be a Float

skylight_shgc
optional

Skylight SHGC. Must be between 0.099-0.817

Validations:

  • Must be a Float

skylight_vt
optional

Skylight VT. Must be between 0.06-0.893

Validations:

  • Must be a Float

skylight_layout_id
required

Skylight Layout ID. Must be greater than 0

Validations:

  • Must be a Integer

skylight_percent_footprint
required

Skylight Percent Footprint. Specifies skylight percent of roof area. Must be less than 95

Validations:

  • Must be a Integer


PUT /api/v1/skylights/:id
Update an existing skylight. Nothing is returned.

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.

Params

Param name Description
skylight_type_id
required

Skylight Type ID. Specifies type of Skylight to create.

Validations:

  • Must be a Integer

ufactor
optional

Skylight U-Factor. Must be between 0.12-1.22

Validations:

  • Must be a Float

skylight_shgc
optional

Skylight SHGC. Must be between 0.099-0.817

Validations:

  • Must be a Float

skylight_vt
optional

Skylight VT. Must be between 0.06-0.893

Validations:

  • Must be a Float

skylight_layout_id
required

Skylight Layout ID. Must be greater than 0

Validations:

  • Must be a Integer

skylight_percent_footprint
required

Skylight Percent Footprint. Specifies skylight percent of roof area. Must be less than 95

Validations:

  • Must be a Integer


DELETE /api/v1/skylights/:id
Delete the skylight and disassociate it from the building. Nothing is returned.

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.