@planning-inspectorate/data-model 1.11.0

package/docs/nsip-subscription.md

@@ -0,0 +1,193 @@
+## nsip-subscription Type
+
+`object` ([nsip-subscription](nsip-subscription.md))
+
+# nsip-subscription Properties
+
+| Property                              | Type      | Required | Nullable       | Defined by                                                                                                                         |
+| :------------------------------------ | :-------- | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------------------------- |
+| [subscriptionId](#subscriptionid)     | `integer` | Required | can be null    | [nsip-subscription](nsip-subscription-properties-subscriptionid.md "nsip-subscription.schema.json#/properties/subscriptionId")     |
+| [caseReference](#casereference)       | `string`  | Required | cannot be null | [nsip-subscription](nsip-subscription-properties-casereference.md "nsip-subscription.schema.json#/properties/caseReference")       |
+| [emailAddress](#emailaddress)         | `string`  | Required | cannot be null | [nsip-subscription](nsip-subscription-properties-emailaddress.md "nsip-subscription.schema.json#/properties/emailAddress")         |
+| [subscriptionType](#subscriptiontype) | `string`  | Required | cannot be null | [nsip-subscription](nsip-subscription-properties-subscriptiontype.md "nsip-subscription.schema.json#/properties/subscriptionType") |
+| [startDate](#startdate)               | `string`  | Required | can be null    | [nsip-subscription](nsip-subscription-properties-startdate.md "nsip-subscription.schema.json#/properties/startDate")               |
+| [endDate](#enddate)                   | `string`  | Required | can be null    | [nsip-subscription](nsip-subscription-properties-enddate.md "nsip-subscription.schema.json#/properties/endDate")                   |
+| [language](#language)                 | `string`  | Required | can be null    | [nsip-subscription](nsip-subscription-properties-language.md "nsip-subscription.schema.json#/properties/language")                 |
+| Additional Properties                 | Any       | Optional | can be null    |                                                                                                                                    |
+
+## subscriptionId
+
+The unique identifier within the Back Office. Ignored as part of register-nsip-subscription.
+
+`subscriptionId`
+
+* is required
+
+* Type: `integer`
+
+* can be null
+
+* defined in: [nsip-subscription](nsip-subscription-properties-subscriptionid.md "nsip-subscription.schema.json#/properties/subscriptionId")
+
+### subscriptionId Type
+
+`integer`
+
+## caseReference
+
+the case reference the subscription relates to
+
+`caseReference`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [nsip-subscription](nsip-subscription-properties-casereference.md "nsip-subscription.schema.json#/properties/caseReference")
+
+### caseReference Type
+
+`string`
+
+## emailAddress
+
+
+
+`emailAddress`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [nsip-subscription](nsip-subscription-properties-emailaddress.md "nsip-subscription.schema.json#/properties/emailAddress")
+
+### emailAddress Type
+
+`string`
+
+### emailAddress Constraints
+
+**email**: the string must be an email address, according to [RFC 5322, section 3.4.1](https://tools.ietf.org/html/rfc5322 "check the specification")
+
+### emailAddress Examples
+
+```json
+"alan.turing@planninginspectorate.gov.uk"
+```
+
+## subscriptionType
+
+which update does the subscriber want to get notified of. For multiple types, use multiple messages.
+
+`subscriptionType`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [nsip-subscription](nsip-subscription-properties-subscriptiontype.md "nsip-subscription.schema.json#/properties/subscriptionType")
+
+### subscriptionType Type
+
+`string`
+
+### subscriptionType Constraints
+
+**enum**: the value of this property must be equal to one of the following values:
+
+| Value                    | Explanation |
+| :----------------------- | :---------- |
+| `"allUpdates"`           |             |
+| `"applicationSubmitted"` |             |
+| `"applicationDecided"`   |             |
+| `"registrationOpen"`     |             |
+
+## startDate
+
+The date to start getting updates
+
+`startDate`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [nsip-subscription](nsip-subscription-properties-startdate.md "nsip-subscription.schema.json#/properties/startDate")
+
+### startDate Type
+
+`string`
+
+### startDate Constraints
+
+**date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
+
+## endDate
+
+The date to stop getting updates
+
+`endDate`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [nsip-subscription](nsip-subscription-properties-enddate.md "nsip-subscription.schema.json#/properties/endDate")
+
+### endDate Type
+
+`string`
+
+### endDate Constraints
+
+**date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
+
+## language
+
+
+
+`language`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [nsip-subscription](nsip-subscription-properties-language.md "nsip-subscription.schema.json#/properties/language")
+
+### language Type
+
+`string`
+
+### language Constraints
+
+**enum**: the value of this property must be equal to one of the following values:
+
+| Value       | Explanation |
+| :---------- | :---------- |
+| `"English"` |             |
+| `"Welsh"`   |             |
+| `null`      |             |
+
+### language Default Value
+
+The default value is:
+
+```json
+"English"
+```
+
+## Additional Properties
+
+Additional properties are allowed and do not have to follow a specific schema

package/docs/pins-inspector.md

@@ -0,0 +1,184 @@
+## PINS Inspector Type
+
+`object` ([PINS Inspector](pins-inspector.md))
+
+# PINS Inspector Properties
+
+| Property                              | Type     | Required | Nullable       | Defined by                                                                                                                |
+| :------------------------------------ | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------ |
+| [horizonId](#horizonid)               | `string` | Required | cannot be null | [PINS Inspector](pins-inspector-properties-horizonid.md "pins-inspector.schema.json#/properties/horizonId")               |
+| [firstName](#firstname)               | `string` | Required | cannot be null | [PINS Inspector](pins-inspector-properties-firstname.md "pins-inspector.schema.json#/properties/firstName")               |
+| [lastName](#lastname)                 | `string` | Required | cannot be null | [PINS Inspector](pins-inspector-properties-lastname.md "pins-inspector.schema.json#/properties/lastName")                 |
+| [postName](#postname)                 | `string` | Optional | can be null    | [PINS Inspector](pins-inspector-properties-postname.md "pins-inspector.schema.json#/properties/postName")                 |
+| [organisationName](#organisationname) | `string` | Optional | can be null    | [PINS Inspector](pins-inspector-properties-organisationname.md "pins-inspector.schema.json#/properties/organisationName") |
+| [title](#title)                       | `string` | Optional | can be null    | [PINS Inspector](pins-inspector-properties-title.md "pins-inspector.schema.json#/properties/title")                       |
+| [salutation](#salutation)             | `string` | Optional | can be null    | [PINS Inspector](pins-inspector-properties-salutation.md "pins-inspector.schema.json#/properties/salutation")             |
+| [qualifications](#qualifications)     | `string` | Optional | can be null    | [PINS Inspector](pins-inspector-properties-qualifications.md "pins-inspector.schema.json#/properties/qualifications")     |
+| [email](#email)                       | `string` | Required | can be null    | [PINS Inspector](pins-inspector-properties-email.md "pins-inspector.schema.json#/properties/email")                       |
+| Additional Properties                 | Any      | Optional | can be null    |                                                                                                                           |
+
+## horizonId
+
+The PINS-generated unique horizon ID
+
+`horizonId`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [PINS Inspector](pins-inspector-properties-horizonid.md "pins-inspector.schema.json#/properties/horizonId")
+
+### horizonId Type
+
+`string`
+
+## firstName
+
+The first name of the inspector
+
+`firstName`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [PINS Inspector](pins-inspector-properties-firstname.md "pins-inspector.schema.json#/properties/firstName")
+
+### firstName Type
+
+`string`
+
+## lastName
+
+The last name of the inspector
+
+`lastName`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [PINS Inspector](pins-inspector-properties-lastname.md "pins-inspector.schema.json#/properties/lastName")
+
+### lastName Type
+
+`string`
+
+## postName
+
+The post name of the inspector
+
+`postName`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [PINS Inspector](pins-inspector-properties-postname.md "pins-inspector.schema.json#/properties/postName")
+
+### postName Type
+
+`string`
+
+## organisationName
+
+The organisation name of the inspector
+
+`organisationName`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [PINS Inspector](pins-inspector-properties-organisationname.md "pins-inspector.schema.json#/properties/organisationName")
+
+### organisationName Type
+
+`string`
+
+## title
+
+The title of the inspector
+
+`title`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [PINS Inspector](pins-inspector-properties-title.md "pins-inspector.schema.json#/properties/title")
+
+### title Type
+
+`string`
+
+## salutation
+
+The salutation of the inspector
+
+`salutation`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [PINS Inspector](pins-inspector-properties-salutation.md "pins-inspector.schema.json#/properties/salutation")
+
+### salutation Type
+
+`string`
+
+## qualifications
+
+The qualifications of the inspector
+
+`qualifications`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [PINS Inspector](pins-inspector-properties-qualifications.md "pins-inspector.schema.json#/properties/qualifications")
+
+### qualifications Type
+
+`string`
+
+## email
+
+The email address of the inspector
+
+`email`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [PINS Inspector](pins-inspector-properties-email.md "pins-inspector.schema.json#/properties/email")
+
+### email Type
+
+`string`
+
+## Additional Properties
+
+Additional properties are allowed and do not have to follow a specific schema

package/docs/pins-lpa.md

@@ -0,0 +1,260 @@
+## PINS LPA Type
+
+`object` ([PINS LPA](pins-lpa.md))
+
+# PINS LPA Properties
+
+| Property                              | Type     | Required | Nullable       | Defined by                                                                                              |
+| :------------------------------------ | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------ |
+| [lpaName](#lpaname)                   | `string` | Required | cannot be null | [PINS LPA](pins-lpa-properties-lpaname.md "pins-lpa.schema.json#/properties/lpaName")                   |
+| [organisationType](#organisationtype) | `string` | Optional | cannot be null | [PINS LPA](pins-lpa-properties-organisationtype.md "pins-lpa.schema.json#/properties/organisationType") |
+| [pinsLpaCode](#pinslpacode)           | `string` | Required | cannot be null | [PINS LPA](pins-lpa-properties-pinslpacode.md "pins-lpa.schema.json#/properties/pinsLpaCode")           |
+| [poBox](#pobox)                       | `string` | Optional | can be null    | [PINS LPA](pins-lpa-properties-pobox.md "pins-lpa.schema.json#/properties/poBox")                       |
+| [address1](#address1)                 | `string` | Optional | can be null    | [PINS LPA](pins-lpa-properties-address1.md "pins-lpa.schema.json#/properties/address1")                 |
+| [address2](#address2)                 | `string` | Optional | can be null    | [PINS LPA](pins-lpa-properties-address2.md "pins-lpa.schema.json#/properties/address2")                 |
+| [city](#city)                         | `string` | Optional | can be null    | [PINS LPA](pins-lpa-properties-city.md "pins-lpa.schema.json#/properties/city")                         |
+| [county](#county)                     | `string` | Optional | can be null    | [PINS LPA](pins-lpa-properties-county.md "pins-lpa.schema.json#/properties/county")                     |
+| [postcode](#postcode)                 | `string` | Optional | can be null    | [PINS LPA](pins-lpa-properties-postcode.md "pins-lpa.schema.json#/properties/postcode")                 |
+| [country](#country)                   | `string` | Optional | can be null    | [PINS LPA](pins-lpa-properties-country.md "pins-lpa.schema.json#/properties/country")                   |
+| [telephoneNumber](#telephonenumber)   | `string` | Optional | can be null    | [PINS LPA](pins-lpa-properties-telephonenumber.md "pins-lpa.schema.json#/properties/telephoneNumber")   |
+| [fax](#fax)                           | `string` | Optional | can be null    | [PINS LPA](pins-lpa-properties-fax.md "pins-lpa.schema.json#/properties/fax")                           |
+| [emailAddress](#emailaddress)         | `string` | Optional | can be null    | [PINS LPA](pins-lpa-properties-emailaddress.md "pins-lpa.schema.json#/properties/emailAddress")         |
+| Additional Properties                 | Any      | Optional | can be null    |                                                                                                         |
+
+## lpaName
+
+The PINS name of the LPA
+
+`lpaName`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [PINS LPA](pins-lpa-properties-lpaname.md "pins-lpa.schema.json#/properties/lpaName")
+
+### lpaName Type
+
+`string`
+
+## organisationType
+
+The organisation type of the LPA
+
+`organisationType`
+
+* is optional
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [PINS LPA](pins-lpa-properties-organisationtype.md "pins-lpa.schema.json#/properties/organisationType")
+
+### organisationType Type
+
+`string`
+
+## pinsLpaCode
+
+The PINS-generated unqiue LPA code
+
+`pinsLpaCode`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [PINS LPA](pins-lpa-properties-pinslpacode.md "pins-lpa.schema.json#/properties/pinsLpaCode")
+
+### pinsLpaCode Type
+
+`string`
+
+## poBox
+
+LPA address Post Office Box
+
+`poBox`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [PINS LPA](pins-lpa-properties-pobox.md "pins-lpa.schema.json#/properties/poBox")
+
+### poBox Type
+
+`string`
+
+## address1
+
+First line of LPA address
+
+`address1`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [PINS LPA](pins-lpa-properties-address1.md "pins-lpa.schema.json#/properties/address1")
+
+### address1 Type
+
+`string`
+
+## address2
+
+Second line of LPA address
+
+`address2`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [PINS LPA](pins-lpa-properties-address2.md "pins-lpa.schema.json#/properties/address2")
+
+### address2 Type
+
+`string`
+
+## city
+
+LPA address city or town
+
+`city`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [PINS LPA](pins-lpa-properties-city.md "pins-lpa.schema.json#/properties/city")
+
+### city Type
+
+`string`
+
+## county
+
+LPA address county
+
+`county`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [PINS LPA](pins-lpa-properties-county.md "pins-lpa.schema.json#/properties/county")
+
+### county Type
+
+`string`
+
+## postcode
+
+LPA address postcode
+
+`postcode`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [PINS LPA](pins-lpa-properties-postcode.md "pins-lpa.schema.json#/properties/postcode")
+
+### postcode Type
+
+`string`
+
+## country
+
+LPA address country
+
+`country`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [PINS LPA](pins-lpa-properties-country.md "pins-lpa.schema.json#/properties/country")
+
+### country Type
+
+`string`
+
+## telephoneNumber
+
+LPA telephine number
+
+`telephoneNumber`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [PINS LPA](pins-lpa-properties-telephonenumber.md "pins-lpa.schema.json#/properties/telephoneNumber")
+
+### telephoneNumber Type
+
+`string`
+
+## fax
+
+LPA fax number
+
+`fax`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [PINS LPA](pins-lpa-properties-fax.md "pins-lpa.schema.json#/properties/fax")
+
+### fax Type
+
+`string`
+
+## emailAddress
+
+LPA email address
+
+`emailAddress`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [PINS LPA](pins-lpa-properties-emailaddress.md "pins-lpa.schema.json#/properties/emailAddress")
+
+### emailAddress Type
+
+`string`
+
+## Additional Properties
+
+Additional properties are allowed and do not have to follow a specific schema