Services relating to building_use_types of the Energy Asset Tool

Supported Formats

json, xml

GET /api/v1/building_use_types/:id
Retrieve the building_use_type 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-25T19:58:24Z","id":2,"updated_at":"2013-07-25T19:58:24Z","use_type_id":7}
<building-use-type>
<building-id type="integer">8</building-id>
<created-at type="datetime">2013-06-28T19:18:06Z</created-at>
<id type="integer">14</id>
<updated-at type="datetime">2013-06-28T19:18:06Z</updated-at>
<use-type-id type="integer">3</use-type-id>
</building-use-type>

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

Also see Use 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

{\"use_type_id\":7}
<building_use_type>
  <use-type-id type="integer">7</use-type-id>
</building_use_type>

Params

Param name Description
use_type_id
required

Specifies Use Type.

Validations:

  • Must be a Integer


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

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