Services relating to walls of the Energy Asset Tool

Supported Formats

json, xml

GET /api/v1/walls/:id
Retrieve the wall 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:55:21Z","id":1,"name":"Wall 1","updated_at":"2013-07-26T16:55:21Z","wall_insulation_thickness":3.3,"wall_r_value":17.0,"wall_type_id":3,"wall_u_factor":0.23}
<wall>
<building-id type="integer">11</building-id>
<created-at type="datetime">2013-06-28T21:58:58Z</created-at>
<id type="integer">11</id>
<name type="string">wall1</name>
<updated-at type="datetime">2013-06-28T21:58:58Z</updated-at>
<wall-insulation-thickness type="float" nil="true"/>
<wall-r-value type="float">13.0</wall-r-value>
<wall-type-id type="integer">5</wall-type-id>
<wall-u-factor type="float" nil="true"/>
</wall>

GET /api/v1/buildings/:building_id/walls
Retrieve all walls 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.

Examples

[
  {
    "building_id": 38,
    "created_at": "2014-10-31T21:18:59Z",
    "id": 7,
    "updated_at": "2014-10-31T21:18:59Z",
    "wall_insulation_thickness": 11,
    "wall_r_value": null,
    "wall_type_id": 5,
    "wall_u_factor": null
  },
  {
    "building_id": 38,
    "created_at": "2014-11-02T01:09:34Z",
    "id": 9,
    "updated_at": "2014-11-12T20:26:38Z",
    "wall_insulation_thickness": 9.87600040435791,
    "wall_r_value": null,
    "wall_type_id": 3,
    "wall_u_factor": null
  }
]

POST /api/v1/buildings/:building_id/walls
Create a new wall. This will associate the wall with the building and return a Wall 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":"Wall 1","wall_r_value":17.0,"wall_u_factor":0.23,"wall_insulation_thickness":3.3,"wall_type_id":3}
<wall>
  <name type="string">Wall 3</name>
  <wall-r-value type="float">17.0</wall-r-value>
  <wall-u-factor type="float">0.23</wall-u-factor>
  <wall-insulation-thickness type="float">3.3</wall-insulation-thickness>
  <wall-type-id type="integer">3</wall-type-id>
</wall>

Params

Param name Description
wall_u_factor
optional

Wall U-Factor. Must be between 0.008 to 1.28

Validations:

  • Must be a Float

wall_r_value
optional

Wall R-Value. Must be between 1 to 100

Validations:

  • Must be a Float

wall_insulation_thickness
optional

Wall Insulation Thickness. Must be between 1.0 and 38

Validations:

  • Must be a Float

wall_type_id
required

Wall Type ID. Specifies type of wall to create.

Validations:

  • Must be a Integer


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

{"wall_type_id":2,"wall_r_value":17.5}

Params

Param name Description
wall_u_factor
optional

Wall U-Factor. Must be between 0.008 to 1.28

Validations:

  • Must be a Float

wall_r_value
optional

Wall R-Value. Must be between 1 to 100

Validations:

  • Must be a Float

wall_insulation_thickness
optional

Wall Insulation Thickness. Must be between 1.0 and 38

Validations:

  • Must be a Float

wall_type_id
required

Wall Type ID. Specifies type of wall to create.

Validations:

  • Must be a Integer


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