Skip to main content
The repository includes comprehensive example payloads for each application type supported by the Digital Planning Data schemas. These examples demonstrate valid data structures and real-world usage patterns.

​
Example Categories

Examples are organized by schema type and application category:

​
Application Schemas

Prototype application payloads for initial submission:

Planning Permission

  • Full householder applications
  • Full householder in conservation area
  • Minor planning permission
  • Major planning permission

Prior Approval

  • Larger home extensions
  • Convert commercial to residential
  • Extend university buildings
  • Build new homes
  • Solar panel installations

Lawful Development Certificate

  • Proposed development (LDCP)
  • Existing development (LDCE)

Other Application Types

  • Listed Building Consent
  • Land Drainage Consent
  • Works to Trees
  • Hedgerow Removal Notice
  • Compliance Confirmation
  • Advert Consent

​
Post-Submission Schemas

Examples showing application lifecycle stages:
  • Submission
  • Validation (valid/invalid)
  • Consultation
  • Assessment (in progress, determined by council, in committee, committee determined)
  • Appeal (lodged, validated, started, determined)
  • Withdrawn

​
Pre-Application Schema

Pre-application advice request examples.

​
Enforcement Schema

Planning breach reporting examples.

​
Example Structure

All example payloads follow a consistent structure:

​
Data Section

Contains the core application data: 
{
  "data": {
    "application": {
      "type": {
        "value": "pp.full.householder",
        "description": "Planning Permission - Full householder"
      },
      "fee": {
        "calculated": 258,
        "payable": 258,
        "category": {
          "sixAndSeven": 258
        }
      }
    },
    "applicant": {
      "type": "individual",
      "name": {
        "first": "David",
        "last": "Bowie"
      },
      "email": "[email protected]"
    },
    "property": {
      "address": {
        "latitude": 51.4656522,
        "longitude": -0.1185926,
        "title": "40, STANSFIELD ROAD, LONDON",
        "uprn": "100021892955"
      }
    }
  }
}

​
Responses Section

Captures user responses to questions asked during the application journey: 
{
  "responses": [
    {
      "question": "Is the property in a conservation area?",
      "responses": [
        {
          "value": "Yes"
        }
      ],
      "metadata": {
        "autoAnswered": true
      }
    }
  ]
}

​
Metadata Section

Includes submission metadata and service information: 
{
  "metadata": {
    "id": "80d3c3c2-0d1c-4a79-be99-912f488c2f02",
    "organisation": "SWK",
    "submittedAt": "2024-03-18T11:25:13.924Z",
    "source": "PlanX",
    "service": {
      "flowId": "50b3e139-ad36-420b-8f2a-10c87ecb6668",
      "url": "https://editor.planx.dev/southwark/apply-for-planning-permission/published",
      "fee": {
        "calculated": 258,
        "payable": 258
      }
    },
    "schema": "https://theopensystemslab.github.io/digital-planning-data-schemas/@next/schemas/application.json"
  }
}

​
Accessing Examples

Examples are available in the repository’s /examples directory:
1

Browse GitHub

View examples directly on GitHub
2

Clone Repository

git clone https://github.com/theopensystemslab/digital-planning-data-schemas.git
cd digital-planning-data-schemas/examples
3

Reference Hosted Files

Access JSON examples via the hosted schema site:
https://theopensystemslab.github.io/digital-planning-data-schemas/<VERSION>/examples/<EXAMPLE>.json

​
Example Files by Type

​
Planning Permission

  • application/planningPermission/fullHouseholder.json - Standard householder application
  • application/planningPermission/fullHouseholderInConservationArea.json - Householder in conservation area
  • application/planningPermission/minor.json - Minor development
  • application/planningPermission/major.json - Major development

​
Prior Approval

  • application/priorApproval/largerExtension.json - Single-storey rear extension
  • application/priorApproval/convertCommercialToHome.json - Change of use
  • application/priorApproval/extendUniversity.json - Educational building extension
  • application/priorApproval/buildHomes.json - New residential development
  • application/priorApproval/solarPanels.json - Renewable energy installation

​
Lawful Development Certificate

  • application/lawfulDevelopmentCertificate/proposed.json - LDCP application
  • application/lawfulDevelopmentCertificate/existing.json - LDCE application

​
Other Types

  • application/listedBuildingConsent.json - Listed building works
  • application/landDrainageConsent.json - Drainage works
  • preApplication/preApp.json - Pre-application advice request
  • enforcement/breach.json - Planning breach report

​
Using Examples in Your Project

Examples can be used for:

Schema Validation

Test your implementation against known-valid payloads

Development

Use as templates when building new services

Testing

Create comprehensive test suites with real-world data

Documentation

Reference concrete examples in technical specifications

​
Validation

All examples are validated against their respective schemas during the build process. You can validate your own payloads: 
pnpm test
See the Contributing guide for more details on adding and testing new examples.

Build docs developers (and LLMs) love

Get started for freeTalk to us