@planning-inspectorate/data-model 1.11.0

package/schemas/folder.schema.json

@@ -0,0 +1,49 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "folder.schema.json",
+  "title": "Folder",
+  "description": "Folders can have optional parents. All folders belong to a Case.",
+  "type": "object",
+  "additionalProperties": true,
+  "required": ["id", "caseReference", "displayNameEnglish", "displayNameWelsh", "parentFolderId", "caseStage"],
+  "properties": {
+    "id": {
+      "type": "integer",
+      "description": "The unique identifier within the Back Office."
+    },
+    "caseReference": {
+      "type": "string",
+      "description": "The case reference this folder belongs to."
+    },
+    "displayNameEnglish": {
+      "type": "string",
+      "description": "Folder display name in English."
+    },
+    "displayNameWelsh": {
+      "type": ["string", "null"],
+      "description": "Folder display name in Welsh."
+    },
+    "parentFolderId": {
+      "type": ["integer", "null"],
+      "description": "Optional parent folder ID."
+    },
+    "caseStage": {
+      "type": ["string", "null"],
+      "enum": [
+        "draft",
+        "pre-application",
+        "acceptance",
+        "pre-examination",
+        "examination",
+        "recommendation",
+        "decision",
+        "post_decision",
+        "withdrawn",
+        "developers_application",
+        "correspondence",
+        "0",
+        null
+      ]
+    }
+  }
+}

package/schemas/gettimesheets-response.schema.json

@@ -0,0 +1,46 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "gettimesheets-response.schema.json",
+  "title": "Get Timesheets API response",
+  "description": "Schema defining the data returned by the DaRT API",
+  "type": "object",
+  "additionalProperties": true,
+  "required": ["caseReference", "applicationReference"],
+  "properties": {
+    "caseReference": {
+      "type": "integer",
+      "examples": ["6002744"],
+      "description": "External case identifier"
+    },
+    "applicationReference": {
+      "type": "string",
+      "examples": ["12345"],
+      "description": "The unique identifier of the application"
+    },
+    "siteAddressLine1": {
+      "type": "string",
+      "examples": ["21 The Pavement"],
+      "description": "First line of case site address"
+    },
+    "siteAddressLine2": {
+      "type": "string",
+      "examples": ["Shotesham Road"],
+      "description": "Second line of case site address"
+    },
+    "siteAddressTown": {
+      "type": "string",
+      "examples": ["Bristol"],
+      "description": "Town / City of the site address"
+    },
+    "siteAddressCounty": {
+      "type": "string",
+      "examples": ["Wandsworth"],
+      "description": "County of the site address"
+    },
+    "siteAddressPostcode": {
+      "type": "string",
+      "examples": ["SW4 0HY"],
+      "description": "Postal code of the site address"
+    }
+  }
+}

package/schemas/listed-building.schema.json

@@ -0,0 +1,31 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "listed-building.schema.json",
+  "title": "Listed Building",
+  "description": "Delta of listed building data pushed by the ODW. Primary use case is to support Appeals UI",
+  "type": "object",
+  "additionalProperties": true,
+  "required": ["entity", "reference", "name", "listedBuildingGrade"],
+  "properties": {
+    "entity": {
+      "type": "integer",
+      "description": "A unique identifier for the listed building.",
+      "examples": ["31717222"]
+    },
+    "reference": {
+      "type": ["string"],
+      "description": "Reference number for the listed buildign",
+      "examples": ["1260842"]
+    },
+    "name": {
+      "type": ["string"],
+      "description": "Name of listed building",
+      "examples": ["41A, NEWBIGGIN"]
+    },
+    "listedBuildingGrade": {
+      "type": ["string"],
+      "description": "Grade assigned to the listing.",
+      "examples": ["II"]
+    }
+  }
+}

package/schemas/listed-buildings.schema.json

@@ -0,0 +1,31 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "listed-buildings.schema.json",
+  "title": "Listed Buildings",
+  "description": "Temporary copy of listed-building to ensure compatibility until ODW is updated",
+  "type": "object",
+  "additionalProperties": true,
+  "required": ["entity", "reference", "name", "listedBuildingGrade"],
+  "properties": {
+    "entity": {
+      "type": "integer",
+      "description": "A unique identifier for the listed building.",
+      "examples": ["31717222"]
+    },
+    "reference": {
+      "type": ["string"],
+      "description": "Reference number for the listed buildign",
+      "examples": ["1260842"]
+    },
+    "name": {
+      "type": ["string"],
+      "description": "Name of listed building",
+      "examples": ["41A, NEWBIGGIN"]
+    },
+    "listedBuildingGrade": {
+      "type": ["string"],
+      "description": "Grade assigned to the listing.",
+      "examples": ["II"]
+    }
+  }
+}

package/schemas/nsip-document.schema.json

@@ -0,0 +1,235 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "nsip-document.schema.json",
+  "title": "NSIP Document",
+  "description": "NSIP document schema",
+  "type": "object",
+  "additionalProperties": true,
+  "required": [
+    "documentId",
+    "caseId",
+    "caseRef",
+    "documentReference",
+    "version",
+    "examinationRefNo",
+    "filename",
+    "originalFilename",
+    "size",
+    "mime",
+    "documentURI",
+    "publishedDocumentURI",
+    "path",
+    "virusCheckStatus",
+    "fileMD5",
+    "dateCreated",
+    "lastModified",
+    "caseType",
+    "redactedStatus",
+    "publishedStatus",
+    "datePublished",
+    "documentType",
+    "securityClassification",
+    "sourceSystem",
+    "origin",
+    "owner",
+    "author",
+    "representative",
+    "description",
+    "documentCaseStage",
+    "filter1",
+    "filter2",
+    "horizonFolderId",
+    "transcriptId"
+  ],
+  "properties": {
+    "documentId": {
+      "type": "string",
+      "examples": ["01c958f2-4e9f-4ce2-adf9-81038702cafa"],
+      "description": "The unique identifier for the file. This will be different to documentReference"
+    },
+    "caseId": {
+      "type": ["integer", "null"],
+      "examples": [1],
+      "description": "Internal case identifier"
+    },
+    "caseRef": {
+      "type": ["string", "null"],
+      "examples": ["EN010120"]
+    },
+    "documentReference": {
+      "type": ["string", "null"],
+      "examples": ["WA0110015-000002"],
+      "description": "Reference used throughout ODT <CaseRef>-<SequenceNo>"
+    },
+    "version": {
+      "type": "integer",
+      "examples": [1]
+    },
+    "examinationRefNo": {
+      "type": ["string", "null"],
+      "examples": ["XXX-0000"]
+    },
+    "filename": {
+      "type": "string",
+      "examples": ["filename.pdf"],
+      "description": "Current stored filename of the file"
+    },
+    "originalFilename": {
+      "type": "string",
+      "examples": ["original_filename.pdf"],
+      "description": "Original filename of file"
+    },
+    "size": {
+      "type": "integer",
+      "examples": [23452]
+    },
+    "mime": {
+      "type": ["string", "null"],
+      "examples": ["application/pdf"]
+    },
+    "documentURI": {
+      "type": "string",
+      "examples": [
+        "https://pinsstdocsboprodukw001.blob.core.windows.net/document-service-uploads/application/BC0110001/01adeade-791a-483a-a51d-99df2122b5cc/1"
+      ],
+      "description": "The internal location of the document"
+    },
+    "publishedDocumentURI": {
+      "type": ["string", "null"],
+      "examples": [
+        "https://pinsstdocsboprodukw001.blob.core.windows.net/published-documents/BC0110003-001-olive-oil.pdf"
+      ],
+      "description": "The location of the published document. Only applicable to documents which are published."
+    },
+    "path": {
+      "type": ["string", "null"],
+      "examples": ["EN010011/2. Post-Submission/Application Documents/Application Form/Letter.PDF"]
+    },
+    "virusCheckStatus": {
+      "type": ["string", "null"],
+      "enum": ["not_scanned", "scanned", "affected", null]
+    },
+    "fileMD5": {
+      "type": ["string", "null"],
+      "examples": ["b1946ac92492d2347c6235b4d2611184"]
+    },
+    "dateCreated": {
+      "type": "string",
+      "format": "date-time",
+      "examples": ["2023-07-27T20:30:00.000Z"]
+    },
+    "lastModified": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "examples": ["2023-07-27T20:30:00.000Z"]
+    },
+    "caseType": {
+      "type": ["string", "null"],
+      "enum": ["nsip", "has", null]
+    },
+    "redactedStatus": {
+      "type": ["string", "null"],
+      "enum": ["not_redacted", "redacted", null]
+    },
+    "publishedStatus": {
+      "type": ["string", "null"],
+      "enum": [
+        "not_checked",
+        "checked",
+        "ready_to_publish",
+        "do_not_publish",
+        "publishing",
+        "published",
+        "archived",
+        "unpublished",
+        "unpublishing",
+        "awaiting_upload",
+        null
+      ]
+    },
+    "datePublished": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "examples": ["2023-07-27T20:30:00.000Z"]
+    },
+    "documentType": {
+      "type": ["string", "null"],
+      "examples": ["Rule 8 letter"]
+    },
+    "securityClassification": {
+      "type": ["string", "null"],
+      "enum": ["public", "official", "secret", "top-secret", null]
+    },
+    "sourceSystem": {
+      "type": ["string", "null"],
+      "enum": ["back-office-appeals", "back-office-applications", "horizon", "ni_file", "sharepoint", null]
+    },
+    "origin": {
+      "type": ["string", "null"],
+      "enum": ["pins", "citizen", "lpa", "ogd", null]
+    },
+    "owner": {
+      "type": ["string", "null"]
+    },
+    "author": {
+      "type": ["string", "null"],
+      "description": "Name of person who authored document"
+    },
+    "authorWelsh": {
+      "type": ["string", "null"],
+      "description": "Welsh name of person who authored document"
+    },
+    "representative": {
+      "type": ["string", "null"],
+      "examples": ["ZZZ Agency"],
+      "description": "The on behalf of or agent submitter of document"
+    },
+    "description": {
+      "type": ["string", "null"],
+      "examples": ["Attachments to the letter to Department for Business, Energy & Industrial Strategy"]
+    },
+    "descriptionWelsh": {
+      "type": ["string", "null"]
+    },
+    "documentCaseStage": {
+      "type": ["string", "null"],
+      "enum": [
+        "draft",
+        "pre-application",
+        "acceptance",
+        "pre-examination",
+        "examination",
+        "recommendation",
+        "decision",
+        "post_decision",
+        "withdrawn",
+        "developers_application",
+        "correspondence",
+        "0",
+        null
+      ]
+    },
+    "filter1": {
+      "type": ["string", "null"],
+      "examples": ["Deadline 2"],
+      "description": "Filter field to provide additional filtering"
+    },
+    "filter1Welsh": {
+      "type": ["string", "null"],
+      "description": "Filter field in Welsh"
+    },
+    "filter2": {
+      "type": ["string", "null"],
+      "examples": ["Scoping Option Report"],
+      "description": "Filter field to provide additional filtering"
+    },
+    "horizonFolderId": {
+      "type": ["string", "null"],
+      "description": "The folder where the document exists"
+    },
+    "transcriptId": {
+      "type": ["string", "null"],
+      "description": "The GUID of the transcript document (if one was provided)."
+    }
+  }
+}

package/schemas/nsip-exam-timetable.schema.json

@@ -0,0 +1,101 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "nsip-exam-timetable.schema.json",
+  "title": "Examination Timetable",
+  "description": "Examination Timetable for an NSIP Project",
+  "type": "object",
+  "additionalProperties": true,
+  "required": ["caseReference", "events"],
+  "properties": {
+    "caseReference": {
+      "type": "string",
+      "description": "Unique string reference of the associated Case"
+    },
+    "published": {
+      "type": ["boolean", "null"],
+      "description": "whether the Examination Timetable has been published or not"
+    },
+    "events": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/event"
+      }
+    }
+  },
+  "$defs": {
+    "event": {
+      "type": "object",
+      "additionalProperties": true,
+      "required": ["eventId", "type", "eventTitle", "description", "date", "eventLineItems"],
+      "properties": {
+        "eventId": {
+          "type": "integer",
+          "description": "Event Identifier"
+        },
+        "type": {
+          "type": "string",
+          "description": "Compulsory Acquisition Hearing/Deadline/Issue Specific Hearing etc",
+          "enum": [
+            "Accompanied Site Inspection",
+            "Compulsory Acquisition Hearing",
+            "Deadline",
+            "Deadline For Close Of Examination",
+            "Issued By",
+            "Issue Specific Hearing",
+            "Open Floor Hearing",
+            "Other Meeting",
+            "Preliminary Meeting",
+            "Procedural Deadline (Pre-Examination)",
+            "Procedural Decision",
+            "Publication Of"
+          ]
+        },
+        "eventTitle": {
+          "type": "string",
+          "description": "Title Of Examination Timetable Event"
+        },
+        "eventTitleWelsh": {
+          "type": ["string", "null"],
+          "description": "Title Of Examination Timetable Event In Welsh"
+        },
+        "description": {
+          "type": "string"
+        },
+        "descriptionWelsh": {
+          "type": ["string", "null"]
+        },
+        "eventDeadlineStartDate": {
+          "type": ["string", "null"],
+          "description": "Optional start date for event window",
+          "format": "date-time",
+          "examples": ["2023-07-27T20:30:00.000Z"]
+        },
+        "date": {
+          "type": "string",
+          "description": "Event Date = effective deadline (end) date",
+          "format": "date-time",
+          "examples": ["2023-07-27T20:30:00.000Z"]
+        },
+        "eventLineItems": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/line-item"
+          }
+        }
+      }
+    },
+    "line-item": {
+      "type": "object",
+      "additionalProperties": true,
+      "required": ["description"],
+      "properties": {
+        "description": {
+          "type": "string"
+        },
+        "descriptionWelsh": {
+          "type": ["string", "null"]
+        }
+      }
+    }
+  }
+}

package/schemas/nsip-project-update.schema.json

@@ -0,0 +1,49 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "nsip-project-update.schema.json",
+  "title": "NSIP Project Update",
+  "description": "NSIP Project Update (formerly known as Banners)",
+  "type": "object",
+  "additionalProperties": true,
+  "required": [
+    "id",
+    "caseReference",
+    "updateDate",
+    "updateName",
+    "updateContentEnglish",
+    "updateContentWelsh",
+    "updateStatus"
+  ],
+  "properties": {
+    "id": {
+      "type": "integer",
+      "description": "The unique identifier within the Back Office."
+    },
+    "caseReference": {
+      "type": "string",
+      "description": "the case reference this update relates to"
+    },
+    "updateDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "The date the update was published"
+    },
+    "updateName": {
+      "type": ["string", "null"],
+      "description": "Internal title or name of the update"
+    },
+    "updateContentEnglish": {
+      "type": "string",
+      "description": "HTML content of the update in English. Can only include `<a> <b> <ul> <li>` tags."
+    },
+    "updateContentWelsh": {
+      "type": ["string", "null"],
+      "description": "HTML content of the update in Welsh. Can only include `<a> <b> <ul> <li>` tags."
+    },
+    "updateStatus": {
+      "type": "string",
+      "enum": ["draft", "ready-to-publish", "published", "ready-to-unpublish", "unpublished", "archived"],
+      "description": "The current status of this update"
+    }
+  }
+}