Skip to main content

Planning permission specifications

POC This is a proof of concept viewer for the planning permission specifications - your feedback will help us to improve it.

module: res-units

Residential units

Details of the residential units that make up both the current and proposed development.

Fields

Residential unit change
will-residential-units-change

Proposal includes the gain, loss or change of use of residential units

Required: True

Datatype: boolean

Expected number: 1

Residential unit summary
residential-unit-summary

Breakdown of unit counts by tenure and housing type

Required: False

Datatype: object

Expected number: 1 or more

Residential unit summary component

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

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

Total existing units
total-existing-units

The total number of existing units

Required: True

Datatype: number

Expected number: 1

Total proposed units
total-proposed-units

The total number of proposed units

Required: True

Datatype: number

Expected number: 1

Net change
net-change

Calculated net change in units

Required: True

Datatype: number

Expected number: 1

Rules

  • residential-unit-summary is required when will-residential-units-change is true
  • net-change is calculated as total-proposed-units minus total-existing-units
  • if will-residential-units-change is true, at least one breakdown for existing and proposed is required (count could be unknown)