@planning-inspectorate/data-model 1.17.0 → 1.18.1

package/docs/appeal-has.md

@@ -452,23 +452,16 @@ A list of specialisms for allocation purposes
 ### caseSpecialisms Examples
 
 ```json
-"Access"
+[
+  "Access",
+  "Listed building and enforcement"
+]
 ```
 
 ```json
-"Listed building and enforcement"
-```
-
-```json
-"Roads and traffics"
-```
-
-```json
-"Natural heritage"
-```
-
-```json
-"Schedule 1"
+[
+  "Schedule 1"
+]
 ```
 
 ## caseSubmittedDate
@@ -2229,6 +2222,21 @@ The methods used to notify relevant parties
 
 `string[]`
 
+### notificationMethod Examples
+
+```json
+[
+  "notice",
+  "letter"
+]
+```
+
+```json
+[
+  "advert"
+]
+```
+
 ## ownersInformed
 
 Indicates if the appellant has informed other owners of the site

package/docs/appeal-s78.md

@@ -506,23 +506,16 @@ A list of specialisms for allocation purposes
 ### caseSpecialisms Examples
 
 ```json
-"Access"
+[
+  "Access",
+  "Listed building and enforcement"
+]
 ```
 
 ```json
-"Listed building and enforcement"
-```
-
-```json
-"Roads and traffics"
-```
-
-```json
-"Natural heritage"
-```
-
-```json
-"Schedule 1"
+[
+  "Schedule 1"
+]
 ```
 
 ## caseSubmittedDate
@@ -1914,6 +1907,21 @@ The methods used to notify relevant parties
 
 `string[]`
 
+### notificationMethod Examples
+
+```json
+[
+  "notice",
+  "letter"
+]
+```
+
+```json
+[
+  "advert"
+]
+```
+
 ## ownersInformed
 
 Indicates if the appellant has informed other owners of the site

package/docs/dart-response.md

@@ -301,15 +301,16 @@ A list of case specialisms for allocation purposes
 ### caseSpecialisms Examples
 
 ```json
-"General allocation"
+[
+  "General allocation",
+  "Housing orders"
+]
 ```
 
 ```json
-"Housing orders"
-```
-
-```json
-"Waste"
+[
+  "Waste"
+]
 ```
 
 ## caseSubmittedDate

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@planning-inspectorate/data-model",
-  "version": "1.17.0",
+  "version": "1.18.1",
   "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-09-09T11:38:23+00:00
+#   timestamp: 2025-09-15T15:35:44+00:00
 
 from __future__ import annotations
 
@@ -175,16 +175,12 @@ class KnowsAllOwners(Enum):
     NoneType_None = None
 
 
-class NotificationMethodEnumEnumEnum(Enum):
+class NotificationMethodEnum(Enum):
     notice = "notice"
     letter = "letter"
     advert = "advert"
 
 
-class NotificationMethodEnum(RootModel[NotificationMethodEnumEnumEnum | None]):
-    root: NotificationMethodEnumEnumEnum | None = None
-
-
 class NeighbouringSiteAddress(BaseModel):
     model_config = ConfigDict(
         extra="allow",
@@ -291,14 +287,7 @@ class AppealHasCase1(BaseModel):
     A band used for allocation purposes
     """
     caseSpecialisms: list[str] = Field(
-        ...,
-        examples=[
-            "Access",
-            "Listed building and enforcement",
-            "Roads and traffics",
-            "Natural heritage",
-            "Schedule 1",
-        ],
+        ..., examples=[["Access", "Listed building and enforcement"], ["Schedule 1"]]
     )
     """
     A list of specialisms for allocation purposes
@@ -643,7 +632,9 @@ class AppealHasCase1(BaseModel):
     """
     Indicates if the appellant has advertised the appeal to the LPA decision
     """
-    notificationMethod: list[NotificationMethodEnum]
+    notificationMethod: list[NotificationMethodEnum] = Field(
+        ..., examples=[["notice", "letter"], ["advert"]]
+    )
     """
     The methods used to notify relevant parties
     """
@@ -722,16 +713,6 @@ class AppealHasCase1(BaseModel):
     advertType: str | None = None
 
 
-class NotificationMethodEnum1EnumEnum(Enum):
-    notice = "notice"
-    letter = "letter"
-    advert = "advert"
-
-
-class NotificationMethodEnum1(RootModel[NotificationMethodEnum1EnumEnum | None]):
-    root: NotificationMethodEnum1EnumEnum | None = None
-
-
 class AppealHasCase2(BaseModel):
     """
     Group A - Schema defining the metadata for an appeal
@@ -787,14 +768,7 @@ class AppealHasCase2(BaseModel):
     A band used for allocation purposes
     """
     caseSpecialisms: list[str] = Field(
-        ...,
-        examples=[
-            "Access",
-            "Listed building and enforcement",
-            "Roads and traffics",
-            "Natural heritage",
-            "Schedule 1",
-        ],
+        ..., examples=[["Access", "Listed building and enforcement"], ["Schedule 1"]]
     )
     """
     A list of specialisms for allocation purposes
@@ -1139,7 +1113,9 @@ class AppealHasCase2(BaseModel):
     """
     Indicates if the appellant has advertised the appeal to the LPA decision
     """
-    notificationMethod: list[NotificationMethodEnum1]
+    notificationMethod: list[NotificationMethodEnum] = Field(
+        ..., examples=[["notice", "letter"], ["advert"]]
+    )
     """
     The methods used to notify relevant parties
     """

package/pins_data_model/models/model_appeal_s78.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  appeal-s78.schema.json
-#   timestamp: 2025-09-09T11:38:22+00:00
+#   timestamp: 2025-09-15T15:35:44+00:00
 
 from __future__ import annotations
 
@@ -169,16 +169,12 @@ class KnowsAllOwners(Enum):
     NoneType_None = None
 
 
-class NotificationMethodEnumEnumEnum(Enum):
+class NotificationMethodEnum(Enum):
     notice = "notice"
     letter = "letter"
     advert = "advert"
 
 
-class NotificationMethodEnum(RootModel[NotificationMethodEnumEnumEnum | None]):
-    root: NotificationMethodEnumEnumEnum | None = None
-
-
 class NeighbouringSiteAddress(BaseModel):
     model_config = ConfigDict(
         extra="allow",
@@ -357,14 +353,7 @@ class AppealS78Case1(BaseModel):
     A band used for allocation purposes
     """
     caseSpecialisms: list[str] = Field(
-        ...,
-        examples=[
-            "Access",
-            "Listed building and enforcement",
-            "Roads and traffics",
-            "Natural heritage",
-            "Schedule 1",
-        ],
+        ..., examples=[["Access", "Listed building and enforcement"], ["Schedule 1"]]
     )
     """
     A list of specialisms for allocation purposes
@@ -611,7 +600,9 @@ class AppealS78Case1(BaseModel):
     """
     Indicates if the appellant has advertised the appeal to the LPA decision
     """
-    notificationMethod: list[NotificationMethodEnum]
+    notificationMethod: list[NotificationMethodEnum] = Field(
+        ..., examples=[["notice", "letter"], ["advert"]]
+    )
     """
     The methods used to notify relevant parties
     """
@@ -875,16 +866,6 @@ class AppealS78Case1(BaseModel):
     )
 
 
-class NotificationMethodEnum1EnumEnum(Enum):
-    notice = "notice"
-    letter = "letter"
-    advert = "advert"
-
-
-class NotificationMethodEnum1(RootModel[NotificationMethodEnum1EnumEnum | None]):
-    root: NotificationMethodEnum1EnumEnum | None = None
-
-
 class AppealS78Case2(BaseModel):
     """
     Group B - Schema defining the metadata for an appeal
@@ -940,14 +921,7 @@ class AppealS78Case2(BaseModel):
     A band used for allocation purposes
     """
     caseSpecialisms: list[str] = Field(
-        ...,
-        examples=[
-            "Access",
-            "Listed building and enforcement",
-            "Roads and traffics",
-            "Natural heritage",
-            "Schedule 1",
-        ],
+        ..., examples=[["Access", "Listed building and enforcement"], ["Schedule 1"]]
     )
     """
     A list of specialisms for allocation purposes
@@ -1194,7 +1168,9 @@ class AppealS78Case2(BaseModel):
     """
     Indicates if the appellant has advertised the appeal to the LPA decision
     """
-    notificationMethod: list[NotificationMethodEnum1]
+    notificationMethod: list[NotificationMethodEnum] = Field(
+        ..., examples=[["notice", "letter"], ["advert"]]
+    )
     """
     The methods used to notify relevant parties
     """

package/pins_data_model/models/model_dart_response.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  dart-response.schema.json
-#   timestamp: 2025-08-29T10:40:44+00:00
+#   timestamp: 2025-09-15T15:35:43+00:00
 
 from __future__ import annotations
 
@@ -78,7 +78,7 @@ class DartApiResponse(BaseModel):
     A band used for allocation purposes
     """
     caseSpecialisms: list[str] | None = Field(
-        None, examples=["General allocation", "Housing orders", "Waste"]
+        None, examples=[["General allocation", "Housing orders"], ["Waste"]]
     )
     """
     A list of case specialisms for allocation purposes

package/schemas/appeal-has.schema.json

@@ -167,9 +167,16 @@
     "caseSpecialisms": {
       "type": ["array", "null"],
       "items": {
-        "type": "string"
+        "type": "string",
+        "examples": [
+          "Access",
+          "Listed building and enforcement",
+          "Roads and traffics",
+          "Natural heritage",
+          "Schedule 1"
+        ]
       },
-      "examples": ["Access", "Listed building and enforcement", "Roads and traffics", "Natural heritage", "Schedule 1"],
+      "examples": [["Access", "Listed building and enforcement"], ["Schedule 1"]],
       "description": "A list of specialisms for allocation purposes"
     },
     "caseSubmittedDate": {
@@ -573,8 +580,9 @@
       "type": ["array", "null"],
       "items": {
         "type": "string",
-        "enum": ["notice", "letter", "advert", null]
+        "enum": ["notice", "letter", "advert"]
       },
+      "examples": [["notice", "letter"], ["advert"]],
       "description": "The methods used to notify relevant parties"
     },
     "ownersInformed": {

package/schemas/appeal-s78.schema.json

@@ -236,9 +236,16 @@
     "caseSpecialisms": {
       "type": ["array", "null"],
       "items": {
-        "type": "string"
+        "type": "string",
+        "examples": [
+          "Access",
+          "Listed building and enforcement",
+          "Roads and traffics",
+          "Natural heritage",
+          "Schedule 1"
+        ]
       },
-      "examples": ["Access", "Listed building and enforcement", "Roads and traffics", "Natural heritage", "Schedule 1"],
+      "examples": [["Access", "Listed building and enforcement"], ["Schedule 1"]],
       "description": "A list of specialisms for allocation purposes",
       "$comment": "Also available on HAS cases"
     },
@@ -584,8 +591,9 @@
       "type": ["array", "null"],
       "items": {
         "type": "string",
-        "enum": ["notice", "letter", "advert", null]
+        "enum": ["notice", "letter", "advert"]
       },
+      "examples": [["notice", "letter"], ["advert"]],
       "description": "The methods used to notify relevant parties",
       "$comment": "Also available on HAS cases"
     },

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

@@ -0,0 +1,23 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "commands/appeal-advert.submission.schema.json",
+  "title": "Advert specific properties",
+  "description": "Schema defining any properties for advertisement appeals",
+  "type": "object",
+  "additionalProperties": true,
+  "required": ["isSiteOnHighwayLand", "isAdvertInPosition", "hasLandownersPermission"],
+  "properties": {
+    "hasLandownersPermission": {
+      "type": ["boolean", "null"],
+      "description": "Indicates if the appellant has land owners permission"
+    },
+    "isAdvertInPosition": {
+      "type": ["boolean", "null"],
+      "description": "Indicates if the advert is already in position"
+    },
+    "isSiteOnHighwayLand": {
+      "type": ["boolean", "null"],
+      "description": "Indicates if site is on highway land"
+    }
+  }
+}

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

@@ -16,16 +16,28 @@
     "applicationDecision",
     "applicationDecisionDate",
     "caseSubmissionDueDate",
-    "siteAddressLine1",
-    "siteAddressLine2",
-    "siteAddressTown",
-    "siteAddressCounty",
-    "siteAddressPostcode",
     "siteAccessDetails",
     "siteSafetyDetails",
     "neighbouringSiteAddresses",
     "nearbyCaseReferences"
   ],
+  "anyOf": [
+    {
+      "required": ["siteGridReferenceEasting", "siteGridReferenceNorthing"],
+      "properties": {
+        "siteGridReferenceEasting": { "not": { "type": "null" } },
+        "siteGridReferenceNorthing": { "not": { "type": "null" } }
+      }
+    },
+    {
+      "required": ["siteAddressLine1", "siteAddressTown", "siteAddressPostcode"],
+      "properties": {
+        "siteAddressLine1": { "not": { "type": "null" } },
+        "siteAddressTown": { "not": { "type": "null" } },
+        "siteAddressPostcode": { "not": { "type": "null" } }
+      }
+    }
+  ],
   "properties": {
     "submissionId": {
       "type": "string",
@@ -84,7 +96,7 @@
       "$comment": "Calculated from the applicationDecisionDate"
     },
     "siteAddressLine1": {
-      "type": "string",
+      "type": ["string", "null"],
       "examples": ["96 The Avenue"],
       "description": "First line of address for the appeal site"
     },
@@ -93,7 +105,7 @@
       "description": "Second line of address for the appeal site"
     },
     "siteAddressTown": {
-      "type": "string",
+      "type": ["string", "null"],
       "examples": ["Maidstone"],
       "description": "Town / City of the site address"
     },
@@ -103,10 +115,20 @@
       "description": "County of the site address"
     },
     "siteAddressPostcode": {
-      "type": "string",
+      "type": ["string", "null"],
       "examples": ["MD21 5XY"],
       "description": "Postal code of the site address"
     },
+    "siteGridReferenceEasting": {
+      "type": ["string", "null"],
+      "pattern": "^\\d{6}$",
+      "examples": ["357144"]
+    },
+    "siteGridReferenceNorthing": {
+      "type": ["string", "null"],
+      "pattern": "^\\d{6}$",
+      "examples": ["400534"]
+    },
     "siteAccessDetails": {
       "type": ["array", "null"],
       "items": {

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

@@ -20,7 +20,6 @@
     "appellantCostsAppliedFor"
   ],
   "allOf": [
-    { "$ref": "appeal-common-submission.schema.json" },
     {
       "properties": {
         "isGreenBelt": {

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

@@ -21,7 +21,7 @@
     },
     "representationType": {
       "type": "string",
-      "enum": ["statement", "comment", "final_comment", "proofs_evidence", null],
+      "enum": ["statement", "comment", "final_comment", "proofs_evidence"],
       "description": "The type of representation"
     },
     "representation": {

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

@@ -19,7 +19,6 @@
     "developmentType"
   ],
   "allOf": [
-    { "$ref": "appeal-has-submission.schema.json" },
     {
       "properties": {
         "agriculturalHolding": {

package/schemas/commands/appellant-submission.schema.json

@@ -14,19 +14,30 @@
       "required": ["caseType"],
       "oneOf": [
         {
-          "allOf": [{ "properties": { "caseType": { "const": "D" } } }, { "$ref": "appeal-has-submission.schema.json" }]
-        },
-        {
+          "$comment": "Householder + CAS Planning",
           "allOf": [
-            { "properties": { "caseType": { "const": "ZP" } } },
+            { "properties": { "caseType": { "enum": ["D", "ZP"] } } },
+            { "$ref": "appeal-common-submission.schema.json" },
             { "$ref": "appeal-has-submission.schema.json" }
           ]
         },
         {
-          "allOf": [{ "properties": { "caseType": { "const": "W" } } }, { "$ref": "appeal-s78-submission.schema.json" }]
+          "$comment": "S78 + S20",
+          "allOf": [
+            { "properties": { "caseType": { "enum": ["W", "Y"] } } },
+            { "$ref": "appeal-common-submission.schema.json" },
+            { "$ref": "appeal-has-submission.schema.json" },
+            { "$ref": "appeal-s78-submission.schema.json" }
+          ]
         },
         {
-          "allOf": [{ "properties": { "caseType": { "const": "Y" } } }, { "$ref": "appeal-s78-submission.schema.json" }]
+          "$comment": "Adverts + CAS Adverts",
+          "allOf": [
+            { "properties": { "caseType": { "enum": ["H", "ZA"] } } },
+            { "$ref": "appeal-common-submission.schema.json" },
+            { "$ref": "appeal-has-submission.schema.json" },
+            { "$ref": "appeal-advert.submission.schema.json" }
+          ]
         }
       ]
     },

package/schemas/commands/lpa-questionnaire-has.schema.json

@@ -16,7 +16,6 @@
     "lpaStatement"
   ],
   "allOf": [
-    { "$ref": "lpa-questionnaire-common.schema.json" },
     {
       "properties": {
         "isCorrectAppealType": {

package/schemas/commands/lpa-questionnaire-s78.schema.json

@@ -35,7 +35,6 @@
     "lpaProcedurePreferenceDuration"
   ],
   "allOf": [
-    { "$ref": "lpa-questionnaire-has.schema.json" },
     {
       "properties": {
         "changedListedBuildingNumbers": {

package/schemas/commands/lpa-questionnaire.schema.json

@@ -11,27 +11,29 @@
     "casedata": {
       "type": "object",
       "additionalProperties": true,
-      "anyOf": [
+      "oneOf": [
         {
+          "$comment": "Householder + CAS Planning",
           "allOf": [
-            { "$comment": "backwards compatibility for no case type, when removed can update allOf to oneOf" },
-            { "not": { "required": ["caseType"] } },
+            { "properties": { "caseType": { "enum": ["D", "ZP"] } } },
+            { "$ref": "lpa-questionnaire-common.schema.json" },
             { "$ref": "lpa-questionnaire-has.schema.json" }
           ]
         },
         {
-          "allOf": [{ "properties": { "caseType": { "const": "W" } } }, { "$ref": "lpa-questionnaire-s78.schema.json" }]
-        },
-        {
-          "allOf": [{ "properties": { "caseType": { "const": "Y" } } }, { "$ref": "lpa-questionnaire-s78.schema.json" }]
-        },
-        {
-          "allOf": [{ "properties": { "caseType": { "const": "D" } } }, { "$ref": "lpa-questionnaire-has.schema.json" }]
+          "$comment": "S78 + S20",
+          "allOf": [
+            { "properties": { "caseType": { "enum": ["W", "Y"] } } },
+            { "$ref": "lpa-questionnaire-common.schema.json" },
+            { "$ref": "lpa-questionnaire-has.schema.json" },
+            { "$ref": "lpa-questionnaire-s78.schema.json" }
+          ]
         },
         {
+          "$comment": "Adverts + CAS Adverts - TBD - may need separate schemas",
           "allOf": [
-            { "properties": { "caseType": { "const": "ZP" } } },
-            { "$ref": "lpa-questionnaire-has.schema.json" }
+            { "properties": { "caseType": { "enum": ["H", "ZA"] } } },
+            { "$ref": "lpa-questionnaire-common.schema.json" }
           ]
         }
       ]

package/schemas/dart-response.schema.json

@@ -55,9 +55,10 @@
     "caseSpecialisms": {
       "type": ["array", "null"],
       "items": {
-        "type": "string"
+        "type": "string",
+        "examples": ["General allocation", "Housing orders", "Waste"]
       },
-      "examples": ["General allocation", "Housing orders", "Waste"],
+      "examples": [["General allocation", "Housing orders"], ["Waste"]],
       "description": "A list of case specialisms for allocation purposes"
     },
     "caseSubmittedDate": {