@planning-inspectorate/data-model 1.11.0

package/schemas/commands/appeal-common-submission.schema.json

@@ -0,0 +1,202 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "commands/appeal-common-submission.schema.json",
+  "title": "Appellant common submission properties",
+  "description": "Schema defining any properties common across all appeal types for appeal submissions",
+  "type": "object",
+  "additionalProperties": true,
+  "required": [
+    "submissionId",
+    "caseProcedure",
+    "lpaCode",
+    "caseSubmittedDate",
+    "enforcementNotice",
+    "applicationReference",
+    "applicationDate",
+    "applicationDecision",
+    "applicationDecisionDate",
+    "caseSubmissionDueDate",
+    "siteAddressLine1",
+    "siteAddressLine2",
+    "siteAddressTown",
+    "siteAddressCounty",
+    "siteAddressPostcode",
+    "siteAccessDetails",
+    "siteSafetyDetails",
+    "neighbouringSiteAddresses",
+    "nearbyCaseReferences"
+  ],
+  "properties": {
+    "submissionId": {
+      "type": "string",
+      "format": "uuid",
+      "examples": ["7f45748c-2342-4b59-b934-ad6183e8d834"],
+      "description": "Case submission id - link to draft submission created by appellant"
+    },
+    "caseProcedure": {
+      "type": "string",
+      "enum": ["written", "hearing", "inquiry"],
+      "description": "The type of procedure for the appeal"
+    },
+    "lpaCode": {
+      "type": "string",
+      "examples": ["Q9999"],
+      "description": "A unique identifier for the Local Planning Authority",
+      "$comment": "Uses the internal PINS code identifying LPAs"
+    },
+    "caseSubmittedDate": {
+      "type": "string",
+      "format": "date-time",
+      "examples": ["2023-07-27T20:30:00.000Z"],
+      "description": "The date the appeal was submitted by the appellant"
+    },
+    "enforcementNotice": {
+      "type": ["boolean", "null"],
+      "description": "Indicates if an enforcement notice is the reason for the appeal"
+    },
+    "applicationReference": {
+      "type": "string",
+      "examples": ["43010/APP/1/290572"],
+      "description": "The unique identifier of the LPA application"
+    },
+    "applicationDate": {
+      "type": "string",
+      "format": "date-time",
+      "examples": ["2023-07-27T20:30:00.000Z"],
+      "description": "The date of the original LPA application"
+    },
+    "applicationDecision": {
+      "type": "string",
+      "enum": ["granted", "refused", "not_received"],
+      "description": "The outcome of the original LPA decision"
+    },
+    "applicationDecisionDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "examples": ["2023-07-27T20:30:00.000Z"],
+      "description": "The date of the original LPA decision"
+    },
+    "caseSubmissionDueDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "examples": ["2023-07-27T20:30:00.000Z"],
+      "description": "The statutory deadline for submitting an appeal from the original LPA decision date",
+      "$comment": "Calculated from the applicationDecisionDate"
+    },
+    "siteAddressLine1": {
+      "type": "string",
+      "examples": ["96 The Avenue"],
+      "description": "First line of address for the appeal site"
+    },
+    "siteAddressLine2": {
+      "type": ["string", "null"],
+      "description": "Second line of address for the appeal site"
+    },
+    "siteAddressTown": {
+      "type": "string",
+      "examples": ["Maidstone"],
+      "description": "Town / City of the site address"
+    },
+    "siteAddressCounty": {
+      "type": ["string", "null"],
+      "examples": ["Kent"],
+      "description": "County of the site address"
+    },
+    "siteAddressPostcode": {
+      "type": "string",
+      "examples": ["MD21 5XY"],
+      "description": "Postal code of the site address"
+    },
+    "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"
+    },
+    "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"
+    },
+    "nearbyCaseReferences": {
+      "type": ["array", "null"],
+      "items": {
+        "type": "string",
+        "examples": ["6000456", "8004567"]
+      },
+      "description": "A list of related case references known to the appellant and the LPA"
+    },
+    "typeOfPlanningApplication": {
+      "type": ["string", "null"],
+      "enum": [
+        "full-appeal",
+        "householder-planning",
+        "outline-planning",
+        "prior-approval",
+        "reserved-matters",
+        "removal-or-variation-of-conditions",
+        "listed-building",
+        "minor-commercial-development",
+        null
+      ]
+    }
+  }
+}

package/schemas/commands/appeal-has-submission.schema.json

@@ -0,0 +1,82 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "commands/appeal-has-submission.schema.json",
+  "title": "Appellant HAS submission properties",
+  "description": "Schema defining any HAS specific properties for submissions",
+  "type": "object",
+  "additionalProperties": true,
+  "required": [
+    "isGreenBelt",
+    "siteAreaSquareMetres",
+    "floorSpaceSquareMetres",
+    "ownsAllLand",
+    "ownsSomeLand",
+    "knowsOtherOwners",
+    "knowsAllOwners",
+    "advertisedAppeal",
+    "ownersInformed",
+    "originalDevelopmentDescription",
+    "changedDevelopmentDescription",
+    "appellantCostsAppliedFor"
+  ],
+  "allOf": [
+    { "$ref": "appeal-common-submission.schema.json" },
+    {
+      "properties": {
+        "isGreenBelt": {
+          "type": ["boolean", "null"],
+          "description": "Indicates if the site is in a green belt"
+        },
+        "siteAreaSquareMetres": {
+          "type": ["number", "null"],
+          "examples": [45.7],
+          "description": "The site area, in square meters"
+        },
+        "floorSpaceSquareMetres": {
+          "type": ["number", "null"],
+          "examples": [3.5],
+          "description": "The floor space, in square meters"
+        },
+        "ownsAllLand": {
+          "type": ["boolean", "null"],
+          "description": "Indicates if the appellant has complete ownership of the site"
+        },
+        "ownsSomeLand": {
+          "type": ["boolean", "null"],
+          "description": "Indicates if the appellant has partial ownership of the site"
+        },
+        "knowsOtherOwners": {
+          "type": ["string", "null"],
+          "enum": ["Yes", "No", "Some", null],
+          "description": "Indicates if the appellant knows other owners of the site"
+        },
+        "knowsAllOwners": {
+          "type": ["string", "null"],
+          "enum": ["Yes", "No", "Some", null],
+          "description": "Indicates if the appellant knows all owners of the site"
+        },
+        "advertisedAppeal": {
+          "type": ["boolean", "null"],
+          "description": "Indicates if the appellant has advertised the appeal to the LPA decision"
+        },
+        "ownersInformed": {
+          "type": ["boolean", "null"],
+          "description": "Indicates if the appellant has informed other owners of the site"
+        },
+        "originalDevelopmentDescription": {
+          "type": ["string", "null"],
+          "examples": ["Replacement of an existing gate to access the property"],
+          "description": "The original description of the development, as provided by the appellant"
+        },
+        "changedDevelopmentDescription": {
+          "type": ["boolean", "null"],
+          "description": "Indicates that the LPA has changed the development description"
+        },
+        "appellantCostsAppliedFor": {
+          "type": ["boolean", "null"],
+          "description": "Indicates if the appellant has applied for costs"
+        }
+      }
+    }
+  ]
+}

package/schemas/commands/appeal-representation-submission.schema.json

@@ -0,0 +1,192 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "commands/appeal-representation-submission.schema.json",
+  "title": "appeal representation submission",
+  "description": "Schema defining the data produced by the Front-Office when a representation is created on an appeal",
+  "type": "object",
+  "additionalProperties": true,
+  "required": ["caseReference", "representationSubmittedDate", "representation", "representationType", "documents"],
+  "oneOf": [{ "required": ["serviceUserId"] }, { "required": ["lpaCode"] }, { "required": ["newUser"] }],
+  "properties": {
+    "caseReference": {
+      "type": "string",
+      "examples": ["7002471"],
+      "description": "External case identifier"
+    },
+    "representationSubmittedDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "examples": ["2023-07-27T20:30:00.000Z"],
+      "description": "The date the representation was submitted"
+    },
+    "representationType": {
+      "type": "string",
+      "enum": ["statement", "comment", "final_comment", "proofs_evidence", null],
+      "description": "The type of representation"
+    },
+    "representation": {
+      "type": ["string", "null"],
+      "description": "The original representation"
+    },
+    "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": [
+              "interestedPartyComment",
+              "lpaStatement",
+              "rule6Statement",
+              "appellantFinalComment",
+              "lpaFinalComment",
+              "appellantProofOfEvidence",
+              "appellantWitnessesEvidence",
+              "lpaProofOfEvidence",
+              "lpaWitnessesEvidence",
+              "rule6ProofOfEvidence",
+              "rule6WitnessesEvidence",
+              null
+            ],
+            "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"
+        ]
+      }
+    },
+    "serviceUserId": {
+      "type": ["string", "null"],
+      "description": "Service User Id of the person or organisation making the representation"
+    },
+    "lpaCode": {
+      "type": ["string", "null"],
+      "examples": ["Q9999"],
+      "description": "A unique identifier for the Local Planning Authority",
+      "$comment": "Uses the internal PINS code identifying LPAs"
+    },
+    "newUser": {
+      "type": "object",
+      "additionalProperties": true,
+      "required": [
+        "salutation",
+        "firstName",
+        "lastName",
+        "emailAddress",
+        "telephoneNumber",
+        "organisation",
+        "serviceUserType"
+      ],
+      "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": ["InterestedParty"]
+        },
+        "addressLine1": {
+          "type": "string",
+          "examples": ["96 The Avenue"],
+          "description": "First line of address of the user making the representation"
+        },
+        "addressLine2": {
+          "type": ["string", "null"],
+          "description": "Second line of address of the user making the representation"
+        },
+        "addressTown": {
+          "type": "string",
+          "examples": ["Maidstone"],
+          "description": "Town / City of the user making the representation"
+        },
+        "addressCounty": {
+          "type": ["string", "null"],
+          "examples": ["Kent"],
+          "description": "County of the user making the representation"
+        },
+        "addressPostcode": {
+          "type": "string",
+          "examples": ["MD21 5XY"],
+          "description": "Postal code of the user making the representation"
+        }
+      }
+    }
+  }
+}

package/schemas/commands/appeal-s78-submission.schema.json

@@ -0,0 +1,100 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "commands/appeal-s78-submission.schema.json",
+  "title": "Appellant s78 submission properties",
+  "description": "Schema defining any S78 specific properties for questionnaire submissions",
+  "type": "object",
+  "additionalProperties": true,
+  "required": [
+    "agriculturalHolding",
+    "tenantAgriculturalHolding",
+    "otherTenantsAgriculturalHolding",
+    "informedTenantsAgriculturalHolding",
+    "appellantProcedurePreference",
+    "appellantProcedurePreferenceDetails",
+    "appellantProcedurePreferenceDuration",
+    "appellantProcedurePreferenceWitnessCount",
+    "planningObligation",
+    "statusPlanningObligation",
+    "developmentType"
+  ],
+  "allOf": [
+    { "$ref": "appeal-has-submission.schema.json" },
+    {
+      "properties": {
+        "agriculturalHolding": {
+          "type": ["boolean", "null"],
+          "description": "Indicates if the site is an agricultural holding",
+          "$comment": "Only available in S78 cases"
+        },
+        "tenantAgriculturalHolding": {
+          "type": ["boolean", "null"],
+          "description": "Indicates if the site is a tenant agricultural holding",
+          "$comment": "Only available in S78 cases"
+        },
+        "otherTenantsAgriculturalHolding": {
+          "type": ["boolean", "null"],
+          "description": "Indicates if the site is an agricultural holding with other tenants",
+          "$comment": "Only available in S78 cases"
+        },
+        "informedTenantsAgriculturalHolding": {
+          "type": ["boolean", "null"],
+          "description": "If the site is an agricultural holding, indicates tenants are informed",
+          "$comment": "Only available in S78 cases"
+        },
+        "appellantProcedurePreference": {
+          "type": ["string", "null"],
+          "enum": ["written", "hearing", "inquiry", null],
+          "description": "The procedure preference indicated by the appellant",
+          "$comment": "Only available in S78 cases"
+        },
+        "appellantProcedurePreferenceDetails": {
+          "type": ["string", "null"],
+          "description": "The procedure details preference indicated by the appellant",
+          "$comment": "Only available in S78 cases"
+        },
+        "appellantProcedurePreferenceDuration": {
+          "type": ["number", "null"],
+          "description": "The duration of the procedure indicated by the appellant",
+          "$comment": "Only available in S78 cases"
+        },
+        "appellantProcedurePreferenceWitnessCount": {
+          "type": ["number", "null"],
+          "description": "The number of witnesses in inquiries",
+          "$comment": "Only available in S78 cases"
+        },
+        "planningObligation": {
+          "type": ["boolean", "null"],
+          "description": "Indicates the existence of a planning obligation",
+          "$comment": "Only available in S78 cases"
+        },
+        "statusPlanningObligation": {
+          "type": ["string", "null"],
+          "description": "The planning obligation information, if available",
+          "$comment": "Only available in S78 cases"
+        },
+        "developmentType": {
+          "type": ["string", "null"],
+          "enum": [
+            "householder",
+            "change-of-use",
+            "major-dwellings",
+            "major-industry-storage",
+            "major-offices",
+            "major-retail-services",
+            "major-traveller-caravan",
+            "mineral-workings",
+            "minor-dwellings",
+            "minor-industry-storage",
+            "minor-offices",
+            "minor-retail-services",
+            "minor-traveller-caravan",
+            "other-major",
+            "other-minor",
+            null
+          ]
+        }
+      }
+    }
+  ]
+}