Site

Use cases and requirements

The Site model should have properties for:

parent UPRN

For flats and other shared properties, the parent UPRN is often the site with associated features shared by all child sites.

attributes

To record specific information about the site related to the service provision there.

Types

This is a sub-type of Place. Depending on the system, many of the Place properties may be optional.

Properties

Term Mapping Definition
parent_uprn Text A unique identifier for a parent property.
attributes Name-value pairs. List of attributes.

Serialisation

  {
  "@type": "Site",
  "@id": "/sites/1",
  "address": {
    "@type": "BS7666Address",
    "paon": "1",
    "street": "Acacia Avenue",
    "locality": "Anytown",
    "region": "Anyshire",
    "postcode": "AB1 2CD"
  },
  "geo": {
    "@type": "GeoCoordinates",
    "latitude": "40.75",
    "longitude": "73.98"
  },
  "uprn": "123456789012",
  "usrn": "12345678",
  "parent_uprn": "123456789012",
  "attributes": [
    {
      "name": "assisted collection",
      "value": "yes"
    }
  ]  
}

  
  <?xml version="1.0" encoding="UTF-8"?>
<site>
  <type>Site</type>
  <href>/sites/1</href>
  <address>
    <type>BS7666Address</type>
    <paon>1</paon>
    <street>Acacia Avenue</street>
    <locality>Anytown</locality>
    <region>Anyshire</region>
    <postcode>AB1 2CD</postcode>
  </address>
  <geo>
    <type>GeoCoordinates</type>
    <latitude>40.75</latitude>
    <longitude>73.98</longitude>
  </geo>
  <uprn>123456789012</uprn>
  <usrn>12345678</usrn>
  <parent-uprn>123456789012</parent-uprn>
  <attributes type="array">
    <attribute>
      <name>assisted collection</name>
      <value>yes</value>
    </attribute>
  </attributes>
</site>

  

Parent-child relationships

Properties such as flats often have shared bin stores. A typical pattern to model this is:

  • The building has a UPRN
  • Each flat has a UPRN and a parent UPRN for the building
  • The shared bin store contains Features associated with the building

This basic pattern is accounted for with the include=related parameter of the Tasks endpoint and other endpoints.

There are other kinds of patterns for recording these relationships, depending on how the council has modelled the information.

See section 11.9, Grouped Properties in NLPG Data Entry and Best Practice for more information.