Skip to main content

Overview

The PrototypeApplication schema represents the prototype version of the planning application data structure used in digital planning services. This schema includes additional metadata and features that are being tested and refined before potentially being incorporated into the main Application schema.

Purpose

PrototypeApplication serves as a testing ground for:
  • New features - Experimental fields and structures
  • Enhanced metadata - Additional tracking and analytics capabilities
  • Pre-assessment logic - Automated eligibility and route checking
  • Service improvements - Fields supporting improved user experience

Schema Structure

The PrototypeApplication uses a generic base type that varies based on the applicationType:
applicationType
ApplicationType
required
The granular application type (e.g., “pp.full.householder”, “ldc.proposed”, “pa.part1.classA”)
data
object
required
Core application data
responses
Responses
required
The ordered list of questions and answers from the user’s journey through the service
files
File[]
required
Files uploaded with the application
metadata
PrototypePlanXMetadata
required
Enhanced metadata with additional service and analytics information

Pre-Assessment Feature

For certain application types, PrototypeApplication includes a preAssessment field:
preAssessment
object
Automated assessment result based on user inputs, available for applications like Prior Approval and Lawful Development Certificates

Application Types with Pre-Assessment

The following application types include pre-assessment:
  • Lawful Development Certificates
    • LDC Existing (ldc.existing)
    • LDC Proposed (ldc.proposed)
  • Prior Approval (all parts and classes)
    • Part 1 Class A, AA
    • Part 3 Classes G, M, MA, N, Q, R, S, T, V
    • Part 4 Classes BB, BC, CA, E
    • Part 6, 7, 9, 11, 14, 16, 17, 18, 19, 20

Type-Specific Variations

The PrototypeApplication structure varies based on the application type:

Planning Permission Applications

  • Full fee calculations
  • CIL declarations
  • Ownership certificates
  • Detailed proposal information

Prior Approval Applications

  • Simplified fees
  • Permitted development parameters
  • Pre-assessment results
  • Specific class requirements

Lawful Development Certificates

  • Lawfulness tests
  • Evidence requirements
  • Pre-assessment of lawfulness
  • Historical information

Other Types

  • Type-specific proposal fields
  • Relevant legislation references
  • Application-specific declarations

Example Payload

Here’s an example of an Advertisement Consent application:
{
  "applicationType": "advertConsent",
  "data": {
    "user": {
      "role": "applicant"
    },
    "applicant": {
      "name": {
        "first": "Caroline",
        "last": "Chisholm"
      },
      "email": "[email protected]",
      "phone": {
        "primary": "7946 0000"
      },
      "address": {
        "sameAsSiteAddress": true
      },
      "siteContact": {
        "role": "applicant"
      },
      "ownership": {
        "interest": "owner"
      }
    },
    "property": {
      "address": {
        "latitude": 51.5345753,
        "longitude": -0.1030664,
        "title": "32, CHARLTON PLACE, LONDON",
        "uprn": "005300018831",
        "postcode": "N1 8AJ"
      },
      "type": "residential.dwelling.house.terrace"
    },
    "application": {
      "fee": {
        "calculated": 165,
        "payable": 165
      },
      "declaration": {
        "accurate": true,
        "connection": {
          "value": "none"
        }
      }
    },
    "proposal": {
      "advertType": "onPremise",
      "date": {
        "start": "2025-03-20",
        "completion": "2025-08-20"
      },
      "advertisementDetails": {
        "fascia": 1,
        "projecting": 1,
        "hoarding": 1,
        "other": 1
      },
      "highwayProjection": false,
      "visibility": {
        "public": true
      }
    }
  },
  "responses": [
    {
      "question": "What type of property is it?",
      "responses": [
        {
          "value": "House"
        }
      ],
      "metadata": {
        "autoAnswered": true,
        "sectionName": "The property"
      }
    }
  ],
  "files": [
    {
      "name": "advertisement-details.pdf",
      "type": ["proposals.illustration"]
    }
  ],
  "metadata": {
    "organisation": "ISL",
    "id": "abc123def456",
    "submittedAt": "2025-01-15T10:00:00.000Z",
    "schema": "https://theopensystemslab.github.io/digital-planning-data-schemas/@next/schemas/prototypeApplication.json",
    "source": "PlanX",
    "service": {
      "flowId": "flow-advert-consent",
      "url": "https://www.planx.uk/islington/apply-for-advert-consent"
    }
  }
}

Supported Application Types

PrototypeApplication supports all planning application types including:

Planning Permission (pp.*)

  • Full householder, minor, major
  • Outline applications
  • Listed building applications
  • Demolition, fast track affordable
  • Technical details

Prior Approval (pa.*)

  • All GPDO parts (1, 3, 4, 6, 7, 9, 11, 14, 16, 17, 18, 19, 20)
  • All relevant classes

Lawful Development Certificates (ldc.*)

  • Existing use or development
  • Proposed use or development
  • Breach of condition
  • Listed building works

Other Types

  • Advertisement Consent
  • Listed Building Consent
  • Works to Trees (consent and notice)
  • Hedgerow Removal Notice
  • Land Drainage Consent
  • Amendments and approvals
  • Enforcement-related applications
Each type is represented as a specific union member with appropriate type-specific fields.

Differences from Application Schema

PrototypeApplication differs from the base Application schema in:
  1. Type discrimination - Uses applicationType field to discriminate union types
  2. Enhanced metadata - Includes service and analytics information
  3. Type-specific structures - Property, Proposal, and Applicant structures vary by type
  4. Pre-assessment - Some types include pre-assessment results
  5. Experimental features - May include fields being tested for future inclusion

JSON Schema

The complete JSON Schema definition is available at:
https://theopensystemslab.github.io/digital-planning-data-schemas/@next/schemas/prototypeApplication.json
As a prototype schema, this specification may change more frequently than the stable Application schema. Use versioned schema URLs in production systems.

Migration Path

PrototypeApplication features that prove successful may be:
  • Incorporated into the main Application schema
  • Refined based on real-world usage
  • Standardized for wider adoption
This prototype approach allows for innovation while maintaining stability in the core specification.

Application

Stable application schema

PostSubmissionApplication

Extended schema for back office systems

PreApplication

Pre-application advice schema

Build docs developers (and LLMs) love