@planning-inspectorate/data-model 2.54.0 → 2.56.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 +2 -2
- package/docs/address.md +67 -48
- package/docs/applications-crowndev-application-defs-address.md +29 -10
- package/docs/applications-crowndev-application.md +29 -10
- package/docs/nsip-project.md +36 -0
- package/package.json +1 -1
- package/pins_data_model/models/model_address.py +7 -3
- package/pins_data_model/models/model_applications_crowndev_application.py +5 -1
- package/pins_data_model/models/model_nsip_project.py +21 -0
- package/schemas/address.schema.json +9 -4
- package/schemas/applications-crowndev-application.schema.json +6 -2
- package/schemas/nsip-project.schema.json +16 -0
- package/src/enums.cjs +13 -0
- package/src/enums.d.ts +12 -0
- package/src/enums.js +12 -0
- package/src/index.cjs +13 -0
- package/src/schemas.d.ts +27 -5
package/docs/README.md
CHANGED
|
@@ -2,6 +2,8 @@
|
|
|
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`
|
|
@@ -46,8 +48,6 @@
|
|
|
46
48
|
|
|
47
49
|
* [NSIP Project Update](./nsip-project-update.md "NSIP Project Update (formerly known as Banners)") – `nsip-project-update.schema.json`
|
|
48
50
|
|
|
49
|
-
* [PINS Address Schema](./address.md "A schema to define the structure of an Address object in PINS") – `address.schema.json`
|
|
50
|
-
|
|
51
51
|
* [PINS Inspector](./pins-inspector.md "Inspector Details originating from Horizon, SAP HR and Entra") – `pins-inspector.schema.json`
|
|
52
52
|
|
|
53
53
|
* [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
|
|
|
@@ -4,14 +4,33 @@
|
|
|
4
4
|
|
|
5
5
|
# address Properties
|
|
6
6
|
|
|
7
|
-
| Property
|
|
8
|
-
|
|
|
9
|
-
| [
|
|
10
|
-
| [
|
|
11
|
-
| [
|
|
12
|
-
| [
|
|
13
|
-
| [
|
|
14
|
-
|
|
|
7
|
+
| Property | Type | Required | Nullable | Defined by |
|
|
8
|
+
| :---------------------- | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
9
|
+
| [addressId](#addressid) | `string` | Required | cannot be null | [Crown Development Application](applications-crowndev-application-defs-address-properties-addressid.md "applications-crowndev-application.schema.json#/$defs/address/properties/addressId") |
|
|
10
|
+
| [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") |
|
|
11
|
+
| [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") |
|
|
12
|
+
| [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") |
|
|
13
|
+
| [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") |
|
|
14
|
+
| [postcode](#postcode) | `string` | Optional | can be null | [Crown Development Application](applications-crowndev-application-defs-address-properties-postcode.md "applications-crowndev-application.schema.json#/$defs/address/properties/postcode") |
|
|
15
|
+
| Additional Properties | Any | Optional | can be null | |
|
|
16
|
+
|
|
17
|
+
## addressId
|
|
18
|
+
|
|
19
|
+
The source system Primary Key for an address.
|
|
20
|
+
|
|
21
|
+
`addressId`
|
|
22
|
+
|
|
23
|
+
* is required
|
|
24
|
+
|
|
25
|
+
* Type: `string`
|
|
26
|
+
|
|
27
|
+
* cannot be null
|
|
28
|
+
|
|
29
|
+
* defined in: [Crown Development Application](applications-crowndev-application-defs-address-properties-addressid.md "applications-crowndev-application.schema.json#/$defs/address/properties/addressId")
|
|
30
|
+
|
|
31
|
+
### addressId Type
|
|
32
|
+
|
|
33
|
+
`string`
|
|
15
34
|
|
|
16
35
|
## line1
|
|
17
36
|
|
|
@@ -91,11 +110,11 @@
|
|
|
91
110
|
|
|
92
111
|
`postcode`
|
|
93
112
|
|
|
94
|
-
* is
|
|
113
|
+
* is optional
|
|
95
114
|
|
|
96
115
|
* Type: `string`
|
|
97
116
|
|
|
98
|
-
*
|
|
117
|
+
* can be null
|
|
99
118
|
|
|
100
119
|
* defined in: [Crown Development Application](applications-crowndev-application-defs-address-properties-postcode.md "applications-crowndev-application.schema.json#/$defs/address/properties/postcode")
|
|
101
120
|
|
|
@@ -2153,14 +2153,33 @@ Reference this group by using
|
|
|
2153
2153
|
{"$ref":"applications-crowndev-application.schema.json#/$defs/address"}
|
|
2154
2154
|
```
|
|
2155
2155
|
|
|
2156
|
-
| Property
|
|
2157
|
-
|
|
|
2158
|
-
| [
|
|
2159
|
-
| [
|
|
2160
|
-
| [
|
|
2161
|
-
| [
|
|
2162
|
-
| [
|
|
2163
|
-
|
|
|
2156
|
+
| Property | Type | Required | Nullable | Defined by |
|
|
2157
|
+
| :---------------------- | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2158
|
+
| [addressId](#addressid) | `string` | Required | cannot be null | [Crown Development Application](applications-crowndev-application-defs-address-properties-addressid.md "applications-crowndev-application.schema.json#/$defs/address/properties/addressId") |
|
|
2159
|
+
| [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") |
|
|
2160
|
+
| [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") |
|
|
2161
|
+
| [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") |
|
|
2162
|
+
| [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") |
|
|
2163
|
+
| [postcode](#postcode) | `string` | Optional | can be null | [Crown Development Application](applications-crowndev-application-defs-address-properties-postcode.md "applications-crowndev-application.schema.json#/$defs/address/properties/postcode") |
|
|
2164
|
+
| Additional Properties | Any | Optional | can be null | |
|
|
2165
|
+
|
|
2166
|
+
### addressId
|
|
2167
|
+
|
|
2168
|
+
The source system Primary Key for an address.
|
|
2169
|
+
|
|
2170
|
+
`addressId`
|
|
2171
|
+
|
|
2172
|
+
* is required
|
|
2173
|
+
|
|
2174
|
+
* Type: `string`
|
|
2175
|
+
|
|
2176
|
+
* cannot be null
|
|
2177
|
+
|
|
2178
|
+
* defined in: [Crown Development Application](applications-crowndev-application-defs-address-properties-addressid.md "applications-crowndev-application.schema.json#/$defs/address/properties/addressId")
|
|
2179
|
+
|
|
2180
|
+
#### addressId Type
|
|
2181
|
+
|
|
2182
|
+
`string`
|
|
2164
2183
|
|
|
2165
2184
|
### line1
|
|
2166
2185
|
|
|
@@ -2240,11 +2259,11 @@ Reference this group by using
|
|
|
2240
2259
|
|
|
2241
2260
|
`postcode`
|
|
2242
2261
|
|
|
2243
|
-
* is
|
|
2262
|
+
* is optional
|
|
2244
2263
|
|
|
2245
2264
|
* Type: `string`
|
|
2246
2265
|
|
|
2247
|
-
*
|
|
2266
|
+
* can be null
|
|
2248
2267
|
|
|
2249
2268
|
* defined in: [Crown Development Application](applications-crowndev-application-defs-address-properties-postcode.md "applications-crowndev-application.schema.json#/$defs/address/properties/postcode")
|
|
2250
2269
|
|
package/docs/nsip-project.md
CHANGED
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
| [projectDescription](#projectdescription) | `string` | Required | can be null | [NSIP Project](nsip-project-properties-projectdescription.md "nsip-project.schema.json#/properties/projectDescription") |
|
|
14
14
|
| [projectDescriptionWelsh](#projectdescriptionwelsh) | `string` | Optional | can be null | [NSIP Project](nsip-project-properties-projectdescriptionwelsh.md "nsip-project.schema.json#/properties/projectDescriptionWelsh") |
|
|
15
15
|
| [decision](#decision) | `string` | Required | can be null | [NSIP Project](nsip-project-properties-decision.md "nsip-project.schema.json#/properties/decision") |
|
|
16
|
+
| [dcoStatus](#dcostatus) | `string` | Optional | can be null | [NSIP Project](nsip-project-properties-dcostatus.md "nsip-project.schema.json#/properties/dcoStatus") |
|
|
16
17
|
| [publishStatus](#publishstatus) | `string` | Required | can be null | [NSIP Project](nsip-project-properties-publishstatus.md "nsip-project.schema.json#/properties/publishStatus") |
|
|
17
18
|
| [sector](#sector) | `string` | Required | can be null | [NSIP Project](nsip-project-properties-sector.md "nsip-project.schema.json#/properties/sector") |
|
|
18
19
|
| [projectType](#projecttype) | `string` | Required | can be null | [NSIP Project](nsip-project-properties-projecttype.md "nsip-project.schema.json#/properties/projectType") |
|
|
@@ -305,6 +306,41 @@ Decision outcome: approved/refused/split-decision/granted/partially\_consented/q
|
|
|
305
306
|
| `"withdrawn"` | |
|
|
306
307
|
| `null` | |
|
|
307
308
|
|
|
309
|
+
## dcoStatus
|
|
310
|
+
|
|
311
|
+
Decision outcome: approved/refused/split-decision/granted/partially\_consented/quashed/redetermination/withdrawn/revoked
|
|
312
|
+
|
|
313
|
+
`dcoStatus`
|
|
314
|
+
|
|
315
|
+
* is optional
|
|
316
|
+
|
|
317
|
+
* Type: `string`
|
|
318
|
+
|
|
319
|
+
* can be null
|
|
320
|
+
|
|
321
|
+
* defined in: [NSIP Project](nsip-project-properties-dcostatus.md "nsip-project.schema.json#/properties/dcoStatus")
|
|
322
|
+
|
|
323
|
+
### dcoStatus Type
|
|
324
|
+
|
|
325
|
+
`string`
|
|
326
|
+
|
|
327
|
+
### dcoStatus Constraints
|
|
328
|
+
|
|
329
|
+
**enum**: the value of this property must be equal to one of the following values:
|
|
330
|
+
|
|
331
|
+
| Value | Explanation |
|
|
332
|
+
| :---------------------- | :---------- |
|
|
333
|
+
| `"approved"` | |
|
|
334
|
+
| `"refused"` | |
|
|
335
|
+
| `"split-decision"` | |
|
|
336
|
+
| `"granted"` | |
|
|
337
|
+
| `"partially_consented"` | |
|
|
338
|
+
| `"quashed"` | |
|
|
339
|
+
| `"redetermination"` | |
|
|
340
|
+
| `"withdrawn"` | |
|
|
341
|
+
| `"revoked"` | |
|
|
342
|
+
| `null` | |
|
|
343
|
+
|
|
308
344
|
## publishStatus
|
|
309
345
|
|
|
310
346
|
|
package/package.json
CHANGED
|
@@ -20,7 +20,7 @@ class AddressType(StrEnum):
|
|
|
20
20
|
contact = "contact"
|
|
21
21
|
|
|
22
22
|
|
|
23
|
-
class
|
|
23
|
+
class Address(BaseModel):
|
|
24
24
|
"""
|
|
25
25
|
A schema to define the structure of an Address object in PINS.
|
|
26
26
|
"""
|
|
@@ -28,9 +28,13 @@ class PinsAddressSchema(BaseModel):
|
|
|
28
28
|
model_config = ConfigDict(
|
|
29
29
|
extra="allow",
|
|
30
30
|
)
|
|
31
|
-
|
|
31
|
+
addressId: str = Field(..., examples=["BBBBBBBBB-1234-1234-1234-AAAAAAAAAAAA"])
|
|
32
32
|
"""
|
|
33
|
-
Primary Key for an
|
|
33
|
+
The source system Primary Key for an address.
|
|
34
|
+
"""
|
|
35
|
+
addressDimKey: float | None = Field(None, examples=[12345])
|
|
36
|
+
"""
|
|
37
|
+
ODW Address Dimension Primary Key.
|
|
34
38
|
"""
|
|
35
39
|
addressType: AddressType | None = Field(None, examples=["site"])
|
|
36
40
|
"""
|
|
@@ -172,11 +172,15 @@ class Address(BaseModel):
|
|
|
172
172
|
model_config = ConfigDict(
|
|
173
173
|
extra="allow",
|
|
174
174
|
)
|
|
175
|
+
addressId: str
|
|
176
|
+
"""
|
|
177
|
+
The source system Primary Key for an address.
|
|
178
|
+
"""
|
|
175
179
|
line1: str | None = None
|
|
176
180
|
line2: str | None = None
|
|
177
181
|
townCity: str | None = None
|
|
178
182
|
county: str | None = None
|
|
179
|
-
postcode: str
|
|
183
|
+
postcode: str | None = None
|
|
180
184
|
|
|
181
185
|
|
|
182
186
|
class Organisation(BaseModel):
|
|
@@ -25,6 +25,23 @@ class Decision(Enum):
|
|
|
25
25
|
NoneType_None = None
|
|
26
26
|
|
|
27
27
|
|
|
28
|
+
class DcoStatus(Enum):
|
|
29
|
+
"""
|
|
30
|
+
Decision outcome: approved/refused/split-decision/granted/partially_consented/quashed/redetermination/withdrawn/revoked
|
|
31
|
+
"""
|
|
32
|
+
|
|
33
|
+
approved = "approved"
|
|
34
|
+
refused = "refused"
|
|
35
|
+
split_decision = "split-decision"
|
|
36
|
+
granted = "granted"
|
|
37
|
+
partially_consented = "partially_consented"
|
|
38
|
+
quashed = "quashed"
|
|
39
|
+
redetermination = "redetermination"
|
|
40
|
+
withdrawn = "withdrawn"
|
|
41
|
+
revoked = "revoked"
|
|
42
|
+
NoneType_None = None
|
|
43
|
+
|
|
44
|
+
|
|
28
45
|
class PublishStatus(Enum):
|
|
29
46
|
published = "published"
|
|
30
47
|
unpublished = "unpublished"
|
|
@@ -440,6 +457,10 @@ class NsipProject(BaseModel):
|
|
|
440
457
|
"""
|
|
441
458
|
Decision outcome: approved/refused/split-decision/granted/partially_consented/quashed/redetermination/withdrawn
|
|
442
459
|
"""
|
|
460
|
+
dcoStatus: DcoStatus | None = None
|
|
461
|
+
"""
|
|
462
|
+
Decision outcome: approved/refused/split-decision/granted/partially_consented/quashed/redetermination/withdrawn/revoked
|
|
463
|
+
"""
|
|
443
464
|
publishStatus: PublishStatus | None
|
|
444
465
|
sector: Sector | None
|
|
445
466
|
"""
|
|
@@ -1,15 +1,20 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
3
|
"$id": "address.schema.json",
|
|
4
|
-
"title": "
|
|
4
|
+
"title": "Address",
|
|
5
5
|
"description": "A schema to define the structure of an Address object in PINS.",
|
|
6
6
|
"type": "object",
|
|
7
7
|
"additionalProperties": true,
|
|
8
|
-
"required": ["
|
|
8
|
+
"required": ["addressId", "caseReference", "caseId", "caseType"],
|
|
9
9
|
"properties": {
|
|
10
|
+
"addressId": {
|
|
11
|
+
"type": "string",
|
|
12
|
+
"description": "The source system Primary Key for an address.",
|
|
13
|
+
"example": "BBBBBBBBB-1234-1234-1234-AAAAAAAAAAAA"
|
|
14
|
+
},
|
|
10
15
|
"addressDimKey": {
|
|
11
|
-
"type": "number",
|
|
12
|
-
"description": "
|
|
16
|
+
"type": ["number", "null"],
|
|
17
|
+
"description": "ODW Address Dimension Primary Key.",
|
|
13
18
|
"example": 12345
|
|
14
19
|
},
|
|
15
20
|
"addressType": {
|
|
@@ -518,8 +518,12 @@
|
|
|
518
518
|
"address": {
|
|
519
519
|
"type": "object",
|
|
520
520
|
"additionalProperties": true,
|
|
521
|
-
"required": ["
|
|
521
|
+
"required": ["addressId"],
|
|
522
522
|
"properties": {
|
|
523
|
+
"addressId": {
|
|
524
|
+
"type": "string",
|
|
525
|
+
"description": "The source system Primary Key for an address."
|
|
526
|
+
},
|
|
523
527
|
"line1": {
|
|
524
528
|
"type": ["string", "null"]
|
|
525
529
|
},
|
|
@@ -533,7 +537,7 @@
|
|
|
533
537
|
"type": ["string", "null"]
|
|
534
538
|
},
|
|
535
539
|
"postcode": {
|
|
536
|
-
"type": "string"
|
|
540
|
+
"type": ["string", "null"]
|
|
537
541
|
}
|
|
538
542
|
}
|
|
539
543
|
}
|
|
@@ -118,6 +118,22 @@
|
|
|
118
118
|
null
|
|
119
119
|
]
|
|
120
120
|
},
|
|
121
|
+
"dcoStatus": {
|
|
122
|
+
"type": ["string", "null"],
|
|
123
|
+
"description": "Decision outcome: approved/refused/split-decision/granted/partially_consented/quashed/redetermination/withdrawn/revoked",
|
|
124
|
+
"enum": [
|
|
125
|
+
"approved",
|
|
126
|
+
"refused",
|
|
127
|
+
"split-decision",
|
|
128
|
+
"granted",
|
|
129
|
+
"partially_consented",
|
|
130
|
+
"quashed",
|
|
131
|
+
"redetermination",
|
|
132
|
+
"withdrawn",
|
|
133
|
+
"revoked",
|
|
134
|
+
null
|
|
135
|
+
]
|
|
136
|
+
},
|
|
121
137
|
"publishStatus": {
|
|
122
138
|
"type": ["string", "null"],
|
|
123
139
|
"enum": ["published", "unpublished", null]
|
package/src/enums.cjs
CHANGED
|
@@ -626,6 +626,18 @@ const NSIP_CASE_TYPE = Object.freeze({
|
|
|
626
626
|
NSIP: 'nsip',
|
|
627
627
|
});
|
|
628
628
|
|
|
629
|
+
const NSIP_DCO_STATUS = Object.freeze({
|
|
630
|
+
APPROVED: 'approved',
|
|
631
|
+
GRANTED: 'granted',
|
|
632
|
+
PARTIALLY_CONSENTED: 'partially_consented',
|
|
633
|
+
QUASHED: 'quashed',
|
|
634
|
+
REDETERMINATION: 'redetermination',
|
|
635
|
+
REFUSED: 'refused',
|
|
636
|
+
REVOKED: 'revoked',
|
|
637
|
+
SPLIT_DECISION: 'split-decision',
|
|
638
|
+
WITHDRAWN: 'withdrawn',
|
|
639
|
+
});
|
|
640
|
+
|
|
629
641
|
const NSIP_DECISION = Object.freeze({
|
|
630
642
|
APPROVED: 'approved',
|
|
631
643
|
GRANTED: 'granted',
|
|
@@ -1024,6 +1036,7 @@ exports.MESSAGE_EVENT_TYPE = MESSAGE_EVENT_TYPE;
|
|
|
1024
1036
|
exports.METHOD = METHOD;
|
|
1025
1037
|
exports.NSIP_CASE_TYPE = NSIP_CASE_TYPE;
|
|
1026
1038
|
exports.NSIP_CA_AND_TP_EVIDENCE = NSIP_CA_AND_TP_EVIDENCE;
|
|
1039
|
+
exports.NSIP_DCO_STATUS = NSIP_DCO_STATUS;
|
|
1027
1040
|
exports.NSIP_DECISION = NSIP_DECISION;
|
|
1028
1041
|
exports.NSIP_DESIGN_APPROACH_DOCUMENT = NSIP_DESIGN_APPROACH_DOCUMENT;
|
|
1029
1042
|
exports.NSIP_DOCUMENT_CASE_STAGE = NSIP_DOCUMENT_CASE_STAGE;
|
package/src/enums.d.ts
CHANGED
|
@@ -624,6 +624,18 @@ export const NSIP_CASE_TYPE = {
|
|
|
624
624
|
NSIP: 'nsip',
|
|
625
625
|
} as const;
|
|
626
626
|
|
|
627
|
+
export const NSIP_DCO_STATUS = {
|
|
628
|
+
APPROVED: 'approved',
|
|
629
|
+
GRANTED: 'granted',
|
|
630
|
+
PARTIALLY_CONSENTED: 'partially_consented',
|
|
631
|
+
QUASHED: 'quashed',
|
|
632
|
+
REDETERMINATION: 'redetermination',
|
|
633
|
+
REFUSED: 'refused',
|
|
634
|
+
REVOKED: 'revoked',
|
|
635
|
+
SPLIT_DECISION: 'split-decision',
|
|
636
|
+
WITHDRAWN: 'withdrawn',
|
|
637
|
+
} as const;
|
|
638
|
+
|
|
627
639
|
export const NSIP_DECISION = {
|
|
628
640
|
APPROVED: 'approved',
|
|
629
641
|
GRANTED: 'granted',
|
package/src/enums.js
CHANGED
|
@@ -624,6 +624,18 @@ export const NSIP_CASE_TYPE = Object.freeze({
|
|
|
624
624
|
NSIP: 'nsip',
|
|
625
625
|
});
|
|
626
626
|
|
|
627
|
+
export const NSIP_DCO_STATUS = Object.freeze({
|
|
628
|
+
APPROVED: 'approved',
|
|
629
|
+
GRANTED: 'granted',
|
|
630
|
+
PARTIALLY_CONSENTED: 'partially_consented',
|
|
631
|
+
QUASHED: 'quashed',
|
|
632
|
+
REDETERMINATION: 'redetermination',
|
|
633
|
+
REFUSED: 'refused',
|
|
634
|
+
REVOKED: 'revoked',
|
|
635
|
+
SPLIT_DECISION: 'split-decision',
|
|
636
|
+
WITHDRAWN: 'withdrawn',
|
|
637
|
+
});
|
|
638
|
+
|
|
627
639
|
export const NSIP_DECISION = Object.freeze({
|
|
628
640
|
APPROVED: 'approved',
|
|
629
641
|
GRANTED: 'granted',
|
package/src/index.cjs
CHANGED
|
@@ -707,6 +707,18 @@ const NSIP_CASE_TYPE = Object.freeze({
|
|
|
707
707
|
NSIP: 'nsip',
|
|
708
708
|
});
|
|
709
709
|
|
|
710
|
+
const NSIP_DCO_STATUS = Object.freeze({
|
|
711
|
+
APPROVED: 'approved',
|
|
712
|
+
GRANTED: 'granted',
|
|
713
|
+
PARTIALLY_CONSENTED: 'partially_consented',
|
|
714
|
+
QUASHED: 'quashed',
|
|
715
|
+
REDETERMINATION: 'redetermination',
|
|
716
|
+
REFUSED: 'refused',
|
|
717
|
+
REVOKED: 'revoked',
|
|
718
|
+
SPLIT_DECISION: 'split-decision',
|
|
719
|
+
WITHDRAWN: 'withdrawn',
|
|
720
|
+
});
|
|
721
|
+
|
|
710
722
|
const NSIP_DECISION = Object.freeze({
|
|
711
723
|
APPROVED: 'approved',
|
|
712
724
|
GRANTED: 'granted',
|
|
@@ -1137,6 +1149,7 @@ exports.MESSAGE_EVENT_TYPE = MESSAGE_EVENT_TYPE;
|
|
|
1137
1149
|
exports.METHOD = METHOD;
|
|
1138
1150
|
exports.NSIP_CASE_TYPE = NSIP_CASE_TYPE;
|
|
1139
1151
|
exports.NSIP_CA_AND_TP_EVIDENCE = NSIP_CA_AND_TP_EVIDENCE;
|
|
1152
|
+
exports.NSIP_DCO_STATUS = NSIP_DCO_STATUS;
|
|
1140
1153
|
exports.NSIP_DECISION = NSIP_DECISION;
|
|
1141
1154
|
exports.NSIP_DESIGN_APPROACH_DOCUMENT = NSIP_DESIGN_APPROACH_DOCUMENT;
|
|
1142
1155
|
exports.NSIP_DOCUMENT_CASE_STAGE = NSIP_DOCUMENT_CASE_STAGE;
|
package/src/schemas.d.ts
CHANGED
|
@@ -8,11 +8,15 @@
|
|
|
8
8
|
/**
|
|
9
9
|
* A schema to define the structure of an Address object in PINS.
|
|
10
10
|
*/
|
|
11
|
-
export interface
|
|
11
|
+
export interface Address {
|
|
12
|
+
/**
|
|
13
|
+
* The source system Primary Key for an address.
|
|
14
|
+
*/
|
|
15
|
+
addressId: string;
|
|
12
16
|
/**
|
|
13
|
-
*
|
|
17
|
+
* ODW Address Dimension Primary Key.
|
|
14
18
|
*/
|
|
15
|
-
addressDimKey
|
|
19
|
+
addressDimKey?: number | null;
|
|
16
20
|
/**
|
|
17
21
|
* The type of thing this address is for.
|
|
18
22
|
*/
|
|
@@ -2262,11 +2266,15 @@ export interface Organisation {
|
|
|
2262
2266
|
[k: string]: unknown;
|
|
2263
2267
|
}
|
|
2264
2268
|
export interface Address {
|
|
2269
|
+
/**
|
|
2270
|
+
* The source system Primary Key for an address.
|
|
2271
|
+
*/
|
|
2272
|
+
addressId: string;
|
|
2265
2273
|
line1?: string | null;
|
|
2266
2274
|
line2?: string | null;
|
|
2267
2275
|
townCity?: string | null;
|
|
2268
2276
|
county?: string | null;
|
|
2269
|
-
postcode
|
|
2277
|
+
postcode?: string | null;
|
|
2270
2278
|
[k: string]: unknown;
|
|
2271
2279
|
}
|
|
2272
2280
|
export interface Contact {
|
|
@@ -3239,6 +3247,20 @@ export interface NSIPProject {
|
|
|
3239
3247
|
| 'redetermination'
|
|
3240
3248
|
| 'withdrawn'
|
|
3241
3249
|
| null;
|
|
3250
|
+
/**
|
|
3251
|
+
* Decision outcome: approved/refused/split-decision/granted/partially_consented/quashed/redetermination/withdrawn/revoked
|
|
3252
|
+
*/
|
|
3253
|
+
dcoStatus?:
|
|
3254
|
+
| 'approved'
|
|
3255
|
+
| 'refused'
|
|
3256
|
+
| 'split-decision'
|
|
3257
|
+
| 'granted'
|
|
3258
|
+
| 'partially_consented'
|
|
3259
|
+
| 'quashed'
|
|
3260
|
+
| 'redetermination'
|
|
3261
|
+
| 'withdrawn'
|
|
3262
|
+
| 'revoked'
|
|
3263
|
+
| null;
|
|
3242
3264
|
publishStatus: 'published' | 'unpublished' | null;
|
|
3243
3265
|
/**
|
|
3244
3266
|
* {Sector Abbreviation} - {Sector Display Name}
|
|
@@ -5896,7 +5918,7 @@ export interface InterestedParty1 {
|
|
|
5896
5918
|
|
|
5897
5919
|
export type SchemaMap = {
|
|
5898
5920
|
schemas: {
|
|
5899
|
-
'address.schema.json':
|
|
5921
|
+
'address.schema.json': Address;
|
|
5900
5922
|
'appeal-document.schema.json': AppealDocument;
|
|
5901
5923
|
'appeal-event-estimate.schema.json': AppealEventEstimate;
|
|
5902
5924
|
'appeal-event.schema.json': AppealEvent;
|