Support for Material Information Part B & C - Properties API

Internal Reference: AC-10700

Notes: New table has been added in AC DB to support the requirements for properties to list Material Information (part B & C).

Request: Platform to support surfacing this information in the Properties API

Rights & Restrictions
Flood and erosion risk
Accessibility

Specification

Project: Reapit.Services.Properties
As there is a lot of new information going in we should consider a new endpoint for some of this information. The biggest snag with this change is that the utilities object is now applicable to both sales and lettings properties. As we haven't solve the versioning issue, I suggest a new properties/{id}/utilities endpoint, and the utilities object in the lettings model can later be deprecated in a new version
New data comes from the new matinfo table
Read and write should be considered here
Some initial suggestions:

Add to PropertyModel:

{
  "accessibility": [ --> bitwise field matinfo.access
    "unsuitableForWheelchairs",
    "levelAccess",
    "liftAccess",
    "rampedAccess",
    "wetRoom",
    "wideDoorways",
    "stepFreeAccess",
    "levelAccessShower",
    "lateralLiving"
  ],
  "rightsRestrictions": {
     "listed": true|false -> matinfo.listed
     "restrictions": true|false -> matinfo.restrictions
     "easementsOrWayleaves": true|false -> matinfo.easements
     "rightOfWay": true|false -> matinfo.publicright
  },
  "floodErosion": {
    "floodingLast5Years": true|false -> matinfo.flooded
    "lastFlood": "YYYY-mm-dd", -> matinfo.flooddate
    "floodSources": [ -> bitwise field matinfo.floodsources
      "river", "lake", "sea", "reservoir", "groundwater", "other"
    ],
    "floodDefences": true|false -> matinfo.defences
  },
}

Setup new endpoint specifically for utilities. Bitwise fields should be handled in the same way we handle property attributes

{
     "propertyId": "PRP230001",
    "created": "0000-00-00T00:00:00Z",
    "modified": "0000-00-00T00:00:00Z",
      "gas": {
        "hasGas": true,
        "gasCompanyId": "OXF21000001",
        "gasMeterPoint": "123",    
      },
      "electricity": {
        "type": "windTurbine | mainsSupply | privateSupply | solar", -> matinfo.electricity
    "electricityCompanyId": "OXF21000003",
        "electricityMeterPoint": "789",
      },
      "water": {
        "type": "mainsSupply | privateSupply", -> matinfo.water
    "waterCompanyId": "OXF21000002",
        "waterMeterPoint": "456",
        "sewerage": {
          "type": "mainsSupply | privateSupply" -> matinfo.sewerage
        }
      },
      "internet": { -> bitwise field matinfo.broadtype
        "type": [
          "none",
          "adsl",
          "fttc",
          "fttp"
        ],
        "internetCompanyId": "OXF21000004",
      }, 
      "telephoneCompanyId": "OXF21000006",
      "cableTvCompanyId": "OXF21000005",
      "heating": [ -> bitwise field matinfo.heating (sort alphabatically)
         "airConditioning",
         "central",
         "doubleGlazing",
         "ecoFriendly",
         "electric",
         "gas",
         "gasCentral",
         "nightStorage",
         "oil",
         "solar",
         "solarWater",
         "underFloor",****
         "woodBurner",
         "openFire",
         "biomassBoiler",
         "groundSourceHeatPump",
         "airSourceHeatPump",
         "solarPvThermal",
         "underFloorHeating",****
         "solarThermal",
      ]
    },
    "mobileSignal": "", -> matinfo.mobilesignalinfo varchar(300)
    "_eTag": "XXXYYY123456",
   "_links": {
 "self": {}, 
"property": ""
"telephonyCompany": "",
"cableTvTompany: "", 
"electricityCompany": "",
"gasCompany": "",
"waterCompany": ""
}
}

reapit / foundations

Support for Material Information Part B & C - Properties API #11087