Simple_buildings
Simple Buildings

Services relating to Quick Building Assessment Tool (QBAT) buildings.

Supported Formats

json
>>>

POST /api/v2/simple_buildings
Create a new Quick Building Assessment Tool (QBAT) building. The response for a successful request is the assigned unique ID of the new building.

Supported Formats

json

Errors

Code Description
401 Unauthorized - The "token" parameter MUST be provided for each service call.
422 Unprocessable Entity - The form data contains errors.

Params

Param name Description
token
required

The token for user authentication.

Validations:

  • Must be a String
simple_building
optional

The form data for the new simple building.

Validations:

  • Must be a Hash
simple_building[address]
required

Street

Validations:

  • Must be a String
simple_building[city]
required

City

Validations:

  • Must be a String
simple_building[name]
required

Building Name

Validations:

  • Must be a String
simple_building[notes]
optional

Add notes about this building.

Validations:

  • Must be a String
simple_building[number_of_floors]
required

Number of Above Grade Floors

Validations:

  • Must be a String
simple_building[predominant_hvac_system_type_name]
required

Predominant HVAC System Type

Validations:

  • Must be one of: Four Pipe Fan Coil Unit, Packaged Terminal Air Conditioner, Packaged Terminal Heat Pump, Packaged VAV with Electric Reheat, Packaged VAV with Hot Water Reheat, Rooftop Air Conditioner and Gas Furnace, Rooftop Air Source Heat Pump, VAV with Electric Reheat, VAV with Hot Water Reheat, VRF, Warm Air Furnace, Water Loop Heat Pump, Window AC + Baseboard.
simple_building[reported_floor_area]
required

Total Floor Area

Validations:

  • Must be a number.
simple_building[shape_name]
required

Building Shape

Validations:

  • Must be one of: H-shape, L-shape, Rectangle, U-shape.
simple_building[state]
required

State

Validations:

  • Must be one of: AK, AL, AR, AZ, CA, CO, CT, DC, DE, FL, GA, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MI, MN, MO, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VA, VT, WA, WI, WV, WY.
simple_building[use_type_name]
required

Predominant Use Type

Validations:

  • Must be one of: Assisted Living Facility, City Hall, Community Center, Courthouse, Education, Library, Lodging, Medical Office, Multi-family (4 floors or greater), Multi-family (fewer than 4 floors), Office, Police Station, Post Office, Religious Building, Retail, Senior Center.
simple_building[year_of_construction]
required

Year Completed

Validations:

  • Must be a number.
simple_building[zip_code]
required

Zip Code

Validations:

  • Must be a String

Returns

Code: 200

Description:

OK

Param name Description
id
required

The ID of the building.

Validations:

  • Must be a Integer
name
required

The name of the building.

Validations:

  • Must be a String
owner
required

The user that owns the building.

Validations:

  • Must be a Hash
owner[id]
required

The ID of the user that owns the building.

Validations:

  • Must be a Integer
owner[email]
required

The email address of the user that owns the building.

Validations:

  • Must be a String
owner[first_name]
required

The first name of the user that owns the building.

Validations:

  • Must be a String
owner[last_name]
required

The last name of the user that owns the building.

Validations:

  • Must be a String
owner[organization]
optional

The organization to which the user that owns the building is assigned.

Validations:

  • Must be a Hash
owner[organization][id]
required

The ID of the organization to which the user that owns the building is assigned.

Validations:

  • Must be a Integer
owner[organization][name]
required

The name of the organization to which the user that owns the building is assigned.

Validations:

  • Must be a String
owner[site_admin]
required

Set to “true” if the user that owns the building is a site administrator.

Validations:

  • Must be one of: true, false, 1, 0.
owner[type]
required

The type of the user. Always: “User”

Validations:

  • Must be one of: User.
status
required

The status of the building.

Validations:

  • Must be one of: Editing, Running, Rated.
created_at
required

The timestamp for when the building was created.

Validations:

  • Must be a DateTime
updated_at
required

The timestamp for when the building was last modified.

Validations:

  • Must be a DateTime
html_url
required

The URL for the building in the Asset Score tool.

Validations:

  • Must be a String

Code: 422

Description:

Unprocessable Content

Param name Description
address
required

Validations:

  • Must be an array of String
city
required

Validations:

  • Must be an array of String
name
required

Validations:

  • Must be an array of String
notes
required

Validations:

  • Must be an array of String
number_of_floors
required

Validations:

  • Must be an array of String
predominant_hvac_system_type_name
required

Validations:

  • Must be an array of String
reported_floor_area
required

Validations:

  • Must be an array of String
shape_name
required

Validations:

  • Must be an array of String
state
required

Validations:

  • Must be an array of String
use_type_name
required

Validations:

  • Must be an array of String
year_of_construction
required

Validations:

  • Must be an array of String
zip_code
required

Validations:

  • Must be an array of String