@planning-inspectorate/data-model 1.11.0

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

@@ -0,0 +1,125 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "commands/lpa-questionnaire.schema.json",
+  "title": "LPA Questionnaire Command",
+  "description": "Schema defining the data produced by the Front-Office when an LPA Questionnaire is submitted",
+  "$comment": "This is a combination of an LPA Questionnaire and Documents",
+  "type": "object",
+  "additionalProperties": true,
+  "required": ["casedata", "documents"],
+  "properties": {
+    "casedata": {
+      "type": "object",
+      "additionalProperties": true,
+      "anyOf": [
+        {
+          "allOf": [
+            { "$comment": "backwards compatibility for no case type, when removed can update allOf to oneOf" },
+            { "not": { "required": ["caseType"] } },
+            { "$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" }]
+        }
+      ]
+    },
+    "documents": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "additionalProperties": true,
+        "properties": {
+          "documentId": {
+            "type": "string",
+            "examples": ["4547fec8-16b2-47bb-836d-4d0baac04079"],
+            "description": "The unique identifier for the document"
+          },
+          "filename": {
+            "type": "string",
+            "examples": ["filename.pdf"],
+            "description": "Current stored name of the document"
+          },
+          "originalFilename": {
+            "type": "string",
+            "examples": ["original_filename.pdf"],
+            "description": "Original name of document"
+          },
+          "size": {
+            "type": "integer",
+            "examples": [23452],
+            "description": "The file size, in bytes"
+          },
+          "mime": {
+            "type": ["string"],
+            "examples": ["application/pdf"],
+            "description": "The mime type for the current version of the file"
+          },
+          "documentURI": {
+            "type": "string",
+            "examples": [
+              "https://custom-domain.gov.uk/container-name/appeal/7002471/4547fec8-16b2-47bb-836d-4d0baac04079/v1/filename.pdf"
+            ],
+            "description": "The internal location of the document",
+            "$comment": "This property contains blob storage info (domain, container), caseReference, version and filename"
+          },
+          "dateCreated": {
+            "type": "string",
+            "format": "date-time",
+            "examples": ["2023-07-27T20:30:00.000Z"],
+            "description": "The creation date for the document"
+          },
+          "documentType": {
+            "type": ["string", "null"],
+            "enum": [
+              "whoNotified",
+              "whoNotifiedSiteNotice",
+              "whoNotifiedLetterToNeighbours",
+              "whoNotifiedPressAdvert",
+              "conservationMap",
+              "lpaCaseCorrespondence",
+              "lpaCostsApplication",
+              "lpaCostsCorrespondence",
+              "lpaCostsWithdrawal",
+              "otherPartyRepresentations",
+              "planningOfficerReport",
+              "plansDrawings",
+              "developmentPlanPolicies",
+              "supplementaryPlanning",
+              "emergingPlan",
+              "appealNotification",
+              null,
+              "otherRelevantPolicies",
+              "treePreservationPlan",
+              "consultationResponses",
+              "eiaEnvironmentalStatement",
+              "eiaScreeningDirection",
+              "eiaScreeningOpinion",
+              "eiaScopingOpinion",
+              "communityInfrastructureLevy",
+              "definitiveMapStatement",
+              "historicEnglandConsultation"
+            ],
+            "description": "The type of document, used for exchange, migrations and consumption from the appeal back-office system"
+          }
+        },
+        "required": [
+          "documentId",
+          "filename",
+          "originalFilename",
+          "size",
+          "mime",
+          "documentURI",
+          "dateCreated",
+          "documentType"
+        ]
+      }
+    }
+  }
+}

package/schemas/commands/new-deadline-submission.schema.json

@@ -0,0 +1,59 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "commands/new-deadline-submission.schema.json",
+  "title": "new-deadline-submission",
+  "description": "A command to deliver metadata about a new document submission added to a deadline",
+  "type": "object",
+  "additionalProperties": true,
+  "required": ["caseReference", "name", "email", "deadline", "submissionType", "blobGuid", "documentName"],
+  "properties": {
+    "caseReference": {
+      "type": "string",
+      "description": "The unique reference of the case"
+    },
+    "name": {
+      "type": "string",
+      "description": "The name of the FO user who made the submission"
+    },
+    "email": {
+      "type": "string",
+      "format": "email",
+      "description": "The email address of the FO user who made the submission"
+    },
+    "interestedParty": {
+      "type": "boolean",
+      "description": "Was the submission made by an interested party on behalf of someone else?"
+    },
+    "interestedPartyReference": {
+      "type": "string",
+      "description": "Only necessary if `interestedParty` is true"
+    },
+    "deadline": {
+      "type": "string",
+      "description": "The name of the deadline which the submission was made against"
+    },
+    "submissionType": {
+      "type": "string",
+      "description": "The name of the deadline line item the submission was made against"
+    },
+    "sensitiveData": {
+      "type": "boolean",
+      "description": "Does the submission contain sensitive data?"
+    },
+    "lateSubmission": {
+      "type": "boolean"
+    },
+    "submissionId": {
+      "type": "string",
+      "description": "ID of the submission in the database"
+    },
+    "blobGuid": {
+      "type": "string",
+      "description": "The GUID of the blob in storage"
+    },
+    "documentName": {
+      "type": "string",
+      "description": "The file name of the document in blob storage"
+    }
+  }
+}

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

@@ -0,0 +1,27 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "commands/nsip-exam-timetable-submission.schema.json",
+  "title": "nsip-exam-timetable-submission",
+  "description": "Result of processing a new exam timetable submission",
+  "type": "object",
+  "additionalProperties": true,
+  "required": ["status", "deadline", "submissionType", "blobGuid", "documentName"],
+  "properties": {
+    "status": {
+      "type": "string",
+      "enum": ["SUCCESS", "VIRUS_DETECTED", "FAILURE"]
+    },
+    "deadline": {
+      "type": "string"
+    },
+    "submissionType": {
+      "type": "string"
+    },
+    "blobGuid": {
+      "type": "string"
+    },
+    "documentName": {
+      "type": "string"
+    }
+  }
+}

package/schemas/commands/register-nsip-subscription.schema.json

@@ -0,0 +1,32 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "commands/register-nsip-subscription.schema.json",
+  "title": "register-nsip-subscription",
+  "description": "A command to register an NSIP subscription with the back office",
+  "type": "object",
+  "additionalProperties": true,
+  "required": ["emailSubscriber"],
+  "properties": {
+    "__additionalProperties__": {
+      "type": "object",
+      "description": "Properties in additionalProperties in the Service Bus message. Not present in the message body.",
+      "properties": {
+        "type": {
+          "type": "string",
+          "enum": ["Create", "Delete"]
+        }
+      }
+    },
+    "nsipSubscription": {
+      "$ref": "nsip-subscription.schema.json"
+    },
+    "subscriptionTypes": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "enum": ["allUpdates", "applicationSubmitted", "applicationDecided", "registrationOpen"]
+      },
+      "description": "Which update(s) does the subscriber want to get notified of. Note nsipSubscription.subscriptionType is ignored."
+    }
+  }
+}

package/schemas/commands/register-representation.schema.json

@@ -0,0 +1,51 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "commands/register-representation.schema.json",
+  "title": "Register Representation",
+  "type": "object",
+  "additionalProperties": true,
+  "required": [
+    "referenceId",
+    "caseReference",
+    "originalRepresentation",
+    "representationFrom",
+    "registerFor",
+    "represented"
+  ],
+  "properties": {
+    "referenceId": {
+      "type": "string",
+      "description": "registration identification number"
+    },
+    "caseReference": {
+      "type": "string",
+      "description": "The unique reference of the case"
+    },
+    "representationType": {
+      "type": "string",
+      "description": "Type of representation"
+    },
+    "originalRepresentation": {
+      "type": "string"
+    },
+    "representationFrom": {
+      "type": "string",
+      "enum": ["PERSON", "ORGANISATION", "AGENT"]
+    },
+    "registerFor": {
+      "type": "string",
+      "enum": ["PERSON", "ORGANISATION", "FAMILY_GROUP"]
+    },
+    "represented": {
+      "$ref": "commands/interested-party.schema.json",
+      "description": "Person or organisation being represented"
+    },
+    "representative": {
+      "$ref": "commands/interested-party.schema.json",
+      "description": "Person or organisation submitting representation in the case of Agent representationFrom"
+    },
+    "dateReceived": {
+      "type": "string"
+    }
+  }
+}

package/schemas/dart-response.schema.json

@@ -0,0 +1,350 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "dart-response.schema.json",
+  "title": "DaRT API response",
+  "description": "Schema defining the data returned by the DaRT API",
+  "type": "object",
+  "additionalProperties": true,
+  "required": ["caseReference", "applicationReference"],
+  "properties": {
+    "caseId": {
+      "type": "integer",
+      "examples": ["2744"],
+      "description": "Internal case identifier"
+    },
+    "caseReference": {
+      "type": "integer",
+      "examples": ["6002744"],
+      "description": "External case identifier"
+    },
+    "caseStatus": {
+      "type": "string",
+      "examples": ["lpa_questionnaire"],
+      "description": "The processing state for the case"
+    },
+    "caseType": {
+      "type": "string",
+      "examples": ["w"],
+      "description": "The internal code for a type of case"
+    },
+    "caseProcedure": {
+      "type": ["string", "null"],
+      "examples": ["W"],
+      "description": "The type of procedure for the case"
+    },
+    "lpaCode": {
+      "type": ["string", "null"],
+      "examples": ["DORS"],
+      "description": "PINS internal code for LPA"
+    },
+    "lpaName": {
+      "type": ["string", "null"],
+      "examples": ["example"],
+      "description": "Name of the LPA"
+    },
+    "allocationLevel": {
+      "type": ["string", "null"],
+      "examples": ["H"],
+      "description": "A case level used for allocation purposes"
+    },
+    "allocationBand": {
+      "type": ["string", "null"],
+      "examples": ["1"],
+      "description": "A band used for allocation purposes"
+    },
+    "caseSpecialisms": {
+      "type": ["array", "null"],
+      "items": {
+        "type": "string"
+      },
+      "examples": ["General allocation", "Housing orders", "Waste"],
+      "description": "A list of case specialisms for allocation purposes"
+    },
+    "caseSubmittedDate": {
+      "type": "string",
+      "examples": ["025-01-02T16:20:07.753Z"],
+      "description": "The date the case was submitted by the appellant"
+    },
+    "caseCreatedDate": {
+      "type": "string",
+      "examples": ["025-01-02T16:20:07.753Z"],
+      "description": "The date the case was received"
+    },
+    "caseUpdatedDate": {
+      "type": "string",
+      "examples": ["025-01-02T16:20:07.753Z"],
+      "description": "The date the case was last updated in the back-office"
+    },
+    "caseValidDate": {
+      "type": ["string", "null"],
+      "examples": ["025-01-02T16:20:07.753Z"],
+      "description": "The date since when the case was considered valid"
+    },
+    "caseValidationDate": {
+      "type": ["string", "null"],
+      "examples": ["025-01-02T16:20:07.753Z"],
+      "description": "The date the case was validated in the back-office"
+    },
+    "caseValidationOutcome": {
+      "type": ["string", "null"],
+      "examples": ["valid"],
+      "description": "The outcome of the validation action"
+    },
+    "caseValidationInvalidDetails": {
+      "type": ["array", "null"],
+      "items": {
+        "type": "string"
+      },
+      "examples": [
+        "Appeal has not been submitted on time",
+        "Documents have not been submitted on time",
+        "Other: scddsfv"
+      ],
+      "description": "A list of reasons why the appeal is invalid",
+      "$comment": "The list will contain items only if the caseValidationOutcome is invalid"
+    },
+    "caseValidationIncompleteDetails": {
+      "type": ["array", "null"],
+      "items": {
+        "type": "string"
+      },
+      "examples": [
+        "Appellant name is not the same on the application form and appeal form",
+        "LPA's decision notice is missing"
+      ],
+      "description": "A list of reasons why the appeal is incomplete",
+      "$comment": "The list will contain items only if the caseValidationOutcome is incomplete"
+    },
+    "caseExtensionDate": {
+      "type": ["string", "null"],
+      "examples": ["2025-01-10T00:00:00.000Z"],
+      "description": "When the validation outcome is incomplete, an extension may be granted to provide missing information"
+    },
+    "caseStartedDate": {
+      "type": ["string", "null"],
+      "examples": ["2025-01-10T00:00:00.000Z"],
+      "description": "A date indicating when the case was started, resulting in the creation of a timetable"
+    },
+    "casePublishedDate": {
+      "type": ["string", "null"],
+      "examples": ["2025-01-10T00:00:00.000Z"],
+      "description": "A date indicating when the case was published"
+    },
+    "linkedCaseStatus": {
+      "type": ["string", "null"],
+      "examples": ["child"],
+      "description": "Indicates if the case is linked, and the type of relationship"
+    },
+    "leadCaseReference": {
+      "type": ["string", "null"],
+      "examples": ["6002745"],
+      "description": "The reference of the lead case, if the case is a child case"
+    },
+    "caseWithdrawnDate": {
+      "type": ["string", "null"],
+      "examples": ["2025-01-10T00:00:00.000Z"],
+      "description": "The date the case was withdrawn by the appellant"
+    },
+    "caseTransferredDate": {
+      "type": ["string", "null"],
+      "examples": ["2025-01-10T00:00:00.000Z"],
+      "description": "The date the case was transferred to a new case of a different type"
+    },
+    "transferredCaseClosedDate": {
+      "type": ["string", "null"],
+      "examples": ["2025-01-10T00:00:00.000Z"],
+      "description": "The date the case was closed and the appellant requested to resubmit"
+    },
+    "caseDecisionOutcomeDate": {
+      "type": ["string", "null"],
+      "examples": ["2025-01-10T00:00:00.000Z"],
+      "description": "The date of the case decision"
+    },
+    "caseDecisionPublishedDate": {
+      "type": ["string", "null"],
+      "examples": ["2025-01-10T00:00:00.000Z"],
+      "description": "The date the case decision was published"
+    },
+    "caseDecisionOutcome": {
+      "type": ["string", "null"],
+      "examples": ["allowed"],
+      "description": "The final outcome for the decision"
+    },
+    "caseCompletedDate": {
+      "type": ["string", "null"],
+      "examples": ["2025-01-10T00:00:00.000Z"],
+      "description": "The date the case decision letter"
+    },
+    "enforcementNotice": {
+      "type": ["boolean", "null"],
+      "description": "Indicates if an enforcement notice is the reason for the appeal"
+    },
+    "applicationReference": {
+      "type": "string",
+      "examples": ["21824/APP/0/203130"],
+      "description": "The unique identifier of the LPA application"
+    },
+    "applicationDate": {
+      "type": "string",
+      "examples": ["2025-01-10T00:00:00.000Z"],
+      "description": "The date of the original LPA application"
+    },
+    "applicationDecision": {
+      "type": "string",
+      "examples": ["refused"],
+      "description": "The outcome of the original LPA decision"
+    },
+    "lpaDecisionDate": {
+      "type": ["string", "null"],
+      "examples": ["2025-01-10T00:00:00.000Z"],
+      "description": "The date of the original LPA decision"
+    },
+    "caseSubmissionDueDate": {
+      "type": ["string", "null"],
+      "examples": ["2025-01-10T00:00:00.000Z"],
+      "description": "The statutory deadline for submitting an appeal from the original LPA decision date"
+    },
+    "siteAddressLine1": {
+      "type": ["string", "null"],
+      "examples": ["21 The Pavement"],
+      "description": "First line of case site address"
+    },
+    "siteAddressLine2": {
+      "type": ["string", "null"],
+      "examples": ["Shotesham Road"],
+      "description": "Second line of case site address"
+    },
+    "siteAddressTown": {
+      "type": ["string", "null"],
+      "examples": ["Bristol"],
+      "description": "Town / City of the site address"
+    },
+    "siteAddressCounty": {
+      "type": ["string", "null"],
+      "examples": ["Wandsworth"],
+      "description": "County of the site address"
+    },
+    "siteAddressPostcode": {
+      "type": ["string", "null"],
+      "examples": ["SW4 0HY"],
+      "description": "Postal code of the site address"
+    },
+    "isCorrectAppealType": {
+      "type": ["boolean", "null"],
+      "examples": ["True"],
+      "description": "Indicates if the LPA considers the appeal type appropriate"
+    },
+    "originalDevelopmentDescription": {
+      "type": ["string", "null"],
+      "examples": ["Replacement of an existing gate to access the property"],
+      "description": "The original description of the development, as provided by the appellant"
+    },
+    "changedDevelopmentDescription": {
+      "type": ["boolean", "null"],
+      "examples": ["True"],
+      "description": "Indicates that the LPA has changed the development description"
+    },
+    "newConditionDetails": {
+      "type": ["string", "null"],
+      "examples": ["example"],
+      "description": "Since the original application, a number of things have changed."
+    },
+    "nearbyCaseReferences": {
+      "type": ["array", "null"],
+      "items": {
+        "type": "string",
+        "examples": ["6000456", "8004567"]
+      },
+      "description": "A list of related case references known to the appellant and the LPA"
+    },
+    "neighbouringSiteAddresses": {
+      "type": ["array", "null"],
+      "items": {
+        "type": "object",
+        "additionalProperties": true,
+        "properties": {
+          "neighbouringSiteAddressLine1": {
+            "type": ["string", "null"],
+            "examples": ["96 The Avenue"],
+            "description": "First line of address of the neighbouring site"
+          },
+          "neighbouringSiteAddressLine2": {
+            "type": ["string", "null"],
+            "description": "Second line of address of the neighbouring site"
+          },
+          "neighbouringSiteAddressTown": {
+            "type": ["string", "null"],
+            "examples": ["Maidstone"],
+            "description": "Town / City of the neighbouring site address"
+          },
+          "neighbouringSiteAddressCounty": {
+            "type": ["string", "null"],
+            "examples": ["Kent"],
+            "description": "County of the neighbouring site address"
+          },
+          "neighbouringSiteAddressPostcode": {
+            "type": ["string", "null"],
+            "examples": ["MD21 5XY"],
+            "description": "Postal code of the neighbouring site address"
+          }
+        },
+        "required": [
+          "neighbouringSiteAddressLine1",
+          "neighbouringSiteAddressLine2",
+          "neighbouringSiteAddressTown",
+          "neighbouringSiteAddressCounty",
+          "neighbouringSiteAddressPostcode"
+        ]
+      },
+      "description": "A list of neighbouring site addresses"
+    },
+    "affectedListedBuildingNumbers": {
+      "type": ["array", "null"],
+      "items": {
+        "type": "string",
+        "examples": ["10023", "17824"]
+      },
+      "description": "A list of affected listed building IDs from Historic England"
+    },
+    "appellantCostsAppliedFor": {
+      "type": ["boolean", "null"],
+      "examples": ["True"],
+      "description": "Indicates if the appellant has applied for costs"
+    },
+    "lpaCostsAppliedFor": {
+      "type": ["boolean", "null"],
+      "examples": ["False"],
+      "description": "Indicates if the LPA has applied for costs"
+    },
+    "appellantName": {
+      "type": "string",
+      "examples": ["example"],
+      "description": "Name of the appellant"
+    },
+    "typeOfEvent": {
+      "type": ["string", "null"],
+      "examples": ["site_visit_access_required"],
+      "description": "The type of event"
+    },
+    "startDateOfTheEvent": {
+      "type": ["string", "null"],
+      "examples": ["2025-01-10T00:00:00.000Z"],
+      "description": "Event start date and time"
+    },
+    "inspectorName": {
+      "type": ["string", "null"],
+      "examples": ["In Spector"],
+      "description": "Name of inspector allocated to case"
+    },
+    "caseOfficerName": {
+      "type": ["string", "null"],
+      "examples": ["example"],
+      "description": "name of case officer assigned to case"
+    },
+    "inspectorQualifications": {
+      "type": ["string", "null"],
+      "examples": ["example"],
+      "description": "The qualifications of the inspector"
+    }
+  }
+}

package/schemas/entraid.schema.json

@@ -0,0 +1,31 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "entraid.schema.json",
+  "title": "Entra ID User Objects",
+  "description": "A list of users from EntraID ",
+  "type": "object",
+  "additionalProperties": true,
+  "required": ["id", "employeeId", "givenName", "surname", "userPrincipalName"],
+  "properties": {
+    "employeeId": {
+      "type": ["string"],
+      "description": "The employee's unique identifier"
+    },
+    "id": {
+      "type": ["string"],
+      "description": "The unique identifier within the EntraID"
+    },
+    "givenName": {
+      "type": ["string"],
+      "description": "The employee's given name"
+    },
+    "surname": {
+      "type": ["string"],
+      "description": "The employee's surname"
+    },
+    "userPrincipalName": {
+      "type": ["string"],
+      "description": "The employee's email address"
+    }
+  }
+}