@planning-inspectorate/data-model 2.56.0 → 2.58.0

package/docs/appeal-has.md

@@ -261,23 +261,28 @@ The internal code for an appeal type, e.g. D (Householder)
 
 **enum**: the value of this property must be equal to one of the following values:
 
-| Value  | Explanation |
-| :----- | :---------- |
-| `"C"`  |             |
-| `"D"`  |             |
-| `"F"`  |             |
-| `"G"`  |             |
-| `"H"`  |             |
-| `"L"`  |             |
-| `"Q"`  |             |
-| `"S"`  |             |
-| `"V"`  |             |
-| `"W"`  |             |
-| `"X"`  |             |
-| `"Y"`  |             |
-| `"Z"`  |             |
-| `"ZA"` |             |
-| `"ZP"` |             |
+| Value   | Explanation |
+| :------ | :---------- |
+| `"C"`   |             |
+| `"D"`   |             |
+| `"F"`   |             |
+| `"G"`   |             |
+| `"H"`   |             |
+| `"L"`   |             |
+| `"Q"`   |             |
+| `"S"`   |             |
+| `"V"`   |             |
+| `"W"`   |             |
+| `"X"`   |             |
+| `"Y"`   |             |
+| `"Z"`   |             |
+| `"ZA"`  |             |
+| `"ZP"`  |             |
+| `"TPO"` |             |
+| `"TRN"` |             |
+| `"HH"`  |             |
+| `"HR"`  |             |
+| `"ENV"` |             |
 
 ## caseProcedure
 

package/docs/appeal-s78.md

@@ -364,23 +364,28 @@ The internal code for an appeal type, e.g. D (Householder)
 
 **enum**: the value of this property must be equal to one of the following values:
 
-| Value  | Explanation |
-| :----- | :---------- |
-| `"C"`  |             |
-| `"D"`  |             |
-| `"F"`  |             |
-| `"G"`  |             |
-| `"H"`  |             |
-| `"L"`  |             |
-| `"Q"`  |             |
-| `"S"`  |             |
-| `"V"`  |             |
-| `"W"`  |             |
-| `"X"`  |             |
-| `"Y"`  |             |
-| `"Z"`  |             |
-| `"ZA"` |             |
-| `"ZP"` |             |
+| Value   | Explanation |
+| :------ | :---------- |
+| `"C"`   |             |
+| `"D"`   |             |
+| `"F"`   |             |
+| `"G"`   |             |
+| `"H"`   |             |
+| `"L"`   |             |
+| `"Q"`   |             |
+| `"S"`   |             |
+| `"V"`   |             |
+| `"W"`   |             |
+| `"X"`   |             |
+| `"Y"`   |             |
+| `"Z"`   |             |
+| `"ZA"`  |             |
+| `"ZP"`  |             |
+| `"TPO"` |             |
+| `"TRN"` |             |
+| `"HH"`  |             |
+| `"HR"`  |             |
+| `"ENV"` |             |
 
 ## caseProcedure
 
@@ -1378,6 +1383,7 @@ The final outcome for the decision
 | `"planning_permission_granted"` |             |
 | `"quashed_on_legal_grounds"`    |             |
 | `"notice_varied_and_upheld"`    |             |
+| `"notice_quashed"`              |             |
 | `null`                          |             |
 
 ## caseCompletedDate
@@ -3697,6 +3703,13 @@ The net gain in residences of the proposed development
 | `"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`                                 |             |
 
 ## developmentType

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@planning-inspectorate/data-model",
-  "version": "2.56.0",
+  "version": "2.58.0",
   "description": "JSON Schemas for the Planning Inspectorate's Data Model",
   "main": "src/index.js",
   "type": "module",
@@ -36,7 +36,7 @@
     "@commitlint/cli": "^21.0.0",
     "@commitlint/config-conventional": "^21.0.0",
     "@eslint/js": "^10.0.1",
-    "@planning-inspectorate/coding-standards": "^1.1.1",
+    "@planning-inspectorate/coding-standards": "^2.0.0",
     "ajv": "^8.17.1",
     "ajv-formats": "^3.0.1",
     "conventional-changelog-conventionalcommits": "^10.2.0",

package/pins_data_model/models/model_appeal_document.py

@@ -39,6 +39,11 @@ class CaseType(Enum):
     Z = "Z"
     ZA = "ZA"
     ZP = "ZP"
+    TPO = "TPO"
+    TRN = "TRN"
+    HH = "HH"
+    HR = "HR"
+    ENV = "ENV"
     NoneType_None = None
 
 
@@ -58,6 +63,7 @@ class DocumentType(Enum):
     The type of document, used for exchange, migrations and consumption from the appeal back-office system
     """
 
+    appellantCase = "appellantCase"
     appellantCaseCorrespondence = "appellantCaseCorrespondence"
     appellantCaseWithdrawalLetter = "appellantCaseWithdrawalLetter"
     appellantCostsApplication = "appellantCostsApplication"
@@ -72,6 +78,7 @@ class DocumentType(Enum):
     whoNotifiedLetterToNeighbours = "whoNotifiedLetterToNeighbours"
     whoNotifiedPressAdvert = "whoNotifiedPressAdvert"
     conservationMap = "conservationMap"
+    lpaQuestionnaire = "lpaQuestionnaire"
     lpaCaseCorrespondence = "lpaCaseCorrespondence"
     lpaCostsApplication = "lpaCostsApplication"
     lpaCostsCorrespondence = "lpaCostsCorrespondence"

package/pins_data_model/models/model_appeal_group_c.py

@@ -0,0 +1,458 @@
+# generated by datamodel-codegen:
+#   filename:  appeal-group-c.schema.json
+
+from __future__ import annotations
+
+from enum import Enum, StrEnum
+
+from pydantic import AwareDatetime, BaseModel, ConfigDict, Field, constr
+
+
+class CaseType(StrEnum):
+    """
+    Internal letter code for appeal types
+    """
+
+    C = "C"
+    D = "D"
+    F = "F"
+    G = "G"
+    H = "H"
+    L = "L"
+    Q = "Q"
+    S = "S"
+    V = "V"
+    W = "W"
+    X = "X"
+    Y = "Y"
+    Z = "Z"
+    ZA = "ZA"
+    ZP = "ZP"
+    TPO = "TPO"
+    TRN = "TRN"
+    HH = "HH"
+    HR = "HR"
+    ENV = "ENV"
+
+
+class CaseStatus(StrEnum):
+    """
+    The processing status for the appeal
+    """
+
+    assign_case_officer = "assign_case_officer"
+    validation = "validation"
+    ready_to_start = "ready_to_start"
+    lpa_questionnaire = "lpa_questionnaire"
+    issue_determination = "issue_determination"
+    statements = "statements"
+    evidence = "evidence"
+    witnesses = "witnesses"
+    final_comments = "final_comments"
+    complete = "complete"
+    invalid = "invalid"
+    closed = "closed"
+    withdrawn = "withdrawn"
+    awaiting_transfer = "awaiting_transfer"
+    transferred = "transferred"
+    event = "event"
+    awaiting_event = "awaiting_event"
+    notice_withdrawn = "notice_withdrawn"
+    closed_opened_in_error = "closed_opened_in_error"
+
+
+class CaseProcedure(Enum):
+    """
+    The type of procedure for the appeal
+    """
+
+    written = "written"
+    hearing = "hearing"
+    inquiry = "inquiry"
+    writtenPart1 = "writtenPart1"
+    writtenPart2 = "writtenPart2"
+    NoneType_None = None
+
+
+class CaseValidationOutcome(Enum):
+    """
+    The outcome of the validation action
+    """
+
+    valid = "valid"
+    invalid = "invalid"
+    incomplete = "incomplete"
+    NoneType_None = None
+
+
+class LpaQuestionnaireValidationOutcome(Enum):
+    """
+    The outcome of the LPA questionnaire validation action
+    """
+
+    complete = "complete"
+    incomplete = "incomplete"
+    NoneType_None = None
+
+
+class CaseDecisionOutcome(Enum):
+    """
+    The final outcome for the decision
+    """
+
+    allowed = "allowed"
+    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"
+    notice_quashed = "notice_quashed"
+    NoneType_None = None
+
+
+class AllocationLevel(Enum):
+    """
+    A level used for allocation purposes
+    """
+
+    A = "A"
+    B = "B"
+    C = "C"
+    D = "D"
+    E = "E"
+    F = "F"
+    G = "G"
+    H = "H"
+    NoneType_None = None
+
+
+class AllocationBand(Enum):
+    """
+    A band used for allocation purposes
+    """
+
+    int_1 = 1
+    int_2 = 2
+    int_3 = 3
+    NoneType_None = None
+
+
+class TypeOfPlanningApplication(Enum):
+    """
+    The type of application or notice that is the subject of the appeal
+    """
+
+    full_appeal = "full-appeal"
+    householder_planning = "householder-planning"
+    outline_planning = "outline-planning"
+    prior_approval = "prior-approval"
+    reserved_matters = "reserved-matters"
+    removal_or_variation_of_conditions = "removal-or-variation-of-conditions"
+    listed_building = "listed-building"
+    minor_commercial_development = "minor-commercial-development"
+    advertisement = "advertisement"
+    lawful_development_certificate = "lawful-development-certificate"
+    discontinuance_notice = "discontinuance-notice"
+    permission_in_principle = "permission-in-principle"
+    tree_preservation_order = "tree-preservation-order"
+    tree_replacement_notice = "tree-replacement-notice"
+    high_hedge_appeal = "high-hedge-appeal"
+    hedgerows_appeal = "hedgerows-appeal"
+    community_infrastructure_levy = "community-infrastructure-levy"
+    planning_obligation = "planning-obligation"
+    environmental = "environmental"
+    NoneType_None = None
+
+
+class CaseSubType(Enum):
+    """
+    Sub-type categorization for generic/low-volume appeals
+    """
+
+    anti_pollution_works_notice = "anti_pollution_works_notice"
+    contaminated_land = "contaminated_land"
+    marine_licensing = "marine_licensing"
+    waste_carriers = "waste_carriers"
+    water_abstraction = "water_abstraction"
+    environmental_liability = "environmental_liability"
+    environmental_permitting = "environmental_permitting"
+    hazardous_substances = "hazardous_substances"
+    silage_and_slurry = "silage_and_slurry"
+    sssi = "sssi"
+    affordable_housing = "affordable_housing"
+    NoneType_None = None
+
+
+class LinkedCaseStatus(Enum):
+    """
+    Indicates if the case is linked, and the type of relationship
+    """
+
+    lead = "lead"
+    child = "child"
+    NoneType_None = None
+
+
+class EnvironmentalPermitSubtypes(Enum):
+    """
+    Case sub-division applying to Environmental Permitting caseSubType
+    """
+
+    refusal_of_a_permit = "refusal_of_a_permit"
+    deemed_refusal = "deemed_refusal"
+    conditions_attached_to_a_permit = "conditions_attached_to_a_permit"
+    decision_to_impose_conditions_by_regulator = (
+        "decision_to_impose_conditions_by_regulator"
+    )
+    deemed_withdrawal = "deemed_withdrawal"
+    enforcement_notice = "enforcement_notice"
+    suspension_notice = "suspension_notice"
+    closure_notice = "closure_notice"
+    flood_risk_activity = "flood_risk_activity"
+    revocation_notice = "revocation_notice"
+    prohibition_notice = "prohibition_notice"
+    NoneType_None = None
+
+
+class AppealGroupCCase(BaseModel):
+    """
+    Group C - Schema defining the metadata for generic and low-volume appeals
+    """
+
+    model_config = ConfigDict(
+        extra="allow",
+    )
+    caseId: int | None = Field(..., examples=[6000001])
+    """
+    Internal case identifier
+    """
+    caseReference: constr(pattern=r"^6\d{6}$") = Field(..., examples=["6000001"])
+    """
+    External case identifier for Group C appeals (7 digit number starting in 6)
+    """
+    caseType: CaseType
+    """
+    Internal letter code for appeal types
+    """
+    caseStatus: CaseStatus
+    """
+    The processing status for the appeal
+    """
+    caseProcedure: CaseProcedure | None
+    """
+    The type of procedure for the appeal
+    """
+    caseCreatedDate: AwareDatetime = Field(..., examples=["2026-07-27T20:30:00.000Z"])
+    """
+    The date the appeal was received
+    """
+    caseSubmittedDate: AwareDatetime | None = Field(
+        ..., examples=["2026-07-27T20:30:00.000Z"]
+    )
+    """
+    The date the appeal was submitted by the appellant
+    """
+    caseUpdatedDate: AwareDatetime | None = Field(
+        ..., examples=["2026-07-27T20:30:00.000Z"]
+    )
+    """
+    The date the appeal was last updated in the back-office
+    """
+    caseValidDate: AwareDatetime | None = Field(
+        ..., examples=["2026-07-27T20:30:00.000Z"]
+    )
+    """
+    The date since when the appeal was considered valid
+    """
+    caseValidationDate: AwareDatetime | None = Field(
+        ..., examples=["2026-07-27T20:30:00.000Z"]
+    )
+    """
+    The date the appeal was validated in the back-office
+    """
+    caseValidationOutcome: CaseValidationOutcome | None
+    """
+    The outcome of the validation action
+    """
+    caseStartedDate: AwareDatetime | None = Field(
+        ..., examples=["2026-07-27T20:30:00.000Z"]
+    )
+    """
+    A date indicating when the case was started, resulting in the creation of a timetable
+    """
+    casePublishedDate: AwareDatetime | None = Field(
+        ..., examples=["2026-07-27T20:30:00.000Z"]
+    )
+    """
+    A date indicating when the case was published
+    """
+    lpaQuestionnaireCreatedDate: AwareDatetime | None = Field(
+        ..., examples=["2026-07-27T20:30:00.000Z"]
+    )
+    """
+    The date the LPA response was received
+    """
+    lpaQuestionnaireSubmittedDate: AwareDatetime | None = Field(
+        ..., examples=["2026-07-27T20:30:00.000Z"]
+    )
+    """
+    The date the LPA provided a response to the case
+    """
+    lpaQuestionnaireValidationOutcome: LpaQuestionnaireValidationOutcome | None
+    """
+    The outcome of the LPA questionnaire validation action
+    """
+    lpaQuestionnaireDueDate: AwareDatetime | None = Field(
+        ..., examples=["2026-07-27T20:30:00.000Z"]
+    )
+    """
+    If the case is started and has a timetable, a deadline for the LPA to provide a response
+    """
+    caseDecisionOutcomeDate: AwareDatetime | None = Field(
+        ..., examples=["2026-07-27T20:30:00.000Z"]
+    )
+    """
+    The date of the appeal decision
+    """
+    caseDecisionOutcome: CaseDecisionOutcome | None
+    """
+    The final outcome for the decision
+    """
+    caseCompletedDate: AwareDatetime | None = Field(
+        ..., examples=["2026-07-27T20:30:00.000Z"]
+    )
+    """
+    The date the appeal decision letter was issued
+    """
+    lpaCode: str | None = Field(..., examples=["Q9999"])
+    """
+    A unique identifier for the Local Planning Authority
+    """
+    caseOfficerId: str | None
+    """
+    Unique identifier for the case officer assigned to the case
+    """
+    inspectorId: str | None
+    """
+    Unique identifier for the inspector assigned to the case
+    """
+    padsSapId: str | None
+    """
+    padsSapId for PADS inspectors
+    """
+    allocationLevel: AllocationLevel | None
+    """
+    A level used for allocation purposes
+    """
+    allocationBand: AllocationBand | None
+    """
+    A band used for allocation purposes
+    """
+    caseSpecialisms: list[str] | None = Field(..., examples=[["Environmental", "SSSI"]])
+    """
+    A list of specialisms for allocation purposes
+    """
+    siteAddressLine1: str | None = Field(..., examples=["96 The Avenue"])
+    """
+    First line of address for the appeal site
+    """
+    siteAddressLine2: str | None
+    """
+    Second line of address for the appeal site
+    """
+    siteAddressTown: str | None = Field(..., examples=["Maidstone"])
+    """
+    Town / City of the site address
+    """
+    siteAddressCounty: str | None = Field(..., examples=["Kent"])
+    """
+    County of the site address
+    """
+    siteAddressPostcode: str | None = Field(..., examples=["MD21 5XY"])
+    """
+    Postal code of the site address
+    """
+    caseManagementConferenceDate: AwareDatetime | None = Field(
+        None, examples=["2026-07-27T20:30:00.000Z"]
+    )
+    """
+    The date of the Case Management Conference (CMC)
+    """
+    statementDueDate: AwareDatetime | None = Field(
+        None, examples=["2026-07-27T20:30:00.000Z"]
+    )
+    """
+    Deadline for statements
+    """
+    proofsOfEvidenceDueDate: AwareDatetime | None = Field(
+        None, examples=["2026-07-27T20:30:00.000Z"]
+    )
+    """
+    Deadline for proofs of evidence
+    """
+    finalCommentsDueDate: AwareDatetime | None = Field(
+        None, examples=["2026-07-27T20:30:00.000Z"]
+    )
+    """
+    Deadline for final comments
+    """
+    interestedPartyRepsDueDate: AwareDatetime | None = Field(
+        None, examples=["2026-07-27T20:30:00.000Z"]
+    )
+    """
+    Deadline for interested party representations
+    """
+    statementOfCommonGroundDueDate: AwareDatetime | None = Field(
+        None, examples=["2026-07-27T20:30:00.000Z"]
+    )
+    """
+    Deadline for statement of common ground
+    """
+    planningObligationDueDate: AwareDatetime | None = Field(
+        None, examples=["2026-07-27T20:30:00.000Z"]
+    )
+    """
+    Deadline for planning obligation
+    """
+    typeOfPlanningApplication: TypeOfPlanningApplication | None = None
+    """
+    The type of application or notice that is the subject of the appeal
+    """
+    caseSubType: CaseSubType | None = None
+    """
+    Sub-type categorization for generic/low-volume appeals
+    """
+    caseWithdrawnDate: AwareDatetime | None = Field(
+        ..., examples=["2026-07-27T20:30:00.000Z"]
+    )
+    """
+    The date the appeal was withdrawn by the appellant
+    """
+    caseTransferredDate: AwareDatetime | None = Field(
+        ..., examples=["2026-07-27T20:30:00.000Z"]
+    )
+    """
+    The date the appeal was transferred to a new case of a different type
+    """
+    enforcementNoticeReference: str | None = Field(None, examples=["myC45e-123"])
+    """
+    The reference number of the enforcement notice
+    """
+    applicationReference: str | None = Field(None, examples=["43010/APP/1/290572"])
+    """
+    The unique identifier of the LPA or regulator application
+    """
+    linkedCaseStatus: LinkedCaseStatus | None = None
+    """
+    Indicates if the case is linked, and the type of relationship
+    """
+    leadCaseReference: str | None = Field(None, examples=["6000001"])
+    """
+    The reference of the lead case, if the case is a child case
+    """
+    environmentalPermitSubtypes: EnvironmentalPermitSubtypes | None = None
+    """
+    Case sub-division applying to Environmental Permitting caseSubType
+    """

package/pins_data_model/models/model_appeal_has.py

@@ -51,6 +51,11 @@ class CaseType(StrEnum):
     Z = "Z"
     ZA = "ZA"
     ZP = "ZP"
+    TPO = "TPO"
+    TRN = "TRN"
+    HH = "HH"
+    HR = "HR"
+    ENV = "ENV"
 
 
 class CaseProcedure(Enum):

package/pins_data_model/models/model_appeal_s78.py

@@ -55,6 +55,11 @@ class CaseType(StrEnum):
     Z = "Z"
     ZA = "ZA"
     ZP = "ZP"
+    TPO = "TPO"
+    TRN = "TRN"
+    HH = "HH"
+    HR = "HR"
+    ENV = "ENV"
 
 
 class CaseProcedure(Enum):
@@ -141,6 +146,7 @@ class CaseDecisionOutcome(Enum):
     planning_permission_granted = "planning_permission_granted"
     quashed_on_legal_grounds = "quashed_on_legal_grounds"
     notice_varied_and_upheld = "notice_varied_and_upheld"
+    notice_quashed = "notice_quashed"
     NoneType_None = None
 
 
@@ -288,6 +294,13 @@ class TypeOfPlanningApplication(Enum):
     lawful_development_certificate = "lawful-development-certificate"
     discontinuance_notice = "discontinuance-notice"
     permission_in_principle = "permission-in-principle"
+    tree_preservation_order = "tree-preservation-order"
+    tree_replacement_notice = "tree-replacement-notice"
+    high_hedge_appeal = "high-hedge-appeal"
+    hedgerows_appeal = "hedgerows-appeal"
+    community_infrastructure_levy = "community-infrastructure-levy"
+    planning_obligation = "planning-obligation"
+    environmental = "environmental"
     NoneType_None = None