@planning-inspectorate/data-model 1.11.0

package/schemas/commands/appellant-submission.schema.json

@@ -0,0 +1,164 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "commands/appellant-submission.schema.json",
+  "title": "Appellant Submission Command",
+  "description": "Schema defining the data produced by the Front-Office when an appeal is requested",
+  "$comment": "This is a combination of Appeal, Documents and Service user data",
+  "type": "object",
+  "additionalProperties": true,
+  "required": ["casedata", "documents", "users"],
+  "properties": {
+    "casedata": {
+      "type": "object",
+      "additionalProperties": true,
+      "required": ["caseType"],
+      "oneOf": [
+        {
+          "allOf": [{ "properties": { "caseType": { "const": "D" } } }, { "$ref": "appeal-has-submission.schema.json" }]
+        },
+        {
+          "allOf": [{ "properties": { "caseType": { "const": "W" } } }, { "$ref": "appeal-s78-submission.schema.json" }]
+        },
+        {
+          "allOf": [{ "properties": { "caseType": { "const": "Y" } } }, { "$ref": "appeal-s78-submission.schema.json" }]
+        }
+      ]
+    },
+    "documents": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "additionalProperties": true,
+        "properties": {
+          "documentId": {
+            "type": "string",
+            "examples": ["4547fec8-16b2-47bb-836d-4d0baac04079"],
+            "description": "The unique identifier for the document"
+          },
+          "filename": {
+            "type": "string",
+            "examples": ["filename.pdf"],
+            "description": "Current stored name of the document"
+          },
+          "originalFilename": {
+            "type": "string",
+            "examples": ["original_filename.pdf"],
+            "description": "Original name of document"
+          },
+          "size": {
+            "type": "integer",
+            "examples": [23452],
+            "description": "The file size, in bytes"
+          },
+          "mime": {
+            "type": ["string"],
+            "examples": ["application/pdf"],
+            "description": "The mime type for the current version of the file"
+          },
+          "documentURI": {
+            "type": "string",
+            "examples": [
+              "https://custom-domain.gov.uk/container-name/appeal/7002471/4547fec8-16b2-47bb-836d-4d0baac04079/v1/filename.pdf"
+            ],
+            "description": "The internal location of the document",
+            "$comment": "This property contains blob storage info (domain, container), caseReference, version and filename"
+          },
+          "dateCreated": {
+            "type": "string",
+            "format": "date-time",
+            "examples": ["2023-07-27T20:30:00.000Z"],
+            "description": "The creation date for the document"
+          },
+          "documentType": {
+            "type": ["string", "null"],
+            "enum": [
+              "appellantCaseCorrespondence",
+              "appellantCaseWithdrawalLetter",
+              "appellantCostsApplication",
+              "appellantCostsCorrespondence",
+              "appellantCostsWithdrawal",
+              "appellantStatement",
+              "applicationDecisionLetter",
+              "changedDescription",
+              "originalApplicationForm",
+              "planningObligation",
+              "ownershipCertificate",
+              "statementCommonGround",
+              "designAccessStatement",
+              "plansDrawings",
+              "newPlansDrawings",
+              "otherNewDocuments",
+              null,
+              "environmentalAssessment"
+            ],
+            "description": "The type of document, used for exchange, migrations and consumption from the appeal back-office system"
+          }
+        },
+        "required": [
+          "documentId",
+          "filename",
+          "originalFilename",
+          "size",
+          "mime",
+          "documentURI",
+          "dateCreated",
+          "documentType"
+        ]
+      }
+    },
+    "users": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "type": "object",
+        "additionalProperties": true,
+        "properties": {
+          "salutation": {
+            "type": ["string", "null"],
+            "description": "A formal greeting, e.g., Mr, Mrs, Ms.",
+            "examples": ["Mr"]
+          },
+          "firstName": {
+            "type": ["string", "null"],
+            "description": "The first name of the individual.",
+            "examples": ["John"]
+          },
+          "lastName": {
+            "type": ["string", "null"],
+            "description": "The last name of the individual.",
+            "examples": ["Doe"]
+          },
+          "emailAddress": {
+            "type": ["string", "null"],
+            "description": "The primary email address for contact.",
+            "examples": ["john.doe@example.com"]
+          },
+          "telephoneNumber": {
+            "type": ["string", "null"],
+            "description": "The primary telephone contact number.",
+            "examples": ["+447123456789"]
+          },
+          "organisation": {
+            "type": ["string", "null"],
+            "description": "The name of the organisation associated with the individual.",
+            "examples": ["Tech Corp"]
+          },
+          "serviceUserType": {
+            "type": "string",
+            "description": "Type or category of the service user.",
+            "enum": ["Appellant", "Agent"]
+          }
+        },
+        "required": [
+          "salutation",
+          "firstName",
+          "lastName",
+          "emailAddress",
+          "telephoneNumber",
+          "organisation",
+          "serviceUserType"
+        ]
+      }
+    }
+  }
+}

package/schemas/commands/interested-party.schema.json

@@ -0,0 +1,80 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "commands/interested-party.schema.json",
+  "title": "interested-party",
+  "description": "Subset of Pins Data Model [Service User]",
+  "type": "object",
+  "additionalProperties": true,
+  "required": [],
+  "properties": {
+    "id": {
+      "type": "number",
+      "examples": [18]
+    },
+    "interestedPartyNumber": {
+      "type": "string",
+      "examples": ["IP1234"]
+    },
+    "firstName": {
+      "type": "string",
+      "examples": ["Alan"]
+    },
+    "lastName": {
+      "type": "string",
+      "examples": ["Turing"]
+    },
+    "under18": {
+      "type": "boolean"
+    },
+    "organisationName": {
+      "title": "Name",
+      "type": "string",
+      "default": "",
+      "examples": ["National Highways"],
+      "pattern": "^.*$"
+    },
+    "jobTitle": {
+      "type": "string",
+      "examples": ["Communications Manager"]
+    },
+    "contactMethod": {
+      "type": "string",
+      "enum": ["email", "post"]
+    },
+    "email": {
+      "type": "string",
+      "examples": ["alan.turing@planninginspectorate.gov.uk"]
+    },
+    "phoneNumber": {
+      "type": "string",
+      "examples": ["0137732432"]
+    },
+    "address": {
+      "title": "Address",
+      "type": "object",
+      "required": ["addressLine1", "town", "postcode"],
+      "properties": {
+        "addressLine1": {
+          "type": "string",
+          "examples": ["National Traffic Operations Centre"]
+        },
+        "addressLine2": {
+          "type": "string",
+          "examples": ["3 Ridgeway, Quinton Business Park"]
+        },
+        "town": {
+          "type": "string",
+          "examples": ["Birmingham"]
+        },
+        "postcode": {
+          "type": "string",
+          "examples": ["B32 1AF"]
+        },
+        "country": {
+          "type": "string",
+          "examples": ["England"]
+        }
+      }
+    }
+  }
+}

package/schemas/commands/lpa-questionnaire-common.schema.json

@@ -0,0 +1,110 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "commands/lpa-questionnaire-common.schema.json",
+  "title": "LPAQ common submission properties",
+  "description": "Schema defining any properties common across all appeal types for LPAQ submissions",
+  "type": "object",
+  "additionalProperties": true,
+  "required": [
+    "caseReference",
+    "lpaQuestionnaireSubmittedDate",
+    "siteAccessDetails",
+    "siteSafetyDetails",
+    "nearbyCaseReferences",
+    "neighbouringSiteAddresses"
+  ],
+  "properties": {
+    "caseReference": {
+      "type": "string",
+      "examples": ["7002471"],
+      "description": "External case identifier"
+    },
+    "lpaQuestionnaireSubmittedDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "examples": ["2023-07-27T20:30:00.000Z"],
+      "description": "The date the LPA provided a response to the case"
+    },
+    "siteAccessDetails": {
+      "type": ["array", "null"],
+      "items": {
+        "type": "string",
+        "examples": ["The site is accessible through the small gate on the left of the property"]
+      },
+      "description": "Provided information on site accessibility"
+    },
+    "siteSafetyDetails": {
+      "type": ["array", "null"],
+      "items": {
+        "type": "string",
+        "examples": ["There is an aggressive dog in the property"]
+      },
+      "description": "Provided information on site health and safety"
+    },
+    "nearbyCaseReferences": {
+      "type": ["array", "null"],
+      "items": {
+        "type": "string",
+        "examples": ["6000456", "8004567"]
+      },
+      "description": "A list of related case references known to the appellant and the LPA"
+    },
+    "neighbouringSiteAddresses": {
+      "type": ["array", "null"],
+      "items": {
+        "type": "object",
+        "additionalProperties": true,
+        "properties": {
+          "neighbouringSiteAddressLine1": {
+            "type": "string",
+            "examples": ["96 The Avenue"],
+            "description": "First line of address of the site"
+          },
+          "neighbouringSiteAddressLine2": {
+            "type": ["string", "null"],
+            "description": "Second line of address of the site"
+          },
+          "neighbouringSiteAddressTown": {
+            "type": "string",
+            "examples": ["Maidstone"],
+            "description": "Town / City of the site address"
+          },
+          "neighbouringSiteAddressCounty": {
+            "type": ["string", "null"],
+            "examples": ["Kent"],
+            "description": "County of the site address"
+          },
+          "neighbouringSiteAddressPostcode": {
+            "type": "string",
+            "examples": ["MD21 5XY"],
+            "description": "Postal code of the site address"
+          },
+          "neighbouringSiteAccessDetails": {
+            "type": ["string", "null"],
+            "examples": ["Ongoing road works at this address"],
+            "description": "Provided information on site accessibility on this address"
+          },
+          "neighbouringSiteSafetyDetails": {
+            "type": ["string", "null"],
+            "examples": ["Ongoing road works at this address"],
+            "description": "Provided information on site health and safety on this address"
+          }
+        },
+        "required": [
+          "neighbouringSiteAddressLine1",
+          "neighbouringSiteAddressLine2",
+          "neighbouringSiteAddressTown",
+          "neighbouringSiteAddressCounty",
+          "neighbouringSiteAddressPostcode",
+          "neighbouringSiteAccessDetails",
+          "neighbouringSiteSafetyDetails"
+        ]
+      },
+      "description": "A list of neighbouring site addresses"
+    },
+    "reasonForNeighbourVisits": {
+      "type": ["string", "null"],
+      "description": "A general reason given for the need to visit any neighbours"
+    }
+  }
+}

package/schemas/commands/lpa-questionnaire-has.schema.json

@@ -0,0 +1,69 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "commands/lpa-questionnaire-has.schema.json",
+  "title": "LPAQ HAS submission properties",
+  "description": "Schema defining any HAS specific properties for LPAQ submissions",
+  "type": "object",
+  "additionalProperties": true,
+  "required": [
+    "isCorrectAppealType",
+    "affectedListedBuildingNumbers",
+    "isGreenBelt",
+    "inConservationArea",
+    "newConditionDetails",
+    "notificationMethod",
+    "lpaCostsAppliedFor",
+    "lpaStatement"
+  ],
+  "allOf": [
+    { "$ref": "lpa-questionnaire-common.schema.json" },
+    {
+      "properties": {
+        "isCorrectAppealType": {
+          "type": ["boolean", "null"],
+          "description": "Indicates if the LPA considers the appeal type appropriate"
+        },
+        "affectedListedBuildingNumbers": {
+          "type": ["array", "null"],
+          "items": {
+            "type": "string",
+            "examples": ["10023", "17824"]
+          },
+          "description": "A list of affected listed building IDs from Historic England"
+        },
+        "isGreenBelt": {
+          "type": ["boolean", "null"],
+          "description": "Indicates if the site is in a green belt"
+        },
+
+        "inConservationArea": {
+          "type": ["boolean", "null"],
+          "description": "Indicates if the site is in a conservation area"
+        },
+        "newConditionDetails": {
+          "type": ["string", "null"],
+          "examples": ["Since the original application, a number of things have changed..."],
+          "description": "New conditions details provided by the LPA"
+        },
+        "notificationMethod": {
+          "type": ["array", "null"],
+          "items": {
+            "type": "string",
+            "examples": ["notice", "letter", "advert"]
+          },
+          "description": "The methods used to notify relevant parties"
+        },
+
+        "lpaCostsAppliedFor": {
+          "type": ["boolean", "null"],
+          "description": "Indicates if the LPA has applied for costs"
+        },
+        "lpaStatement": {
+          "type": ["string", "null"],
+          "examples": ["We refused the application because of ..."],
+          "description": "A statement provided by the LPA, unused?"
+        }
+      }
+    }
+  ]
+}

package/schemas/commands/lpa-questionnaire-s78.schema.json

@@ -0,0 +1,218 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "commands/lpa-questionnaire-s78.schema.json",
+  "title": "LPAQ S78 submission properties",
+  "description": "Schema defining any S78 specific properties for LPAQ submissions",
+  "type": "object",
+  "additionalProperties": true,
+  "required": [
+    "changedListedBuildingNumbers",
+    "affectsScheduledMonument",
+    "hasProtectedSpecies",
+    "isAonbNationalLandscape",
+    "designatedSitesNames",
+    "hasTreePreservationOrder",
+    "isGypsyOrTravellerSite",
+    "isPublicRightOfWay",
+    "eiaEnvironmentalImpactSchedule",
+    "eiaDevelopmentDescription",
+    "eiaSensitiveAreaDetails",
+    "eiaColumnTwoThreshold",
+    "eiaScreeningOpinion",
+    "eiaRequiresEnvironmentalStatement",
+    "eiaCompletedEnvironmentalStatement",
+    "hasStatutoryConsultees",
+    "consultedBodiesDetails",
+    "hasConsultationResponses",
+    "hasEmergingPlan",
+    "hasSupplementaryPlanningDocs",
+    "hasInfrastructureLevy",
+    "isInfrastructureLevyFormallyAdopted",
+    "infrastructureLevyAdoptedDate",
+    "infrastructureLevyExpectedDate",
+    "lpaProcedurePreference",
+    "lpaProcedurePreferenceDetails",
+    "lpaProcedurePreferenceDuration"
+  ],
+  "allOf": [
+    { "$ref": "lpa-questionnaire-has.schema.json" },
+    {
+      "properties": {
+        "changedListedBuildingNumbers": {
+          "type": ["array", "null"],
+          "items": {
+            "type": "string",
+            "examples": ["10023", "17824"]
+          },
+          "description": "A list of changed listed building IDs from Historic England",
+          "$comment": "Only available in S78 cases"
+        },
+        "preserveGrantLoan": {
+          "type": ["boolean", "null"],
+          "description": "A grant or loan has been made to preserve the listed building",
+          "$comment": "Only available in S20 cases"
+        },
+        "consultHistoricEngland": {
+          "type": ["boolean", "null"],
+          "description": "Are Historic England to be consulted?",
+          "$comment": "Only available in S20 cases"
+        },
+        "affectsScheduledMonument": {
+          "type": ["boolean", "null"],
+          "description": "Indicates that a scheduled monument is affected",
+          "$comment": "Only available in S78 cases"
+        },
+        "hasProtectedSpecies": {
+          "type": ["boolean", "null"],
+          "description": "Indicates the existence of protected species",
+          "$comment": "Only available in S78 cases"
+        },
+        "isAonbNationalLandscape": {
+          "type": ["boolean", "null"],
+          "description": "Indicates an area of outstanding beauty (National Landscape)",
+          "$comment": "Only available in S78 cases"
+        },
+        "designatedSitesNames": {
+          "type": ["array", "null"],
+          "items": {
+            "type": "string",
+            "examples": ["SSSI", "cSAC", "SAC", "pSPA", "SPA", "user entered value"]
+          },
+          "description": "The designated site names",
+          "$comment": "Only available in S78 cases"
+        },
+        "hasTreePreservationOrder": {
+          "type": ["boolean", "null"],
+          "description": "Indicates a TPO (tree preservation order)",
+          "$comment": "Only available in S78 cases"
+        },
+        "isGypsyOrTravellerSite": {
+          "type": ["boolean", "null"],
+          "description": "Indicates a traveller site",
+          "$comment": "Only available in S78 cases"
+        },
+        "isPublicRightOfWay": {
+          "type": ["boolean", "null"],
+          "description": "Indicates a PROW (public right of way)",
+          "$comment": "Only available in S78 cases"
+        },
+        "eiaEnvironmentalImpactSchedule": {
+          "type": ["string", "null"],
+          "enum": ["schedule-1", "schedule-2", null],
+          "description": "The impact schedule from EIA",
+          "$comment": "Only available in S78 cases"
+        },
+        "eiaDevelopmentDescription": {
+          "type": ["string", "null"],
+          "enum": [
+            "agriculture-aquaculture",
+            "change-extensions",
+            "chemical-industry",
+            "energy-industry",
+            "extractive-industry",
+            "food-industry",
+            "infrastructure-projects",
+            "mineral-industry",
+            "other-projects",
+            "production-processing-of-metals",
+            "rubber-industry",
+            "textile-industries",
+            "tourism-leisure",
+            null
+          ],
+          "description": "The development description from EIA",
+          "$comment": "Only available in S78 cases"
+        },
+        "eiaSensitiveAreaDetails": {
+          "type": ["string", "null"],
+          "description": "The sensitive area details from EIA",
+          "$comment": "Only available in S78 cases"
+        },
+        "eiaColumnTwoThreshold": {
+          "type": ["boolean", "null"],
+          "description": "EIA specific threshold",
+          "$comment": "Only available in S78 cases"
+        },
+        "eiaScreeningOpinion": {
+          "type": ["boolean", "null"],
+          "description": "EIA screening opinion",
+          "$comment": "Only available in S78 cases"
+        },
+        "eiaRequiresEnvironmentalStatement": {
+          "type": ["boolean", "null"],
+          "description": "EIA environmental statement required",
+          "$comment": "Only available in S78 cases"
+        },
+        "eiaCompletedEnvironmentalStatement": {
+          "type": ["boolean", "null"],
+          "description": "EIA completed environmental statement required",
+          "$comment": "Only available in S78 cases"
+        },
+        "hasStatutoryConsultees": {
+          "type": ["boolean", "null"],
+          "description": "Indicates statutory consultees",
+          "$comment": "Only available in S78 cases"
+        },
+        "consultedBodiesDetails": {
+          "type": ["string", "null"],
+          "description": "The details of the bodies consulted"
+        },
+        "hasConsultationResponses": {
+          "type": ["boolean", "null"],
+          "description": "Indicates consultation responses",
+          "$comment": "Only available in S78 cases"
+        },
+        "hasEmergingPlan": {
+          "type": ["boolean", "null"],
+          "description": "Indicates emerging plans",
+          "$comment": "Only available in S78 cases"
+        },
+        "hasSupplementaryPlanningDocs": {
+          "type": ["boolean", "null"],
+          "description": "Indicates supplementary planning documents",
+          "$comment": "Only available in S78 cases"
+        },
+        "hasInfrastructureLevy": {
+          "type": ["boolean", "null"],
+          "description": "Indicates the existence of an infrastructure levy",
+          "$comment": "Only available in S78 cases"
+        },
+        "isInfrastructureLevyFormallyAdopted": {
+          "type": ["boolean", "null"],
+          "description": "Indicates if the infrastructure levy is formally adopted",
+          "$comment": "Only available in S78 cases"
+        },
+        "infrastructureLevyAdoptedDate": {
+          "type": ["string", "null"],
+          "format": "date-time",
+          "examples": ["2023-07-27T20:30:00.000Z"],
+          "description": "The date of the infrastructure levy adoption",
+          "$comment": "Only available in S78 cases"
+        },
+        "infrastructureLevyExpectedDate": {
+          "type": ["string", "null"],
+          "format": "date-time",
+          "examples": ["2023-07-27T20:30:00.000Z"],
+          "description": "The expected date of the infrastructure levy",
+          "$comment": "Only available in S78 cases"
+        },
+        "lpaProcedurePreference": {
+          "type": ["string", "null"],
+          "enum": ["written", "hearing", "inquiry", null],
+          "description": "The procedure preference indicated by the LPA",
+          "$comment": "Only available in S78 cases"
+        },
+        "lpaProcedurePreferenceDetails": {
+          "type": ["string", "null"],
+          "description": "The procedure details preference indicated by the LPA",
+          "$comment": "Only available in S78 cases"
+        },
+        "lpaProcedurePreferenceDuration": {
+          "type": ["number", "null"],
+          "description": "The duration of enquiry indicated by the LPA",
+          "$comment": "Only available in S78 cases"
+        }
+      }
+    }
+  ]
+}