@planning-inspectorate/data-model 1.11.0

package/docs/interested-party.md

@@ -0,0 +1,284 @@
+## interested-party Type
+
+`object` ([interested-party](interested-party.md))
+
+# interested-party Properties
+
+| Property                                        | Type      | Required | Nullable       | Defined by                                                                                                                                |
+| :---------------------------------------------- | :-------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------- |
+| [id](#id)                                       | `number`  | Optional | cannot be null | [interested-party](interested-party-properties-id.md "interested-party.schema.json#/properties/id")                                       |
+| [interestedPartyNumber](#interestedpartynumber) | `string`  | Optional | cannot be null | [interested-party](interested-party-properties-interestedpartynumber.md "interested-party.schema.json#/properties/interestedPartyNumber") |
+| [firstName](#firstname)                         | `string`  | Optional | cannot be null | [interested-party](interested-party-properties-firstname.md "interested-party.schema.json#/properties/firstName")                         |
+| [lastName](#lastname)                           | `string`  | Optional | cannot be null | [interested-party](interested-party-properties-lastname.md "interested-party.schema.json#/properties/lastName")                           |
+| [under18](#under18)                             | `boolean` | Optional | cannot be null | [interested-party](interested-party-properties-under18.md "interested-party.schema.json#/properties/under18")                             |
+| [organisationName](#organisationname)           | `string`  | Optional | cannot be null | [interested-party](interested-party-properties-name.md "interested-party.schema.json#/properties/organisationName")                       |
+| [jobTitle](#jobtitle)                           | `string`  | Optional | cannot be null | [interested-party](interested-party-properties-jobtitle.md "interested-party.schema.json#/properties/jobTitle")                           |
+| [contactMethod](#contactmethod)                 | `string`  | Optional | cannot be null | [interested-party](interested-party-properties-contactmethod.md "interested-party.schema.json#/properties/contactMethod")                 |
+| [email](#email)                                 | `string`  | Optional | cannot be null | [interested-party](interested-party-properties-email.md "interested-party.schema.json#/properties/email")                                 |
+| [phoneNumber](#phonenumber)                     | `string`  | Optional | cannot be null | [interested-party](interested-party-properties-phonenumber.md "interested-party.schema.json#/properties/phoneNumber")                     |
+| [address](#address)                             | `object`  | Optional | cannot be null | [interested-party](interested-party-properties-address.md "interested-party.schema.json#/properties/address")                             |
+
+## id
+
+
+
+`id`
+
+*   is optional
+
+*   Type: `number`
+
+*   cannot be null
+
+*   defined in: [interested-party](interested-party-properties-id.md "interested-party.schema.json#/properties/id")
+
+### id Type
+
+`number`
+
+### id Examples
+
+```json
+18
+```
+
+## interestedPartyNumber
+
+
+
+`interestedPartyNumber`
+
+*   is optional
+
+*   Type: `string`
+
+*   cannot be null
+
+*   defined in: [interested-party](interested-party-properties-interestedpartynumber.md "interested-party.schema.json#/properties/interestedPartyNumber")
+
+### interestedPartyNumber Type
+
+`string`
+
+### interestedPartyNumber Examples
+
+```json
+"IP1234"
+```
+
+## firstName
+
+
+
+`firstName`
+
+*   is optional
+
+*   Type: `string`
+
+*   cannot be null
+
+*   defined in: [interested-party](interested-party-properties-firstname.md "interested-party.schema.json#/properties/firstName")
+
+### firstName Type
+
+`string`
+
+### firstName Examples
+
+```json
+"Alan"
+```
+
+## lastName
+
+
+
+`lastName`
+
+*   is optional
+
+*   Type: `string`
+
+*   cannot be null
+
+*   defined in: [interested-party](interested-party-properties-lastname.md "interested-party.schema.json#/properties/lastName")
+
+### lastName Type
+
+`string`
+
+### lastName Examples
+
+```json
+"Turing"
+```
+
+## under18
+
+
+
+`under18`
+
+*   is optional
+
+*   Type: `boolean`
+
+*   cannot be null
+
+*   defined in: [interested-party](interested-party-properties-under18.md "interested-party.schema.json#/properties/under18")
+
+### under18 Type
+
+`boolean`
+
+## organisationName
+
+
+
+`organisationName`
+
+*   is optional
+
+*   Type: `string` ([Name](interested-party-properties-name.md))
+
+*   cannot be null
+
+*   defined in: [interested-party](interested-party-properties-name.md "interested-party.schema.json#/properties/organisationName")
+
+### organisationName Type
+
+`string` ([Name](interested-party-properties-name.md))
+
+### organisationName Constraints
+
+**pattern**: the string must match the following regular expression: 
+
+```regexp
+^.*$
+```
+
+[try pattern](https://regexr.com/?expression=%5E.*%24 "try regular expression with regexr.com")
+
+### organisationName Examples
+
+```json
+"National Highways"
+```
+
+## jobTitle
+
+
+
+`jobTitle`
+
+*   is optional
+
+*   Type: `string`
+
+*   cannot be null
+
+*   defined in: [interested-party](interested-party-properties-jobtitle.md "interested-party.schema.json#/properties/jobTitle")
+
+### jobTitle Type
+
+`string`
+
+### jobTitle Examples
+
+```json
+"Communications Manager"
+```
+
+## contactMethod
+
+
+
+`contactMethod`
+
+*   is optional
+
+*   Type: `string`
+
+*   cannot be null
+
+*   defined in: [interested-party](interested-party-properties-contactmethod.md "interested-party.schema.json#/properties/contactMethod")
+
+### contactMethod Type
+
+`string`
+
+### contactMethod Constraints
+
+**enum**: the value of this property must be equal to one of the following values:
+
+| Value     | Explanation |
+| :-------- | :---------- |
+| `"email"` |             |
+| `"post"`  |             |
+
+## email
+
+
+
+`email`
+
+*   is optional
+
+*   Type: `string`
+
+*   cannot be null
+
+*   defined in: [interested-party](interested-party-properties-email.md "interested-party.schema.json#/properties/email")
+
+### email Type
+
+`string`
+
+### email Examples
+
+```json
+"alan.turing@planninginspectorate.gov.uk"
+```
+
+## phoneNumber
+
+
+
+`phoneNumber`
+
+*   is optional
+
+*   Type: `string`
+
+*   cannot be null
+
+*   defined in: [interested-party](interested-party-properties-phonenumber.md "interested-party.schema.json#/properties/phoneNumber")
+
+### phoneNumber Type
+
+`string`
+
+### phoneNumber Examples
+
+```json
+"0137732432"
+```
+
+## address
+
+
+
+`address`
+
+*   is optional
+
+*   Type: `object` ([Address](interested-party-properties-address.md))
+
+*   cannot be null
+
+*   defined in: [interested-party](interested-party-properties-address.md "interested-party.schema.json#/properties/address")
+
+### address Type
+
+`object` ([Address](interested-party-properties-address.md))

package/docs/listed-building.md

@@ -0,0 +1,113 @@
+## Listed Building Type
+
+`object` ([Listed Building](listed-building.md))
+
+# Listed Building Properties
+
+| Property                                    | Type      | Required | Nullable       | Defined by                                                                                                                         |
+| :------------------------------------------ | :-------- | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------------------------- |
+| [entity](#entity)                           | `integer` | Required | cannot be null | [Listed Building](listed-building-properties-entity.md "listed-building.schema.json#/properties/entity")                           |
+| [reference](#reference)                     | `string`  | Required | cannot be null | [Listed Building](listed-building-properties-reference.md "listed-building.schema.json#/properties/reference")                     |
+| [name](#name)                               | `string`  | Required | cannot be null | [Listed Building](listed-building-properties-name.md "listed-building.schema.json#/properties/name")                               |
+| [listedBuildingGrade](#listedbuildinggrade) | `string`  | Required | cannot be null | [Listed Building](listed-building-properties-listedbuildinggrade.md "listed-building.schema.json#/properties/listedBuildingGrade") |
+| Additional Properties                       | Any       | Optional | can be null    |                                                                                                                                    |
+
+## entity
+
+A unique identifier for the listed building.
+
+`entity`
+
+* is required
+
+* Type: `integer`
+
+* cannot be null
+
+* defined in: [Listed Building](listed-building-properties-entity.md "listed-building.schema.json#/properties/entity")
+
+### entity Type
+
+`integer`
+
+### entity Examples
+
+```json
+"31717222"
+```
+
+## reference
+
+Reference number for the listed buildign
+
+`reference`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [Listed Building](listed-building-properties-reference.md "listed-building.schema.json#/properties/reference")
+
+### reference Type
+
+`string`
+
+### reference Examples
+
+```json
+"1260842"
+```
+
+## name
+
+Name of listed building
+
+`name`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [Listed Building](listed-building-properties-name.md "listed-building.schema.json#/properties/name")
+
+### name Type
+
+`string`
+
+### name Examples
+
+```json
+"41A, NEWBIGGIN"
+```
+
+## listedBuildingGrade
+
+Grade assigned to the listing.
+
+`listedBuildingGrade`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [Listed Building](listed-building-properties-listedbuildinggrade.md "listed-building.schema.json#/properties/listedBuildingGrade")
+
+### listedBuildingGrade Type
+
+`string`
+
+### listedBuildingGrade Examples
+
+```json
+"II"
+```
+
+## Additional Properties
+
+Additional properties are allowed and do not have to follow a specific schema

package/docs/listed-buildings.md

@@ -0,0 +1,113 @@
+## Listed Buildings Type
+
+`object` ([Listed Buildings](listed-buildings.md))
+
+# Listed Buildings Properties
+
+| Property                                    | Type      | Required | Nullable       | Defined by                                                                                                                            |
+| :------------------------------------------ | :-------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------ |
+| [entity](#entity)                           | `integer` | Required | cannot be null | [Listed Buildings](listed-buildings-properties-entity.md "listed-buildings.schema.json#/properties/entity")                           |
+| [reference](#reference)                     | `string`  | Required | cannot be null | [Listed Buildings](listed-buildings-properties-reference.md "listed-buildings.schema.json#/properties/reference")                     |
+| [name](#name)                               | `string`  | Required | cannot be null | [Listed Buildings](listed-buildings-properties-name.md "listed-buildings.schema.json#/properties/name")                               |
+| [listedBuildingGrade](#listedbuildinggrade) | `string`  | Required | cannot be null | [Listed Buildings](listed-buildings-properties-listedbuildinggrade.md "listed-buildings.schema.json#/properties/listedBuildingGrade") |
+| Additional Properties                       | Any       | Optional | can be null    |                                                                                                                                       |
+
+## entity
+
+A unique identifier for the listed building.
+
+`entity`
+
+* is required
+
+* Type: `integer`
+
+* cannot be null
+
+* defined in: [Listed Buildings](listed-buildings-properties-entity.md "listed-buildings.schema.json#/properties/entity")
+
+### entity Type
+
+`integer`
+
+### entity Examples
+
+```json
+"31717222"
+```
+
+## reference
+
+Reference number for the listed buildign
+
+`reference`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [Listed Buildings](listed-buildings-properties-reference.md "listed-buildings.schema.json#/properties/reference")
+
+### reference Type
+
+`string`
+
+### reference Examples
+
+```json
+"1260842"
+```
+
+## name
+
+Name of listed building
+
+`name`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [Listed Buildings](listed-buildings-properties-name.md "listed-buildings.schema.json#/properties/name")
+
+### name Type
+
+`string`
+
+### name Examples
+
+```json
+"41A, NEWBIGGIN"
+```
+
+## listedBuildingGrade
+
+Grade assigned to the listing.
+
+`listedBuildingGrade`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [Listed Buildings](listed-buildings-properties-listedbuildinggrade.md "listed-buildings.schema.json#/properties/listedBuildingGrade")
+
+### listedBuildingGrade Type
+
+`string`
+
+### listedBuildingGrade Examples
+
+```json
+"II"
+```
+
+## Additional Properties
+
+Additional properties are allowed and do not have to follow a specific schema