@planning-inspectorate/data-model 2.3.0 → 2.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@planning-inspectorate/data-model",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "description": "JSON Schemas for the Planning Inspectorate's Data Model",
   "main": "src/index.js",
   "type": "module",

package/pins_data_model/models/model_appeal_has.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  appeal-has.schema.json
-#   timestamp: 2025-12-02T17:41:26+00:00
+#   timestamp: 2025-12-09T12:06:41+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_appeal_s78.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  appeal-s78.schema.json
-#   timestamp: 2025-12-02T17:41:26+00:00
+#   timestamp: 2025-12-09T15:01:57+00:00
 
 from __future__ import annotations
 
@@ -134,6 +134,10 @@ class CaseDecisionOutcome(Enum):
     split_decision = "split_decision"
     dismissed = "dismissed"
     invalid = "invalid"
+    notice_upheld = "notice_upheld"
+    planning_permission_granted = "planning_permission_granted"
+    quashed_on_legal_grounds = "quashed_on_legal_grounds"
+    notice_varied_and_upheld = "notice_varied_and_upheld"
     NoneType_None = None
 
 
@@ -330,6 +334,41 @@ class AdvertDetail(BaseModel):
     """
 
 
+class AppealGroundLetter(Enum):
+    a = "a"
+    b = "b"
+    c = "c"
+    d = "d"
+    e = "e"
+    f = "f"
+    g = "g"
+    NoneType_None = None
+
+
+class EnforcementAppealGroundsDetail(BaseModel):
+    model_config = ConfigDict(
+        extra="allow",
+    )
+    appealGroundLetter: AppealGroundLetter | None = None
+    groundForAppealStartDate: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    groundFacts: str | None = None
+    """
+    Facts supporting the appeal ground
+    """
+
+
+class ApplicationPartOrWholeDevelopment(Enum):
+    """
+    Did the application relate to all or part of the development
+    """
+
+    all_of_the_development = "all-of-the-development"
+    part_of_the_development = "part-of-the-development"
+    NoneType_None = None
+
+
 class AppealS78Case1(BaseModel):
     """
     Group B - Schema defining the metadata for an appeal
@@ -846,6 +885,9 @@ class AppealS78Case1(BaseModel):
     appellantCommentsSubmittedDate: AwareDatetime | None = Field(
         ..., examples=["2023-07-27T20:30:00.000Z"]
     )
+    appellantStatementDueDate: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
     appellantStatementSubmittedDate: AwareDatetime | None = Field(
         ..., examples=["2023-07-27T20:30:00.000Z"]
     )
@@ -920,6 +962,90 @@ class AppealS78Case1(BaseModel):
     """
     padsSapId for PADS inspectors
     """
+    ownerOccupancyStatus: str | None = Field(
+        None, examples=["Owner", "Tenant", "Mortgage lender"]
+    )
+    """
+    The nature of the appellant's interest in the appeal site
+    """
+    occupancyConditionsMet: bool | None = None
+    """
+    Does the appellant meet the criteria in relation to their interest in the site
+    """
+    enforcementAppealGroundsDetails: list[EnforcementAppealGroundsDetail] | None = None
+    """
+    A list of grounds for the appeal, supporting facts & start dates. Enforcement cases (C) can have grounds (a) to (g)
+    """
+    applicationMadeAndFeePaid: bool | None = None
+    """
+    Was an application made and paid for
+    """
+    noticeRelatesToBuildingEngineeringMiningOther: bool | None = None
+    changeOfUseRefuseOrWaste: bool | None = None
+    changeOfUseMineralExtraction: bool | None = None
+    changeOfUseMineralStorage: bool | None = None
+    relatesToErectionOfBuildingOrBuildings: bool | None = None
+    relatesToBuildingWithAgriculturalPurpose: bool | None = None
+    relatesToBuildingSingleDwellingHouse: bool | None = None
+    previousPlanningPermissionGranted: bool | None = None
+    """
+    Was planning permission granted in relation to a prior application
+    """
+    issueDateOfEnforcementNotice: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    The date on which an enforcement notice was issued
+    """
+    effectiveDateOfEnforcementNotice: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    The effective date of an enforcement notice
+    """
+    didAppellantAppealLpaDecision: bool | None = None
+    """
+    Did the appellant appeal the decision made
+    """
+    dateLpaDecisionDue: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Date on which LPA decision in relation to application is due
+    """
+    dateLpaDecisionReceived: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Date on which LPA decision in relation to application was received
+    """
+    areaOfAllegedBreachInSquareMetres: float | None = Field(None, examples=[3.5])
+    doesAllegedBreachCreateFloorSpace: bool | None = None
+    floorSpaceCreatedByBreachInSquareMetres: float | None = Field(None, examples=[5.3])
+    applicationPartOrWholeDevelopment: ApplicationPartOrWholeDevelopment | None = None
+    """
+    Did the application relate to all or part of the development
+    """
+    hasPcnBeenServed: bool | None = None
+    isSiteWithin67MOfTrunkRd: bool | None = None
+    affectedTrunkRoadName: str | None = None
+    """
+    Name of trunk road within 67M of site
+    """
+    isSiteOnCrownLand: bool | None = None
+    stopNoticeExists: bool | None = None
+    isSiteWithin400MOfMineralInterest: bool | None = None
+    isSiteWithin250MOfLandfill: bool | None = None
+    hasDevelopmentInvolvedWasteImportation: bool | None = None
+    isSiteSubjectToArticle4Direction: bool | None = None
+    article4AffectedDevelopmentRights: str | None = None
+    """
+    What permitted development rights are affected by the Article 4 Direction
+    """
+    pcnRestrictedDevelopmentRights: bool | None = None
+    """
+    Have any development rights been restricted by means of a planning condition?
+    """
 
 
 class AdvertDetail1(BaseModel):
@@ -937,6 +1063,20 @@ class AdvertDetail1(BaseModel):
     """
 
 
+class EnforcementAppealGroundsDetail1(BaseModel):
+    model_config = ConfigDict(
+        extra="allow",
+    )
+    appealGroundLetter: AppealGroundLetter | None = None
+    groundForAppealStartDate: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    groundFacts: str | None = None
+    """
+    Facts supporting the appeal ground
+    """
+
+
 class AppealS78Case2(BaseModel):
     """
     Group B - Schema defining the metadata for an appeal
@@ -1453,6 +1593,9 @@ class AppealS78Case2(BaseModel):
     appellantCommentsSubmittedDate: AwareDatetime | None = Field(
         ..., examples=["2023-07-27T20:30:00.000Z"]
     )
+    appellantStatementDueDate: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
     appellantStatementSubmittedDate: AwareDatetime | None = Field(
         ..., examples=["2023-07-27T20:30:00.000Z"]
     )
@@ -1527,6 +1670,90 @@ class AppealS78Case2(BaseModel):
     """
     padsSapId for PADS inspectors
     """
+    ownerOccupancyStatus: str | None = Field(
+        None, examples=["Owner", "Tenant", "Mortgage lender"]
+    )
+    """
+    The nature of the appellant's interest in the appeal site
+    """
+    occupancyConditionsMet: bool | None = None
+    """
+    Does the appellant meet the criteria in relation to their interest in the site
+    """
+    enforcementAppealGroundsDetails: list[EnforcementAppealGroundsDetail1] | None = None
+    """
+    A list of grounds for the appeal, supporting facts & start dates. Enforcement cases (C) can have grounds (a) to (g)
+    """
+    applicationMadeAndFeePaid: bool | None = None
+    """
+    Was an application made and paid for
+    """
+    noticeRelatesToBuildingEngineeringMiningOther: bool | None = None
+    changeOfUseRefuseOrWaste: bool | None = None
+    changeOfUseMineralExtraction: bool | None = None
+    changeOfUseMineralStorage: bool | None = None
+    relatesToErectionOfBuildingOrBuildings: bool | None = None
+    relatesToBuildingWithAgriculturalPurpose: bool | None = None
+    relatesToBuildingSingleDwellingHouse: bool | None = None
+    previousPlanningPermissionGranted: bool | None = None
+    """
+    Was planning permission granted in relation to a prior application
+    """
+    issueDateOfEnforcementNotice: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    The date on which an enforcement notice was issued
+    """
+    effectiveDateOfEnforcementNotice: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    The effective date of an enforcement notice
+    """
+    didAppellantAppealLpaDecision: bool | None = None
+    """
+    Did the appellant appeal the decision made
+    """
+    dateLpaDecisionDue: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Date on which LPA decision in relation to application is due
+    """
+    dateLpaDecisionReceived: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Date on which LPA decision in relation to application was received
+    """
+    areaOfAllegedBreachInSquareMetres: float | None = Field(None, examples=[3.5])
+    doesAllegedBreachCreateFloorSpace: bool | None = None
+    floorSpaceCreatedByBreachInSquareMetres: float | None = Field(None, examples=[5.3])
+    applicationPartOrWholeDevelopment: ApplicationPartOrWholeDevelopment | None = None
+    """
+    Did the application relate to all or part of the development
+    """
+    hasPcnBeenServed: bool | None = None
+    isSiteWithin67MOfTrunkRd: bool | None = None
+    affectedTrunkRoadName: str | None = None
+    """
+    Name of trunk road within 67M of site
+    """
+    isSiteOnCrownLand: bool | None = None
+    stopNoticeExists: bool | None = None
+    isSiteWithin400MOfMineralInterest: bool | None = None
+    isSiteWithin250MOfLandfill: bool | None = None
+    hasDevelopmentInvolvedWasteImportation: bool | None = None
+    isSiteSubjectToArticle4Direction: bool | None = None
+    article4AffectedDevelopmentRights: str | None = None
+    """
+    What permitted development rights are affected by the Article 4 Direction
+    """
+    pcnRestrictedDevelopmentRights: bool | None = None
+    """
+    Have any development rights been restricted by means of a planning condition?
+    """
 
 
 class AppealS78Case(RootModel[AppealS78Case1 | AppealS78Case2]):

package/schemas/appeal-s78.schema.json

@@ -438,9 +438,19 @@
     },
     "caseDecisionOutcome": {
       "type": ["string", "null"],
-      "enum": ["allowed", "split_decision", "dismissed", "invalid", null],
+      "enum": [
+        "allowed",
+        "split_decision",
+        "dismissed",
+        "invalid",
+        "notice_upheld",
+        "planning_permission_granted",
+        "quashed_on_legal_grounds",
+        "notice_varied_and_upheld",
+        null
+      ],
       "description": "The final outcome for the decision",
-      "$comment": "Also available on HAS cases"
+      "$comment": "List expanded for Enforcement Case Decision Outcomes"
     },
     "caseCompletedDate": {
       "type": ["string", "null"],
@@ -918,6 +928,11 @@
       "format": "date-time",
       "examples": ["2023-07-27T20:30:00.000Z"]
     },
+    "appellantStatementDueDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "examples": ["2023-07-27T20:30:00.000Z"]
+    },
     "appellantStatementSubmittedDate": {
       "type": ["string", "null"],
       "format": "date-time",
@@ -1092,6 +1107,148 @@
     "padsSapId": {
       "type": ["string", "null"],
       "description": "padsSapId for PADS inspectors"
+    },
+    "ownerOccupancyStatus": {
+      "type": ["string", "null"],
+      "description": "The nature of the appellant's interest in the appeal site",
+      "examples": ["Owner", "Tenant", "Mortgage lender"]
+    },
+    "occupancyConditionsMet": {
+      "type": ["boolean", "null"],
+      "description": "Does the appellant meet the criteria in relation to their interest in the site"
+    },
+    "enforcementAppealGroundsDetails": {
+      "type": ["array", "null"],
+      "items": {
+        "type": "object",
+        "additionalProperties": true,
+        "properties": {
+          "appealGroundLetter": {
+            "type": ["string", "null"],
+            "enum": ["a", "b", "c", "d", "e", "f", "g", null]
+          },
+          "groundForAppealStartDate": {
+            "type": ["string", "null"],
+            "format": "date-time",
+            "examples": ["2023-07-27T20:30:00.000Z"]
+          },
+          "groundFacts": {
+            "type": ["string", "null"],
+            "description": "Facts supporting the appeal ground"
+          }
+        }
+      },
+      "description": "A list of grounds for the appeal, supporting facts & start dates. Enforcement cases (C) can have grounds (a) to (g)",
+      "$comment": "Enforcement Listed Building cases (F) have a separate list of grounds (a) to (k)"
+    },
+    "applicationMadeAndFeePaid": {
+      "type": ["boolean", "null"],
+      "description": "Was an application made and paid for"
+    },
+    "noticeRelatesToBuildingEngineeringMiningOther": {
+      "type": ["boolean", "null"]
+    },
+    "changeOfUseRefuseOrWaste": {
+      "type": ["boolean", "null"]
+    },
+    "changeOfUseMineralExtraction": {
+      "type": ["boolean", "null"]
+    },
+    "changeOfUseMineralStorage": {
+      "type": ["boolean", "null"]
+    },
+    "relatesToErectionOfBuildingOrBuildings": {
+      "type": ["boolean", "null"]
+    },
+    "relatesToBuildingWithAgriculturalPurpose": {
+      "type": ["boolean", "null"]
+    },
+    "relatesToBuildingSingleDwellingHouse": {
+      "type": ["boolean", "null"]
+    },
+    "previousPlanningPermissionGranted": {
+      "type": ["boolean", "null"],
+      "description": "Was planning permission granted in relation to a prior application"
+    },
+    "issueDateOfEnforcementNotice": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "The date on which an enforcement notice was issued",
+      "examples": ["2023-07-27T20:30:00.000Z"]
+    },
+    "effectiveDateOfEnforcementNotice": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "The effective date of an enforcement notice",
+      "examples": ["2023-07-27T20:30:00.000Z"]
+    },
+    "didAppellantAppealLpaDecision": {
+      "type": ["boolean", "null"],
+      "description": "Did the appellant appeal the decision made"
+    },
+    "dateLpaDecisionDue": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "Date on which LPA decision in relation to application is due",
+      "examples": ["2023-07-27T20:30:00.000Z"]
+    },
+    "dateLpaDecisionReceived": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "Date on which LPA decision in relation to application was received",
+      "examples": ["2023-07-27T20:30:00.000Z"]
+    },
+    "areaOfAllegedBreachInSquareMetres": {
+      "type": ["number", "null"],
+      "examples": [3.5]
+    },
+    "doesAllegedBreachCreateFloorSpace": {
+      "type": ["boolean", "null"]
+    },
+    "floorSpaceCreatedByBreachInSquareMetres": {
+      "type": ["number", "null"],
+      "examples": [5.3]
+    },
+    "applicationPartOrWholeDevelopment": {
+      "type": ["string", "null"],
+      "description": "Did the application relate to all or part of the development",
+      "enum": ["all-of-the-development", "part-of-the-development", null]
+    },
+    "hasPcnBeenServed": {
+      "type": ["boolean", "null"]
+    },
+    "isSiteWithin67MOfTrunkRd": {
+      "type": ["boolean", "null"]
+    },
+    "affectedTrunkRoadName": {
+      "type": ["string", "null"],
+      "description": "Name of trunk road within 67M of site"
+    },
+    "isSiteOnCrownLand": {
+      "type": ["boolean", "null"]
+    },
+    "stopNoticeExists": {
+      "type": ["boolean", "null"]
+    },
+    "isSiteWithin400MOfMineralInterest": {
+      "type": ["boolean", "null"]
+    },
+    "isSiteWithin250MOfLandfill": {
+      "type": ["boolean", "null"]
+    },
+    "hasDevelopmentInvolvedWasteImportation": {
+      "type": ["boolean", "null"]
+    },
+    "isSiteSubjectToArticle4Direction": {
+      "type": ["boolean", "null"]
+    },
+    "article4AffectedDevelopmentRights": {
+      "type": ["string", "null"],
+      "description": "What permitted development rights are affected by the Article 4 Direction"
+    },
+    "pcnRestrictedDevelopmentRights": {
+      "type": ["boolean", "null"],
+      "description": "Have any development rights been restricted by means of a planning condition?"
     }
   }
 }

package/src/enums.cjs

@@ -23,10 +23,19 @@ const APPEAL_APPLICATION_DECISION = Object.freeze({
   REFUSED: 'refused',
 });
 
+const APPEAL_APPLICATION_PART_OR_WHOLE_DEVELOPMENT = Object.freeze({
+  ALL_OF_THE_DEVELOPMENT: 'all-of-the-development',
+  PART_OF_THE_DEVELOPMENT: 'part-of-the-development',
+});
+
 const APPEAL_CASE_DECISION_OUTCOME = Object.freeze({
   ALLOWED: 'allowed',
   DISMISSED: 'dismissed',
   INVALID: 'invalid',
+  NOTICE_UPHELD: 'notice_upheld',
+  NOTICE_VARIED_AND_UPHELD: 'notice_varied_and_upheld',
+  PLANNING_PERMISSION_GRANTED: 'planning_permission_granted',
+  QUASHED_ON_LEGAL_GROUNDS: 'quashed_on_legal_grounds',
   SPLIT_DECISION: 'split_decision',
 });
 
@@ -685,6 +694,7 @@ const STATUS = Object.freeze({
 exports.APPEAL_ALLOCATION_LEVEL = APPEAL_ALLOCATION_LEVEL;
 exports.APPEAL_APPELLANT_PROCEDURE_PREFERENCE = APPEAL_APPELLANT_PROCEDURE_PREFERENCE;
 exports.APPEAL_APPLICATION_DECISION = APPEAL_APPLICATION_DECISION;
+exports.APPEAL_APPLICATION_PART_OR_WHOLE_DEVELOPMENT = APPEAL_APPLICATION_PART_OR_WHOLE_DEVELOPMENT;
 exports.APPEAL_CASE_DECISION_OUTCOME = APPEAL_CASE_DECISION_OUTCOME;
 exports.APPEAL_CASE_PROCEDURE = APPEAL_CASE_PROCEDURE;
 exports.APPEAL_CASE_STAGE = APPEAL_CASE_STAGE;

package/src/enums.d.ts

@@ -21,10 +21,19 @@ export const APPEAL_APPLICATION_DECISION = {
   REFUSED: 'refused',
 } as const;
 
+export const APPEAL_APPLICATION_PART_OR_WHOLE_DEVELOPMENT = {
+  ALL_OF_THE_DEVELOPMENT: 'all-of-the-development',
+  PART_OF_THE_DEVELOPMENT: 'part-of-the-development',
+} as const;
+
 export const APPEAL_CASE_DECISION_OUTCOME = {
   ALLOWED: 'allowed',
   DISMISSED: 'dismissed',
   INVALID: 'invalid',
+  NOTICE_UPHELD: 'notice_upheld',
+  NOTICE_VARIED_AND_UPHELD: 'notice_varied_and_upheld',
+  PLANNING_PERMISSION_GRANTED: 'planning_permission_granted',
+  QUASHED_ON_LEGAL_GROUNDS: 'quashed_on_legal_grounds',
   SPLIT_DECISION: 'split_decision',
 } as const;
 

package/src/enums.js

@@ -21,10 +21,19 @@ export const APPEAL_APPLICATION_DECISION = Object.freeze({
   REFUSED: 'refused',
 });
 
+export const APPEAL_APPLICATION_PART_OR_WHOLE_DEVELOPMENT = Object.freeze({
+  ALL_OF_THE_DEVELOPMENT: 'all-of-the-development',
+  PART_OF_THE_DEVELOPMENT: 'part-of-the-development',
+});
+
 export const APPEAL_CASE_DECISION_OUTCOME = Object.freeze({
   ALLOWED: 'allowed',
   DISMISSED: 'dismissed',
   INVALID: 'invalid',
+  NOTICE_UPHELD: 'notice_upheld',
+  NOTICE_VARIED_AND_UPHELD: 'notice_varied_and_upheld',
+  PLANNING_PERMISSION_GRANTED: 'planning_permission_granted',
+  QUASHED_ON_LEGAL_GROUNDS: 'quashed_on_legal_grounds',
   SPLIT_DECISION: 'split_decision',
 });
 

package/src/index.cjs

@@ -104,10 +104,19 @@ const APPEAL_APPLICATION_DECISION = Object.freeze({
   REFUSED: 'refused',
 });
 
+const APPEAL_APPLICATION_PART_OR_WHOLE_DEVELOPMENT = Object.freeze({
+  ALL_OF_THE_DEVELOPMENT: 'all-of-the-development',
+  PART_OF_THE_DEVELOPMENT: 'part-of-the-development',
+});
+
 const APPEAL_CASE_DECISION_OUTCOME = Object.freeze({
   ALLOWED: 'allowed',
   DISMISSED: 'dismissed',
   INVALID: 'invalid',
+  NOTICE_UPHELD: 'notice_upheld',
+  NOTICE_VARIED_AND_UPHELD: 'notice_varied_and_upheld',
+  PLANNING_PERMISSION_GRANTED: 'planning_permission_granted',
+  QUASHED_ON_LEGAL_GROUNDS: 'quashed_on_legal_grounds',
   SPLIT_DECISION: 'split_decision',
 });
 
@@ -798,6 +807,7 @@ function loadAllSchemasSync() {
 exports.APPEAL_ALLOCATION_LEVEL = APPEAL_ALLOCATION_LEVEL;
 exports.APPEAL_APPELLANT_PROCEDURE_PREFERENCE = APPEAL_APPELLANT_PROCEDURE_PREFERENCE;
 exports.APPEAL_APPLICATION_DECISION = APPEAL_APPLICATION_DECISION;
+exports.APPEAL_APPLICATION_PART_OR_WHOLE_DEVELOPMENT = APPEAL_APPLICATION_PART_OR_WHOLE_DEVELOPMENT;
 exports.APPEAL_CASE_DECISION_OUTCOME = APPEAL_CASE_DECISION_OUTCOME;
 exports.APPEAL_CASE_PROCEDURE = APPEAL_CASE_PROCEDURE;
 exports.APPEAL_CASE_STAGE = APPEAL_CASE_STAGE;