@planning-inspectorate/data-model 2.49.0 → 2.50.0

package/schemas/applications-application.schema.json

@@ -0,0 +1,539 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "applications-application.schema.json",
+  "title": "Crown Development Application",
+  "description": "Main application details for Crown Development Project",
+  "type": "object",
+  "additionalProperties": true,
+  "required": ["id", "reference", "createdDate", "type", "hasAgent"],
+  "properties": {
+    "id": {
+      "type": "string",
+      "description": "Internal Identifier UUID",
+      "example": "AAAAAAAA-1234-1234-1234-AAAAAAAAAAAA"
+    },
+    "reference": {
+      "type": "string",
+      "description": "External Identifier: CROWN/YYYY/XXXXXXX",
+      "example": "CROWN/2025/12345"
+    },
+    "createdDate": {
+      "type": "string",
+      "format": "date-time",
+      "description": "Date the case was created"
+    },
+    "updatedDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "Date the case was updated"
+    },
+    "type": {
+      "type": "string",
+      "description": "Type of application. Name displayed to users",
+      "example": "Outline planning permission with some matters reserved",
+      "enum": [
+        "Planning permission",
+        "Outline planning permission with some matters reserved",
+        "Outline planning permission with all matters reserved",
+        "Approval of reserved matters following outline approval",
+        "Planning permission and listed building consent (LBC) for alterations, extension or demolition of a listed building"
+      ]
+    },
+    "subType": {
+      "type": ["string", "null"],
+      "description": "SubType applies to Planning permissions and LBC",
+      "example": "Listed building consent (LBC)",
+      "enum": ["Planning permission", "Listed building consent (LBC)"]
+    },
+    "linkedParentId": {
+      "type": ["string", "null"],
+      "description": "Self-referencial for parent to children relationship",
+      "example": "AAAAAAAA-1234-1234-1234-AAAAAAAAAAAA"
+    },
+    "description": {
+      "type": ["string", "null"],
+      "description": "Description of the project"
+    },
+    "primaryLPACode": {
+      "type": "string",
+      "description": "Primary Planning Body code",
+      "example": "Z0116"
+    },
+    "secondaryLPACode": {
+      "type": ["string", "null"],
+      "description": "Secondary LPAs when project overlaps authorities",
+      "example": "Z0116"
+    },
+    "hasAgent": {
+      "type": "boolean",
+      "description": "Is an agent assigned to the case on behalf of the applicant"
+    },
+    "organisations": {
+      "type": "array",
+      "description": "Applications can have one or more organisaitons associated with them.",
+      "items": {
+        "$ref": "#/$defs/organisation"
+      }
+    },
+    "siteAddress": {
+      "type": ["array", "null"],
+      "description": "Site Address details",
+      "items": {
+        "$ref": "#/$defs/address"
+      }
+    },
+    "siteEasting": {
+      "type": ["string", "null"],
+      "description": "Easting of the site, if known",
+      "example": "216600"
+    },
+    "siteNorthing": {
+      "type": ["string", "null"],
+      "description": "Northing of the site, if known",
+      "example": "771200"
+    },
+    "siteArea": {
+      "type": ["number", "null"],
+      "description": "Site area in hectares",
+      "example": 4.44
+    },
+    "expectedDateOfSubmission": {
+      "type": "string",
+      "format": "date-time",
+      "description": "Date case officer expects the application to be submitted (NB: cases are created before document submissions as applicants upload directly)"
+    },
+    "applicationStatus": {
+      "type": "string",
+      "description": "Current status of the case (enum)",
+      "enum": [
+        "New",
+        "Accepted",
+        "Invalid",
+        "Consultation period open",
+        "Hearing/Inquiry date set",
+        "Application on hold awaiting further information",
+        "Report awaited",
+        "Report sent to Decision Branch",
+        "Decision awaited",
+        "Decided",
+        "Withdrawn",
+        "Declined to determine",
+        "Closed - invalid",
+        "Closed - opened in error"
+      ]
+    },
+    "applicationStage": {
+      "type": ["string", "null"],
+      "description": "Current stage of the case (enum)",
+      "enum": [
+        "Accepted",
+        "Consultation",
+        "Procedure choice",
+        "Written representations",
+        "Inquiry",
+        "Hearing/Inquiry date set",
+        "Final decision"
+      ]
+    },
+    "nationallyImportant": {
+      "type": ["boolean", "null"],
+      "description": "Site is nationally important (Yes/No)"
+    },
+    "nationallyImportantConfirmationDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "Date the application's national importance was confirmed"
+    },
+    "notNationallyImportantEmailSent": {
+      "type": ["boolean", "null"],
+      "description": "Flags if a notNationallyImportant email has been sent"
+    },
+    "containsDistressingContent": {
+      "type": ["boolean", "null"],
+      "description": "Highlights the cases as containing distressing content"
+    },
+    "lpaReference": {
+      "type": ["string", "null"],
+      "description": "LPA cross reference. Reference number for the case as known by the Local Planning Authority (LPA)"
+    },
+    "category": {
+      "type": ["string", "null"],
+      "description": "Application category (enum)",
+      "enum": [
+        "Major Development",
+        "Buildings over 1000 square metres",
+        "Development of a site above 1 hectare",
+        "Dwellings numbering 10 or more",
+        "Dwellings of 0.5 hectare or more",
+        "Minerals",
+        "Waste",
+        "Non-Major Development",
+        "Buildings less than 1000 square metres",
+        "Development of a site less than 1 hectare",
+        "Dwellings numbering between 1 and 9",
+        "Dwellings of less than 0.5 hectare",
+        "Change of use",
+        "Relevant demolition",
+        "Other",
+        "Listed building consent to alter/extend",
+        "Listed building consent to demolish"
+      ]
+    },
+    "isGreenBelt": {
+      "type": ["boolean", "null"],
+      "description": "Is the site in green belt land"
+    },
+    "healthAndSafetyIssue": {
+      "type": ["boolean", "null"],
+      "description": "Does the Site has H&S Issue"
+    },
+    "applicationReceivedDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "Date the application was received"
+    },
+    "applicationReceivedDateEmailSent": {
+      "type": ["boolean", "null"],
+      "description": "Flags if an applicationReceived email has been sent"
+    },
+    "applicationAcceptedDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "Date the application was accepted"
+    },
+    "lpaQuestionnaireSentDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "Date the lpa questionnaire was sent"
+    },
+    "lpaQuestionnaireReceivedDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "Date the lpa questionnaire was received"
+    },
+    "lpaQuestionnaireReceivedEmailSent": {
+      "type": ["boolean", "null"],
+      "description": "Flags if an lpaQuestionnaireReceived email has been sent"
+    },
+    "publishDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "Date the application was published to the portal"
+    },
+    "pressNoticeDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "Date the press notice was published"
+    },
+    "neighboursNotifiedByLpaDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "Date the neighbours were notified by the LPA"
+    },
+    "siteNoticeByLpaDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "Date the site notice was erected by the LPA"
+    },
+    "targetDecisionDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "Date the application should be decided by"
+    },
+    "extendedTargetDecisionDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "Extended date by which the application should be decided"
+    },
+    "recoveredDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "Date the application was recovered by the Secretary of State"
+    },
+    "recoveredReportSentDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "Date the Inspector's report was sent to the Secretary of State"
+    },
+    "withdrawnDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "Date application was withdrawn"
+    },
+    "decisionDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "Date the application was decided on"
+    },
+    "originalDecisionDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "Date of the original decision if later quashed"
+    },
+    "decisionOutcome": {
+      "type": ["string", "null"],
+      "description": "As displayed to users",
+      "enum": ["Approved", "Approved with conditions", "Refused", "Withdrawn"]
+    },
+    "turnedAwayDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "Date application was turned away"
+    },
+    "representationsPublishDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "Date the representations was publish"
+    },
+    "representationsPeriodStartDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "Start date of the representation period (starts at 00:00)"
+    },
+    "representationsPeriodEndDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "End date of the representation period (ends at 23:59)"
+    },
+    "inspector1Id": {
+      "type": ["string", "null"],
+      "description": "EntraID for Inspector"
+    },
+    "inspector2Id": {
+      "type": ["string", "null"],
+      "description": "EntraID for Inspector"
+    },
+    "inspector3Id": {
+      "type": ["string", "null"],
+      "description": "EntraID for Inspector"
+    },
+    "assessorInspectorId": {
+      "type": ["string", "null"],
+      "description": "EntraID for Assessor"
+    },
+    "caseOfficerId": {
+      "type": ["string", "null"],
+      "description": "EntraID for Case Officer"
+    },
+    "planningOfficerId": {
+      "type": ["string", "null"],
+      "description": "EntraID for Planning Officer"
+    },
+    "eiaScreening": {
+      "type": ["boolean", "null"],
+      "description": "Does the application need an Environmental Impact Assessment"
+    },
+    "eiaScreeningOutcome": {
+      "type": ["string", "null"],
+      "description": "What was the outcome of the Environmental Impact Assessment",
+      "enum": ["required", "not required"]
+    },
+    "environmentalStatementReceivedDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "Date the environmental statement was received"
+    },
+    "siteIsVisibleFromPublicLand": {
+      "type": ["boolean", "null"],
+      "description": "Site is visible from public land (Yes/No or TRUE/FALSE tbc)"
+    },
+    "procedure": {
+      "type": ["string", "null"],
+      "description": "Name displayed to users",
+      "enum": ["Written Representations", "Hearing", "Inquiry"]
+    },
+    "procedureNotificationDate": {
+      "type": ["string", "null"],
+      "format": "date-time"
+    },
+    "eventDate": {
+      "type": ["string", "null"],
+      "format": "date-time"
+    },
+    "eventPrepDuration": {
+      "type": ["number", "null"],
+      "example": 1234.56
+    },
+    "eventSittingDuration": {
+      "type": ["number", "null"],
+      "example": 1234.56
+    },
+    "eventReportingDuration": {
+      "type": ["number", "null"],
+      "example": 1234.56
+    },
+    "eventVenue": {
+      "type": ["string", "null"]
+    },
+    "eventNotificationDate": {
+      "type": ["string", "null"],
+      "format": "date-time"
+    },
+    "eventIssuesReportPublishedDate": {
+      "type": ["string", "null"],
+      "format": "date-time"
+    },
+    "eventStatementsDate": {
+      "type": ["string", "null"],
+      "format": "date-time"
+    },
+    "eventCaseManagementConferenceDate": {
+      "type": ["string", "null"],
+      "format": "date-time"
+    },
+    "eventPreMeetingDate": {
+      "type": ["string", "null"],
+      "format": "date-time"
+    },
+    "eventProofsOfEvidenceDate": {
+      "type": ["string", "null"],
+      "format": "date-time"
+    },
+    "hasApplicationFee": {
+      "type": ["boolean", "null"],
+      "description": "Application has associated Fee (Yes/No or TRUE/FALSE tbc)"
+    },
+    "applicationFee": {
+      "type": ["number", "null"],
+      "description": "The amount to be payed by the Applicant"
+    },
+    "applicationFeeReceivedDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "Date the application fee was received"
+    },
+    "eligibleForFeeRefund": {
+      "type": ["boolean", "null"],
+      "description": "Is the applicant eligible for a refund on the fee"
+    },
+    "applicationFeeRefundAmount": {
+      "type": ["number", "null"],
+      "description": "The amount to be refunded to the Applicant"
+    },
+    "applicationFeeRefundDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "Date the application fee was refunded"
+    },
+    "siteVisitDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "Date the site was/is going to be visited by the inspector"
+    },
+    "cilLiable": {
+      "type": ["boolean", "null"],
+      "description": "Is the application liable for a community infrastructure levy"
+    },
+    "cilAmount": {
+      "type": ["number", "null"],
+      "description": "The amount for the community infrastructure levy"
+    },
+    "bngExempt": {
+      "type": ["boolean", "null"],
+      "description": "Is the site exempt from the Biodiversity Net Gain"
+    },
+    "hasCostsApplications": {
+      "type": ["boolean", "null"],
+      "description": "If a party is making a cost claim against another for unreasonable behaviour"
+    },
+    "costsApplicationsComment": {
+      "type": ["string", "null"],
+      "description": "Details about the cost application"
+    },
+    "environmentalImpactAssessment": {
+      "type": ["boolean", "null"],
+      "description": "Does the application have an Environmental Impact Assessment - used for context in emails to LPAs"
+    },
+    "developmentPlan": {
+      "type": ["boolean", "null"],
+      "description": "Is the application a standard development plan - used for context in emails to LPAs"
+    },
+    "rightOfWay": {
+      "type": ["boolean", "null"],
+      "description": "Does the application apply to rights of way - used for context in emails to LPAs"
+    }
+  },
+  "$defs": {
+    "organisation": {
+      "type": "object",
+      "additionalProperties": true,
+      "required": ["contactRoleType", "organisationId"],
+      "properties": {
+        "roleType": {
+          "type": "string",
+          "description": "Agent or Applicant details",
+          "example": "agent",
+          "enum": ["agent", "applicant"]
+        },
+        "organisationId": {
+          "type": "string",
+          "description": "Source PK for Organisation",
+          "example": "AAAAAAAA-1234-1234-1234-AAAAAAAAAAAA"
+        },
+        "organisationName": {
+          "type": ["string", "null"]
+        },
+        "organisationAddress": {
+          "type": ["array", "null"],
+          "items": {
+            "$ref": "#/$defs/address"
+          }
+        },
+        "contacts": {
+          "type": ["array", "null"],
+          "description": "An Organisation may be linked to one or more Contacts",
+          "items": {
+            "$ref": "#/$defs/contact"
+          }
+        }
+      }
+    },
+    "contact": {
+      "type": "object",
+      "additionalProperties": true,
+      "required": ["contactId"],
+      "properties": {
+        "contactId": {
+          "type": "string",
+          "description": "Source PK for Contact",
+          "example": "AAAAAAAA-1234-1234-1234-AAAAAAAAAAAA"
+        },
+        "contactPreference": {
+          "type": ["string", "null"],
+          "example": "email",
+          "enum": ["email", "post"]
+        },
+        "writtenRepOrgName": {
+          "type": ["string", "null"],
+          "description": "Organisation Name used for written-representation on behalf of an organisation"
+        },
+        "writtenRepJobTitleorRole": {
+          "type": ["string", "null"],
+          "description": "Job Title or Role used for written-representation on behalf of an organisation"
+        }
+      }
+    },
+    "address": {
+      "type": "object",
+      "additionalProperties": true,
+      "required": ["postcode"],
+      "properties": {
+        "line1": {
+          "type": ["string", "null"]
+        },
+        "line2": {
+          "type": ["string", "null"]
+        },
+        "townCity": {
+          "type": ["string", "null"]
+        },
+        "county": {
+          "type": ["string", "null"]
+        },
+        "postcode": {
+          "type": "string"
+        }
+      }
+    }
+  }
+}

package/schemas/applications-notify-email.schema.json

@@ -0,0 +1,118 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "applications-notify-email.schema.json",
+  "title": "Email Notification Record Schema",
+  "description": "Email Notifications for Casework Projects",
+  "type": "object",
+  "additionalProperties": true,
+  "required": ["id", "caseReference", "caseId", "caseType", "status", "lpaCode"],
+  "properties": {
+    "id": {
+      "type": "string",
+      "description": "Internal Identifier UUID",
+      "example": "AAAAAAAA-1234-1234-1234-AAAAAAAAAAAA"
+    },
+    "notifyId": {
+      "type": ["string", "null"],
+      "description": "Id used by Notify"
+    },
+    "reference": {
+      "type": "string",
+      "description": "Reference passed to notify (used to identify the case or representation it relates to)"
+    },
+    "caseReference": {
+      "type": "string",
+      "description": "Business Key for the related case",
+      "example": "CROWN/2025/12345"
+    },
+    "caseId": {
+      "type": "string",
+      "description": "The unique ID for the case this notification belongs to.",
+      "example": "AAAAAAAA-1234-1234-1234-AAAAAAAAAAAA"
+    },
+    "caseType": {
+      "type": "string",
+      "description": "The type of case this notification is for.",
+      "example": "Crown Development Application"
+    },
+    "createdDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "Date the email was created"
+    },
+    "createdBy": {
+      "type": ["string", "null"],
+      "description": "Name of the person that triggered the email (only applies when done manually)"
+    },
+    "completedDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "When the email completed (succeeded or failed)"
+    },
+    "email": {
+      "type": ["string", "null"],
+      "format": "email",
+      "description": "Email address sent to if unable to be linked to an LPA or Contact"
+    },
+    "contact": {
+      "type": ["array", "null"],
+      "description": "Contact(s) the email was sent to",
+      "items": {
+        "$ref": "#/$defs/Contact"
+      }
+    },
+    "lpaCode": {
+      "type": "string",
+      "description": "Planning Body code",
+      "example": "Z0116"
+    },
+    "emailStatus": {
+      "type": "string",
+      "description": "Outcome of the email (status)",
+      "enum": ["Sending", "Delivered", "Permanent failure", "Temporary failure", "Technical failure"],
+      "example": "Delivered"
+    },
+    "templateId": {
+      "type": ["string", "null"],
+      "description": "The id of the template sent in Notify"
+    },
+    "templateVersion": {
+      "type": ["integer", "null"],
+      "description": "The version of the template sent"
+    },
+    "body": {
+      "type": ["string", "null"],
+      "description": "The full HTML/plain text body of the email"
+    },
+    "subject": {
+      "type": ["string", "null"],
+      "description": "The full HTML/plain text subject of the email"
+    }
+  },
+  "$defs": {
+    "Contact": {
+      "type": "object",
+      "description": "Contact the email was sent to",
+      "required": ["contactId", "addressId"],
+      "properties": {
+        "contactId": {
+          "type": "string",
+          "description": "Source PK for Contact",
+          "example": "AAAAAAAA-1234-1234-1234-AAAAAAAAAAAA"
+        },
+        "contactPreference": {
+          "type": ["string", "null"],
+          "enum": ["email", "post"],
+          "description": "Preferred contact method",
+          "example": "email"
+        },
+        "writtenRepOrgName": {
+          "type": ["string", "null"]
+        },
+        "writtenRepJobTitleorRole": {
+          "type": ["string", "null"]
+        }
+      }
+    }
+  }
+}