@planning-inspectorate/data-model 1.20.0 → 1.22.0

package/pins_data_model/models/model_appeal_s78.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  appeal-s78.schema.json
-#   timestamp: 2025-10-30T20:02:31+00:00
+#   timestamp: 2025-11-07T15:19:29+00:00
 
 from __future__ import annotations
 
@@ -298,6 +298,38 @@ class DevelopmentType(Enum):
     NoneType_None = None
 
 
+class AdvertType(Enum):
+    field_4_6_Sheet_Non_Illuminated = "4-6 Sheet Non-Illuminated"
+    field_4_6_Sheet_Illuminated = "4-6 Sheet Illuminated"
+    field_12_16_32_Sheet_Non_Illuminated = "12/16/32 Sheet Non-Illuminated"
+    field_12_16_32_Sheet_Illuminated = "12/16/32 Sheet Illuminated"
+    field_48_64_96_Sheet_Non_Illuminated = "48/64/96 Sheet Non-Illuminated"
+    field_48_64_96_Sheet_Illuminated = "48/64/96 Sheet Illuminated"
+    Fascia_Projecting_Signs_Non_Illuminated = "Fascia Projecting Signs Non-Illuminated"
+    Fascia_Projecting_Signs_Illuminated = "Fascia Projecting Signs Illuminated"
+    Directional___Others_Non_Illuminated = "Directional & Others Non-Illuminated"
+    Directional___Others_Illuminated = "Directional & Others Illuminated"
+    Monolith_Totem_Signs_Non_Illuminated = "Monolith/Totem Signs Non-Illuminated"
+    Monolith_Totem_Signs_Illuminated = "Monolith/Totem Signs Illuminated"
+    Other = "Other"
+    NoneType_None = None
+
+
+class AdvertDetail(BaseModel):
+    model_config = ConfigDict(
+        extra="allow",
+    )
+    advertType: AdvertType
+    isAdvertInPosition: bool | None = None
+    """
+    Is the advertisement in position?
+    """
+    isSiteOnHighwayLand: bool | None = None
+    """
+    Is the site on highway land?
+    """
+
+
 class AppealS78Case1(BaseModel):
     """
     Group B - Schema defining the metadata for an appeal
@@ -848,10 +880,10 @@ class AppealS78Case1(BaseModel):
     """
     The net gain in residences of the proposed development
     """
-    siteGridReferenceEasting: constr(pattern=r"^\d{6}$") | None = Field(
+    siteGridReferenceEasting: constr(pattern=r"^\d{6,7}$") = Field(
         ..., examples=["357144"]
     )
-    siteGridReferenceNorthing: constr(pattern=r"^\d{6}$") | None = Field(
+    siteGridReferenceNorthing: constr(pattern=r"^\d{6,7}$") = Field(
         ..., examples=["400534"]
     )
     siteViewableFromRoad: bool | None = None
@@ -864,6 +896,41 @@ class AppealS78Case1(BaseModel):
     planningObligationDueDate: AwareDatetime | None = Field(
         None, examples=["2023-07-27T20:30:00.000Z"]
     )
+    hasLandownersPermission: bool | None = None
+    """
+    Does the appellant have the landowners permission
+    """
+    wasApplicationRefusedDueToHighwayOrTraffic: bool | None = None
+    """
+    Did the LPA refuse the application because of highway or traffic public safety?
+    """
+    didAppellantSubmitCompletePhotosAndPlans: bool | None = None
+    """
+    Did the appellant submit complete photos and plans?
+    """
+    isSiteInAreaOfSpecialControlAdverts: bool | None = None
+    """
+    Is the site in an area of special control of advertisements?
+    """
+    advertDetails: list[AdvertDetail] | None = None
+    """
+    A list of advertisements for the appeal
+    """
+
+
+class AdvertDetail1(BaseModel):
+    model_config = ConfigDict(
+        extra="allow",
+    )
+    advertType: AdvertType
+    isAdvertInPosition: bool | None = None
+    """
+    Is the advertisement in position?
+    """
+    isSiteOnHighwayLand: bool | None = None
+    """
+    Is the site on highway land?
+    """
 
 
 class AppealS78Case2(BaseModel):
@@ -1100,7 +1167,7 @@ class AppealS78Case2(BaseModel):
     """
     The statutory deadline for submitting an appeal from the original LPA decision date
     """
-    siteAddressLine1: str | None = Field(..., examples=["96 The Avenue"])
+    siteAddressLine1: str = Field(..., examples=["96 The Avenue"])
     """
     First line of address for the appeal site
     """
@@ -1108,7 +1175,7 @@ class AppealS78Case2(BaseModel):
     """
     Second line of address for the appeal site
     """
-    siteAddressTown: str | None = Field(..., examples=["Maidstone"])
+    siteAddressTown: str = Field(..., examples=["Maidstone"])
     """
     Town / City of the site address
     """
@@ -1116,7 +1183,7 @@ class AppealS78Case2(BaseModel):
     """
     County of the site address
     """
-    siteAddressPostcode: str | None = Field(..., examples=["MD21 5XY"])
+    siteAddressPostcode: str = Field(..., examples=["MD21 5XY"])
     """
     Postal code of the site address
     """
@@ -1416,10 +1483,10 @@ class AppealS78Case2(BaseModel):
     """
     The net gain in residences of the proposed development
     """
-    siteGridReferenceEasting: constr(pattern=r"^\d{6}$") | None = Field(
+    siteGridReferenceEasting: constr(pattern=r"^\d{6,7}$") | None = Field(
         None, examples=["357144"]
     )
-    siteGridReferenceNorthing: constr(pattern=r"^\d{6}$") | None = Field(
+    siteGridReferenceNorthing: constr(pattern=r"^\d{6,7}$") | None = Field(
         None, examples=["400534"]
     )
     siteViewableFromRoad: bool | None = None
@@ -1432,6 +1499,26 @@ class AppealS78Case2(BaseModel):
     planningObligationDueDate: AwareDatetime | None = Field(
         None, examples=["2023-07-27T20:30:00.000Z"]
     )
+    hasLandownersPermission: bool | None = None
+    """
+    Does the appellant have the landowners permission
+    """
+    wasApplicationRefusedDueToHighwayOrTraffic: bool | None = None
+    """
+    Did the LPA refuse the application because of highway or traffic public safety?
+    """
+    didAppellantSubmitCompletePhotosAndPlans: bool | None = None
+    """
+    Did the appellant submit complete photos and plans?
+    """
+    isSiteInAreaOfSpecialControlAdverts: bool | None = None
+    """
+    Is the site in an area of special control of advertisements?
+    """
+    advertDetails: list[AdvertDetail1] | None = None
+    """
+    A list of advertisements for the appeal
+    """
 
 
 class AppealS78Case(RootModel[AppealS78Case1 | AppealS78Case2]):

package/pins_data_model/models/model_dart_response.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  dart-response.schema.json
-#   timestamp: 2025-10-30T20:02:31+00:00
+#   timestamp: 2025-11-04T12:34:00+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_entraid.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  entraid.schema.json
-#   timestamp: 2025-10-30T20:02:31+00:00
+#   timestamp: 2025-11-04T12:34:00+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_folder.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  folder.schema.json
-#   timestamp: 2025-10-30T20:02:31+00:00
+#   timestamp: 2025-11-04T12:34:00+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_gettimesheets_response.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  gettimesheets-response.schema.json
-#   timestamp: 2025-10-30T20:02:31+00:00
+#   timestamp: 2025-11-04T12:34:00+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_listed_building.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  listed-building.schema.json
-#   timestamp: 2025-10-30T20:02:31+00:00
+#   timestamp: 2025-11-04T12:34:00+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_listed_buildings.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  listed-buildings.schema.json
-#   timestamp: 2025-10-30T20:02:31+00:00
+#   timestamp: 2025-11-04T12:34:00+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_nsip_document.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  nsip-document.schema.json
-#   timestamp: 2025-10-30T20:02:31+00:00
+#   timestamp: 2025-11-04T12:34:00+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_nsip_exam_timetable.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  nsip-exam-timetable.schema.json
-#   timestamp: 2025-10-30T20:02:31+00:00
+#   timestamp: 2025-11-04T12:34:00+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_nsip_project.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  nsip-project.schema.json
-#   timestamp: 2025-10-30T20:02:32+00:00
+#   timestamp: 2025-11-04T12:34:00+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_nsip_project_update.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  nsip-project-update.schema.json
-#   timestamp: 2025-10-30T20:02:31+00:00
+#   timestamp: 2025-11-04T12:34:00+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_nsip_representation.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  nsip-representation.schema.json
-#   timestamp: 2025-10-30T20:02:32+00:00
+#   timestamp: 2025-11-04T12:34:00+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_nsip_subscription.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  nsip-subscription.schema.json
-#   timestamp: 2025-10-30T20:02:32+00:00
+#   timestamp: 2025-11-04T12:34:00+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_pins_inspector.py

@@ -1,21 +1,58 @@
 # generated by datamodel-codegen:
 #   filename:  pins-inspector.schema.json
-#   timestamp: 2025-10-30T20:02:32+00:00
+#   timestamp: 2025-11-04T12:34:00+00:00
 
 from __future__ import annotations
 
-from pydantic import BaseModel, ConfigDict
+from pydantic import AwareDatetime, BaseModel, ConfigDict, EmailStr, Field
+
+
+class Address(BaseModel):
+    model_config = ConfigDict(
+        extra="allow",
+    )
+    addressLine1: str | None = None
+    addressLine2: str | None = None
+    townCity: str | None = None
+    county: str | None = None
+    postcode: str | None = None
+
+
+class Specialism(BaseModel):
+    model_config = ConfigDict(
+        extra="allow",
+    )
+    name: str = Field(..., examples=["S62A Casework Major"])
+    """
+    Working above band is stored as a specialism
+    """
+    proficiency: str | None = Field(..., examples=["trained"])
+    """
+    trained or in-training
+    """
+    validFrom: AwareDatetime | None = Field(..., examples=["2023-07-27T20:30:00.000Z"])
+    """
+    Date training started or date training was completed.
+    """
 
 
 class PinsInspector(BaseModel):
     """
-    Inspector attributes as per Horizon. This will be extended with SAP/Entra data
+    Inspector Details originating from Horizon, SAP HR and Entra.
     """
 
     model_config = ConfigDict(
         extra="allow",
     )
-    horizonId: str
+    entraId: str | None = Field(..., examples=["00000000-0000-0000-0000-000000000000"])
+    """
+    EntraID of the Inspector if available in ODW.
+    """
+    sapId: str | None = Field(..., examples=["12345678"])
+    """
+    SAPID of the Inspector if available in ODW.
+    """
+    horizonId: str | None = None
     """
     The PINS-generated unique horizon ID
     """
@@ -47,7 +84,39 @@ class PinsInspector(BaseModel):
     """
     The qualifications of the inspector
     """
-    email: str | None = None
+    email: EmailStr | None = Field(
+        ..., examples=["example@planninginspectorate.gov.uk"]
+    )
+    """
+    PINS Email address for the Inspector
+    """
+    grade: str = Field(..., examples=["B1"])
+    """
+    Grades as a coded value e.g. B1, B2, B3, FTC-B1, FTC-B2, FTC-B3, PL
+    """
+    fte: float = Field(..., examples=[0.75])
+    """
+    FTE Decimal value e.g. 1, 0.5 etc
+    """
+    unit: str = Field(..., examples=["Operations"])
+    """
+    The personnel area of the Inspector
+    """
+    service: str = Field(..., examples=["Planning and Environmental Appeals Service"])
+    """
+    The personnel sub area of the Inspector
+    """
+    group: str = Field(..., examples=["Enforcement Groups"])
+    """
+    Group of the Inspector
+    """
+    inspectorManager: str = Field(..., examples=["Dan Brown"])
+    """
+    Name of the Inspector's manager.
+    """
+    validFrom: AwareDatetime | None = Field(None, examples=["2023-07-27T20:30:00.000Z"])
     """
-    The email address of the inspector
+    Date the Inspector record was first recorded.
     """
+    address: Address
+    specialisms: list[Specialism]

package/pins_data_model/models/model_pins_lpa.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  pins-lpa.schema.json
-#   timestamp: 2025-10-30T20:02:32+00:00
+#   timestamp: 2025-11-04T12:34:00+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_s51_advice.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  s51-advice.schema.json
-#   timestamp: 2025-10-30T20:02:32+00:00
+#   timestamp: 2025-11-04T12:34:00+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_service_user.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  service-user.schema.json
-#   timestamp: 2025-10-30T20:02:32+00:00
+#   timestamp: 2025-11-04T12:34:00+00:00
 
 from __future__ import annotations
 

package/schemas/appeal-has.schema.json

@@ -78,16 +78,16 @@
     {
       "required": ["siteGridReferenceEasting", "siteGridReferenceNorthing"],
       "properties": {
-        "siteGridReferenceEasting": { "not": { "type": "null" } },
-        "siteGridReferenceNorthing": { "not": { "type": "null" } }
+        "siteGridReferenceEasting": { "type": "string" },
+        "siteGridReferenceNorthing": { "type": "string" }
       }
     },
     {
       "required": ["siteAddressLine1", "siteAddressTown", "siteAddressPostcode"],
       "properties": {
-        "siteAddressLine1": { "not": { "type": "null" } },
-        "siteAddressTown": { "not": { "type": "null" } },
-        "siteAddressPostcode": { "not": { "type": "null" } }
+        "siteAddressLine1": { "type": "string" },
+        "siteAddressTown": { "type": "string" },
+        "siteAddressPostcode": { "type": "string" }
       }
     }
   ],
@@ -701,37 +701,68 @@
     },
     "siteGridReferenceEasting": {
       "type": ["string", "null"],
-      "pattern": "^\\d{6}$",
+      "pattern": "^\\d{6,7}$",
       "examples": ["357144"]
     },
     "siteGridReferenceNorthing": {
       "type": ["string", "null"],
-      "pattern": "^\\d{6}$",
+      "pattern": "^\\d{6,7}$",
       "examples": ["400534"]
     },
     "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"
-    },
-    "isSiteInAreaOfSpecialControlAdverts": {
-      "type": ["boolean", "null"],
-      "description": "Indicates if the site is in an area of special control for adverts"
+      "description": "Does the appellant have the landowners permission"
     },
     "wasApplicationRefusedDueToHighwayOrTraffic": {
       "type": ["boolean", "null"],
-      "description": "Indicates if the application was refused because of highway or traffic public safety?"
+      "description": "Did the LPA refuse the application because of highway or traffic public safety?"
     },
     "didAppellantSubmitCompletePhotosAndPlans": {
       "type": ["boolean", "null"],
-      "description": "Indicates if the appellant submitted complete and accurate photographs and plans"
+      "description": "Did the appellant submit complete photos and plans?"
     },
-    "advertType": {
-      "type": ["string", "null"],
-      "$comment": "Pick from a TBD list of reference data for advert type"
+    "isSiteInAreaOfSpecialControlAdverts": {
+      "type": ["boolean", "null"],
+      "description": "Is the site in an area of special control of advertisements?"
+    },
+    "advertDetails": {
+      "type": ["array", "null"],
+      "items": {
+        "type": "object",
+        "additionalProperties": true,
+        "properties": {
+          "advertType": {
+            "type": ["string", "null"],
+            "enum": [
+              "4-6 Sheet Non-Illuminated",
+              "4-6 Sheet Illuminated",
+              "12/16/32 Sheet Non-Illuminated",
+              "12/16/32 Sheet Illuminated",
+              "48/64/96 Sheet Non-Illuminated",
+              "48/64/96 Sheet Illuminated",
+              "Fascia Projecting Signs Non-Illuminated",
+              "Fascia Projecting Signs Illuminated",
+              "Directional & Others Non-Illuminated",
+              "Directional & Others Illuminated",
+              "Monolith/Totem Signs Non-Illuminated",
+              "Monolith/Totem Signs Illuminated",
+              "Other",
+              null
+            ]
+          },
+          "isAdvertInPosition": {
+            "type": ["boolean", "null"],
+            "description": "Is the advertisement in position?"
+          },
+          "isSiteOnHighwayLand": {
+            "type": ["boolean", "null"],
+            "description": "Is the site on highway land?"
+          }
+        },
+        "required": ["advertType", "isAdvertInPosition", "isSiteOnHighwayLand"]
+      },
+      "description": "A list of advertisements for the appeal",
+      "$comment": "Also available on CAS Adverts (ZA) cases"
     }
   }
 }

package/schemas/appeal-s78.schema.json

@@ -136,16 +136,16 @@
     {
       "required": ["siteGridReferenceEasting", "siteGridReferenceNorthing"],
       "properties": {
-        "siteGridReferenceEasting": { "not": { "type": "null" } },
-        "siteGridReferenceNorthing": { "not": { "type": "null" } }
+        "siteGridReferenceEasting": { "type": "string" },
+        "siteGridReferenceNorthing": { "type": "string" }
       }
     },
     {
       "required": ["siteAddressLine1", "siteAddressTown", "siteAddressPostcode"],
       "properties": {
-        "siteAddressLine1": { "not": { "type": "null" } },
-        "siteAddressTown": { "not": { "type": "null" } },
-        "siteAddressPostcode": { "not": { "type": "null" } }
+        "siteAddressLine1": { "type": "string" },
+        "siteAddressTown": { "type": "string" },
+        "siteAddressPostcode": { "type": "string" }
       }
     }
   ],
@@ -973,12 +973,12 @@
     },
     "siteGridReferenceEasting": {
       "type": ["string", "null"],
-      "pattern": "^\\d{6}$",
+      "pattern": "^\\d{6,7}$",
       "examples": ["357144"]
     },
     "siteGridReferenceNorthing": {
       "type": ["string", "null"],
-      "pattern": "^\\d{6}$",
+      "pattern": "^\\d{6,7}$",
       "examples": ["400534"]
     },
     "siteViewableFromRoad": {
@@ -1032,6 +1032,61 @@
       "type": ["string", "null"],
       "format": "date-time",
       "examples": ["2023-07-27T20:30:00.000Z"]
+    },
+    "hasLandownersPermission": {
+      "type": ["boolean", "null"],
+      "description": "Does the appellant have the landowners permission"
+    },
+    "wasApplicationRefusedDueToHighwayOrTraffic": {
+      "type": ["boolean", "null"],
+      "description": "Did the LPA refuse the application because of highway or traffic public safety?"
+    },
+    "didAppellantSubmitCompletePhotosAndPlans": {
+      "type": ["boolean", "null"],
+      "description": "Did the appellant submit complete photos and plans?"
+    },
+    "isSiteInAreaOfSpecialControlAdverts": {
+      "type": ["boolean", "null"],
+      "description": "Is the site in an area of special control of advertisements?"
+    },
+    "advertDetails": {
+      "type": ["array", "null"],
+      "items": {
+        "type": "object",
+        "additionalProperties": true,
+        "properties": {
+          "advertType": {
+            "type": ["string", "null"],
+            "enum": [
+              "4-6 Sheet Non-Illuminated",
+              "4-6 Sheet Illuminated",
+              "12/16/32 Sheet Non-Illuminated",
+              "12/16/32 Sheet Illuminated",
+              "48/64/96 Sheet Non-Illuminated",
+              "48/64/96 Sheet Illuminated",
+              "Fascia Projecting Signs Non-Illuminated",
+              "Fascia Projecting Signs Illuminated",
+              "Directional & Others Non-Illuminated",
+              "Directional & Others Illuminated",
+              "Monolith/Totem Signs Non-Illuminated",
+              "Monolith/Totem Signs Illuminated",
+              "Other",
+              null
+            ]
+          },
+          "isAdvertInPosition": {
+            "type": ["boolean", "null"],
+            "description": "Is the advertisement in position?"
+          },
+          "isSiteOnHighwayLand": {
+            "type": ["boolean", "null"],
+            "description": "Is the site on highway land?"
+          }
+        },
+        "required": ["advertType", "isAdvertInPosition", "isSiteOnHighwayLand"]
+      },
+      "description": "A list of advertisements for the appeal",
+      "$comment": "Also available on CAS Adverts (ZA) cases"
     }
   }
 }