
Overview
Digital Planning Data schemas contain data specifications developed by Open Digital Planning to describe Digital Planning services. Each specification is communicated via a JSON Schema document. Our initial specification defines data structures, rules, and validation logic for planning applications - including Lawful Development Certificate, Prior Approval, and Planning Permission services - that are being designed and submitted via PlanX. Digital Planning Data schemas aim to encourage more interoperability and consistency between systems by offering a central, version controlled specification for documenting and validating planning data.What’s Included
The schemas currently support the following application types:- Planning Permission (Full Householder, Major, Minor)
- Prior Approval (Larger Extension, Build Homes, Convert Commercial to Home, Extend University, Solar Panels)
- Lawful Development Certificate (Proposed, Existing)
- Listed Building Consent
- Land Drainage Consent
- Hedgerow Removal Notice
- Advert Consent
- Enforcement notices
Quick Start
Get started with Digital Planning Data schemas in minutes
Installation
Learn how to install and integrate the schemas into your project
API Implementation
Guidelines for implementing the schema in your API
Examples
Browse real-world examples of valid planning application payloads
Repository Structure
The Digital Planning Data schemas repository is organized as follows:/schemas
/schemas
The main JSON Schema files. The
main branch reflects the @next version, while historic versions are documented and released on the dist branch.Current schemas:application.jsonprototypeApplication.jsonpreApplication.jsonpostSubmissionApplication.jsonpostSubmissionPublishedApplication.jsonenforcement.json
/types
/types
TypeScript interfaces used to generate the JSON Schemas. The schemas are built using
ts-json-schema-generator from these TypeScript type definitions./examples
/examples
Examples of valid payloads for each application type supported by the specifications. Each example demonstrates real-world usage patterns.
/tests
/tests
Test suites using both
jsonschema and ajv libraries to ensure that the generated schemas and example payloads are valid, accurate, and capable of handling different scenarios.Key Features
Type Safety
Generated from TypeScript interfaces for strong type safety and validation
Version Control
Centralized, version-controlled specifications hosted via GitHub Pages
Standards-Based
Built on JSON Schema standard with comprehensive validation rules
Interoperable
Designed to promote consistency and interoperability between planning systems
Future Roadmap
Going forward, we hope that this repository will expand beyond applications to further describe:- Planning reference numbers
- Site notices
- Consultations
- Additional planning data types
License
Distributed under the Mozilla Public License Version 2.0. SeeLICENSE.txt for more information.
Contributing
We welcome feedback, bug reports, and contributions to help improve and grow the Digital Planning Data schemas via GitHub Issues and Pull Requests.View on GitHub
Contribute to the Digital Planning Data schemas project
