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: Education.
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