@planning-inspectorate/data-model 1.11.0

package/schemas/nsip-subscription.schema.json

@@ -0,0 +1,52 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "nsip-subscription.schema.json",
+  "title": "nsip-subscription",
+  "description": "Subscribers are a subset of Service Users, part of the PINS Data Model",
+  "type": "object",
+  "additionalProperties": true,
+  "required": [
+    "subscriptionId",
+    "caseReference",
+    "emailAddress",
+    "subscriptionType",
+    "startDate",
+    "endDate",
+    "language"
+  ],
+  "properties": {
+    "subscriptionId": {
+      "type": ["integer", "null"],
+      "description": "The unique identifier within the Back Office. Ignored as part of register-nsip-subscription."
+    },
+    "caseReference": {
+      "type": "string",
+      "description": "the case reference the subscription relates to"
+    },
+    "emailAddress": {
+      "type": "string",
+      "format": "email",
+      "examples": ["alan.turing@planninginspectorate.gov.uk"]
+    },
+    "subscriptionType": {
+      "type": "string",
+      "enum": ["allUpdates", "applicationSubmitted", "applicationDecided", "registrationOpen"],
+      "description": "which update does the subscriber want to get notified of. For multiple types, use multiple messages."
+    },
+    "startDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "The date to start getting updates"
+    },
+    "endDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "The date to stop getting updates"
+    },
+    "language": {
+      "type": ["string", "null"],
+      "enum": ["English", "Welsh", null],
+      "default": "English"
+    }
+  }
+}

package/schemas/pins-inspector.schema.json

@@ -0,0 +1,47 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "pins-inspector.schema.json",
+  "title": "PINS Inspector",
+  "description": "Inspector attributes as per Horizon. This will be extended with SAP/Entra data",
+  "type": "object",
+  "additionalProperties": true,
+  "required": ["firstName", "lastName", "horizonId", "email"],
+  "properties": {
+    "horizonId": {
+      "type": "string",
+      "description": "The PINS-generated unique horizon ID"
+    },
+    "firstName": {
+      "type": "string",
+      "description": "The first name of the inspector"
+    },
+    "lastName": {
+      "type": "string",
+      "description": "The last name of the inspector"
+    },
+    "postName": {
+      "type": ["string", "null"],
+      "description": "The post name of the inspector"
+    },
+    "organisationName": {
+      "type": ["string", "null"],
+      "description": "The organisation name of the inspector"
+    },
+    "title": {
+      "type": ["string", "null"],
+      "description": "The title of the inspector"
+    },
+    "salutation": {
+      "type": ["string", "null"],
+      "description": "The salutation of the inspector"
+    },
+    "qualifications": {
+      "type": ["string", "null"],
+      "description": "The qualifications of the inspector"
+    },
+    "email": {
+      "type": ["string", "null"],
+      "description": "The email address of the inspector"
+    }
+  }
+}

package/schemas/pins-lpa.schema.json

@@ -0,0 +1,63 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "pins-lpa.schema.json",
+  "title": "PINS LPA",
+  "description": "Local Planning Authority (LPA) attributes as per Horizon. This will be extended with ONS data",
+  "type": "object",
+  "additionalProperties": true,
+  "required": ["lpaName", "pinsLpaCode"],
+  "properties": {
+    "lpaName": {
+      "type": "string",
+      "description": "The PINS name of the LPA"
+    },
+    "organisationType": {
+      "type": "string",
+      "description": "The organisation type of the LPA"
+    },
+    "pinsLpaCode": {
+      "type": "string",
+      "description": "The PINS-generated unqiue LPA code"
+    },
+    "poBox": {
+      "type": ["string", "null"],
+      "description": "LPA address Post Office Box"
+    },
+    "address1": {
+      "type": ["string", "null"],
+      "description": "First line of LPA address"
+    },
+    "address2": {
+      "type": ["string", "null"],
+      "description": "Second line of LPA address"
+    },
+    "city": {
+      "type": ["string", "null"],
+      "description": "LPA address city or town"
+    },
+    "county": {
+      "type": ["string", "null"],
+      "description": "LPA address county"
+    },
+    "postcode": {
+      "type": ["string", "null"],
+      "description": "LPA address postcode"
+    },
+    "country": {
+      "type": ["string", "null"],
+      "description": "LPA address country"
+    },
+    "telephoneNumber": {
+      "type": ["string", "null"],
+      "description": "LPA telephine number"
+    },
+    "fax": {
+      "type": ["string", "null"],
+      "description": "LPA fax number"
+    },
+    "emailAddress": {
+      "type": ["string", "null"],
+      "description": "LPA email address"
+    }
+  }
+}

package/schemas/s51-advice.schema.json

@@ -0,0 +1,113 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "s51-advice.schema.json",
+  "title": "S51 Advice",
+  "description": "Section 51 Advice schema",
+  "type": "object",
+  "additionalProperties": true,
+  "required": [
+    "adviceId",
+    "adviceReference",
+    "caseId",
+    "caseReference",
+    "title",
+    "from",
+    "agent",
+    "method",
+    "enquiryDate",
+    "enquiryDetails",
+    "adviceGivenBy",
+    "adviceDate",
+    "adviceDetails",
+    "status",
+    "redactionStatus",
+    "attachmentIds"
+  ],
+  "properties": {
+    "adviceId": {
+      "type": "integer",
+      "examples": [1234]
+    },
+    "adviceReference": {
+      "type": "string",
+      "examples": ["TR0200007-0005"]
+    },
+    "caseId": {
+      "type": ["integer", "null"],
+      "examples": [1234]
+    },
+    "caseReference": {
+      "type": ["string", "null"],
+      "examples": ["BC0110002"]
+    },
+    "title": {
+      "type": "string",
+      "description": "Title of the advice",
+      "examples": ["Advice following issue of decision to accept the application for examination"]
+    },
+    "titleWelsh": {
+      "type": ["string", "null"],
+      "description": "Title of the advice in Welsh"
+    },
+    "from": {
+      "type": ["string", "null"],
+      "description": "Who the enquiry is from"
+    },
+    "agent": {
+      "type": ["string", "null"],
+      "description": "Who the enquiry is on behalf of"
+    },
+    "method": {
+      "type": ["string", "null"],
+      "description": "How the enquiry was made",
+      "enum": ["phone", "email", "meeting", "post", "fax", null]
+    },
+    "enquiryDate": {
+      "type": ["string", "null"],
+      "description": "Date the enquiry was made",
+      "format": "date-time",
+      "examples": ["2023-07-27T20:30:00.000Z"]
+    },
+    "enquiryDetails": {
+      "type": ["string", "null"],
+      "description": "Details of the enquiry"
+    },
+    "enquiryDetailsWelsh": {
+      "type": ["string", "null"],
+      "description": "Details of the enquiry in Welsh"
+    },
+    "adviceGivenBy": {
+      "type": ["string", "null"],
+      "description": "Who issued the advice"
+    },
+    "adviceDate": {
+      "type": ["string", "null"],
+      "description": "Date the advice was given",
+      "format": "date-time",
+      "examples": ["2023-07-27T20:30:00.000Z"]
+    },
+    "adviceDetails": {
+      "type": ["string", "null"],
+      "description": "Details of the advice"
+    },
+    "adviceDetailsWelsh": {
+      "type": ["string", "null"],
+      "description": "Details of the advice in Welsh"
+    },
+    "status": {
+      "type": ["string", "null"],
+      "enum": ["checked", "unchecked", "readytopublish", "published", "donotpublish", null]
+    },
+    "redactionStatus": {
+      "type": ["string", "null"],
+      "enum": ["unredacted", "redacted", null]
+    },
+    "attachmentIds": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "description": "Collection of document IDs which are related to the S51 Advice"
+      }
+    }
+  }
+}

package/schemas/service-user.schema.json

@@ -0,0 +1,152 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "service-user.schema.json",
+  "title": "Service User",
+  "description": "Service User of the planning inspectorate. Also contains role information by combining serviceUserType and caseReference.",
+  "type": "object",
+  "additionalProperties": true,
+  "required": [
+    "id",
+    "salutation",
+    "firstName",
+    "lastName",
+    "addressLine1",
+    "addressLine2",
+    "addressTown",
+    "addressCounty",
+    "postcode",
+    "addressCountry",
+    "organisation",
+    "organisationType",
+    "role",
+    "telephoneNumber",
+    "otherPhoneNumber",
+    "faxNumber",
+    "emailAddress",
+    "webAddress",
+    "serviceUserType",
+    "caseReference",
+    "sourceSystem",
+    "sourceSuid"
+  ],
+  "properties": {
+    "id": {
+      "type": "string",
+      "description": "A unique identifier for the entity.",
+      "examples": ["12345"]
+    },
+    "salutation": {
+      "type": ["string", "null"],
+      "description": "A formal greeting, e.g., Mr, Mrs, Ms.",
+      "examples": ["Mr"]
+    },
+    "firstName": {
+      "type": ["string", "null"],
+      "description": "The first name of the individual.",
+      "examples": ["John"]
+    },
+    "lastName": {
+      "type": ["string", "null"],
+      "description": "The last name of the individual.",
+      "examples": ["Doe"]
+    },
+    "addressLine1": {
+      "type": ["string", "null"],
+      "description": "The first line of the address.",
+      "examples": ["123 Elm Street"]
+    },
+    "addressLine2": {
+      "type": ["string", "null"],
+      "description": "The second line of the address, usually includes suite or apartment number.",
+      "examples": ["Apt 4B"]
+    },
+    "addressTown": {
+      "type": ["string", "null"],
+      "description": "The town or city of the address.",
+      "examples": ["Springfield"]
+    },
+    "addressCounty": {
+      "type": ["string", "null"],
+      "description": "The county in which the town or city is located.",
+      "examples": ["Hampshire"]
+    },
+    "postcode": {
+      "type": ["string", "null"],
+      "description": "The postal code for the address.",
+      "examples": ["M12 4AF"]
+    },
+    "addressCountry": {
+      "type": ["string", "null"],
+      "description": "The country of the address.",
+      "examples": ["United Kingdom"]
+    },
+    "organisation": {
+      "type": ["string", "null"],
+      "description": "The name of the organisation associated with the individual.",
+      "examples": ["Tech Corp"]
+    },
+    "organisationType": {
+      "type": ["string", "null"],
+      "description": "The type or nature of the organisation.",
+      "examples": ["Private Company"]
+    },
+    "role": {
+      "type": ["string", "null"],
+      "description": "The individual's role or position within the organisation.",
+      "examples": ["Agent"]
+    },
+    "telephoneNumber": {
+      "type": ["string", "null"],
+      "description": "The primary telephone contact number.",
+      "examples": ["+447123456789"]
+    },
+    "otherPhoneNumber": {
+      "type": ["string", "null"],
+      "description": "An alternate or secondary phone number.",
+      "examples": ["+447123456789"]
+    },
+    "faxNumber": {
+      "type": ["string", "null"],
+      "description": "A fax contact number.",
+      "examples": ["+447123456789"]
+    },
+    "emailAddress": {
+      "type": ["string", "null"],
+      "description": "The primary email address for contact.",
+      "examples": ["john.doe@example.com"]
+    },
+    "webAddress": {
+      "type": ["string", "null"],
+      "description": "Website address or URL.",
+      "examples": ["https://www.example.com"]
+    },
+    "serviceUserType": {
+      "type": "string",
+      "description": "Type or category of the service user.",
+      "enum": [
+        "Applicant",
+        "Appellant",
+        "Agent",
+        "Rule6Party",
+        "InterestedParty",
+        "RepresentationContact",
+        "Subscriber"
+      ]
+    },
+    "caseReference": {
+      "type": "string",
+      "description": "Reference number for a particular case or incident.",
+      "examples": ["BC0510001"]
+    },
+    "sourceSystem": {
+      "type": "string",
+      "description": "The originating system from where the data was sourced.",
+      "examples": ["ODT", "Horizon"]
+    },
+    "sourceSuid": {
+      "type": "string",
+      "description": "Unique identifier from the source system.",
+      "examples": ["12345"]
+    }
+  }
+}

package/setup.py

@@ -0,0 +1,15 @@
+from setuptools import find_packages, setup
+
+setup(
+    name='pins_data_model',
+    packages=find_packages(),
+    include_package_data=True,
+    package_data={
+        "schemas": ["*"],
+        "schemas.commands": ["*"],
+    },
+    version='1.0.0',
+    description='JSON Schemas for the Planning Inspectorate\'s Data Model',
+    install_requires=['jsonc-parser==1.1.0'],
+    setup_requires=[]
+)