@planning-inspectorate/data-model 1.20.0 → 1.22.0

package/docs/README.md

@@ -34,7 +34,7 @@
 
 * [NSIP Project Update](./nsip-project-update.md "NSIP Project Update (formerly known as Banners)") – `nsip-project-update.schema.json`
 
-* [PINS Inspector](./pins-inspector.md "Inspector attributes as per Horizon") – `pins-inspector.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`
 
@@ -52,8 +52,12 @@
 
 * [Untitled object in Appeal HAS Case](./appeal-has-properties-neighbouringsiteaddresses-items.md) – `appeal-has.schema.json#/properties/neighbouringSiteAddresses/items`
 
+* [Untitled object in Appeal HAS Case](./appeal-has-properties-advertdetails-items.md) – `appeal-has.schema.json#/properties/advertDetails/items`
+
 * [Untitled object in Appeal S78 Case](./appeal-s78-properties-neighbouringsiteaddresses-items.md) – `appeal-s78.schema.json#/properties/neighbouringSiteAddresses/items`
 
+* [Untitled object in Appeal S78 Case](./appeal-s78-properties-advertdetails-items.md) – `appeal-s78.schema.json#/properties/advertDetails/items`
+
 * [Untitled object in DaRT API response](./dart-response-properties-neighbouringsiteaddresses-items.md) – `dart-response.schema.json#/properties/neighbouringSiteAddresses/items`
 
 * [Untitled object in Examination Timetable](./nsip-exam-timetable-defs-event.md) – `nsip-exam-timetable.schema.json#/$defs/event`
@@ -64,6 +68,10 @@
 
 * [Untitled object in NSIP Project](./nsip-project-defs-invoice.md "An invoice related to the project") – `nsip-project.schema.json#/$defs/invoice`
 
+* [Untitled object in PINS Inspector](./pins-inspector-properties-address.md) – `pins-inspector.schema.json#/properties/address`
+
+* [Untitled object in PINS Inspector](./pins-inspector-defs-specialism.md) – `pins-inspector.schema.json#/$defs/specialism`
+
 ### Arrays
 
 * [Untitled array in Appeal Representation](./appeal-representation-properties-documentids.md "An array of documentIds") – `appeal-representation.schema.json#/properties/documentIds`
@@ -96,6 +104,8 @@
 
 * [Untitled array in NSIP Project](./nsip-project-properties-invoices.md "Collection of invoices associated with this project") – `nsip-project.schema.json#/properties/invoices`
 
+* [Untitled array in PINS Inspector](./pins-inspector-properties-specialisms.md) – `pins-inspector.schema.json#/properties/specialisms`
+
 * [Untitled array in Representation](./nsip-representation-properties-attachmentids.md) – `nsip-representation.schema.json#/properties/attachmentIds`
 
 * [Untitled array in S51 Advice](./s51-advice-properties-attachmentids.md) – `s51-advice.schema.json#/properties/attachmentIds`

package/docs/appeal-has.md

@@ -111,11 +111,10 @@ any of
 | [siteGridReferenceEasting](#sitegridreferenceeasting)                                     | `string`  | Optional | can be null    | [Appeal HAS Case](appeal-has-properties-sitegridreferenceeasting.md "appeal-has.schema.json#/properties/siteGridReferenceEasting")                                     |
 | [siteGridReferenceNorthing](#sitegridreferencenorthing)                                   | `string`  | Optional | can be null    | [Appeal HAS Case](appeal-has-properties-sitegridreferencenorthing.md "appeal-has.schema.json#/properties/siteGridReferenceNorthing")                                   |
 | [hasLandownersPermission](#haslandownerspermission)                                       | `boolean` | Optional | can be null    | [Appeal HAS Case](appeal-has-properties-haslandownerspermission.md "appeal-has.schema.json#/properties/hasLandownersPermission")                                       |
-| [isAdvertInPosition](#isadvertinposition)                                                 | `boolean` | Optional | can be null    | [Appeal HAS Case](appeal-has-properties-isadvertinposition.md "appeal-has.schema.json#/properties/isAdvertInPosition")                                                 |
-| [isSiteInAreaOfSpecialControlAdverts](#issiteinareaofspecialcontroladverts)               | `boolean` | Optional | can be null    | [Appeal HAS Case](appeal-has-properties-issiteinareaofspecialcontroladverts.md "appeal-has.schema.json#/properties/isSiteInAreaOfSpecialControlAdverts")               |
 | [wasApplicationRefusedDueToHighwayOrTraffic](#wasapplicationrefusedduetohighwayortraffic) | `boolean` | Optional | can be null    | [Appeal HAS Case](appeal-has-properties-wasapplicationrefusedduetohighwayortraffic.md "appeal-has.schema.json#/properties/wasApplicationRefusedDueToHighwayOrTraffic") |
 | [didAppellantSubmitCompletePhotosAndPlans](#didappellantsubmitcompletephotosandplans)     | `boolean` | Optional | can be null    | [Appeal HAS Case](appeal-has-properties-didappellantsubmitcompletephotosandplans.md "appeal-has.schema.json#/properties/didAppellantSubmitCompletePhotosAndPlans")     |
-| [advertType](#adverttype)                                                                 | `string`  | Optional | can be null    | [Appeal HAS Case](appeal-has-properties-adverttype.md "appeal-has.schema.json#/properties/advertType")                                                                 |
+| [isSiteInAreaOfSpecialControlAdverts](#issiteinareaofspecialcontroladverts)               | `boolean` | Optional | can be null    | [Appeal HAS Case](appeal-has-properties-issiteinareaofspecialcontroladverts.md "appeal-has.schema.json#/properties/isSiteInAreaOfSpecialControlAdverts")               |
+| [advertDetails](#advertdetails)                                                           | `array`   | Optional | can be null    | [Appeal HAS Case](appeal-has-properties-advertdetails.md "appeal-has.schema.json#/properties/advertDetails")                                                           |
 | Additional Properties                                                                     | Any       | Optional | can be null    |                                                                                                                                                                        |
 
 ## caseId
@@ -2487,10 +2486,10 @@ Indicates if the appellant has applied for costs
 **pattern**: the string must match the following regular expression: 
 
 ```regexp
-^\d{6}$
+^\d{6,7}$
 ```
 
-[try pattern](https://regexr.com/?expression=%5E%5Cd%7B6%7D%24 "try regular expression with regexr.com")
+[try pattern](https://regexr.com/?expression=%5E%5Cd%7B6%2C7%7D%24 "try regular expression with regexr.com")
 
 ### siteGridReferenceEasting Examples
 
@@ -2521,10 +2520,10 @@ Indicates if the appellant has applied for costs
 **pattern**: the string must match the following regular expression: 
 
 ```regexp
-^\d{6}$
+^\d{6,7}$
 ```
 
-[try pattern](https://regexr.com/?expression=%5E%5Cd%7B6%7D%24 "try regular expression with regexr.com")
+[try pattern](https://regexr.com/?expression=%5E%5Cd%7B6%2C7%7D%24 "try regular expression with regexr.com")
 
 ### siteGridReferenceNorthing Examples
 
@@ -2534,7 +2533,7 @@ Indicates if the appellant has applied for costs
 
 ## hasLandownersPermission
 
-Indicates if the appellant has land owners permission
+Does the appellant have the landowners permission
 
 `hasLandownersPermission`
 
@@ -2550,29 +2549,11 @@ Indicates if the appellant has land owners permission
 
 `boolean`
 
-## isAdvertInPosition
-
-Indicates if the advert is already in position
-
-`isAdvertInPosition`
-
-* is optional
-
-* Type: `boolean`
-
-* can be null
-
-* defined in: [Appeal HAS Case](appeal-has-properties-isadvertinposition.md "appeal-has.schema.json#/properties/isAdvertInPosition")
-
-### isAdvertInPosition Type
-
-`boolean`
-
-## isSiteInAreaOfSpecialControlAdverts
+## wasApplicationRefusedDueToHighwayOrTraffic
 
-Indicates if the site is in an area of special control for adverts
+Did the LPA refuse the application because of highway or traffic public safety?
 
-`isSiteInAreaOfSpecialControlAdverts`
+`wasApplicationRefusedDueToHighwayOrTraffic`
 
 * is optional
 
@@ -2580,17 +2561,17 @@ Indicates if the site is in an area of special control for adverts
 
 * can be null
 
-* defined in: [Appeal HAS Case](appeal-has-properties-issiteinareaofspecialcontroladverts.md "appeal-has.schema.json#/properties/isSiteInAreaOfSpecialControlAdverts")
+* defined in: [Appeal HAS Case](appeal-has-properties-wasapplicationrefusedduetohighwayortraffic.md "appeal-has.schema.json#/properties/wasApplicationRefusedDueToHighwayOrTraffic")
 
-### isSiteInAreaOfSpecialControlAdverts Type
+### wasApplicationRefusedDueToHighwayOrTraffic Type
 
 `boolean`
 
-## wasApplicationRefusedDueToHighwayOrTraffic
+## didAppellantSubmitCompletePhotosAndPlans
 
-Indicates if the application was refused because of highway or traffic public safety?
+Did the appellant submit complete photos and plans?
 
-`wasApplicationRefusedDueToHighwayOrTraffic`
+`didAppellantSubmitCompletePhotosAndPlans`
 
 * is optional
 
@@ -2598,17 +2579,17 @@ Indicates if the application was refused because of highway or traffic public sa
 
 * can be null
 
-* defined in: [Appeal HAS Case](appeal-has-properties-wasapplicationrefusedduetohighwayortraffic.md "appeal-has.schema.json#/properties/wasApplicationRefusedDueToHighwayOrTraffic")
+* defined in: [Appeal HAS Case](appeal-has-properties-didappellantsubmitcompletephotosandplans.md "appeal-has.schema.json#/properties/didAppellantSubmitCompletePhotosAndPlans")
 
-### wasApplicationRefusedDueToHighwayOrTraffic Type
+### didAppellantSubmitCompletePhotosAndPlans Type
 
 `boolean`
 
-## didAppellantSubmitCompletePhotosAndPlans
+## isSiteInAreaOfSpecialControlAdverts
 
-Indicates if the appellant submitted complete and accurate photographs and plans
+Is the site in an area of special control of advertisements?
 
-`didAppellantSubmitCompletePhotosAndPlans`
+`isSiteInAreaOfSpecialControlAdverts`
 
 * is optional
 
@@ -2616,31 +2597,31 @@ Indicates if the appellant submitted complete and accurate photographs and plans
 
 * can be null
 
-* defined in: [Appeal HAS Case](appeal-has-properties-didappellantsubmitcompletephotosandplans.md "appeal-has.schema.json#/properties/didAppellantSubmitCompletePhotosAndPlans")
+* defined in: [Appeal HAS Case](appeal-has-properties-issiteinareaofspecialcontroladverts.md "appeal-has.schema.json#/properties/isSiteInAreaOfSpecialControlAdverts")
 
-### didAppellantSubmitCompletePhotosAndPlans Type
+### isSiteInAreaOfSpecialControlAdverts Type
 
 `boolean`
 
-## advertType
-
+## advertDetails
 
+A list of advertisements for the appeal
 
-> Pick from a TBD list of reference data for advert type
+> Also available on CAS Adverts (ZA) cases
 
-`advertType`
+`advertDetails`
 
 * is optional
 
-* Type: `string`
+* Type: `object[]` ([Details](appeal-has-properties-advertdetails-items.md))
 
 * can be null
 
-* defined in: [Appeal HAS Case](appeal-has-properties-adverttype.md "appeal-has.schema.json#/properties/advertType")
+* defined in: [Appeal HAS Case](appeal-has-properties-advertdetails.md "appeal-has.schema.json#/properties/advertDetails")
 
-### advertType Type
+### advertDetails Type
 
-`string`
+`object[]` ([Details](appeal-has-properties-advertdetails-items.md))
 
 ## Additional Properties