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

  Allowed values

  Tenure type codelist

  Expected number

  1

• Required: True
• Datatype: enum
• Allowed values: Tenure type codelist
• Expected number: 1
• Housing type housing-type:

  Type of housing

  Required

  True

  Datatype

  enum

  Allowed values

  Housing type codelist

  Expected number

  1

• Required: True
• Datatype: enum
• Allowed values: Housing type codelist
• Expected number: 1
• Existing unit breakdown existing-unit-breakdown: Component

  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

  Component

  Number of units broken down by bedroom count

  Required

  False

  Datatype

  object

  Expected number

  1 or more

  This field uses the Bedroom count component.

  Total units

  total-units

  Total number of units

  Required

  False

  Datatype

  integer

  Expected number

  1

• Required: False
• Datatype: object
• Expected number: 1 or more
• Units unknown units-unknown:

  Whether the number of units is unknown

  Required

  True

  Datatype

  boolean

  Expected number

  1

• Required: True
• Datatype: boolean
• Expected number: 1
• Units per bedroom number units-per-bedroom-no: Component

  Number of units broken down by bedroom count

  Required

  False

  Datatype

  object

  Expected number

  1 or more

  This field uses the Bedroom count component.

• Required: False
• Datatype: object
• Expected number: 1 or more
• Total units total-units:

  Total number of units

  Required

  False

  Datatype

  integer

  Expected number

  1

• Required: False
• Datatype: integer
• Expected number: 1
• Proposed unit breakdown proposed-unit-breakdown: Component

  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

  Component

  Number of units broken down by bedroom count

  Required

  False

  Datatype

  object

  Expected number

  1 or more

  This field uses the Bedroom count component.

  Total units

  total-units

  Total number of units

  Required

  False

  Datatype

  integer

  Expected number

  1

• Required: False
• Datatype: object
• Expected number: 1 or more
• Units unknown units-unknown:

  Whether the number of units is unknown

  Required

  True

  Datatype

  boolean

  Expected number

  1

• Required: True
• Datatype: boolean
• Expected number: 1
• Units per bedroom number units-per-bedroom-no: Component

  Number of units broken down by bedroom count

  Required

  False

  Datatype

  object

  Expected number

  1 or more

  This field uses the Bedroom count component.

• Required: False
• Datatype: object
• Expected number: 1 or more
• Total units total-units:

  Total number of units

  Required

  False

  Datatype

  integer

  Expected number

  1

• Required: False
• Datatype: integer
• Expected number: 1

Where this is used

Fields

This component is used in 1 field:

• Residential unit summary

Modules

This component is used in 1 module:

• Residential units