prototype

theopensystemslab · Sep 19, 2024 · 64d31c5 · 64d31c5
1 parent 81ad720
commit 64d31c5
Show file tree

Hide file tree

Showing 2 changed files with 98 additions and 0 deletions.
diff --git a/schemas/application.json b/schemas/application.json
@@ -8577,6 +8577,9 @@
             "flowId": {
               "$ref": "#/definitions/UUID"
             },
+            "overrides": {
+              "$ref": "#/definitions/UserOverrides"
+            },
             "url": {
               "$ref": "#/definitions/URL"
             }
@@ -25439,6 +25442,78 @@
         "town"
       ],
       "type": "object"
+    },
+    "UserOverrides": {
+      "$id": "#UserOverrides",
+      "additionalProperties": false,
+      "description": "PlanX fetches and suggests administrative data to users throughout a service; if a user contests or changes this data, those details will come through here",
+      "properties": {
+        "property": {
+          "additionalProperties": false,
+          "properties": {
+            "planning": {
+              "additionalProperties": false,
+              "properties": {
+                "designations": {
+                  "items": {
+                    "additionalProperties": false,
+                    "properties": {
+                      "entityId": {
+                        "type": "string"
+                      },
+                      "sourceIntersects": {
+                        "const": true,
+                        "type": "boolean"
+                      },
+                      "userIntersects": {
+                        "const": false,
+                        "type": "boolean"
+                      },
+                      "userReason": {
+                        "type": "string"
+                      },
+                      "value": {
+                        "type": "string"
+                      }
+                    },
+                    "required": [
+                      "value",
+                      "entityId",
+                      "sourceIntersects",
+                      "userIntersects",
+                      "userReason"
+                    ],
+                    "type": "object"
+                  },
+                  "type": "array"
+                }
+              },
+              "required": [
+                "designations"
+              ],
+              "type": "object"
+            },
+            "type": {
+              "additionalProperties": false,
+              "properties": {
+                "sourceClassification": {
+                  "type": "string"
+                },
+                "userClassification": {
+                  "type": "string"
+                }
+              },
+              "required": [
+                "sourceClassification",
+                "userClassification"
+              ],
+              "type": "object"
+            }
+          },
+          "type": "object"
+        }
+      },
+      "type": "object"
     }
   },
   "description": "The root specification for a planning application in England generated by a digital planning service",

diff --git a/types/schemas/application/Metadata.ts b/types/schemas/application/Metadata.ts
@@ -93,6 +93,28 @@ export interface FeeExplanation {
   };
 }
 
+/**
+ * @id #UserOverrides
+ * @description PlanX fetches and suggests administrative data to users throughout a service; if a user contests or changes this data, those details will come through here
+ */
+export interface UserOverrides {
+  property?: {
+    type?: {
+      sourceClassification: string;
+      userClassification: string;
+    };
+    planning?: {
+      designations: {
+        value: string; // @TODO enum
+        entityId: string;
+        sourceIntersects: true;
+        userIntersects: false;
+        userReason: string;
+      }[];
+    };
+  };
+}
+
 /**
  * @id #PlanXMetadata
  * @description Additional metadata associated with applications submitted via PlanX
@@ -104,5 +126,6 @@ export interface PlanXMetadata extends BaseMetadata {
     url: URL;
     files: RequestedFiles;
     fee: FeeExplanation | FeeExplanationNotApplicable;
+    overrides?: UserOverrides;
   };
 }