Services relating to windows of the Energy Asset Tool

Supported Formats

json, xml

GET /api/v1/windows/:id
Retrieve the window 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:59:30Z","framing_type_id":1,"gas_fill_type_id":1,"glass_type_id":1,"id":1,"name":"Window 1","shgc":0.101,"ufactor":1.11,"updated_at":"2013-07-26T16:59:30Z","vt":0.11}
<window>
<building-id type="integer">20</building-id>
<created-at type="datetime">2013-07-01T23:21:19Z</created-at>
<framing-type-id type="integer">2</framing-type-id>
<gas-fill-type-id type="integer">3</gas-fill-type-id>
<glass-type-id type="integer">1</glass-type-id>
<id type="integer">17</id>
<name type="string">win1</name>
<shgc type="float" nil="true"/>
<ufactor type="float" nil="true"/>
<updated-at type="datetime">2013-07-01T23:21:19Z</updated-at>
<vt type="float" nil="true"/>
</window>

GET /api/v1/buildings/:building_id/windows
Retrieve all windows 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/windows
Create a new window. This will associate the window with the building and return a Window 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

{"name":"Window 1","framing_type_id":1,"glass_type_id":1,"gas_fill_type_id":1,"ufactor":1.11,"shgc":0.101,"vt":0.11}
<window>
  <name type="string">Window 6</name>
  <framing-type-id type="integer">1</framing-type-id>
  <glass-type-id type="integer">1</glass-type-id>
  <gas-fill-type-id type="integer">1</gas-fill-type-id>
  <ufactor type="float">1.11</ufactor>
  <shgc type="float">0.101</shgc>
  <vt type="float">0.11</vt>
</window>

Params

Param name Description
framing_type_id
required

Framing Type ID. Specifies type of window framing to create. Must be greater than or equal to 0

Validations:

  • Must be a Integer

glass_type_id
required

Glass Type ID. Specifies type of window glass. Must be greater than or equal to 0

Validations:

  • Must be a Integer

gas_fill_type_id
optional

Gas Fill Type ID. Specifies type of gas used (if filled). Must be greater than or equal to 0

Validations:

  • Must be a Integer

ufactor
optional

Window U-Factor. Must be between 0.12-1.22

Validations:

  • Must be a Float

shgc
optional

Window SHGC. Must be between 0.099-0.817

Validations:

  • Must be a Float

vt
optional

Window VT. Must be between 0.06-0.893

Validations:

  • Must be a Float


PUT /api/v1/windows/:id
Update an existing window. 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
framing_type_id
required

Framing Type ID. Specifies type of window framing to create. Must be greater than or equal to 0

Validations:

  • Must be a Integer

glass_type_id
required

Glass Type ID. Specifies type of window glass. Must be greater than or equal to 0

Validations:

  • Must be a Integer

gas_fill_type_id
optional

Gas Fill Type ID. Specifies type of gas used (if filled). Must be greater than or equal to 0

Validations:

  • Must be a Integer

ufactor
optional

Window U-Factor. Must be between 0.12-1.22

Validations:

  • Must be a Float

shgc
optional

Window SHGC. Must be between 0.099-0.817

Validations:

  • Must be a Float

vt
optional

Window VT. Must be between 0.06-0.893

Validations:

  • Must be a Float


DELETE /api/v1/windows/:id
Delete the window 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.