@planning-inspectorate/data-model 2.55.0 → 2.57.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/README.md +4 -2
- package/docs/address.md +67 -48
- package/docs/appeal-document.md +2 -0
- package/docs/appeal-group-c.md +1415 -0
- package/docs/appeal-s78.md +8 -0
- package/docs/applications-crowndev-application-defs-address.md +29 -10
- package/docs/applications-crowndev-application.md +29 -10
- package/package.json +2 -2
- package/pins_data_model/models/model_address.py +7 -3
- package/pins_data_model/models/model_appeal_document.py +2 -0
- package/pins_data_model/models/model_appeal_group_c.py +453 -0
- package/pins_data_model/models/model_appeal_s78.py +8 -0
- package/pins_data_model/models/model_applications_crowndev_application.py +5 -1
- package/schemas/address.schema.json +9 -4
- package/schemas/appeal-document.schema.json +2 -0
- package/schemas/appeal-group-c.schema.json +385 -0
- package/schemas/appeal-s78.schema.json +8 -0
- package/schemas/applications-crowndev-application.schema.json +6 -2
- package/src/enums.cjs +40 -0
- package/src/enums.d.ts +38 -0
- package/src/enums.js +38 -0
- package/src/index.cjs +40 -0
- package/src/schemas.d.ts +296 -5
- package/tests/appeals/appeal-group-c.test.js +342 -0
package/docs/README.md
CHANGED
|
@@ -2,12 +2,16 @@
|
|
|
2
2
|
|
|
3
3
|
## Top-level Schemas
|
|
4
4
|
|
|
5
|
+
* [Address](./address.md "A schema to define the structure of an Address object in PINS") – `address.schema.json`
|
|
6
|
+
|
|
5
7
|
* [Appeal Document](./appeal-document.md "Schema defining the metadata for appeal documents") – `appeal-document.schema.json`
|
|
6
8
|
|
|
7
9
|
* [Appeal Event](./appeal-event.md "Schema defining the metadata for appeal events, such as site visits, inquiries, hearings") – `appeal-event.schema.json`
|
|
8
10
|
|
|
9
11
|
* [Appeal Event Estimate](./appeal-event-estimate.md "All event estimates belong to a case") – `appeal-event-estimate.schema.json`
|
|
10
12
|
|
|
13
|
+
* [Appeal Group C Case](./appeal-group-c.md "Group C - Schema defining the metadata for generic and low-volume appeals") – `appeal-group-c.schema.json`
|
|
14
|
+
|
|
11
15
|
* [Appeal HAS Case](./appeal-has.md "Group A - Schema defining the metadata for an appeal") – `appeal-has.schema.json`
|
|
12
16
|
|
|
13
17
|
* [Appeal Representation](./appeal-representation.md "Schema defining the metadata for appeal representations, such as statements, third-party comments and final comments") – `appeal-representation.schema.json`
|
|
@@ -46,8 +50,6 @@
|
|
|
46
50
|
|
|
47
51
|
* [NSIP Project Update](./nsip-project-update.md "NSIP Project Update (formerly known as Banners)") – `nsip-project-update.schema.json`
|
|
48
52
|
|
|
49
|
-
* [PINS Address Schema](./address.md "A schema to define the structure of an Address object in PINS") – `address.schema.json`
|
|
50
|
-
|
|
51
53
|
* [PINS Inspector](./pins-inspector.md "Inspector Details originating from Horizon, SAP HR and Entra") – `pins-inspector.schema.json`
|
|
52
54
|
|
|
53
55
|
* [PINS LPA](./pins-lpa.md "Local Planning Authority (LPA) attributes as per Horizon") – `pins-lpa.schema.json`
|
package/docs/address.md
CHANGED
|
@@ -1,44 +1,63 @@
|
|
|
1
|
-
##
|
|
2
|
-
|
|
3
|
-
`object` ([
|
|
4
|
-
|
|
5
|
-
#
|
|
6
|
-
|
|
7
|
-
| Property | Type | Required | Nullable | Defined by
|
|
8
|
-
| :-------------------------------------- | :------------ | :------- | :------------- |
|
|
9
|
-
| [
|
|
10
|
-
| [
|
|
11
|
-
| [
|
|
12
|
-
| [
|
|
13
|
-
| [
|
|
14
|
-
| [
|
|
15
|
-
| [
|
|
16
|
-
| [
|
|
17
|
-
| [
|
|
18
|
-
| [
|
|
19
|
-
| [
|
|
20
|
-
| [
|
|
21
|
-
| [
|
|
22
|
-
| [
|
|
23
|
-
| [
|
|
24
|
-
| [
|
|
25
|
-
| [
|
|
26
|
-
| [
|
|
27
|
-
|
|
|
1
|
+
## Address Type
|
|
2
|
+
|
|
3
|
+
`object` ([Address](address.md))
|
|
4
|
+
|
|
5
|
+
# Address Properties
|
|
6
|
+
|
|
7
|
+
| Property | Type | Required | Nullable | Defined by |
|
|
8
|
+
| :-------------------------------------- | :------------ | :------- | :------------- | :----------------------------------------------------------------------------------------------------- |
|
|
9
|
+
| [addressId](#addressid) | `string` | Required | cannot be null | [Address](address-properties-addressid.md "address.schema.json#/properties/addressId") |
|
|
10
|
+
| [addressDimKey](#addressdimkey) | `number` | Optional | can be null | [Address](address-properties-addressdimkey.md "address.schema.json#/properties/addressDimKey") |
|
|
11
|
+
| [addressType](#addresstype) | `string` | Optional | cannot be null | [Address](address-properties-addresstype.md "address.schema.json#/properties/addressType") |
|
|
12
|
+
| [caseReference](#casereference) | `string` | Required | cannot be null | [Address](address-properties-casereference.md "address.schema.json#/properties/caseReference") |
|
|
13
|
+
| [caseId](#caseid) | `string` | Required | cannot be null | [Address](address-properties-caseid.md "address.schema.json#/properties/caseId") |
|
|
14
|
+
| [caseType](#casetype) | `string` | Required | cannot be null | [Address](address-properties-casetype.md "address.schema.json#/properties/caseType") |
|
|
15
|
+
| [description](#description) | `string` | Optional | can be null | [Address](address-properties-description.md "address.schema.json#/properties/description") |
|
|
16
|
+
| [line1](#line1) | `string` | Optional | can be null | [Address](address-properties-line1.md "address.schema.json#/properties/line1") |
|
|
17
|
+
| [line2](#line2) | `string` | Optional | can be null | [Address](address-properties-line2.md "address.schema.json#/properties/line2") |
|
|
18
|
+
| [townCity](#towncity) | `string` | Optional | can be null | [Address](address-properties-towncity.md "address.schema.json#/properties/townCity") |
|
|
19
|
+
| [county](#county) | `string` | Optional | can be null | [Address](address-properties-county.md "address.schema.json#/properties/county") |
|
|
20
|
+
| [postcode](#postcode) | `string` | Optional | can be null | [Address](address-properties-postcode.md "address.schema.json#/properties/postcode") |
|
|
21
|
+
| [country](#country) | `string` | Optional | can be null | [Address](address-properties-country.md "address.schema.json#/properties/country") |
|
|
22
|
+
| [easting](#easting) | `string` | Optional | can be null | [Address](address-properties-easting.md "address.schema.json#/properties/easting") |
|
|
23
|
+
| [northing](#northing) | `string` | Optional | can be null | [Address](address-properties-northing.md "address.schema.json#/properties/northing") |
|
|
24
|
+
| [latitudeWGS84](#latitudewgs84) | `number` | Optional | can be null | [Address](address-properties-latitudewgs84.md "address.schema.json#/properties/latitudeWGS84") |
|
|
25
|
+
| [longitudeWGS84](#longitudewgs84) | `number` | Optional | can be null | [Address](address-properties-longitudewgs84.md "address.schema.json#/properties/longitudeWGS84") |
|
|
26
|
+
| [UPRN](#uprn) | `string` | Optional | can be null | [Address](address-properties-uprn.md "address.schema.json#/properties/UPRN") |
|
|
27
|
+
| [dependentRequired](#dependentrequired) | Not specified | Optional | cannot be null | [Address](address-properties-dependentrequired.md "address.schema.json#/properties/dependentRequired") |
|
|
28
|
+
| Additional Properties | Any | Optional | can be null | |
|
|
29
|
+
|
|
30
|
+
## addressId
|
|
31
|
+
|
|
32
|
+
The source system Primary Key for an address.
|
|
33
|
+
|
|
34
|
+
`addressId`
|
|
35
|
+
|
|
36
|
+
* is required
|
|
37
|
+
|
|
38
|
+
* Type: `string`
|
|
39
|
+
|
|
40
|
+
* cannot be null
|
|
41
|
+
|
|
42
|
+
* defined in: [Address](address-properties-addressid.md "address.schema.json#/properties/addressId")
|
|
43
|
+
|
|
44
|
+
### addressId Type
|
|
45
|
+
|
|
46
|
+
`string`
|
|
28
47
|
|
|
29
48
|
## addressDimKey
|
|
30
49
|
|
|
31
|
-
|
|
50
|
+
ODW Address Dimension Primary Key.
|
|
32
51
|
|
|
33
52
|
`addressDimKey`
|
|
34
53
|
|
|
35
|
-
* is
|
|
54
|
+
* is optional
|
|
36
55
|
|
|
37
56
|
* Type: `number`
|
|
38
57
|
|
|
39
|
-
*
|
|
58
|
+
* can be null
|
|
40
59
|
|
|
41
|
-
* defined in: [
|
|
60
|
+
* defined in: [Address](address-properties-addressdimkey.md "address.schema.json#/properties/addressDimKey")
|
|
42
61
|
|
|
43
62
|
### addressDimKey Type
|
|
44
63
|
|
|
@@ -56,7 +75,7 @@ The type of thing this address is for.
|
|
|
56
75
|
|
|
57
76
|
* cannot be null
|
|
58
77
|
|
|
59
|
-
* defined in: [
|
|
78
|
+
* defined in: [Address](address-properties-addresstype.md "address.schema.json#/properties/addressType")
|
|
60
79
|
|
|
61
80
|
### addressType Type
|
|
62
81
|
|
|
@@ -85,7 +104,7 @@ Business Key for the related case
|
|
|
85
104
|
|
|
86
105
|
* cannot be null
|
|
87
106
|
|
|
88
|
-
* defined in: [
|
|
107
|
+
* defined in: [Address](address-properties-casereference.md "address.schema.json#/properties/caseReference")
|
|
89
108
|
|
|
90
109
|
### caseReference Type
|
|
91
110
|
|
|
@@ -103,7 +122,7 @@ The unique ID for the case this representation belongs to.
|
|
|
103
122
|
|
|
104
123
|
* cannot be null
|
|
105
124
|
|
|
106
|
-
* defined in: [
|
|
125
|
+
* defined in: [Address](address-properties-caseid.md "address.schema.json#/properties/caseId")
|
|
107
126
|
|
|
108
127
|
### caseId Type
|
|
109
128
|
|
|
@@ -121,7 +140,7 @@ The type of case this representation is for.
|
|
|
121
140
|
|
|
122
141
|
* cannot be null
|
|
123
142
|
|
|
124
|
-
* defined in: [
|
|
143
|
+
* defined in: [Address](address-properties-casetype.md "address.schema.json#/properties/caseType")
|
|
125
144
|
|
|
126
145
|
### caseType Type
|
|
127
146
|
|
|
@@ -139,7 +158,7 @@ Some sites may have a postcode, but do not have postal addresses.
|
|
|
139
158
|
|
|
140
159
|
* can be null
|
|
141
160
|
|
|
142
|
-
* defined in: [
|
|
161
|
+
* defined in: [Address](address-properties-description.md "address.schema.json#/properties/description")
|
|
143
162
|
|
|
144
163
|
### description Type
|
|
145
164
|
|
|
@@ -157,7 +176,7 @@ Some sites may have a postcode, but do not have postal addresses.
|
|
|
157
176
|
|
|
158
177
|
* can be null
|
|
159
178
|
|
|
160
|
-
* defined in: [
|
|
179
|
+
* defined in: [Address](address-properties-line1.md "address.schema.json#/properties/line1")
|
|
161
180
|
|
|
162
181
|
### line1 Type
|
|
163
182
|
|
|
@@ -175,7 +194,7 @@ Some sites may have a postcode, but do not have postal addresses.
|
|
|
175
194
|
|
|
176
195
|
* can be null
|
|
177
196
|
|
|
178
|
-
* defined in: [
|
|
197
|
+
* defined in: [Address](address-properties-line2.md "address.schema.json#/properties/line2")
|
|
179
198
|
|
|
180
199
|
### line2 Type
|
|
181
200
|
|
|
@@ -193,7 +212,7 @@ Some sites may have a postcode, but do not have postal addresses.
|
|
|
193
212
|
|
|
194
213
|
* can be null
|
|
195
214
|
|
|
196
|
-
* defined in: [
|
|
215
|
+
* defined in: [Address](address-properties-towncity.md "address.schema.json#/properties/townCity")
|
|
197
216
|
|
|
198
217
|
### townCity Type
|
|
199
218
|
|
|
@@ -211,7 +230,7 @@ Some sites may have a postcode, but do not have postal addresses.
|
|
|
211
230
|
|
|
212
231
|
* can be null
|
|
213
232
|
|
|
214
|
-
* defined in: [
|
|
233
|
+
* defined in: [Address](address-properties-county.md "address.schema.json#/properties/county")
|
|
215
234
|
|
|
216
235
|
### county Type
|
|
217
236
|
|
|
@@ -229,7 +248,7 @@ Some sites may have a postcode, but do not have postal addresses.
|
|
|
229
248
|
|
|
230
249
|
* can be null
|
|
231
250
|
|
|
232
|
-
* defined in: [
|
|
251
|
+
* defined in: [Address](address-properties-postcode.md "address.schema.json#/properties/postcode")
|
|
233
252
|
|
|
234
253
|
### postcode Type
|
|
235
254
|
|
|
@@ -247,7 +266,7 @@ Some sites may have a postcode, but do not have postal addresses.
|
|
|
247
266
|
|
|
248
267
|
* can be null
|
|
249
268
|
|
|
250
|
-
* defined in: [
|
|
269
|
+
* defined in: [Address](address-properties-country.md "address.schema.json#/properties/country")
|
|
251
270
|
|
|
252
271
|
### country Type
|
|
253
272
|
|
|
@@ -265,7 +284,7 @@ Some sites may have a postcode, but do not have postal addresses.
|
|
|
265
284
|
|
|
266
285
|
* can be null
|
|
267
286
|
|
|
268
|
-
* defined in: [
|
|
287
|
+
* defined in: [Address](address-properties-easting.md "address.schema.json#/properties/easting")
|
|
269
288
|
|
|
270
289
|
### easting Type
|
|
271
290
|
|
|
@@ -283,7 +302,7 @@ Some sites may have a postcode, but do not have postal addresses.
|
|
|
283
302
|
|
|
284
303
|
* can be null
|
|
285
304
|
|
|
286
|
-
* defined in: [
|
|
305
|
+
* defined in: [Address](address-properties-northing.md "address.schema.json#/properties/northing")
|
|
287
306
|
|
|
288
307
|
### northing Type
|
|
289
308
|
|
|
@@ -301,7 +320,7 @@ Some sites may have a postcode, but do not have postal addresses.
|
|
|
301
320
|
|
|
302
321
|
* can be null
|
|
303
322
|
|
|
304
|
-
* defined in: [
|
|
323
|
+
* defined in: [Address](address-properties-latitudewgs84.md "address.schema.json#/properties/latitudeWGS84")
|
|
305
324
|
|
|
306
325
|
### latitudeWGS84 Type
|
|
307
326
|
|
|
@@ -319,7 +338,7 @@ Some sites may have a postcode, but do not have postal addresses.
|
|
|
319
338
|
|
|
320
339
|
* can be null
|
|
321
340
|
|
|
322
|
-
* defined in: [
|
|
341
|
+
* defined in: [Address](address-properties-longitudewgs84.md "address.schema.json#/properties/longitudeWGS84")
|
|
323
342
|
|
|
324
343
|
### longitudeWGS84 Type
|
|
325
344
|
|
|
@@ -337,7 +356,7 @@ The Unique Property Reference Number (UPRN) is a unique number (a geocode) for e
|
|
|
337
356
|
|
|
338
357
|
* can be null
|
|
339
358
|
|
|
340
|
-
* defined in: [
|
|
359
|
+
* defined in: [Address](address-properties-uprn.md "address.schema.json#/properties/UPRN")
|
|
341
360
|
|
|
342
361
|
### UPRN Type
|
|
343
362
|
|
|
@@ -355,7 +374,7 @@ The Unique Property Reference Number (UPRN) is a unique number (a geocode) for e
|
|
|
355
374
|
|
|
356
375
|
* cannot be null
|
|
357
376
|
|
|
358
|
-
* defined in: [
|
|
377
|
+
* defined in: [Address](address-properties-dependentrequired.md "address.schema.json#/properties/dependentRequired")
|
|
359
378
|
|
|
360
379
|
### dependentRequired Type
|
|
361
380
|
|
package/docs/appeal-document.md
CHANGED
|
@@ -537,6 +537,7 @@ The type of document, used for exchange, migrations and consumption from the app
|
|
|
537
537
|
|
|
538
538
|
| Value | Explanation |
|
|
539
539
|
| :------------------------------------- | :---------- |
|
|
540
|
+
| `"appellantCase"` | |
|
|
540
541
|
| `"appellantCaseCorrespondence"` | |
|
|
541
542
|
| `"appellantCaseWithdrawalLetter"` | |
|
|
542
543
|
| `"appellantCostsApplication"` | |
|
|
@@ -551,6 +552,7 @@ The type of document, used for exchange, migrations and consumption from the app
|
|
|
551
552
|
| `"whoNotifiedLetterToNeighbours"` | |
|
|
552
553
|
| `"whoNotifiedPressAdvert"` | |
|
|
553
554
|
| `"conservationMap"` | |
|
|
555
|
+
| `"lpaQuestionnaire"` | |
|
|
554
556
|
| `"lpaCaseCorrespondence"` | |
|
|
555
557
|
| `"lpaCostsApplication"` | |
|
|
556
558
|
| `"lpaCostsCorrespondence"` | |
|