residential-unit-summary

Residential unit summary

Breakdown of residential unit counts by tenure and housing type, with optional unit breakdowns

Fields

• Tenure type tenure-type:

  Category of housing tenure

  Required: True

  Datatype: enum

  Expected number: 1

• Housing type housing-type:

  Type of housing

  Required: True

  Datatype: enum

  Expected number: 1

• Existing unit breakdown existing-unit-breakdown:

  Number of existing units by bedroom count

  Required: False

  Datatype: object

  Expected number: 1 or more

  Unit quantities component

  Units unknown

  units-unknown

  Whether the number of units is unknown

  Required: True

  Datatype: boolean

  Expected number: 1

  Units per bedroom number

  units-per-bedroom-no

  Number of units broken down by bedroom count

  Required: False

  Datatype: object

  Expected number: 1 or more

  Bedroom count component

  No bedrooms unknown

  no-bedrooms-unknown

  Set to true when counting units where bedroom number is unknown

  Required: True

  Datatype: boolean

  Expected number: 1

  Number of bedrooms

  no-of-bedrooms

  The number of bedrooms in unit

  Required: False

  Datatype: number

  Expected number: 1

  Units

  units

  The number of units of that bedroom count

  Required: True

  Datatype: number

  Expected number: 1

  Total units

  total-units

  Total number of units

  Required: False

  Datatype: number

  Expected number: 1

• Units unknown units-unknown:

  Whether the number of units is unknown

  Required: True

  Datatype: boolean

  Expected number: 1

• Units per bedroom number units-per-bedroom-no:

  Number of units broken down by bedroom count

  Required: False

  Datatype: object

  Expected number: 1 or more

  Bedroom count component

  No bedrooms unknown

  no-bedrooms-unknown

  Set to true when counting units where bedroom number is unknown

  Required: True

  Datatype: boolean

  Expected number: 1

  Number of bedrooms

  no-of-bedrooms

  The number of bedrooms in unit

  Required: False

  Datatype: number

  Expected number: 1

  Units

  units

  The number of units of that bedroom count

  Required: True

  Datatype: number

  Expected number: 1

• No bedrooms unknown no-bedrooms-unknown:

  Set to true when counting units where bedroom number is unknown

  Required: True

  Datatype: boolean

  Expected number: 1

• Number of bedrooms no-of-bedrooms:

  The number of bedrooms in unit

  Required: False

  Datatype: number

  Expected number: 1

• Units units:

  The number of units of that bedroom count

  Required: True

  Datatype: number

  Expected number: 1

• Total units total-units:

  Total number of units

  Required: False

  Datatype: number

  Expected number: 1

• Proposed unit breakdown proposed-unit-breakdown:

  Number of proposed units by bedroom count

  Required: False

  Datatype: object

  Expected number: 1 or more

  Unit quantities component

  Units unknown

  units-unknown

  Whether the number of units is unknown

  Required: True

  Datatype: boolean

  Expected number: 1

  Units per bedroom number

  units-per-bedroom-no

  Number of units broken down by bedroom count

  Required: False

  Datatype: object

  Expected number: 1 or more

  Bedroom count component

  No bedrooms unknown

  no-bedrooms-unknown

  Set to true when counting units where bedroom number is unknown

  Required: True

  Datatype: boolean

  Expected number: 1

  Number of bedrooms

  no-of-bedrooms

  The number of bedrooms in unit

  Required: False

  Datatype: number

  Expected number: 1

  Units

  units

  The number of units of that bedroom count

  Required: True

  Datatype: number

  Expected number: 1

  Total units

  total-units

  Total number of units

  Required: False

  Datatype: number

  Expected number: 1

• Units unknown units-unknown:

  Whether the number of units is unknown

  Required: True

  Datatype: boolean

  Expected number: 1

• Units per bedroom number units-per-bedroom-no:

  Number of units broken down by bedroom count

  Required: False

  Datatype: object

  Expected number: 1 or more

  Bedroom count component

  No bedrooms unknown

  no-bedrooms-unknown

  Set to true when counting units where bedroom number is unknown

  Required: True

  Datatype: boolean

  Expected number: 1

  Number of bedrooms

  no-of-bedrooms

  The number of bedrooms in unit

  Required: False

  Datatype: number

  Expected number: 1

  Units

  units

  The number of units of that bedroom count

  Required: True

  Datatype: number

  Expected number: 1

• No bedrooms unknown no-bedrooms-unknown:

  Set to true when counting units where bedroom number is unknown

  Required: True

  Datatype: boolean

  Expected number: 1

• Number of bedrooms no-of-bedrooms:

  The number of bedrooms in unit

  Required: False

  Datatype: number

  Expected number: 1

• Units units:

  The number of units of that bedroom count

  Required: True

  Datatype: number

  Expected number: 1

• Total units total-units:

  Total number of units

  Required: False

  Datatype: number

  Expected number: 1

Used in modules

• Residential units