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

package/keen-dewdney-6ae15b/src/schemas/v2/overlays/nts.json

@@ -0,0 +1,326 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://trust.propdata.org.uk/schemas/v2/overlays/nts.json",
+  "required": [
+    "propertyPack"
+  ],
+  "properties": {
+    "propertyPack": {
+      "required": [
+        "materialFacts"
+      ],
+      "properties": {
+        "materialFacts": {
+          "required": [
+            "ownership",
+            "councilTax",
+            "energyEfficiency"
+          ],
+          "properties": {
+            "priceInformation": {
+              "ntsRef": "A3",
+              "required": [
+                "price",
+                "priceQualifier"
+              ],
+              "properties": {
+                "price": {
+                  "ntsRef": "A3.1"
+                },
+                "priceQualifier": {
+                  "ntsRef": "A3.2"
+                }
+              }
+            },
+            "ownership": {
+              "ntsRef": "A1",
+              "required": [
+                "ownershipsToBeTransferred"
+              ],
+              "properties": {
+                "ownershipsToBeTransferred": {
+                  "ntsRef": "A1",
+                  "items": {
+                    "ntsRef": "A1.1",
+                    "discriminator": {
+                      "propertyName": "ownershipType"
+                    },
+                    "oneOf": [
+                      {
+                        "properties": {
+                          "ownershipType": {
+                            "enum": [
+                              "Freehold"
+                            ]
+                          }
+                        }
+                      },
+                      {
+                        "properties": {
+                          "ownershipType": {
+                            "enum": [
+                              "Managed Freehold",
+                              "Commonhold"
+                            ]
+                          }
+                        }
+                      },
+                      {
+                        "properties": {
+                          "ownershipType": {
+                            "enum": [
+                              "Leasehold"
+                            ]
+                          },
+                          "leaseholdInformation": {
+                            "ntsRef": "A1.2",
+                            "required": [
+                              "typeOfLeasehold",
+                              "leaseTerm",
+                              "groundRent",
+                              "serviceCharge"
+                            ],
+                            "properties": {
+                              "typeOfLeasehold": {
+                                "ntsRef": "A1.2",
+                                "discriminator": {
+                                  "propertyName": "leaseholdType"
+                                },
+                                "oneOf": [
+                                  {
+                                    "properties": {
+                                      "leaseholdType": {
+                                        "enum": [
+                                          "Flat",
+                                          "Long leasehold house"
+                                        ]
+                                      }
+                                    }
+                                  },
+                                  {
+                                    "properties": {
+                                      "leaseholdType": {
+                                        "enum": [
+                                          "Shared ownership"
+                                        ]
+                                      },
+                                      "sharedOwnershipPercentage": {
+                                        "ntsRef": "A1.7.1"
+                                      },
+                                      "sharedOwnershipRent": {
+                                        "ntsRef": "A1.7.2"
+                                      },
+                                      "sharedOwnershipRentFrequency": {
+                                        "ntsRef": "A1.7.3"
+                                      }
+                                    },
+                                    "required": [
+                                      "sharedOwnershipPercentage",
+                                      "sharedOwnershipRent",
+                                      "sharedOwnershipRentFrequency"
+                                    ]
+                                  }
+                                ],
+                                "required": [
+                                  "leaseholdType"
+                                ]
+                              },
+                              "leaseTerm": {
+                                "ntsRef": "A1.2.1",
+                                "required": [
+                                  "startYearOfLease",
+                                  "lengthOfLeaseInYears"
+                                ],
+                                "properties": {
+                                  "startYearOfLease": {
+                                    "ntsRef": "A1.2.1.1"
+                                  },
+                                  "lengthOfLeaseInYears": {
+                                    "ntsRef": "A1.2.1.2"
+                                  }
+                                }
+                              },
+                              "groundRent": {
+                                "ntsRef": "A1.4",
+                                "discriminator": {
+                                  "propertyName": "isGroundRentPayable"
+                                },
+                                "oneOf": [
+                                  {
+                                    "properties": {
+                                      "isGroundRentPayable": {
+                                        "enum": [
+                                          "No"
+                                        ]
+                                      }
+                                    }
+                                  },
+                                  {
+                                    "properties": {
+                                      "isGroundRentPayable": {
+                                        "enum": [
+                                          "Yes"
+                                        ]
+                                      },
+                                      "annualGroundRent": {
+                                        "ntsRef": "A1.4.2"
+                                      },
+                                      "rentSubjectToIncrease": {
+                                        "ntsRef": "A1.4.3",
+                                        "discriminator": {
+                                          "propertyName": "yesNo"
+                                        },
+                                        "oneOf": [
+                                          {
+                                            "properties": {
+                                              "yesNo": {
+                                                "enum": [
+                                                  "No"
+                                                ]
+                                              }
+                                            }
+                                          },
+                                          {
+                                            "properties": {
+                                              "yesNo": {
+                                                "enum": [
+                                                  "Yes"
+                                                ]
+                                              },
+                                              "rentReviewFrequency": {
+                                                "ntsRef": "1.4.3.2"
+                                              },
+                                              "rentIncreaseCalculated": {
+                                                "ntsRef": "1.4.3.3"
+                                              }
+                                            },
+                                            "required": [
+                                              "rentReviewFrequency",
+                                              "rentIncreaseCalculated"
+                                            ]
+                                          }
+                                        ],
+                                        "required": [
+                                          "yesNo"
+                                        ],
+                                        "properties": {
+                                          "yesNo": {
+                                            "ntsRef": "1.4.3.1"
+                                          }
+                                        }
+                                      }
+                                    },
+                                    "required": [
+                                      "annualGroundRent",
+                                      "rentSubjectToIncrease"
+                                    ]
+                                  }
+                                ],
+                                "required": [
+                                  "isGroundRentPayable"
+                                ],
+                                "properties": {
+                                  "isGroundRentPayable": {
+                                    "ntsRef": "A1.4.1"
+                                  }
+                                }
+                              },
+                              "serviceCharge": {
+                                "ntsRef": "A1.5",
+                                "discriminator": {
+                                  "propertyName": "sellerContributesToServiceCharge"
+                                },
+                                "oneOf": [
+                                  {
+                                    "properties": {
+                                      "sellerContributesToServiceCharge": {
+                                        "enum": [
+                                          "No"
+                                        ]
+                                      }
+                                    }
+                                  },
+                                  {
+                                    "properties": {
+                                      "sellerContributesToServiceCharge": {
+                                        "enum": [
+                                          "Yes"
+                                        ]
+                                      },
+                                      "annualServiceCharge": {
+                                        "ntsRef": "A1.5.1.1"
+                                      }
+                                    }
+                                  }
+                                ],
+                                "required": [
+                                  "sellerContributesToServiceCharge"
+                                ],
+                                "properties": {
+                                  "sellerContributesToServiceCharge": {
+                                    "ntsRef": "A1.5.1"
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        }
+                      },
+                      {
+                        "properties": {
+                          "ownershipType": {
+                            "enum": [
+                              "Other"
+                            ]
+                          }
+                        }
+                      }
+                    ],
+                    "required": [
+                      "ownershipType"
+                    ],
+                    "properties": {
+                      "ownershipType": {
+                        "ntsRef": "A1.1.1"
+                      }
+                    }
+                  }
+                }
+              }
+            },
+            "energyEfficiency": {
+              "ntsRef": "A4",
+              "required": [
+                "certificate"
+              ],
+              "properties": {
+                "certificate": {
+                  "ntsRef": "A4.1",
+                  "required": [
+                    "currentEnergyRating"
+                  ],
+                  "properties": {
+                    "currentEnergyRating": {
+                      "ntsRef": "A4.1.1"
+                    }
+                  }
+                }
+              }
+            },
+            "councilTax": {
+              "ntsRef": "A2",
+              "required": [
+                "councilTaxBand"
+              ],
+              "properties": {
+                "councilTaxBand": {
+                  "ntsRef": "A2.1"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}