@planning-inspectorate/data-model 2.55.0 → 2.57.0

package/pins_data_model/models/model_applications_crowndev_application.py

@@ -172,11 +172,15 @@ class Address(BaseModel):
     model_config = ConfigDict(
         extra="allow",
     )
+    addressId: str
+    """
+    The source system Primary Key for an address.
+    """
     line1: str | None = None
     line2: str | None = None
     townCity: str | None = None
     county: str | None = None
-    postcode: str
+    postcode: str | None = None
 
 
 class Organisation(BaseModel):

package/schemas/address.schema.json

@@ -1,15 +1,20 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
   "$id": "address.schema.json",
-  "title": "PINS Address Schema",
+  "title": "Address",
   "description": "A schema to define the structure of an Address object in PINS.",
   "type": "object",
   "additionalProperties": true,
-  "required": ["addressDimKey", "caseReference", "caseId", "caseType"],
+  "required": ["addressId", "caseReference", "caseId", "caseType"],
   "properties": {
+    "addressId": {
+      "type": "string",
+      "description": "The source system Primary Key for an address.",
+      "example": "BBBBBBBBB-1234-1234-1234-AAAAAAAAAAAA"
+    },
     "addressDimKey": {
-      "type": "number",
-      "description": "Primary Key for an Address.",
+      "type": ["number", "null"],
+      "description": "ODW Address Dimension Primary Key.",
       "example": 12345
     },
     "addressType": {

package/schemas/appeal-document.schema.json

@@ -137,6 +137,7 @@
     "documentType": {
       "type": ["string", "null"],
       "enum": [
+        "appellantCase",
         "appellantCaseCorrespondence",
         "appellantCaseWithdrawalLetter",
         "appellantCostsApplication",
@@ -151,6 +152,7 @@
         "whoNotifiedLetterToNeighbours",
         "whoNotifiedPressAdvert",
         "conservationMap",
+        "lpaQuestionnaire",
         "lpaCaseCorrespondence",
         "lpaCostsApplication",
         "lpaCostsCorrespondence",

package/schemas/appeal-group-c.schema.json

@@ -0,0 +1,385 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "appeal-group-c.schema.json",
+  "title": "Appeal Group C Case",
+  "description": "Group C - Schema defining the metadata for generic and low-volume appeals",
+  "type": "object",
+  "additionalProperties": true,
+  "required": [
+    "caseId",
+    "caseReference",
+    "caseStatus",
+    "caseType",
+    "caseProcedure",
+    "lpaCode",
+    "caseOfficerId",
+    "inspectorId",
+    "padsSapId",
+    "allocationLevel",
+    "allocationBand",
+    "caseSpecialisms",
+    "caseCreatedDate",
+    "caseSubmittedDate",
+    "caseUpdatedDate",
+    "caseValidDate",
+    "caseValidationDate",
+    "caseValidationOutcome",
+    "caseStartedDate",
+    "casePublishedDate",
+    "lpaQuestionnaireCreatedDate",
+    "lpaQuestionnaireSubmittedDate",
+    "lpaQuestionnaireValidationOutcome",
+    "lpaQuestionnaireDueDate",
+    "caseWithdrawnDate",
+    "caseTransferredDate",
+    "caseDecisionOutcomeDate",
+    "caseDecisionOutcome",
+    "caseCompletedDate",
+    "siteAddressLine1",
+    "siteAddressLine2",
+    "siteAddressTown",
+    "siteAddressCounty",
+    "siteAddressPostcode"
+  ],
+  "properties": {
+    "caseId": {
+      "type": ["integer", "null"],
+      "examples": [6000001],
+      "description": "Internal case identifier"
+    },
+    "caseReference": {
+      "type": "string",
+      "pattern": "^6\\d{6}$",
+      "examples": ["6000001"],
+      "description": "External case identifier for Group C appeals (7 digit number starting in 6)"
+    },
+    "caseType": {
+      "type": "string",
+      "enum": ["C", "D", "F", "G", "H", "L", "Q", "S", "V", "W", "X", "Y", "Z", "ZA", "ZP"],
+      "description": "The internal letter code for an appeal type, e.g. W (Environmental)"
+    },
+    "caseStatus": {
+      "type": "string",
+      "enum": [
+        "assign_case_officer",
+        "validation",
+        "ready_to_start",
+        "lpa_questionnaire",
+        "issue_determination",
+        "statements",
+        "evidence",
+        "witnesses",
+        "final_comments",
+        "complete",
+        "invalid",
+        "closed",
+        "withdrawn",
+        "awaiting_transfer",
+        "transferred",
+        "event",
+        "awaiting_event",
+        "notice_withdrawn",
+        "closed_opened_in_error"
+      ],
+      "description": "The processing status for the appeal"
+    },
+    "caseProcedure": {
+      "type": ["string", "null"],
+      "enum": ["written", "hearing", "inquiry", "writtenPart1", "writtenPart2", null],
+      "description": "The type of procedure for the appeal"
+    },
+    "caseCreatedDate": {
+      "type": "string",
+      "format": "date-time",
+      "examples": ["2026-07-27T20:30:00.000Z"],
+      "description": "The date the appeal was received"
+    },
+    "caseSubmittedDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "examples": ["2026-07-27T20:30:00.000Z"],
+      "description": "The date the appeal was submitted by the appellant"
+    },
+    "caseUpdatedDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "examples": ["2026-07-27T20:30:00.000Z"],
+      "description": "The date the appeal was last updated in the back-office"
+    },
+    "caseValidDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "examples": ["2026-07-27T20:30:00.000Z"],
+      "description": "The date since when the appeal was considered valid"
+    },
+    "caseValidationDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "examples": ["2026-07-27T20:30:00.000Z"],
+      "description": "The date the appeal was validated in the back-office"
+    },
+    "caseValidationOutcome": {
+      "type": ["string", "null"],
+      "enum": ["valid", "invalid", "incomplete", null],
+      "description": "The outcome of the validation action"
+    },
+    "caseStartedDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "examples": ["2026-07-27T20:30:00.000Z"],
+      "description": "A date indicating when the case was started, resulting in the creation of a timetable"
+    },
+    "casePublishedDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "examples": ["2026-07-27T20:30:00.000Z"],
+      "description": "A date indicating when the case was published"
+    },
+    "lpaQuestionnaireCreatedDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "examples": ["2026-07-27T20:30:00.000Z"],
+      "description": "The date the LPA response was received"
+    },
+    "lpaQuestionnaireSubmittedDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "examples": ["2026-07-27T20:30:00.000Z"],
+      "description": "The date the LPA provided a response to the case"
+    },
+    "lpaQuestionnaireValidationOutcome": {
+      "type": ["string", "null"],
+      "enum": ["complete", "incomplete", null],
+      "description": "The outcome of the LPA questionnaire validation action"
+    },
+    "lpaQuestionnaireDueDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "examples": ["2026-07-27T20:30:00.000Z"],
+      "description": "If the case is started and has a timetable, a deadline for the LPA to provide a response"
+    },
+    "caseDecisionOutcomeDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "examples": ["2026-07-27T20:30:00.000Z"],
+      "description": "The date of the appeal decision"
+    },
+    "caseDecisionOutcome": {
+      "type": ["string", "null"],
+      "enum": [
+        "allowed",
+        "split_decision",
+        "dismissed",
+        "invalid",
+        "notice_upheld",
+        "planning_permission_granted",
+        "quashed_on_legal_grounds",
+        "notice_varied_and_upheld",
+        "notice_quashed",
+        null
+      ],
+      "description": "The final outcome for the decision"
+    },
+    "caseCompletedDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "examples": ["2026-07-27T20:30:00.000Z"],
+      "description": "The date the appeal decision letter was issued"
+    },
+    "lpaCode": {
+      "type": ["string", "null"],
+      "examples": ["Q9999"],
+      "description": "A unique identifier for the Local Planning Authority"
+    },
+    "caseOfficerId": {
+      "type": ["string", "null"],
+      "description": "Unique identifier for the case officer assigned to the case"
+    },
+    "inspectorId": {
+      "type": ["string", "null"],
+      "description": "Unique identifier for the inspector assigned to the case"
+    },
+    "padsSapId": {
+      "type": ["string", "null"],
+      "description": "padsSapId for PADS inspectors"
+    },
+    "allocationLevel": {
+      "type": ["string", "null"],
+      "enum": ["A", "B", "C", "D", "E", "F", "G", "H", null],
+      "description": "A level used for allocation purposes"
+    },
+    "allocationBand": {
+      "type": ["number", "null"],
+      "enum": [1, 2, 3, null],
+      "description": "A band used for allocation purposes"
+    },
+    "caseSpecialisms": {
+      "type": ["array", "null"],
+      "items": {
+        "type": "string"
+      },
+      "examples": [["Environmental", "SSSI"]],
+      "description": "A list of specialisms for allocation purposes"
+    },
+    "siteAddressLine1": {
+      "type": ["string", "null"],
+      "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", "null"],
+      "examples": ["Maidstone"],
+      "description": "Town / City of the site address"
+    },
+    "siteAddressCounty": {
+      "type": ["string", "null"],
+      "examples": ["Kent"],
+      "description": "County of the site address"
+    },
+    "siteAddressPostcode": {
+      "type": ["string", "null"],
+      "examples": ["MD21 5XY"],
+      "description": "Postal code of the site address"
+    },
+    "caseManagementConferenceDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "examples": ["2026-07-27T20:30:00.000Z"],
+      "description": "The date of the Case Management Conference (CMC)"
+    },
+    "statementDueDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "examples": ["2026-07-27T20:30:00.000Z"],
+      "description": "Deadline for statements"
+    },
+    "proofsOfEvidenceDueDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "examples": ["2026-07-27T20:30:00.000Z"],
+      "description": "Deadline for proofs of evidence"
+    },
+    "finalCommentsDueDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "examples": ["2026-07-27T20:30:00.000Z"],
+      "description": "Deadline for final comments"
+    },
+    "interestedPartyRepsDueDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "examples": ["2026-07-27T20:30:00.000Z"],
+      "description": "Deadline for interested party representations"
+    },
+    "statementOfCommonGroundDueDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "examples": ["2026-07-27T20:30:00.000Z"],
+      "description": "Deadline for statement of common ground"
+    },
+    "planningObligationDueDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "examples": ["2026-07-27T20:30:00.000Z"],
+      "description": "Deadline for planning obligation"
+    },
+    "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",
+        "advertisement",
+        "lawful-development-certificate",
+        "discontinuance-notice",
+        "permission-in-principle",
+        "tree-preservation-order",
+        "tree-replacement-notice",
+        "high-hedge-appeal",
+        "hedgerows-appeal",
+        "community-infrastructure-levy",
+        "planning-obligation",
+        "environmental",
+        null
+      ],
+      "description": "The type of application or notice that is the subject of the appeal"
+    },
+    "caseSubType": {
+      "type": ["string", "null"],
+      "enum": [
+        "anti_pollution_works_notice",
+        "contaminated_land",
+        "marine_licensing",
+        "waste_carriers",
+        "water_abstraction",
+        "environmental_liability",
+        "environmental_permitting",
+        "hazardous_substances",
+        "silage_and_slurry",
+        "sssi",
+        "affordable_housing",
+        null
+      ],
+      "description": "Sub-type categorization for generic/low-volume appeals"
+    },
+    "caseWithdrawnDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "examples": ["2026-07-27T20:30:00.000Z"],
+      "description": "The date the appeal was withdrawn by the appellant"
+    },
+    "caseTransferredDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "examples": ["2026-07-27T20:30:00.000Z"],
+      "description": "The date the appeal was transferred to a new case of a different type"
+    },
+    "enforcementNoticeReference": {
+      "type": ["string", "null"],
+      "examples": ["myC45e-123"],
+      "description": "The reference number of the enforcement notice"
+    },
+    "applicationReference": {
+      "type": ["string", "null"],
+      "examples": ["43010/APP/1/290572"],
+      "description": "The unique identifier of the LPA or regulator application"
+    },
+    "linkedCaseStatus": {
+      "type": ["string", "null"],
+      "enum": ["lead", "child", null],
+      "description": "Indicates if the case is linked, and the type of relationship"
+    },
+    "leadCaseReference": {
+      "type": ["string", "null"],
+      "examples": ["6000001"],
+      "description": "The reference of the lead case, if the case is a child case"
+    },
+    "environmentalPermitSubtypes": {
+      "type": ["string", "null"],
+      "enum": [
+        "refusal_of_a_permit",
+        "deemed_refusal",
+        "conditions_attached_to_a_permit",
+        "decision_to_impose_conditions_by_regulator",
+        "deemed_withdrawal",
+        "enforcement_notice",
+        "suspension_notice",
+        "closure_notice",
+        "flood_risk_activity",
+        "revocation_notice",
+        "prohibition_notice",
+        null
+      ],
+      "description": "Case sub-division applying to Environmental Permitting caseSubType"
+    }
+  }
+}

package/schemas/appeal-s78.schema.json

@@ -460,6 +460,7 @@
         "planning_permission_granted",
         "quashed_on_legal_grounds",
         "notice_varied_and_upheld",
+        "notice_quashed",
         null
       ],
       "description": "The final outcome for the decision",
@@ -1049,6 +1050,13 @@
         "lawful-development-certificate",
         "discontinuance-notice",
         "permission-in-principle",
+        "tree-preservation-order",
+        "tree-replacement-notice",
+        "high-hedge-appeal",
+        "hedgerows-appeal",
+        "community-infrastructure-levy",
+        "planning-obligation",
+        "environmental",
         null
       ]
     },

package/schemas/applications-crowndev-application.schema.json

@@ -518,8 +518,12 @@
     "address": {
       "type": "object",
       "additionalProperties": true,
-      "required": ["postcode"],
+      "required": ["addressId"],
       "properties": {
+        "addressId": {
+          "type": "string",
+          "description": "The source system Primary Key for an address."
+        },
         "line1": {
           "type": ["string", "null"]
         },
@@ -533,7 +537,7 @@
           "type": ["string", "null"]
         },
         "postcode": {
-          "type": "string"
+          "type": ["string", "null"]
         }
       }
     }

package/src/enums.cjs

@@ -90,6 +90,7 @@ const APPEAL_CASE_DECISION_OUTCOME = Object.freeze({
   ALLOWED: 'allowed',
   DISMISSED: 'dismissed',
   INVALID: 'invalid',
+  NOTICE_QUASHED: 'notice_quashed',
   NOTICE_UPHELD: 'notice_upheld',
   NOTICE_VARIED_AND_UPHELD: 'notice_varied_and_upheld',
   PLANNING_PERMISSION_GRANTED: 'planning_permission_granted',
@@ -141,6 +142,20 @@ const APPEAL_CASE_STATUS = Object.freeze({
   WITNESSES: 'witnesses',
 });
 
+const APPEAL_CASE_SUB_TYPE = Object.freeze({
+  AFFORDABLE_HOUSING: 'affordable_housing',
+  ANTI_POLLUTION_WORKS_NOTICE: 'anti_pollution_works_notice',
+  CONTAMINATED_LAND: 'contaminated_land',
+  ENVIRONMENTAL_LIABILITY: 'environmental_liability',
+  ENVIRONMENTAL_PERMITTING: 'environmental_permitting',
+  HAZARDOUS_SUBSTANCES: 'hazardous_substances',
+  MARINE_LICENSING: 'marine_licensing',
+  SILAGE_AND_SLURRY: 'silage_and_slurry',
+  SSSI: 'sssi',
+  WASTE_CARRIERS: 'waste_carriers',
+  WATER_ABSTRACTION: 'water_abstraction',
+});
+
 const APPEAL_CASE_TYPE = Object.freeze({
   C: 'C',
   D: 'D',
@@ -192,6 +207,7 @@ const APPEAL_DISCONTINUANCE_NOTICE_SERVED_REASON = Object.freeze({
 const APPEAL_DOCUMENT_TYPE = Object.freeze({
   ADDITIONAL_DOCUMENTS_LPA: 'additionalDocumentsLPA',
   APPEAL_NOTIFICATION: 'appealNotification',
+  APPELLANT_CASE: 'appellantCase',
   APPELLANT_CASE_CORRESPONDENCE: 'appellantCaseCorrespondence',
   APPELLANT_CASE_WITHDRAWAL_LETTER: 'appellantCaseWithdrawalLetter',
   APPELLANT_COSTS_APPLICATION: 'appellantCostsApplication',
@@ -258,6 +274,7 @@ const APPEAL_DOCUMENT_TYPE = Object.freeze({
   LPA_ENFORCEMENT_NOTICE_WITHDRAWAL: 'lpaEnforcementNoticeWithdrawal',
   LPA_FINAL_COMMENT: 'lpaFinalComment',
   LPA_PROOF_OF_EVIDENCE: 'lpaProofOfEvidence',
+  LPA_QUESTIONNAIRE: 'lpaQuestionnaire',
   LPA_STATEMENT: 'lpaStatement',
   LPA_WITNESSES_EVIDENCE: 'lpaWitnessesEvidence',
   MAIN_PARTY_CORRESPONDENCE: 'mainPartyCorrespondence',
@@ -313,6 +330,20 @@ const APPEAL_EIA_ENVIRONMENTAL_IMPACT_SCHEDULE = Object.freeze({
   SCHEDULE_2: 'schedule-2',
 });
 
+const APPEAL_ENVIRONMENTAL_PERMIT_SUBTYPES = Object.freeze({
+  CLOSURE_NOTICE: 'closure_notice',
+  CONDITIONS_ATTACHED_TO_A_PERMIT: 'conditions_attached_to_a_permit',
+  DECISION_TO_IMPOSE_CONDITIONS_BY_REGULATOR: 'decision_to_impose_conditions_by_regulator',
+  DEEMED_REFUSAL: 'deemed_refusal',
+  DEEMED_WITHDRAWAL: 'deemed_withdrawal',
+  ENFORCEMENT_NOTICE: 'enforcement_notice',
+  FLOOD_RISK_ACTIVITY: 'flood_risk_activity',
+  PROHIBITION_NOTICE: 'prohibition_notice',
+  REFUSAL_OF_A_PERMIT: 'refusal_of_a_permit',
+  REVOCATION_NOTICE: 'revocation_notice',
+  SUSPENSION_NOTICE: 'suspension_notice',
+});
+
 const APPEAL_EVENT_STATUS = Object.freeze({
   CHANGE_OF_PROCEDURE: 'change_of_procedure',
   CONFIRMED: 'confirmed',
@@ -430,17 +461,24 @@ const APPEAL_SOURCE_SYSTEM = Object.freeze({
 
 const APPEAL_TYPE_OF_PLANNING_APPLICATION = Object.freeze({
   ADVERTISEMENT: 'advertisement',
+  COMMUNITY_INFRASTRUCTURE_LEVY: 'community-infrastructure-levy',
   DISCONTINUANCE_NOTICE: 'discontinuance-notice',
+  ENVIRONMENTAL: 'environmental',
   FULL_APPEAL: 'full-appeal',
+  HEDGEROWS_APPEAL: 'hedgerows-appeal',
+  HIGH_HEDGE_APPEAL: 'high-hedge-appeal',
   HOUSEHOLDER_PLANNING: 'householder-planning',
   LAWFUL_DEVELOPMENT_CERTIFICATE: 'lawful-development-certificate',
   LISTED_BUILDING: 'listed-building',
   MINOR_COMMERCIAL_DEVELOPMENT: 'minor-commercial-development',
   OUTLINE_PLANNING: 'outline-planning',
   PERMISSION_IN_PRINCIPLE: 'permission-in-principle',
+  PLANNING_OBLIGATION: 'planning-obligation',
   PRIOR_APPROVAL: 'prior-approval',
   REMOVAL_OR_VARIATION_OF_CONDITIONS: 'removal-or-variation-of-conditions',
   RESERVED_MATTERS: 'reserved-matters',
+  TREE_PRESERVATION_ORDER: 'tree-preservation-order',
+  TREE_REPLACEMENT_NOTICE: 'tree-replacement-notice',
 });
 
 const APPEAL_VIRUS_CHECK_STATUS = Object.freeze({
@@ -987,6 +1025,7 @@ exports.APPEAL_CASE_DECISION_OUTCOME = APPEAL_CASE_DECISION_OUTCOME;
 exports.APPEAL_CASE_PROCEDURE = APPEAL_CASE_PROCEDURE;
 exports.APPEAL_CASE_STAGE = APPEAL_CASE_STAGE;
 exports.APPEAL_CASE_STATUS = APPEAL_CASE_STATUS;
+exports.APPEAL_CASE_SUB_TYPE = APPEAL_CASE_SUB_TYPE;
 exports.APPEAL_CASE_TYPE = APPEAL_CASE_TYPE;
 exports.APPEAL_CASE_VALIDATION_OUTCOME = APPEAL_CASE_VALIDATION_OUTCOME;
 exports.APPEAL_DEVELOPMENT_TYPE = APPEAL_DEVELOPMENT_TYPE;
@@ -994,6 +1033,7 @@ exports.APPEAL_DISCONTINUANCE_NOTICE_SERVED_REASON = APPEAL_DISCONTINUANCE_NOTIC
 exports.APPEAL_DOCUMENT_TYPE = APPEAL_DOCUMENT_TYPE;
 exports.APPEAL_EIA_DEVELOPMENT_DESCRIPTION = APPEAL_EIA_DEVELOPMENT_DESCRIPTION;
 exports.APPEAL_EIA_ENVIRONMENTAL_IMPACT_SCHEDULE = APPEAL_EIA_ENVIRONMENTAL_IMPACT_SCHEDULE;
+exports.APPEAL_ENVIRONMENTAL_PERMIT_SUBTYPES = APPEAL_ENVIRONMENTAL_PERMIT_SUBTYPES;
 exports.APPEAL_EVENT_STATUS = APPEAL_EVENT_STATUS;
 exports.APPEAL_EVENT_TYPE = APPEAL_EVENT_TYPE;
 exports.APPEAL_HAS_CASE_DECISION_OUTCOME = APPEAL_HAS_CASE_DECISION_OUTCOME;