@planning-inspectorate/data-model 2.49.0 → 2.50.0

package/docs/README.md

@@ -14,10 +14,16 @@
 
 * [Appeal S78 Case](./appeal-s78.md "Group B - Schema defining the metadata for an appeal") – `appeal-s78.schema.json`
 
-* [Application Update Schema](./application-update.md "Application Update for Casework Project") – `application-update.schema.json`
+* [Application Update Schema](./applications-application-update.md "Application Update for Casework Project") – `applications-application-update.schema.json`
+
+* [Casework Representation Schema](./applications-representation.md "Representations and related document metadata for Casework Projects") – `applications-representation.schema.json`
+
+* [Crown Development Application](./applications-application.md "Main application details for Crown Development Project") – `applications-application.schema.json`
 
 * [DaRT API response](./dart-response.md "Schema defining the data returned by the DaRT API") – `dart-response.schema.json`
 
+* [Email Notification Record Schema](./applications-notify-email.md "Email Notifications for Casework Projects") – `applications-notify-email.schema.json`
+
 * [Entra ID User Objects](./entraid.md "A list of users from EntraID") – `entraid.schema.json`
 
 * [Examination Timetable](./nsip-exam-timetable.md "Examination Timetable for an NSIP Project") – `nsip-exam-timetable.schema.json`
@@ -40,6 +46,8 @@
 
 * [NSIP Project Update](./nsip-project-update.md "NSIP Project Update (formerly known as Banners)") – `nsip-project-update.schema.json`
 
+* [PINS Address Schema](./address.md "A schema to define the structure of an Address object in PINS") – `address.schema.json`
+
 * [PINS Inspector](./pins-inspector.md "Inspector Details originating from Horizon, SAP HR and Entra") – `pins-inspector.schema.json`
 
 * [PINS LPA](./pins-lpa.md "Local Planning Authority (LPA) attributes as per Horizon") – `pins-lpa.schema.json`
@@ -76,8 +84,20 @@
 
 * [Untitled object in Appeal S78 Case](./appeal-s78-properties-significantchangesaffectingapplicationlpa-items.md) – `appeal-s78.schema.json#/properties/significantChangesAffectingApplicationLpa/items`
 
+* [Untitled object in Casework Representation Schema](./applications-representation-definitions-contact.md) – `applications-representation.schema.json#/definitions/contact`
+
+* [Untitled object in Casework Representation Schema](./applications-representation-definitions-representationdocument.md) – `applications-representation.schema.json#/definitions/representationDocument`
+
+* [Untitled object in Crown Development Application](./applications-application-defs-organisation.md) – `applications-application.schema.json#/$defs/organisation`
+
+* [Untitled object in Crown Development Application](./applications-application-defs-contact.md) – `applications-application.schema.json#/$defs/contact`
+
+* [Untitled object in Crown Development Application](./applications-application-defs-address.md) – `applications-application.schema.json#/$defs/address`
+
 * [Untitled object in DaRT API response](./dart-response-properties-neighbouringsiteaddresses-items.md) – `dart-response.schema.json#/properties/neighbouringSiteAddresses/items`
 
+* [Untitled object in Email Notification Record Schema](./applications-notify-email-defs-contact.md "Contact the email was sent to") – `applications-notify-email.schema.json#/$defs/Contact`
+
 * [Untitled object in Examination Timetable](./nsip-exam-timetable-defs-event.md) – `nsip-exam-timetable.schema.json#/$defs/event`
 
 * [Untitled object in Examination Timetable](./nsip-exam-timetable-defs-line-item.md) – `nsip-exam-timetable.schema.json#/$defs/line-item`
@@ -94,6 +114,8 @@
 
 * [Untitled array in Appeal Representation](./appeal-representation-properties-documentids.md "An array of documentIds") – `appeal-representation.schema.json#/properties/documentIds`
 
+* [Untitled array in Crown Development Application](./applications-application-properties-organisations.md "Applications can have one or more organisaitons associated with them") – `applications-application.schema.json#/properties/organisations`
+
 * [Untitled array in Examination Timetable](./nsip-exam-timetable-properties-events.md) – `nsip-exam-timetable.schema.json#/properties/events`
 
 * [Untitled array in Examination Timetable](./nsip-exam-timetable-defs-event-properties-eventlineitems.md) – `nsip-exam-timetable.schema.json#/$defs/event/properties/eventLineItems`

package/docs/address.md

@@ -0,0 +1,366 @@
+## PINS Address Schema Type
+
+`object` ([PINS Address Schema](address.md))
+
+# PINS Address Schema Properties
+
+| Property                                | Type          | Required | Nullable       | Defined by                                                                                                         |
+| :-------------------------------------- | :------------ | :------- | :------------- | :----------------------------------------------------------------------------------------------------------------- |
+| [addressDimKey](#addressdimkey)         | `number`      | Required | cannot be null | [PINS Address Schema](address-properties-addressdimkey.md "address.schema.json#/properties/addressDimKey")         |
+| [addressType](#addresstype)             | `string`      | Optional | cannot be null | [PINS Address Schema](address-properties-addresstype.md "address.schema.json#/properties/addressType")             |
+| [caseReference](#casereference)         | `string`      | Required | cannot be null | [PINS Address Schema](address-properties-casereference.md "address.schema.json#/properties/caseReference")         |
+| [caseId](#caseid)                       | `string`      | Required | cannot be null | [PINS Address Schema](address-properties-caseid.md "address.schema.json#/properties/caseId")                       |
+| [caseType](#casetype)                   | `string`      | Required | cannot be null | [PINS Address Schema](address-properties-casetype.md "address.schema.json#/properties/caseType")                   |
+| [description](#description)             | `string`      | Optional | can be null    | [PINS Address Schema](address-properties-description.md "address.schema.json#/properties/description")             |
+| [line1](#line1)                         | `string`      | Optional | can be null    | [PINS Address Schema](address-properties-line1.md "address.schema.json#/properties/line1")                         |
+| [line2](#line2)                         | `string`      | Optional | can be null    | [PINS Address Schema](address-properties-line2.md "address.schema.json#/properties/line2")                         |
+| [townCity](#towncity)                   | `string`      | Optional | can be null    | [PINS Address Schema](address-properties-towncity.md "address.schema.json#/properties/townCity")                   |
+| [county](#county)                       | `string`      | Optional | can be null    | [PINS Address Schema](address-properties-county.md "address.schema.json#/properties/county")                       |
+| [postcode](#postcode)                   | `string`      | Optional | can be null    | [PINS Address Schema](address-properties-postcode.md "address.schema.json#/properties/postcode")                   |
+| [country](#country)                     | `string`      | Optional | can be null    | [PINS Address Schema](address-properties-country.md "address.schema.json#/properties/country")                     |
+| [easting](#easting)                     | `string`      | Optional | can be null    | [PINS Address Schema](address-properties-easting.md "address.schema.json#/properties/easting")                     |
+| [northing](#northing)                   | `string`      | Optional | can be null    | [PINS Address Schema](address-properties-northing.md "address.schema.json#/properties/northing")                   |
+| [latitudeWGS84](#latitudewgs84)         | `number`      | Optional | can be null    | [PINS Address Schema](address-properties-latitudewgs84.md "address.schema.json#/properties/latitudeWGS84")         |
+| [longitudeWGS84](#longitudewgs84)       | `number`      | Optional | can be null    | [PINS Address Schema](address-properties-longitudewgs84.md "address.schema.json#/properties/longitudeWGS84")       |
+| [UPRN](#uprn)                           | `string`      | Optional | can be null    | [PINS Address Schema](address-properties-uprn.md "address.schema.json#/properties/UPRN")                           |
+| [dependentRequired](#dependentrequired) | Not specified | Optional | cannot be null | [PINS Address Schema](address-properties-dependentrequired.md "address.schema.json#/properties/dependentRequired") |
+| Additional Properties                   | Any           | Optional | can be null    |                                                                                                                    |
+
+## addressDimKey
+
+Primary Key for an Address.
+
+`addressDimKey`
+
+* is required
+
+* Type: `number`
+
+* cannot be null
+
+* defined in: [PINS Address Schema](address-properties-addressdimkey.md "address.schema.json#/properties/addressDimKey")
+
+### addressDimKey Type
+
+`number`
+
+## addressType
+
+The type of thing this address is for.
+
+`addressType`
+
+* is optional
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [PINS Address Schema](address-properties-addresstype.md "address.schema.json#/properties/addressType")
+
+### addressType Type
+
+`string`
+
+### addressType Constraints
+
+**enum**: the value of this property must be equal to one of the following values:
+
+| Value            | Explanation |
+| :--------------- | :---------- |
+| `"site"`         |             |
+| `"neighbouring"` |             |
+| `"organisation"` |             |
+| `"contact"`      |             |
+
+## caseReference
+
+Business Key for the related case
+
+`caseReference`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [PINS Address Schema](address-properties-casereference.md "address.schema.json#/properties/caseReference")
+
+### caseReference Type
+
+`string`
+
+## caseId
+
+The unique ID for the case this representation belongs to.
+
+`caseId`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [PINS Address Schema](address-properties-caseid.md "address.schema.json#/properties/caseId")
+
+### caseId Type
+
+`string`
+
+## caseType
+
+The type of case this representation is for.
+
+`caseType`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [PINS Address Schema](address-properties-casetype.md "address.schema.json#/properties/caseType")
+
+### caseType Type
+
+`string`
+
+## description
+
+Some sites may have a postcode, but do not have postal addresses.
+
+`description`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [PINS Address Schema](address-properties-description.md "address.schema.json#/properties/description")
+
+### description Type
+
+`string`
+
+## line1
+
+
+
+`line1`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [PINS Address Schema](address-properties-line1.md "address.schema.json#/properties/line1")
+
+### line1 Type
+
+`string`
+
+## line2
+
+
+
+`line2`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [PINS Address Schema](address-properties-line2.md "address.schema.json#/properties/line2")
+
+### line2 Type
+
+`string`
+
+## townCity
+
+
+
+`townCity`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [PINS Address Schema](address-properties-towncity.md "address.schema.json#/properties/townCity")
+
+### townCity Type
+
+`string`
+
+## county
+
+
+
+`county`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [PINS Address Schema](address-properties-county.md "address.schema.json#/properties/county")
+
+### county Type
+
+`string`
+
+## postcode
+
+
+
+`postcode`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [PINS Address Schema](address-properties-postcode.md "address.schema.json#/properties/postcode")
+
+### postcode Type
+
+`string`
+
+## country
+
+
+
+`country`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [PINS Address Schema](address-properties-country.md "address.schema.json#/properties/country")
+
+### country Type
+
+`string`
+
+## easting
+
+
+
+`easting`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [PINS Address Schema](address-properties-easting.md "address.schema.json#/properties/easting")
+
+### easting Type
+
+`string`
+
+## northing
+
+
+
+`northing`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [PINS Address Schema](address-properties-northing.md "address.schema.json#/properties/northing")
+
+### northing Type
+
+`string`
+
+## latitudeWGS84
+
+
+
+`latitudeWGS84`
+
+* is optional
+
+* Type: `number`
+
+* can be null
+
+* defined in: [PINS Address Schema](address-properties-latitudewgs84.md "address.schema.json#/properties/latitudeWGS84")
+
+### latitudeWGS84 Type
+
+`number`
+
+## longitudeWGS84
+
+
+
+`longitudeWGS84`
+
+* is optional
+
+* Type: `number`
+
+* can be null
+
+* defined in: [PINS Address Schema](address-properties-longitudewgs84.md "address.schema.json#/properties/longitudeWGS84")
+
+### longitudeWGS84 Type
+
+`number`
+
+## UPRN
+
+The Unique Property Reference Number (UPRN) is a unique number (a geocode) for every addressable location—e.g., a building, a bus stop, a post box, a feature in the landscape, or a defibrillator—in Great Britain.
+
+`UPRN`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [PINS Address Schema](address-properties-uprn.md "address.schema.json#/properties/UPRN")
+
+### UPRN Type
+
+`string`
+
+## dependentRequired
+
+
+
+`dependentRequired`
+
+* is optional
+
+* Type: unknown
+
+* cannot be null
+
+* defined in: [PINS Address Schema](address-properties-dependentrequired.md "address.schema.json#/properties/dependentRequired")
+
+### dependentRequired Type
+
+unknown
+
+## Additional Properties
+
+Additional properties are allowed and do not have to follow a specific schema

package/docs/applications-application-defs-address.md

@@ -0,0 +1,108 @@
+## address Type
+
+`object` ([Details](applications-application-defs-address.md))
+
+# address Properties
+
+| Property              | Type     | Required | Nullable       | Defined by                                                                                                                                                              |
+| :-------------------- | :------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [line1](#line1)       | `string` | Optional | can be null    | [Crown Development Application](applications-application-defs-address-properties-line1.md "applications-application.schema.json#/$defs/address/properties/line1")       |
+| [line2](#line2)       | `string` | Optional | can be null    | [Crown Development Application](applications-application-defs-address-properties-line2.md "applications-application.schema.json#/$defs/address/properties/line2")       |
+| [townCity](#towncity) | `string` | Optional | can be null    | [Crown Development Application](applications-application-defs-address-properties-towncity.md "applications-application.schema.json#/$defs/address/properties/townCity") |
+| [county](#county)     | `string` | Optional | can be null    | [Crown Development Application](applications-application-defs-address-properties-county.md "applications-application.schema.json#/$defs/address/properties/county")     |
+| [postcode](#postcode) | `string` | Required | cannot be null | [Crown Development Application](applications-application-defs-address-properties-postcode.md "applications-application.schema.json#/$defs/address/properties/postcode") |
+| Additional Properties | Any      | Optional | can be null    |                                                                                                                                                                         |
+
+## line1
+
+
+
+`line1`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [Crown Development Application](applications-application-defs-address-properties-line1.md "applications-application.schema.json#/$defs/address/properties/line1")
+
+### line1 Type
+
+`string`
+
+## line2
+
+
+
+`line2`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [Crown Development Application](applications-application-defs-address-properties-line2.md "applications-application.schema.json#/$defs/address/properties/line2")
+
+### line2 Type
+
+`string`
+
+## townCity
+
+
+
+`townCity`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [Crown Development Application](applications-application-defs-address-properties-towncity.md "applications-application.schema.json#/$defs/address/properties/townCity")
+
+### townCity Type
+
+`string`
+
+## county
+
+
+
+`county`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [Crown Development Application](applications-application-defs-address-properties-county.md "applications-application.schema.json#/$defs/address/properties/county")
+
+### county Type
+
+`string`
+
+## postcode
+
+
+
+`postcode`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [Crown Development Application](applications-application-defs-address-properties-postcode.md "applications-application.schema.json#/$defs/address/properties/postcode")
+
+### postcode Type
+
+`string`
+
+## Additional Properties
+
+Additional properties are allowed and do not have to follow a specific schema

package/docs/applications-application-defs-contact.md

@@ -0,0 +1,98 @@
+## contact Type
+
+`object` ([Details](applications-application-defs-contact.md))
+
+# contact Properties
+
+| Property                                              | Type     | Required | Nullable       | Defined by                                                                                                                                                                                              |
+| :---------------------------------------------------- | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| [contactId](#contactid)                               | `string` | Required | cannot be null | [Crown Development Application](applications-application-defs-contact-properties-contactid.md "applications-application.schema.json#/$defs/contact/properties/contactId")                               |
+| [contactPreference](#contactpreference)               | `string` | Optional | can be null    | [Crown Development Application](applications-application-defs-contact-properties-contactpreference.md "applications-application.schema.json#/$defs/contact/properties/contactPreference")               |
+| [writtenRepOrgName](#writtenreporgname)               | `string` | Optional | can be null    | [Crown Development Application](applications-application-defs-contact-properties-writtenreporgname.md "applications-application.schema.json#/$defs/contact/properties/writtenRepOrgName")               |
+| [writtenRepJobTitleorRole](#writtenrepjobtitleorrole) | `string` | Optional | can be null    | [Crown Development Application](applications-application-defs-contact-properties-writtenrepjobtitleorrole.md "applications-application.schema.json#/$defs/contact/properties/writtenRepJobTitleorRole") |
+| Additional Properties                                 | Any      | Optional | can be null    |                                                                                                                                                                                                         |
+
+## contactId
+
+Source PK for Contact
+
+`contactId`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [Crown Development Application](applications-application-defs-contact-properties-contactid.md "applications-application.schema.json#/$defs/contact/properties/contactId")
+
+### contactId Type
+
+`string`
+
+## contactPreference
+
+
+
+`contactPreference`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [Crown Development Application](applications-application-defs-contact-properties-contactpreference.md "applications-application.schema.json#/$defs/contact/properties/contactPreference")
+
+### contactPreference Type
+
+`string`
+
+### contactPreference Constraints
+
+**enum**: the value of this property must be equal to one of the following values:
+
+| Value     | Explanation |
+| :-------- | :---------- |
+| `"email"` |             |
+| `"post"`  |             |
+
+## writtenRepOrgName
+
+Organisation Name used for written-representation on behalf of an organisation
+
+`writtenRepOrgName`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [Crown Development Application](applications-application-defs-contact-properties-writtenreporgname.md "applications-application.schema.json#/$defs/contact/properties/writtenRepOrgName")
+
+### writtenRepOrgName Type
+
+`string`
+
+## writtenRepJobTitleorRole
+
+Job Title or Role used for written-representation on behalf of an organisation
+
+`writtenRepJobTitleorRole`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [Crown Development Application](applications-application-defs-contact-properties-writtenrepjobtitleorrole.md "applications-application.schema.json#/$defs/contact/properties/writtenRepJobTitleorRole")
+
+### writtenRepJobTitleorRole Type
+
+`string`
+
+## Additional Properties
+
+Additional properties are allowed and do not have to follow a specific schema