@planning-inspectorate/data-model 1.11.0

package/pins_data_model/models/model_nsip_project.py

@@ -0,0 +1,488 @@
+# generated by datamodel-codegen:
+#   filename:  nsip-project.schema.json
+#   timestamp: 2025-07-16T14:06:09+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+from typing import Any
+
+from pydantic import AwareDatetime, BaseModel, ConfigDict, Field
+
+
+class Decision(Enum):
+    """
+    Decision: approved/refused/split-decision
+    """
+
+    approved = "approved"
+    refused = "refused"
+    split_decision = "split-decision"
+    NoneType_None = None
+
+
+class PublishStatus(Enum):
+    published = "published"
+    unpublished = "unpublished"
+    NoneType_None = None
+
+
+class Sector(Enum):
+    """
+    {Sector Abbreviation} - {Sector Display Name}
+    """
+
+    BC___Business_and_Commercial = "BC - Business and Commercial"
+    EN___Energy = "EN - Energy"
+    TR___Transport = "TR - Transport"
+    WA___Water = "WA - Water"
+    WS___Waste = "WS - Waste"
+    WW___Waste_Water = "WW - Waste Water"
+    NoneType_None = None
+
+
+class ProjectType(Enum):
+    """
+    {SubSector Abbreviation} - {SubSector Display Name}
+    """
+
+    BC01___Office_Use = "BC01 - Office Use"
+    BC02___Research_and_Development_of_Products_or_Processes = (
+        "BC02 - Research and Development of Products or Processes"
+    )
+    BC03___An_Industrial_Process_or_Processes = (
+        "BC03 - An Industrial Process or Processes"
+    )
+    BC04___Storage_or_Distribution_of_Goods = "BC04 - Storage or Distribution of Goods"
+    BC05___Conferences = "BC05 - Conferences"
+    BC06___Exhibitions = "BC06 - Exhibitions"
+    BC07___Sport = "BC07 - Sport"
+    BC08___Leisure = "BC08 - Leisure"
+    BC09___Tourism = "BC09 - Tourism"
+    EN01___Generating_Stations = "EN01 - Generating Stations"
+    EN02___Electric_Lines = "EN02 - Electric Lines"
+    EN03___Underground_Gas_Storage_Facilities = (
+        "EN03 - Underground Gas Storage Facilities"
+    )
+    EN04___LNG_Facilities = "EN04 - LNG Facilities"
+    EN05___Gas_Reception_Facilities = "EN05 - Gas Reception Facilities"
+    EN06___Gas_Transporter_Pipe_lines = "EN06 - Gas Transporter Pipe-lines"
+    EN07___Other_Pipe_lines = "EN07 - Other Pipe-lines"
+    TR01___Highways = "TR01 - Highways"
+    TR02___Airports = "TR02 - Airports"
+    TR03___Harbour_Facilities = "TR03 - Harbour Facilities"
+    TR04___Railways = "TR04 - Railways"
+    TR05___Rail_Freight_Interchanges = "TR05 - Rail Freight Interchanges"
+    WS01___Hazardous_Waste_Facilities = "WS01 - Hazardous Waste Facilities"
+    WW01___Waste_Water_Treatment_Plants = "WW01 - Waste Water Treatment Plants"
+    WA01___Dams_and_Reservoirs = "WA01 - Dams and Reservoirs"
+    WA02___Transfer_of_Water_Resources = "WA02 - Transfer of Water Resources"
+    NoneType_None = None
+
+
+class SourceSystem(Enum):
+    back_office_applications = "back-office-applications"
+    horizon = "horizon"
+
+
+class Stage(Enum):
+    """
+    Process stage identifier
+    """
+
+    draft = "draft"
+    pre_application = "pre_application"
+    acceptance = "acceptance"
+    pre_examination = "pre_examination"
+    examination = "examination"
+    recommendation = "recommendation"
+    decision = "decision"
+    post_decision = "post_decision"
+    withdrawn = "withdrawn"
+    NoneType_None = None
+
+
+class Region(Enum):
+    """
+    Geographical region of UK. Applications can cover multiple regions.
+    """
+
+    east_midlands = "east_midlands"
+    eastern = "eastern"
+    london = "london"
+    north_east = "north_east"
+    north_west = "north_west"
+    south_east = "south_east"
+    south_west = "south_west"
+    wales = "wales"
+    west_midlands = "west_midlands"
+    yorkshire_and_the_humber = "yorkshire_and_the_humber"
+
+
+class MapZoomLevel(Enum):
+    """
+    Resolution of pinned map. Set when co-ordinates are created.
+    """
+
+    country = "country"
+    region = "region"
+    county = "county"
+    borough = "borough"
+    district = "district"
+    city = "city"
+    town = "town"
+    junction = "junction"
+    none = "none"
+    NoneType_None = None
+
+
+class NsipProject(BaseModel):
+    """
+    Subset of Pins Data Model [Case]
+    """
+
+    model_config = ConfigDict(
+        extra="allow",
+    )
+    caseId: int = Field(..., examples=[1242])
+    """
+    The unique identifier within the Back Office. This is not the same as the case reference
+    """
+    caseReference: str | None = Field(..., examples=["BC0510001"])
+    projectName: str | None = Field(
+        ..., examples=["A1 Birtley to Coal House Improvement Scheme"]
+    )
+    """
+    Name of project
+    """
+    projectNameWelsh: str | None = None
+    """
+    Name of project in Welsh
+    """
+    projectDescription: str | None = Field(
+        ...,
+        examples=[
+            "The scheme is 6.5 km in length and will consist of online widening of the A1 south of Gateshead to four lanes between junction 65"
+        ],
+    )
+    projectDescriptionWelsh: str | None = None
+    decision: Decision
+    """
+    Decision: approved/refused/split-decision
+    """
+    publishStatus: PublishStatus
+    sector: Sector
+    """
+    {Sector Abbreviation} - {Sector Display Name}
+    """
+    projectType: ProjectType
+    """
+    {SubSector Abbreviation} - {SubSector Display Name}
+    """
+    sourceSystem: SourceSystem
+    stage: Stage
+    """
+    Process stage identifier
+    """
+    projectLocation: str | None = Field(
+        ...,
+        examples=[
+            "The scheme is located on the A1 Newcastle Gateshead Western Bypass, between junctions 65 and 67."
+        ],
+    )
+    """
+    Description of site location
+    """
+    projectLocationWelsh: str | None = None
+    """
+    Description of site location in Welsh
+    """
+    projectEmailAddress: str | None = Field(
+        ..., examples=["NIEnquiries@planninginspectorate.gsi.gov.uk"]
+    )
+    """
+    PINS Project email address pubished on website
+    """
+    regions: list[Region]
+    transboundary: bool | None = Field(..., examples=[True, False])
+    """
+    Drives addition of Transboundary tab on website. [TODO]
+    """
+    easting: int | None = Field(..., examples=[345678])
+    """
+    Project site Easting co-ordinate.
+    """
+    northing: int | None = Field(..., examples=[345678])
+    """
+    Project site Northing co-ordinate.
+    """
+    welshLanguage: bool | None = Field(..., examples=[True, False])
+    """
+    Welsh Language translation required.
+    """
+    mapZoomLevel: MapZoomLevel
+    """
+    Resolution of pinned map. Set when co-ordinates are created.
+    """
+    secretaryOfState: str | None = None
+    """
+    Relevant Government Department. [TODO]
+    """
+    field_preApplicationDates: Any | None = Field(None, alias="_preApplicationDates")
+    datePINSFirstNotifiedOfProject: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Date at which applicant notify PINS of a project (pre-publishing)
+    """
+    dateProjectAppearsOnWebsite: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Date Project Appears On Website
+    """
+    anticipatedSubmissionDateNonSpecific: str | None = Field(..., examples=["Q3 2023"])
+    """
+    Approximate Anticipated Submission Date Of Application, e.g. Q3 2023
+    """
+    anticipatedDateOfSubmission: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Anticipated Submission Date Of Application
+    """
+    screeningOpinionSought: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    (TBC by Env. Services Team)
+    """
+    screeningOpinionIssued: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    (TBC by Env. Services Team)
+    """
+    scopingOpinionSought: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    (TBC by Env. Services Team)
+    """
+    scopingOpinionIssued: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    (TBC by Env. Services Team)
+    """
+    section46Notification: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Applicant must notify PINS of statutory consultation
+    """
+    field_acceptanceDates: Any | None = Field(None, alias="_acceptanceDates")
+    dateOfDCOSubmission: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Date Applcation is submitted
+    """
+    deadlineForAcceptanceDecision: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    DeadlineForAcceptanceDecision
+    """
+    dateOfDCOAcceptance: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Date Application is Formerly Accepted by PINS
+    """
+    dateOfNonAcceptance: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Date of Non Acceptance
+    """
+    field_preExaminationDates: Any | None = Field(None, alias="_preExaminationDates")
+    dateOfRepresentationPeriodOpen: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Date at which point publish can submit relevant reps
+    """
+    dateOfRelevantRepresentationClose: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Date at which point publish can no longer submit relevant reps
+    """
+    extensionToDateRelevantRepresentationsClose: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    ExtensionToDateRelevantRepresentationsClose
+    """
+    dateRRepAppearOnWebsite: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Date at which relevant reps appear on the website
+    """
+    dateIAPIDue: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    rule6LetterPublishDate: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    preliminaryMeetingStartDate: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Meeting between all parties inc public
+    """
+    notificationDateForPMAndEventsDirectlyFollowingPM: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    notificationDateForEventsDeveloper: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    field_examinationDates: Any | None = Field(None, alias="_examinationDates")
+    dateSection58NoticeReceived: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Applicant has notified all parties of application
+    """
+    confirmedStartOfExamination: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    ConfirmedStartOfExamination by panel
+    """
+    rule8LetterPublishDate: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    deadlineForCloseOfExamination: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    DeadlineForCloseOfExamination
+    """
+    dateTimeExaminationEnds: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    ConfirmedSEndOfExamination by panel
+    """
+    stage4ExtensionToExamCloseDate: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Examination Period extended to this date
+    """
+    field_recommendationDates: Any | None = Field(None, alias="_recommendationDates")
+    deadlineForSubmissionOfRecommendation: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    DeadlineForSubmissionOfRecommendation
+    """
+    dateOfRecommendations: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Date recomm report sent to SoS
+    """
+    stage5ExtensionToRecommendationDeadline: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Recommendation period extended to this date
+    """
+    field_decisionDates: Any | None = Field(None, alias="_decisionDates")
+    deadlineForDecision: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    DeadlineForDecision
+    """
+    confirmedDateOfDecision: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Decision by SoS
+    """
+    stage5ExtensionToDecisionDeadline: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Decision period extended to this date
+    """
+    field_postDecisionDates: Any | None = Field(None, alias="_postDecisionDates")
+    jRPeriodEndDate: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Judicial Review
+    """
+    field_withdrawalDates: Any | None = Field(None, alias="_withdrawalDates")
+    dateProjectWithdrawn: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    DateProjectWithdrawn by applicant
+    """
+    operationsLeadId: str | None = None
+    """
+    Maps to [Employee].[EmployeeID].
+    """
+    operationsManagerId: str | None = None
+    """
+    New NSIP role, Maps to [Employee].[EmployeeID]
+    """
+    caseManagerId: str | None = None
+    """
+    Maps to [Employee].[EmployeeID]
+    """
+    nsipOfficerIds: list[str]
+    nsipAdministrationOfficerIds: list[str]
+    leadInspectorId: str | None = None
+    """
+    Maps to [Employee].[EmployeeID]
+    """
+    inspectorIds: list[str]
+    environmentalServicesOfficerId: str | None = None
+    """
+    Maps to [Employee].[EmployeeID]
+    """
+    legalOfficerId: str | None = None
+    """
+    Maps to [Employee].[EmployeeID]
+    """
+    applicantId: str | None = None
+    """
+    Maps to [ServiceUser].[id] where the serviceUserType is Applicant
+    """
+    migrationStatus: bool | None = None
+    """
+    Has this case been migrated from the legacy system? True if so.
+    """
+    dateOfReOpenRelevantRepresentationStart: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Date at which relevant reps can be reopened
+    """
+    dateOfReOpenRelevantRepresentationClose: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Date at which relevant reps can no longer be reopened
+    """
+    isMaterialChange: bool | None = Field(None, examples=[True, False])
+    """
+    Is this an application for a material change?
+    """

package/pins_data_model/models/model_nsip_project_update.py

@@ -0,0 +1,60 @@
+# generated by datamodel-codegen:
+#   filename:  nsip-project-update.schema.json
+#   timestamp: 2025-07-16T14:06:09+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+from pydantic import AwareDatetime, BaseModel, ConfigDict
+
+
+class UpdateStatus(Enum):
+    """
+    The current status of this update
+    """
+
+    draft = "draft"
+    ready_to_publish = "ready-to-publish"
+    published = "published"
+    ready_to_unpublish = "ready-to-unpublish"
+    unpublished = "unpublished"
+    archived = "archived"
+
+
+class NsipProjectUpdate(BaseModel):
+    """
+    NSIP Project Update (formerly known as Banners)
+    """
+
+    model_config = ConfigDict(
+        extra="allow",
+    )
+    id: int
+    """
+    The unique identifier within the Back Office.
+    """
+    caseReference: str
+    """
+    the case reference this update relates to
+    """
+    updateDate: AwareDatetime | None = None
+    """
+    The date the update was published
+    """
+    updateName: str | None = None
+    """
+    Internal title or name of the update
+    """
+    updateContentEnglish: str
+    """
+    HTML content of the update in English. Can only include `<a> <b> <ul> <li>` tags.
+    """
+    updateContentWelsh: str | None = None
+    """
+    HTML content of the update in Welsh. Can only include `<a> <b> <ul> <li>` tags.
+    """
+    updateStatus: UpdateStatus
+    """
+    The current status of this update
+    """

package/pins_data_model/models/model_nsip_representation.py

@@ -0,0 +1,83 @@
+# generated by datamodel-codegen:
+#   filename:  nsip-representation.schema.json
+#   timestamp: 2025-07-16T14:06:09+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+from pydantic import AwareDatetime, BaseModel, ConfigDict, Field
+
+
+class Status(Enum):
+    awaiting_review = "awaiting_review"
+    referred = "referred"
+    valid = "valid"
+    invalid = "invalid"
+    published = "published"
+    archived = "archived"
+    draft = "draft"
+    withdrawn = "withdrawn"
+    NoneType_None = None
+
+
+class RepresentationFrom(Enum):
+    PERSON = "PERSON"
+    ORGANISATION = "ORGANISATION"
+    AGENT = "AGENT"
+    NoneType_None = None
+
+
+class RegisterFor(Enum):
+    PERSON = "PERSON"
+    ORGANISATION = "ORGANISATION"
+    FAMILY_GROUP = "FAMILY_GROUP"
+    NoneType_None = None
+
+
+class RepresentationType(Enum):
+    Local_Authorities = "Local Authorities"
+    Parish_Councils = "Parish Councils"
+    Members_of_the_Public_Businesses = "Members of the Public/Businesses"
+    Public___Businesses = "Public & Businesses"
+    Statutory_Consultees = "Statutory Consultees"
+    Non_Statutory_Organisations = "Non-Statutory Organisations"
+    Another_Individual = "Another Individual"
+    NoneType_None = None
+
+
+class Representation(BaseModel):
+    """
+    NSIP Representation schema
+    """
+
+    model_config = ConfigDict(
+        extra="allow",
+    )
+    representationId: int
+    referenceId: str | None = Field(..., examples=["TR043003-000010"])
+    examinationLibraryRef: str | None = Field(..., examples=["RR-0001"])
+    caseRef: str
+    caseId: int | None = Field(..., examples=[1242])
+    """
+    The unique identifier within the Back Office. This is not the same as the case reference
+    """
+    status: Status
+    originalRepresentation: str
+    redacted: bool | None = None
+    redactedRepresentation: str | None = None
+    redactedBy: str | None = Field(..., examples=["Joe Blogs"])
+    redactedNotes: str | None = Field(..., examples=["Removed names of family members"])
+    representationFrom: RepresentationFrom
+    representedId: str
+    """
+    ServiceUser Id of the person or organisation being represented
+    """
+    representativeId: str | None = None
+    """
+    ServiceUser Id of the person or organisation submitting representation in the case of Agent representationFrom
+    """
+    registerFor: RegisterFor
+    representationType: RepresentationType
+    dateReceived: AwareDatetime = Field(..., examples=["2023-07-27T20:30:00.000Z"])
+    attachmentIds: list[str]

package/pins_data_model/models/model_nsip_subscription.py

@@ -0,0 +1,60 @@
+# generated by datamodel-codegen:
+#   filename:  nsip-subscription.schema.json
+#   timestamp: 2025-07-16T14:06:10+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+from pydantic import AwareDatetime, BaseModel, ConfigDict, EmailStr, Field
+
+
+class SubscriptionType(Enum):
+    """
+    which update does the subscriber want to get notified of. For multiple types, use multiple messages.
+    """
+
+    allUpdates = "allUpdates"
+    applicationSubmitted = "applicationSubmitted"
+    applicationDecided = "applicationDecided"
+    registrationOpen = "registrationOpen"
+
+
+class Language(Enum):
+    English = "English"
+    Welsh = "Welsh"
+    NoneType_None = None
+
+
+class NsipSubscription(BaseModel):
+    """
+    Subscribers are a subset of Service Users, part of the PINS Data Model
+    """
+
+    model_config = ConfigDict(
+        extra="allow",
+    )
+    subscriptionId: int | None = None
+    """
+    The unique identifier within the Back Office. Ignored as part of register-nsip-subscription.
+    """
+    caseReference: str
+    """
+    the case reference the subscription relates to
+    """
+    emailAddress: EmailStr = Field(
+        ..., examples=["alan.turing@planninginspectorate.gov.uk"]
+    )
+    subscriptionType: SubscriptionType
+    """
+    which update does the subscriber want to get notified of. For multiple types, use multiple messages.
+    """
+    startDate: AwareDatetime | None = None
+    """
+    The date to start getting updates
+    """
+    endDate: AwareDatetime | None = None
+    """
+    The date to stop getting updates
+    """
+    language: Language