@planning-inspectorate/data-model 2.53.0 → 2.55.0

package/docs/README.md

@@ -18,7 +18,7 @@
 
 * [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`
+* [Crown Development Application](./applications-crowndev-application.md "Main application details for Crown Development Project") – `applications-crowndev-application.schema.json`
 
 * [DaRT API response](./dart-response.md "Schema defining the data returned by the DaRT API") – `dart-response.schema.json`
 
@@ -92,11 +92,11 @@
 
 * [Untitled object in Casework Representation Schema](./applications-representation-defs-representationdocument.md) – `applications-representation.schema.json#/$defs/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-crowndev-application-defs-organisation.md) – `applications-crowndev-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-crowndev-application-defs-contact.md) – `applications-crowndev-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 Crown Development Application](./applications-crowndev-application-defs-address.md) – `applications-crowndev-application.schema.json#/$defs/address`
 
 * [Untitled object in DaRT API response](./dart-response-properties-neighbouringsiteaddresses-items.md) – `dart-response.schema.json#/properties/neighbouringSiteAddresses/items`
 
@@ -118,7 +118,7 @@
 
 * [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 Crown Development Application](./applications-crowndev-application-properties-organisations.md "Applications can have one or more organisaitons associated with them") – `applications-crowndev-application.schema.json#/properties/organisations`
 
 * [Untitled array in Examination Timetable](./nsip-exam-timetable-properties-events.md) – `nsip-exam-timetable.schema.json#/properties/events`
 

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

@@ -0,0 +1,108 @@
+## address Type
+
+`object` ([Details](applications-crowndev-application-defs-address.md))
+
+# address Properties
+
+| Property              | Type     | Required | Nullable       | Defined by                                                                                                                                                                                |
+| :-------------------- | :------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [line1](#line1)       | `string` | Optional | can be null    | [Crown Development Application](applications-crowndev-application-defs-address-properties-line1.md "applications-crowndev-application.schema.json#/$defs/address/properties/line1")       |
+| [line2](#line2)       | `string` | Optional | can be null    | [Crown Development Application](applications-crowndev-application-defs-address-properties-line2.md "applications-crowndev-application.schema.json#/$defs/address/properties/line2")       |
+| [townCity](#towncity) | `string` | Optional | can be null    | [Crown Development Application](applications-crowndev-application-defs-address-properties-towncity.md "applications-crowndev-application.schema.json#/$defs/address/properties/townCity") |
+| [county](#county)     | `string` | Optional | can be null    | [Crown Development Application](applications-crowndev-application-defs-address-properties-county.md "applications-crowndev-application.schema.json#/$defs/address/properties/county")     |
+| [postcode](#postcode) | `string` | Required | cannot be null | [Crown Development Application](applications-crowndev-application-defs-address-properties-postcode.md "applications-crowndev-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-crowndev-application-defs-address-properties-line1.md "applications-crowndev-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-crowndev-application-defs-address-properties-line2.md "applications-crowndev-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-crowndev-application-defs-address-properties-towncity.md "applications-crowndev-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-crowndev-application-defs-address-properties-county.md "applications-crowndev-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-crowndev-application-defs-address-properties-postcode.md "applications-crowndev-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-crowndev-application-defs-contact.md

@@ -0,0 +1,99 @@
+## contact Type
+
+`object` ([Details](applications-crowndev-application-defs-contact.md))
+
+# contact Properties
+
+| Property                                              | Type     | Required | Nullable       | Defined by                                                                                                                                                                                                                |
+| :---------------------------------------------------- | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| [contactId](#contactid)                               | `string` | Required | cannot be null | [Crown Development Application](applications-crowndev-application-defs-contact-properties-contactid.md "applications-crowndev-application.schema.json#/$defs/contact/properties/contactId")                               |
+| [contactPreference](#contactpreference)               | `string` | Optional | can be null    | [Crown Development Application](applications-crowndev-application-defs-contact-properties-contactpreference.md "applications-crowndev-application.schema.json#/$defs/contact/properties/contactPreference")               |
+| [writtenRepOrgName](#writtenreporgname)               | `string` | Optional | can be null    | [Crown Development Application](applications-crowndev-application-defs-contact-properties-writtenreporgname.md "applications-crowndev-application.schema.json#/$defs/contact/properties/writtenRepOrgName")               |
+| [writtenRepJobTitleorRole](#writtenrepjobtitleorrole) | `string` | Optional | can be null    | [Crown Development Application](applications-crowndev-application-defs-contact-properties-writtenrepjobtitleorrole.md "applications-crowndev-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-crowndev-application-defs-contact-properties-contactid.md "applications-crowndev-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-crowndev-application-defs-contact-properties-contactpreference.md "applications-crowndev-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"`  |             |
+| `null`    |             |
+
+## 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-crowndev-application-defs-contact-properties-writtenreporgname.md "applications-crowndev-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-crowndev-application-defs-contact-properties-writtenrepjobtitleorrole.md "applications-crowndev-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

package/docs/applications-crowndev-application-defs-organisation.md

@@ -0,0 +1,117 @@
+## organisation Type
+
+`object` ([Details](applications-crowndev-application-defs-organisation.md))
+
+# organisation Properties
+
+| Property                                    | Type     | Required | Nullable       | Defined by                                                                                                                                                                                                                |
+| :------------------------------------------ | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| [contactRoleType](#contactroletype)         | `string` | Required | cannot be null | [Crown Development Application](applications-crowndev-application-defs-organisation-properties-contactroletype.md "applications-crowndev-application.schema.json#/$defs/organisation/properties/contactRoleType")         |
+| [organisationId](#organisationid)           | `string` | Required | cannot be null | [Crown Development Application](applications-crowndev-application-defs-organisation-properties-organisationid.md "applications-crowndev-application.schema.json#/$defs/organisation/properties/organisationId")           |
+| [organisationName](#organisationname)       | `string` | Optional | can be null    | [Crown Development Application](applications-crowndev-application-defs-organisation-properties-organisationname.md "applications-crowndev-application.schema.json#/$defs/organisation/properties/organisationName")       |
+| [organisationAddress](#organisationaddress) | `array`  | Optional | can be null    | [Crown Development Application](applications-crowndev-application-defs-organisation-properties-organisationaddress.md "applications-crowndev-application.schema.json#/$defs/organisation/properties/organisationAddress") |
+| [contacts](#contacts)                       | `array`  | Optional | can be null    | [Crown Development Application](applications-crowndev-application-defs-organisation-properties-contacts.md "applications-crowndev-application.schema.json#/$defs/organisation/properties/contacts")                       |
+| Additional Properties                       | Any      | Optional | can be null    |                                                                                                                                                                                                                           |
+
+## contactRoleType
+
+Agent or Applicant details
+
+`contactRoleType`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [Crown Development Application](applications-crowndev-application-defs-organisation-properties-contactroletype.md "applications-crowndev-application.schema.json#/$defs/organisation/properties/contactRoleType")
+
+### contactRoleType Type
+
+`string`
+
+### contactRoleType Constraints
+
+**enum**: the value of this property must be equal to one of the following values:
+
+| Value         | Explanation |
+| :------------ | :---------- |
+| `"agent"`     |             |
+| `"applicant"` |             |
+
+## organisationId
+
+Source PK for Organisation
+
+`organisationId`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [Crown Development Application](applications-crowndev-application-defs-organisation-properties-organisationid.md "applications-crowndev-application.schema.json#/$defs/organisation/properties/organisationId")
+
+### organisationId Type
+
+`string`
+
+## organisationName
+
+
+
+`organisationName`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [Crown Development Application](applications-crowndev-application-defs-organisation-properties-organisationname.md "applications-crowndev-application.schema.json#/$defs/organisation/properties/organisationName")
+
+### organisationName Type
+
+`string`
+
+## organisationAddress
+
+
+
+`organisationAddress`
+
+* is optional
+
+* Type: `object[]` ([Details](applications-crowndev-application-defs-address.md))
+
+* can be null
+
+* defined in: [Crown Development Application](applications-crowndev-application-defs-organisation-properties-organisationaddress.md "applications-crowndev-application.schema.json#/$defs/organisation/properties/organisationAddress")
+
+### organisationAddress Type
+
+`object[]` ([Details](applications-crowndev-application-defs-address.md))
+
+## contacts
+
+An Organisation may be linked to one or more Contacts
+
+`contacts`
+
+* is optional
+
+* Type: `object[]` ([Details](applications-crowndev-application-defs-contact.md))
+
+* can be null
+
+* defined in: [Crown Development Application](applications-crowndev-application-defs-organisation-properties-contacts.md "applications-crowndev-application.schema.json#/$defs/organisation/properties/contacts")
+
+### contacts Type
+
+`object[]` ([Details](applications-crowndev-application-defs-contact.md))
+
+## Additional Properties
+
+Additional properties are allowed and do not have to follow a specific schema

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

@@ -0,0 +1,3 @@
+## $defs Type
+
+unknown