Services relating to floors of the Energy Asset Tool

Supported Formats

json, xml

GET /api/v1/floors/:id
Retrieve the floor 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-25T20:08:28Z","floor_insulation_thickness":1.7,"floor_r_value":17.0,"floor_type_id":1,"floor_u_factor":1.1,"has_carpet":null,"id":1,"name":"Floor 1","slab_insulation_type_id":1,"updated_at":"2013-07-25T20:08:28Z","vertical_insulation_depth":2.2}
<floor>
<building-id type="integer">22</building-id>
<created-at type="datetime">2013-07-02T00:45:36Z</created-at>
<floor-insulation-thickness type="float" nil="true"/>
<floor-r-value type="float" nil="true"/>
<floor-type-id type="integer">2</floor-type-id>
<floor-u-factor type="float" nil="true"/>
<has-carpet type="boolean" nil="true"/>
<id type="integer">20</id>
<name type="string">flr1</name>
<slab-insulation-type-id type="integer">1</slab-insulation-type-id>
<updated-at type="datetime">2013-07-02T00:45:36Z</updated-at>
<vertical-insulation-depth type="float" nil="true"/>
</floor>

GET /api/v1/buildings/:building_id/floors
Retrieve all floors 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/floors
Create a new floor. This will associate the floor with the building and return a Floor object with unique ID assigned.

Also see Floor Types and Slab Insulation 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

{"name":"Floor 1","floor_type_id":1,"floor_r_value":17.0,"floor_u_factor":1.1,"floor_insulation_thickness":1.7,"slab_insulation_type_id":1,"vertical_insulation_depth":2.2}
<floor>
  <name type="string">Floor 3</name>
  <floor-type-id type="integer">1</floor-type-id>
  <floor-r-value type="float">17.0</floor-r-value>
  <floor-u-factor type="float">1.1</floor-u-factor>
  <floor-insulation-thickness type="float">1.7</floor-insulation-thickness>
  <slab-insulation-type-id type="integer">1</slab-insulation-type-id>
  <vertical-insulation-depth type="float">2.2</vertical-insulation-depth>
</floor>

Params

Param name Description
floor_type_id
required

Floor Type ID. Specifies type of Floor to create.

Validations:

  • Must be a Integer

floor_u_factor
optional

Floor U-Factor. Must be greater than or equal to 0

Validations:

  • Must be a Float

floor_r_value
optional

Floor R-Value. Must be between 0 and 27.0

Validations:

  • Must be a Float

floor_insulation_thickness
optional

Floor Insulation Thickness. Must be between 1 and 4

Validations:

  • Must be a Float

slab_insulation_type_id
optional

Floor Slab Insulation Type ID. Specifies type of floor slab to use.

Validations:

  • Must be a Integer

vertical_insulation_depth
optional

Vertical Insulation Depth. Must be between 0 and 5

Validations:

  • Must be a Float


PUT /api/v1/floors/:id
Update an existing floor. 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.

Examples

{"floor_type_id":1,"floor_r_value":18.1}

Params

Param name Description
floor_type_id
required

Floor Type ID. Specifies type of Floor to create.

Validations:

  • Must be a Integer

floor_u_factor
optional

Floor U-Factor. Must be greater than or equal to 0

Validations:

  • Must be a Float

floor_r_value
optional

Floor R-Value. Must be between 0 and 27.0

Validations:

  • Must be a Float

floor_insulation_thickness
optional

Floor Insulation Thickness. Must be between 1 and 4

Validations:

  • Must be a Float

slab_insulation_type_id
optional

Floor Slab Insulation Type ID. Specifies type of floor slab to use.

Validations:

  • Must be a Integer

vertical_insulation_depth
optional

Vertical Insulation Depth. Must be between 0 and 5

Validations:

  • Must be a Float


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