Skip to content

home_energy_score_json_schema

About

Type: object
Additional Properties Allowed: False

Property Type Required Format Title
assessment_type enum ✅
assessment_date string ✅ date
comments ['string', 'null']
comment_api_only string
dwelling_unit_type enum ✅
manufactured_home_sections enum
year_built integer ✅
number_bedrooms integer ✅
num_floor_above_grade integer
floor_to_ceiling_height number ✅
conditioned_floor_area number ✅
orientation enum ✅
blower_door_test boolean ✅
air_sealing_present boolean
envelope_leakage integer

allOf Requirement

Conditional Validation

if true validate
dwelling_unit_type is manufactured_home manufactured_home_sections is present
dwelling_unit_type is not manufactured_home manufactured_home_sections is not present
blower_door_test is True envelope_leakage is present
blower_door_test is not True envelope_leakage is not present
dwelling_unit_type is one of [apartment_unit, manufactured_home] num_floor_above_grade is not present
dwelling_unit_type is not one of [apartment_unit, manufactured_home] num_floor_above_grade is present

assessment_type

  • is required
  • Type: enum
Value
initial
final
qa
alternative
test
corrected
mentor
preconstruction

assessment_date

Date the assessment was performed

  • is required
  • Type: string

comments

Free text comment field

  • is not required
  • Type: ['string', 'null']

comment_api_only

Pass through field for use by api users

  • is not required
  • Type: string

dwelling_unit_type

The type of dwelling unit

  • is required
  • Type: enum
Value
single_family_detached
single_family_attached
apartment_unit
manufactured_home

manufactured_home_sections

The sections of a manufactured home

  • is not required
  • Type: enum
Value
single-wide
double-wide
triple-wide

year_built

Year building was built

  • is required
  • Type: integer

Minimum Number: 1600

number_bedrooms

Number of bedrooms in house

  • is required
  • Type: integer

Minimum Number: 1
Maximum Number: 10

num_floor_above_grade

Number of floors above grade. Assumes 1 when dwelling_unit_type is apartment_unit

  • is not required
  • Type: integer

Minimum Number: 1
Maximum Number: 4

floor_to_ceiling_height

Floor to ceiling height (feet)

  • is required
  • Type: number

Minimum Number: 6
Maximum Number: 15

conditioned_floor_area

Total conditioned floor area (square feet)

  • is required
  • Type: number

Minimum Number: 250
Maximum Number: 25000

orientation

Orientation of the front door

  • is required
  • Type: enum
Value
north
north_east
east
south_east
south
south_west
west
north_west

blower_door_test

Was a blower door test performed on this house?

  • is required
  • Type: boolean

air_sealing_present

Has the building been air sealed?

  • is not required
  • Type: boolean

envelope_leakage

Building air leakage measured with a blower door (CFM50) (only used if blower_door_test is true)

  • is not required
  • Type: integer

Minimum Number: 0
Maximum Number: 25000