@pdtf/schemas 3.6.0-dev.3 → 3.6.0-dev.5

package/charming-napier-57a77c/src/schemas/v1/searches.json

@@ -0,0 +1,237 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://trust.propdata.org.uk/schemas/v1/searches.json",
+  "title": "Search Enquiries",
+  "description": "The results of search enquiries",
+  "type": "array",
+  "items": {
+    "type": "object",
+    "properties": {
+      "displayName": {
+        "title": "Human-readable name of instructed search product",
+        "type": "string",
+        "minLength": 1
+      },
+      "productCode": {
+        "title": "Provider code for instructed search product",
+        "type": "string",
+        "minLength": 1
+      },
+      "providerName": {
+        "title": "Name of instructed search provider",
+        "type": "string",
+        "minLength": 1
+      },
+      "providerReference": {
+        "title": "Provider reference",
+        "type": "string",
+        "minLength": 1
+      },
+      "description": {
+        "title": "Description for instructed search product",
+        "type": "string",
+        "minLength": 1
+      },
+      "status": {
+        "type": "string",
+        "title": "Status of the search",
+        "enum": ["Ordered", "Delivered"]
+      }
+    },
+    "required": ["displayName", "status"],
+    "discriminator": { "propertyName": "status" },
+    "oneOf": [
+      {
+        "properties": {
+          "status": {
+            "enum": ["Ordered"]
+          },
+          "orderDate": {
+            "title": "Date search was ordered",
+            "type": "string",
+            "format": "date-time"
+          },
+          "expectedDeliveryDate": {
+            "title": "Date search provider indicates to expect delivery",
+            "type": "string",
+            "format": "date-time"
+          },
+          "searchContentTypes": {
+            "type": "array",
+            "items": {
+              "$ref": "#/$defs/contentTypes"
+            }
+          }
+        },
+        "required": ["providerName", "orderDate"]
+      },
+      {
+        "properties": {
+          "status": {
+            "enum": ["Delivered"]
+          },
+          "reportDate": {
+            "title": "Report date",
+            "type": "string",
+            "format": "date-time"
+          },
+          "summary": {
+            "title": "Summary of report",
+            "type": "string",
+            "minLength": 1
+          },
+          "recommendations": {
+            "title": "Report recommendations",
+            "type": "string",
+            "minLength": 1
+          },
+          "actionAlertRating": {
+            "title": "Action alert rating (1 is Green, 5 is Red)",
+            "type": "string",
+            "enum": ["1", "2", "3", "4", "5"]
+          },
+          "complianceStatement": {
+            "title": "Statement of methodology and compliance with reporting standards",
+            "type": "string",
+            "minLength": 1
+          },
+          "results": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "contentType": {
+                  "$ref": "#/$defs/contentTypes"
+                }
+              },
+              "required": ["contentType"],
+              "discriminator": { "propertyName": "contentType" },
+              "oneOf": [
+                {
+                  "properties": {
+                    "contentType": {
+                      "enum": ["Local Land Charges"]
+                    },
+                    "localLandCharges": {
+                      "$ref": "https://trust.propdata.org.uk/schemas/v1/searches/local-land-charges.json"
+                    }
+                  },
+                  "required": ["localLandCharges"]
+                },
+                {
+                  "properties": {
+                    "contentType": {
+                      "enum": ["Required Local Searches"]
+                    },
+                    "requiredLocalSearches": {
+                      "$ref": "https://trust.propdata.org.uk/schemas/v1/searches/local-searches-required.json"
+                    }
+                  },
+                  "required": ["requiredLocalSearches"]
+                },
+                {
+                  "properties": {
+                    "contentType": {
+                      "enum": ["Drainage and Water Search"]
+                    },
+                    "drainageAndWater": {
+                      "$ref": "https://trust.propdata.org.uk/schemas/v1/searches/drainage-and-water.json"
+                    }
+                  },
+                  "required": ["con29DW"]
+                },
+                {
+                  "properties": {
+                    "contentType": {
+                      "enum": [
+                        "Flood",
+                        "Contaminated Land",
+                        "Coal",
+                        "Bath Stone",
+                        "Metalliferous (Tin)",
+                        "Kaolin & Ball Clay",
+                        "Limestone",
+                        "Brine",
+                        "HS2",
+                        "Crossrail",
+                        "Energy Exploration",
+                        "Wind Farms",
+                        "Renewable Power Plants",
+                        "Solar Farms",
+                        "London Underground",
+                        "Ground Stability",
+                        "Non Coal Mining",
+                        "Ground Movement",
+                        "Mineral",
+                        "Radon",
+                        "Other"
+                      ]
+                    },
+                    "recommendedActionIndicator": {
+                      "title": "Recommended action indicator",
+                      "type": "string",
+                      "enum": ["Yes", "No"]
+                    },
+                    "actionAlertRating": {
+                      "title": "Action alert rating (1 is Green, 5 is Red)",
+                      "type": "string",
+                      "enum": ["1", "2", "3", "4", "5"]
+                    },
+                    "summary": {
+                      "title": "Summary of report",
+                      "type": "string",
+                      "minLength": 1
+                    },
+                    "recommendations": {
+                      "title": "Report recommendations",
+                      "type": "string",
+                      "minLength": 1
+                    },
+                    "complianceStatement": {
+                      "title": "Statement of methodology and compliance with reporting standards",
+                      "type": "string",
+                      "minLength": 1
+                    }
+                  }
+                }
+              ]
+            }
+          }
+        }
+      }
+    ]
+  },
+  "$defs": {
+    "contentTypes": {
+      "type": "string",
+      "enum": [
+        "Local Land Charges",
+        "Required Local Searches",
+        "Optional Local Searches Optional",
+        "Drainage and Water Search",
+        "Flood",
+        "Contaminated Land",
+        "Coal",
+        "Bath Stone",
+        "Metalliferous (Tin)",
+        "Kaolin & Ball Clay",
+        "Limestone",
+        "Brine",
+        "HS2",
+        "Crossrail",
+        "Energy Exploration",
+        "Wind Farms",
+        "Planning",
+        "Utilities",
+        "Renewable Power Plants",
+        "Solar Farms",
+        "London Underground",
+        "Ground Stability",
+        "Non Coal Mining",
+        "Ground Movement",
+        "Mineral",
+        "Radon"
+      ]
+    }
+  }
+}