@planning-inspectorate/data-model 1.21.0 → 1.22.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.
Files changed (33) hide show
  1. package/docs/README.md +4 -0
  2. package/docs/appeal-has.md +30 -49
  3. package/docs/appeal-s78.md +241 -144
  4. package/package.json +1 -1
  5. package/pins_data_model/models/model_appeal_has.py +72 -27
  6. package/pins_data_model/models/model_appeal_s78.py +95 -8
  7. package/schemas/appeal-has.schema.json +52 -21
  8. package/schemas/appeal-s78.schema.json +62 -7
  9. package/schemas/commands/appeals-components/appeal-advert.submission.schema.json +53 -0
  10. package/schemas/commands/{appeal-common-submission.schema.json → appeals-components/appeal-common-submission.schema.json} +8 -8
  11. package/schemas/commands/{appeal-has-submission.schema.json → appeals-components/appeal-has-submission.schema.json} +2 -2
  12. package/schemas/commands/{appeal-s78-submission.schema.json → appeals-components/appeal-s78-submission.schema.json} +2 -2
  13. package/schemas/commands/appeals-components/appellant-procedure-preference.schema.json +37 -0
  14. package/schemas/commands/appeals-components/changed-listed-building-number.schema.json +23 -0
  15. package/schemas/commands/appeals-components/lpa-procedure-preference.schema.json +28 -0
  16. package/schemas/commands/{lpa-questionnaire-cas-advert.schema.json → appeals-components/lpa-questionnaire-advert.schema.json} +8 -33
  17. package/schemas/commands/{lpa-questionnaire-common.schema.json → appeals-components/lpa-questionnaire-common.schema.json} +1 -1
  18. package/schemas/commands/{lpa-questionnaire-has.schema.json → appeals-components/lpa-questionnaire-has.schema.json} +1 -1
  19. package/schemas/commands/{lpa-questionnaire-s78.schema.json → appeals-components/lpa-questionnaire-s78.schema.json} +2 -21
  20. package/schemas/commands/appellant-submission.schema.json +21 -10
  21. package/schemas/commands/lpa-questionnaire.schema.json +24 -10
  22. package/src/index.cjs +6 -2
  23. package/src/index.d.ts +4 -0
  24. package/src/index.js +5 -2
  25. package/src/schemas.d.ts +326 -803
  26. package/tests/appeals/appeal-has.test.js +30 -5
  27. package/tests/appeals/appeal-s78.test.js +17 -3
  28. package/tests/appeals/commands/adverts-questionnaire.test.js +1 -0
  29. package/tests/appeals/commands/adverts-submission.test.js +13 -13
  30. package/tests/appeals/commands/cas-adverts-submission.test.js +184 -0
  31. package/tests/appeals/commands/has-submission.test.js +2 -2
  32. package/tests/appeals/commands/s78-submission.test.js +2 -2
  33. package/schemas/commands/appeal-advert.submission.schema.json +0 -23
package/src/schemas.d.ts CHANGED
@@ -305,23 +305,13 @@ export interface AppealEvent {
305
305
  */
306
306
  export type AppealHASCase = (
307
307
  | {
308
- siteGridReferenceEasting: {
309
- [k: string]: unknown;
310
- };
311
- siteGridReferenceNorthing: {
312
- [k: string]: unknown;
313
- };
308
+ siteGridReferenceEasting: string;
309
+ siteGridReferenceNorthing: string;
314
310
  }
315
311
  | {
316
- siteAddressLine1: {
317
- [k: string]: unknown;
318
- };
319
- siteAddressTown: {
320
- [k: string]: unknown;
321
- };
322
- siteAddressPostcode: {
323
- [k: string]: unknown;
324
- };
312
+ siteAddressLine1: string;
313
+ siteAddressTown: string;
314
+ siteAddressPostcode: string;
325
315
  }
326
316
  ) & {
327
317
  /**
@@ -763,26 +753,52 @@ export type AppealHASCase = (
763
753
  siteGridReferenceEasting?: string | null;
764
754
  siteGridReferenceNorthing?: string | null;
765
755
  /**
766
- * Indicates if the appellant has land owners permission
756
+ * Does the appellant have the landowners permission
767
757
  */
768
758
  hasLandownersPermission?: boolean | null;
769
759
  /**
770
- * Indicates if the advert is already in position
760
+ * Did the LPA refuse the application because of highway or traffic public safety?
771
761
  */
772
- isAdvertInPosition?: boolean | null;
762
+ wasApplicationRefusedDueToHighwayOrTraffic?: boolean | null;
773
763
  /**
774
- * Indicates if the site is in an area of special control for adverts
764
+ * Did the appellant submit complete photos and plans?
775
765
  */
776
- isSiteInAreaOfSpecialControlAdverts?: boolean | null;
766
+ didAppellantSubmitCompletePhotosAndPlans?: boolean | null;
777
767
  /**
778
- * Indicates if the application was refused because of highway or traffic public safety?
768
+ * Is the site in an area of special control of advertisements?
779
769
  */
780
- wasApplicationRefusedDueToHighwayOrTraffic?: boolean | null;
770
+ isSiteInAreaOfSpecialControlAdverts?: boolean | null;
781
771
  /**
782
- * Indicates if the appellant submitted complete and accurate photographs and plans
772
+ * A list of advertisements for the appeal
783
773
  */
784
- didAppellantSubmitCompletePhotosAndPlans?: boolean | null;
785
- advertType?: string | null;
774
+ advertDetails?:
775
+ | {
776
+ advertType:
777
+ | '4-6 Sheet Non-Illuminated'
778
+ | '4-6 Sheet Illuminated'
779
+ | '12/16/32 Sheet Non-Illuminated'
780
+ | '12/16/32 Sheet Illuminated'
781
+ | '48/64/96 Sheet Non-Illuminated'
782
+ | '48/64/96 Sheet Illuminated'
783
+ | 'Fascia Projecting Signs Non-Illuminated'
784
+ | 'Fascia Projecting Signs Illuminated'
785
+ | 'Directional & Others Non-Illuminated'
786
+ | 'Directional & Others Illuminated'
787
+ | 'Monolith/Totem Signs Non-Illuminated'
788
+ | 'Monolith/Totem Signs Illuminated'
789
+ | 'Other'
790
+ | null;
791
+ /**
792
+ * Is the advertisement in position?
793
+ */
794
+ isAdvertInPosition: boolean | null;
795
+ /**
796
+ * Is the site on highway land?
797
+ */
798
+ isSiteOnHighwayLand: boolean | null;
799
+ [k: string]: unknown;
800
+ }[]
801
+ | null;
786
802
  [k: string]: unknown;
787
803
  };
788
804
 
@@ -877,23 +893,13 @@ export interface AppealRepresentation {
877
893
  */
878
894
  export type AppealS78Case = (
879
895
  | {
880
- siteGridReferenceEasting: {
881
- [k: string]: unknown;
882
- };
883
- siteGridReferenceNorthing: {
884
- [k: string]: unknown;
885
- };
896
+ siteGridReferenceEasting: string;
897
+ siteGridReferenceNorthing: string;
886
898
  }
887
899
  | {
888
- siteAddressLine1: {
889
- [k: string]: unknown;
890
- };
891
- siteAddressTown: {
892
- [k: string]: unknown;
893
- };
894
- siteAddressPostcode: {
895
- [k: string]: unknown;
896
- };
900
+ siteAddressLine1: string;
901
+ siteAddressTown: string;
902
+ siteAddressPostcode: string;
897
903
  }
898
904
  ) & {
899
905
  /**
@@ -1452,6 +1458,53 @@ export type AppealS78Case = (
1452
1458
  | null;
1453
1459
  statementOfCommonGroundDueDate?: string | null;
1454
1460
  planningObligationDueDate?: string | null;
1461
+ /**
1462
+ * Does the appellant have the landowners permission
1463
+ */
1464
+ hasLandownersPermission?: boolean | null;
1465
+ /**
1466
+ * Did the LPA refuse the application because of highway or traffic public safety?
1467
+ */
1468
+ wasApplicationRefusedDueToHighwayOrTraffic?: boolean | null;
1469
+ /**
1470
+ * Did the appellant submit complete photos and plans?
1471
+ */
1472
+ didAppellantSubmitCompletePhotosAndPlans?: boolean | null;
1473
+ /**
1474
+ * Is the site in an area of special control of advertisements?
1475
+ */
1476
+ isSiteInAreaOfSpecialControlAdverts?: boolean | null;
1477
+ /**
1478
+ * A list of advertisements for the appeal
1479
+ */
1480
+ advertDetails?:
1481
+ | {
1482
+ advertType:
1483
+ | '4-6 Sheet Non-Illuminated'
1484
+ | '4-6 Sheet Illuminated'
1485
+ | '12/16/32 Sheet Non-Illuminated'
1486
+ | '12/16/32 Sheet Illuminated'
1487
+ | '48/64/96 Sheet Non-Illuminated'
1488
+ | '48/64/96 Sheet Illuminated'
1489
+ | 'Fascia Projecting Signs Non-Illuminated'
1490
+ | 'Fascia Projecting Signs Illuminated'
1491
+ | 'Directional & Others Non-Illuminated'
1492
+ | 'Directional & Others Illuminated'
1493
+ | 'Monolith/Totem Signs Non-Illuminated'
1494
+ | 'Monolith/Totem Signs Illuminated'
1495
+ | 'Other'
1496
+ | null;
1497
+ /**
1498
+ * Is the advertisement in position?
1499
+ */
1500
+ isAdvertInPosition: boolean | null;
1501
+ /**
1502
+ * Is the site on highway land?
1503
+ */
1504
+ isSiteOnHighwayLand: boolean | null;
1505
+ [k: string]: unknown;
1506
+ }[]
1507
+ | null;
1455
1508
  [k: string]: unknown;
1456
1509
  };
1457
1510
 
@@ -3080,46 +3133,148 @@ export interface ServiceUser {
3080
3133
  }
3081
3134
 
3082
3135
  /**
3083
- * Schema defining any properties for advertisement appeals
3136
+ * Schema defining the data produced by the Front-Office when a representation is created on an appeal
3084
3137
  */
3085
- export interface AdvertSpecificProperties {
3138
+ export type AppealRepresentationSubmission = {
3086
3139
  /**
3087
- * Indicates if the appellant has land owners permission
3140
+ * External case identifier
3088
3141
  */
3089
- hasLandownersPermission: boolean | null;
3142
+ caseReference: string;
3090
3143
  /**
3091
- * Indicates if the advert is already in position
3144
+ * The date the representation was submitted
3092
3145
  */
3093
- isAdvertInPosition: boolean | null;
3146
+ representationSubmittedDate: string | null;
3094
3147
  /**
3095
- * Indicates if site is on highway land
3148
+ * The type of representation
3149
+ */
3150
+ representationType: 'statement' | 'comment' | 'final_comment' | 'proofs_evidence';
3151
+ /**
3152
+ * The original representation
3153
+ */
3154
+ representation: string | null;
3155
+ documents: {
3156
+ /**
3157
+ * The unique identifier for the document
3158
+ */
3159
+ documentId: string;
3160
+ /**
3161
+ * Current stored name of the document
3162
+ */
3163
+ filename: string;
3164
+ /**
3165
+ * Original name of document
3166
+ */
3167
+ originalFilename: string;
3168
+ /**
3169
+ * The file size, in bytes
3170
+ */
3171
+ size: number;
3172
+ /**
3173
+ * The mime type for the current version of the file
3174
+ */
3175
+ mime: string;
3176
+ /**
3177
+ * The internal location of the document
3178
+ */
3179
+ documentURI: string;
3180
+ /**
3181
+ * The creation date for the document
3182
+ */
3183
+ dateCreated: string;
3184
+ /**
3185
+ * The type of document, used for exchange, migrations and consumption from the appeal back-office system
3186
+ */
3187
+ documentType:
3188
+ | 'interestedPartyComment'
3189
+ | 'lpaStatement'
3190
+ | 'rule6Statement'
3191
+ | 'appellantFinalComment'
3192
+ | 'lpaFinalComment'
3193
+ | 'appellantProofOfEvidence'
3194
+ | 'appellantWitnessesEvidence'
3195
+ | 'lpaProofOfEvidence'
3196
+ | 'lpaWitnessesEvidence'
3197
+ | 'rule6ProofOfEvidence'
3198
+ | 'rule6WitnessesEvidence'
3199
+ | null;
3200
+ [k: string]: unknown;
3201
+ }[];
3202
+ /**
3203
+ * Service User Id of the person or organisation making the representation
3204
+ */
3205
+ serviceUserId?: string | null;
3206
+ /**
3207
+ * A unique identifier for the Local Planning Authority
3096
3208
  */
3097
- isSiteOnHighwayLand: boolean | null;
3209
+ lpaCode?: string | null;
3210
+ newUser?: {
3211
+ /**
3212
+ * A formal greeting, e.g., Mr, Mrs, Ms.
3213
+ */
3214
+ salutation: string | null;
3215
+ /**
3216
+ * The first name of the individual.
3217
+ */
3218
+ firstName: string | null;
3219
+ /**
3220
+ * The last name of the individual.
3221
+ */
3222
+ lastName: string | null;
3223
+ /**
3224
+ * The primary email address for contact.
3225
+ */
3226
+ emailAddress: string | null;
3227
+ /**
3228
+ * The primary telephone contact number.
3229
+ */
3230
+ telephoneNumber: string | null;
3231
+ /**
3232
+ * The name of the organisation associated with the individual.
3233
+ */
3234
+ organisation: string | null;
3235
+ /**
3236
+ * Type or category of the service user.
3237
+ */
3238
+ serviceUserType: 'InterestedParty';
3239
+ /**
3240
+ * First line of address of the user making the representation
3241
+ */
3242
+ addressLine1?: string;
3243
+ /**
3244
+ * Second line of address of the user making the representation
3245
+ */
3246
+ addressLine2?: string | null;
3247
+ /**
3248
+ * Town / City of the user making the representation
3249
+ */
3250
+ addressTown?: string;
3251
+ /**
3252
+ * County of the user making the representation
3253
+ */
3254
+ addressCounty?: string | null;
3255
+ /**
3256
+ * Postal code of the user making the representation
3257
+ */
3258
+ addressPostcode?: string;
3259
+ [k: string]: unknown;
3260
+ };
3098
3261
  [k: string]: unknown;
3099
- }
3262
+ } & {
3263
+ [k: string]: unknown;
3264
+ };
3100
3265
 
3101
3266
  /**
3102
3267
  * Schema defining any properties common across all appeal types for appeal submissions
3103
3268
  */
3104
3269
  export type AppellantCommonSubmissionProperties = (
3105
3270
  | {
3106
- siteGridReferenceEasting: {
3107
- [k: string]: unknown;
3108
- };
3109
- siteGridReferenceNorthing: {
3110
- [k: string]: unknown;
3111
- };
3271
+ siteGridReferenceEasting: string;
3272
+ siteGridReferenceNorthing: string;
3112
3273
  }
3113
3274
  | {
3114
- siteAddressLine1: {
3115
- [k: string]: unknown;
3116
- };
3117
- siteAddressTown: {
3118
- [k: string]: unknown;
3119
- };
3120
- siteAddressPostcode: {
3121
- [k: string]: unknown;
3122
- };
3275
+ siteAddressLine1: string;
3276
+ siteAddressTown: string;
3277
+ siteAddressPostcode: string;
3123
3278
  }
3124
3279
  ) & {
3125
3280
  /**
@@ -3245,9 +3400,8 @@ export type AppellantCommonSubmissionProperties = (
3245
3400
  | null;
3246
3401
  [k: string]: unknown;
3247
3402
  };
3248
-
3249
3403
  /**
3250
- * Schema defining any HAS specific properties for submissions
3404
+ * Schema defining any HAS specific properties for appeal submissions
3251
3405
  */
3252
3406
  export type AppellantHASSubmissionProperties = {
3253
3407
  /**
@@ -3299,164 +3453,32 @@ export type AppellantHASSubmissionProperties = {
3299
3453
  */
3300
3454
  appellantCostsAppliedFor?: boolean | null;
3301
3455
  };
3302
-
3303
3456
  /**
3304
- * Schema defining the data produced by the Front-Office when a representation is created on an appeal
3457
+ * Schema defining any S78 specific properties for appeal submissions
3305
3458
  */
3306
- export type AppealRepresentationSubmission = {
3459
+ export type AppellantS78SubmissionProperties = {
3307
3460
  /**
3308
- * External case identifier
3461
+ * Indicates if the site is an agricultural holding
3309
3462
  */
3310
- caseReference: string;
3463
+ agriculturalHolding?: boolean | null;
3311
3464
  /**
3312
- * The date the representation was submitted
3465
+ * Indicates if the site is a tenant agricultural holding
3313
3466
  */
3314
- representationSubmittedDate: string | null;
3467
+ tenantAgriculturalHolding?: boolean | null;
3315
3468
  /**
3316
- * The type of representation
3469
+ * Indicates if the site is an agricultural holding with other tenants
3317
3470
  */
3318
- representationType: 'statement' | 'comment' | 'final_comment' | 'proofs_evidence';
3471
+ otherTenantsAgriculturalHolding?: boolean | null;
3319
3472
  /**
3320
- * The original representation
3473
+ * If the site is an agricultural holding, indicates tenants are informed
3321
3474
  */
3322
- representation: string | null;
3323
- documents: {
3324
- /**
3325
- * The unique identifier for the document
3326
- */
3327
- documentId: string;
3328
- /**
3329
- * Current stored name of the document
3330
- */
3331
- filename: string;
3332
- /**
3333
- * Original name of document
3334
- */
3335
- originalFilename: string;
3336
- /**
3337
- * The file size, in bytes
3338
- */
3339
- size: number;
3340
- /**
3341
- * The mime type for the current version of the file
3342
- */
3343
- mime: string;
3344
- /**
3345
- * The internal location of the document
3346
- */
3347
- documentURI: string;
3348
- /**
3349
- * The creation date for the document
3350
- */
3351
- dateCreated: string;
3352
- /**
3353
- * The type of document, used for exchange, migrations and consumption from the appeal back-office system
3354
- */
3355
- documentType:
3356
- | 'interestedPartyComment'
3357
- | 'lpaStatement'
3358
- | 'rule6Statement'
3359
- | 'appellantFinalComment'
3360
- | 'lpaFinalComment'
3361
- | 'appellantProofOfEvidence'
3362
- | 'appellantWitnessesEvidence'
3363
- | 'lpaProofOfEvidence'
3364
- | 'lpaWitnessesEvidence'
3365
- | 'rule6ProofOfEvidence'
3366
- | 'rule6WitnessesEvidence'
3367
- | null;
3368
- [k: string]: unknown;
3369
- }[];
3475
+ informedTenantsAgriculturalHolding?: boolean | null;
3370
3476
  /**
3371
- * Service User Id of the person or organisation making the representation
3477
+ * The procedure preference indicated by the appellant
3372
3478
  */
3373
- serviceUserId?: string | null;
3479
+ appellantProcedurePreference?: 'written' | 'hearing' | 'inquiry' | null;
3374
3480
  /**
3375
- * A unique identifier for the Local Planning Authority
3376
- */
3377
- lpaCode?: string | null;
3378
- newUser?: {
3379
- /**
3380
- * A formal greeting, e.g., Mr, Mrs, Ms.
3381
- */
3382
- salutation: string | null;
3383
- /**
3384
- * The first name of the individual.
3385
- */
3386
- firstName: string | null;
3387
- /**
3388
- * The last name of the individual.
3389
- */
3390
- lastName: string | null;
3391
- /**
3392
- * The primary email address for contact.
3393
- */
3394
- emailAddress: string | null;
3395
- /**
3396
- * The primary telephone contact number.
3397
- */
3398
- telephoneNumber: string | null;
3399
- /**
3400
- * The name of the organisation associated with the individual.
3401
- */
3402
- organisation: string | null;
3403
- /**
3404
- * Type or category of the service user.
3405
- */
3406
- serviceUserType: 'InterestedParty';
3407
- /**
3408
- * First line of address of the user making the representation
3409
- */
3410
- addressLine1?: string;
3411
- /**
3412
- * Second line of address of the user making the representation
3413
- */
3414
- addressLine2?: string | null;
3415
- /**
3416
- * Town / City of the user making the representation
3417
- */
3418
- addressTown?: string;
3419
- /**
3420
- * County of the user making the representation
3421
- */
3422
- addressCounty?: string | null;
3423
- /**
3424
- * Postal code of the user making the representation
3425
- */
3426
- addressPostcode?: string;
3427
- [k: string]: unknown;
3428
- };
3429
- [k: string]: unknown;
3430
- } & {
3431
- [k: string]: unknown;
3432
- };
3433
-
3434
- /**
3435
- * Schema defining any S78 specific properties for questionnaire submissions
3436
- */
3437
- export type AppellantS78SubmissionProperties = {
3438
- /**
3439
- * Indicates if the site is an agricultural holding
3440
- */
3441
- agriculturalHolding?: boolean | null;
3442
- /**
3443
- * Indicates if the site is a tenant agricultural holding
3444
- */
3445
- tenantAgriculturalHolding?: boolean | null;
3446
- /**
3447
- * Indicates if the site is an agricultural holding with other tenants
3448
- */
3449
- otherTenantsAgriculturalHolding?: boolean | null;
3450
- /**
3451
- * If the site is an agricultural holding, indicates tenants are informed
3452
- */
3453
- informedTenantsAgriculturalHolding?: boolean | null;
3454
- /**
3455
- * The procedure preference indicated by the appellant
3456
- */
3457
- appellantProcedurePreference?: 'written' | 'hearing' | 'inquiry' | null;
3458
- /**
3459
- * The procedure details preference indicated by the appellant
3481
+ * The procedure details preference indicated by the appellant
3460
3482
  */
3461
3483
  appellantProcedurePreferenceDetails?: string | null;
3462
3484
  /**
@@ -3493,227 +3515,10 @@ export type AppellantS78SubmissionProperties = {
3493
3515
  | 'other-minor'
3494
3516
  | null;
3495
3517
  };
3496
-
3497
- /**
3498
- * Schema defining any properties common across all appeal types for appeal submissions
3499
- */
3500
- export type AppellantCommonSubmissionProperties = (
3501
- | {
3502
- siteGridReferenceEasting: {
3503
- [k: string]: unknown;
3504
- };
3505
- siteGridReferenceNorthing: {
3506
- [k: string]: unknown;
3507
- };
3508
- }
3509
- | {
3510
- siteAddressLine1: {
3511
- [k: string]: unknown;
3512
- };
3513
- siteAddressTown: {
3514
- [k: string]: unknown;
3515
- };
3516
- siteAddressPostcode: {
3517
- [k: string]: unknown;
3518
- };
3519
- }
3520
- ) & {
3521
- /**
3522
- * Case submission id - link to draft submission created by appellant
3523
- */
3524
- submissionId: string;
3525
- /**
3526
- * The type of procedure for the appeal
3527
- */
3528
- caseProcedure: 'written' | 'hearing' | 'inquiry';
3529
- /**
3530
- * A unique identifier for the Local Planning Authority
3531
- */
3532
- lpaCode: string;
3533
- /**
3534
- * The date the appeal was submitted by the appellant
3535
- */
3536
- caseSubmittedDate: string;
3537
- /**
3538
- * Indicates if an enforcement notice is the reason for the appeal
3539
- */
3540
- enforcementNotice: boolean | null;
3541
- /**
3542
- * The unique identifier of the LPA application
3543
- */
3544
- applicationReference: string;
3545
- /**
3546
- * The date of the original LPA application
3547
- */
3548
- applicationDate: string;
3549
- /**
3550
- * The outcome of the original LPA decision
3551
- */
3552
- applicationDecision: 'granted' | 'refused' | 'not_received';
3553
- /**
3554
- * The date of the original LPA decision
3555
- */
3556
- applicationDecisionDate: string | null;
3557
- /**
3558
- * The statutory deadline for submitting an appeal from the original LPA decision date
3559
- */
3560
- caseSubmissionDueDate: string | null;
3561
- /**
3562
- * First line of address for the appeal site
3563
- */
3564
- siteAddressLine1?: string | null;
3565
- /**
3566
- * Second line of address for the appeal site
3567
- */
3568
- siteAddressLine2?: string | null;
3569
- /**
3570
- * Town / City of the site address
3571
- */
3572
- siteAddressTown?: string | null;
3573
- /**
3574
- * County of the site address
3575
- */
3576
- siteAddressCounty?: string | null;
3577
- /**
3578
- * Postal code of the site address
3579
- */
3580
- siteAddressPostcode?: string | null;
3581
- siteGridReferenceEasting?: string | null;
3582
- siteGridReferenceNorthing?: string | null;
3583
- /**
3584
- * Provided information on site accessibility
3585
- */
3586
- siteAccessDetails: string[] | null;
3587
- /**
3588
- * Provided information on site health and safety
3589
- */
3590
- siteSafetyDetails: string[] | null;
3591
- /**
3592
- * A list of neighbouring site addresses
3593
- */
3594
- neighbouringSiteAddresses:
3595
- | {
3596
- /**
3597
- * First line of address of the site
3598
- */
3599
- neighbouringSiteAddressLine1: string;
3600
- /**
3601
- * Second line of address of the site
3602
- */
3603
- neighbouringSiteAddressLine2: string | null;
3604
- /**
3605
- * Town / City of the site address
3606
- */
3607
- neighbouringSiteAddressTown: string;
3608
- /**
3609
- * County of the site address
3610
- */
3611
- neighbouringSiteAddressCounty: string | null;
3612
- /**
3613
- * Postal code of the site address
3614
- */
3615
- neighbouringSiteAddressPostcode: string;
3616
- /**
3617
- * Provided information on site accessibility on this address
3618
- */
3619
- neighbouringSiteAccessDetails: string | null;
3620
- /**
3621
- * Provided information on site health and safety on this address
3622
- */
3623
- neighbouringSiteSafetyDetails: string | null;
3624
- [k: string]: unknown;
3625
- }[]
3626
- | null;
3627
- /**
3628
- * A list of related case references known to the appellant and the LPA
3629
- */
3630
- nearbyCaseReferences: string[] | null;
3631
- typeOfPlanningApplication?:
3632
- | 'full-appeal'
3633
- | 'householder-planning'
3634
- | 'outline-planning'
3635
- | 'prior-approval'
3636
- | 'reserved-matters'
3637
- | 'removal-or-variation-of-conditions'
3638
- | 'listed-building'
3639
- | 'minor-commercial-development'
3640
- | 'advertisement'
3641
- | null;
3642
- [k: string]: unknown;
3643
- };
3644
- /**
3645
- * Schema defining any HAS specific properties for submissions
3646
- */
3647
- export type AppellantHASSubmissionProperties = {
3648
- /**
3649
- * Indicates if the site is in a green belt
3650
- */
3651
- isGreenBelt?: boolean | null;
3652
- /**
3653
- * The site area, in square meters
3654
- */
3655
- siteAreaSquareMetres?: number | null;
3656
- /**
3657
- * The floor space, in square meters
3658
- */
3659
- floorSpaceSquareMetres?: number | null;
3660
- /**
3661
- * Indicates if the appellant has complete ownership of the site
3662
- */
3663
- ownsAllLand?: boolean | null;
3664
- /**
3665
- * Indicates if the appellant has partial ownership of the site
3666
- */
3667
- ownsSomeLand?: boolean | null;
3668
- /**
3669
- * Indicates if the appellant knows other owners of the site
3670
- */
3671
- knowsOtherOwners?: 'Yes' | 'No' | 'Some' | null;
3672
- /**
3673
- * Indicates if the appellant knows all owners of the site
3674
- */
3675
- knowsAllOwners?: 'Yes' | 'No' | 'Some' | null;
3676
- /**
3677
- * Indicates if the appellant has advertised the appeal to the LPA decision
3678
- */
3679
- advertisedAppeal?: boolean | null;
3680
- /**
3681
- * Indicates if the appellant has informed other owners of the site
3682
- */
3683
- ownersInformed?: boolean | null;
3684
- /**
3685
- * The original description of the development, as provided by the appellant
3686
- */
3687
- originalDevelopmentDescription?: string | null;
3688
- /**
3689
- * Indicates that the LPA has changed the development description
3690
- */
3691
- changedDevelopmentDescription?: boolean | null;
3692
- /**
3693
- * Indicates if the appellant has applied for costs
3694
- */
3695
- appellantCostsAppliedFor?: boolean | null;
3696
- };
3697
3518
  /**
3698
- * Schema defining any S78 specific properties for questionnaire submissions
3519
+ * Schema defining appellant procedure preference properties
3699
3520
  */
3700
- export type AppellantS78SubmissionProperties = {
3701
- /**
3702
- * Indicates if the site is an agricultural holding
3703
- */
3704
- agriculturalHolding?: boolean | null;
3705
- /**
3706
- * Indicates if the site is a tenant agricultural holding
3707
- */
3708
- tenantAgriculturalHolding?: boolean | null;
3709
- /**
3710
- * Indicates if the site is an agricultural holding with other tenants
3711
- */
3712
- otherTenantsAgriculturalHolding?: boolean | null;
3713
- /**
3714
- * If the site is an agricultural holding, indicates tenants are informed
3715
- */
3716
- informedTenantsAgriculturalHolding?: boolean | null;
3521
+ export type AppellantProcedurePreferenceProperties = {
3717
3522
  /**
3718
3523
  * The procedure preference indicated by the appellant
3719
3524
  */
@@ -3730,31 +3535,6 @@ export type AppellantS78SubmissionProperties = {
3730
3535
  * The number of witnesses in inquiries
3731
3536
  */
3732
3537
  appellantProcedurePreferenceWitnessCount?: number | null;
3733
- /**
3734
- * Indicates the existence of a planning obligation
3735
- */
3736
- planningObligation?: boolean | null;
3737
- /**
3738
- * The planning obligation information, if available
3739
- */
3740
- statusPlanningObligation?: string | null;
3741
- developmentType?:
3742
- | 'householder'
3743
- | 'change-of-use'
3744
- | 'major-dwellings'
3745
- | 'major-industry-storage'
3746
- | 'major-offices'
3747
- | 'major-retail-services'
3748
- | 'major-traveller-caravan'
3749
- | 'mineral-workings'
3750
- | 'minor-dwellings'
3751
- | 'minor-industry-storage'
3752
- | 'minor-offices'
3753
- | 'minor-retail-services'
3754
- | 'minor-traveller-caravan'
3755
- | 'other-major'
3756
- | 'other-minor'
3757
- | null;
3758
3538
  };
3759
3539
 
3760
3540
  /**
@@ -3770,12 +3550,19 @@ export interface AppellantSubmissionCommand {
3770
3550
  caseType?: 'W' | 'Y';
3771
3551
  } & AppellantCommonSubmissionProperties &
3772
3552
  AppellantHASSubmissionProperties &
3773
- AppellantS78SubmissionProperties)
3553
+ AppellantS78SubmissionProperties &
3554
+ AppellantProcedurePreferenceProperties)
3774
3555
  | ({
3775
- caseType?: 'H' | 'ZA';
3556
+ caseType?: 'ZA';
3776
3557
  } & AppellantCommonSubmissionProperties &
3777
3558
  AppellantHASSubmissionProperties &
3778
- AdvertSpecificProperties);
3559
+ AdvertSpecificProperties)
3560
+ | ({
3561
+ caseType?: 'H';
3562
+ } & AppellantCommonSubmissionProperties &
3563
+ AppellantHASSubmissionProperties &
3564
+ AdvertSpecificProperties &
3565
+ AppellantProcedurePreferenceProperties);
3779
3566
  documents: {
3780
3567
  /**
3781
3568
  * The unique identifier for the document
@@ -3892,183 +3679,81 @@ export interface AppellantSubmissionCommand {
3892
3679
  /**
3893
3680
  * Type or category of the service user.
3894
3681
  */
3895
- serviceUserType: 'Appellant' | 'Agent';
3896
- [k: string]: unknown;
3897
- }[]
3898
- ];
3899
- [k: string]: unknown;
3900
- }
3901
- /**
3902
- * Schema defining any properties for advertisement appeals
3903
- */
3904
- export interface AdvertSpecificProperties {
3905
- /**
3906
- * Indicates if the appellant has land owners permission
3907
- */
3908
- hasLandownersPermission: boolean | null;
3909
- /**
3910
- * Indicates if the advert is already in position
3911
- */
3912
- isAdvertInPosition: boolean | null;
3913
- /**
3914
- * Indicates if site is on highway land
3915
- */
3916
- isSiteOnHighwayLand: boolean | null;
3917
- [k: string]: unknown;
3918
- }
3919
-
3920
- export type Name = string;
3921
-
3922
- /**
3923
- * Subset of Pins Data Model [Service User]
3924
- */
3925
- export interface InterestedParty {
3926
- id?: number;
3927
- interestedPartyNumber?: string;
3928
- firstName?: string;
3929
- lastName?: string;
3930
- under18?: boolean;
3931
- organisationName?: Name;
3932
- jobTitle?: string;
3933
- contactMethod?: 'email' | 'post';
3934
- email?: string;
3935
- phoneNumber?: string;
3936
- address?: Address;
3937
- [k: string]: unknown;
3938
- }
3939
- export interface Address {
3940
- addressLine1: string;
3941
- addressLine2?: string;
3942
- town: string;
3943
- postcode: string;
3944
- country?: string;
3945
- }
3946
-
3947
- /**
3948
- * Schema defining any cas advert specific properties for LPAQ submissions
3949
- */
3950
- export type LPAQCasAdvertSubmissionProperties = {
3951
- /**
3952
- * Indicates that a scheduled monument is affected
3953
- */
3954
- affectsScheduledMonument?: boolean | null;
3955
- /**
3956
- * Indicates the existence of protected species
3957
- */
3958
- hasProtectedSpecies?: boolean | null;
3959
- /**
3960
- * Indicates an area of outstanding beauty (National Landscape)
3961
- */
3962
- isAonbNationalLandscape?: boolean | null;
3963
- /**
3964
- * The designated site names
3965
- */
3966
- designatedSitesNames?: string[] | null;
3967
- /**
3968
- * Indicates statutory consultees
3969
- */
3970
- hasStatutoryConsultees?: boolean | null;
3971
- /**
3972
- * The details of the bodies consulted
3973
- */
3974
- consultedBodiesDetails?: string | null;
3975
- /**
3976
- * Indicates emerging plans
3977
- */
3978
- hasEmergingPlan?: boolean | null;
3979
- /**
3980
- * The procedure preference indicated by the LPA
3981
- */
3982
- lpaProcedurePreference?: 'written' | 'hearing' | 'inquiry' | null;
3983
- /**
3984
- * The procedure details preference indicated by the LPA
3985
- */
3986
- lpaProcedurePreferenceDetails?: string | null;
3987
- /**
3988
- * The duration of enquiry indicated by the LPA
3989
- */
3990
- lpaProcedurePreferenceDuration?: number | null;
3991
- /**
3992
- * Indicates if the site is in an area of special control for adverts
3993
- */
3994
- isSiteInAreaOfSpecialControlAdverts?: boolean | null;
3995
- /**
3996
- * Indicates if the application was refused because of highway or traffic public safety?
3997
- */
3998
- wasApplicationRefusedDueToHighwayOrTraffic?: boolean | null;
3999
- /**
4000
- * Indicates if the appellant submitted complete and accurate photographs and plans
4001
- */
4002
- didAppellantSubmitCompletePhotosAndPlans?: boolean | null;
4003
- };
4004
-
4005
- /**
4006
- * Schema defining any properties common across all appeal types for LPAQ submissions
4007
- */
4008
- export interface LPAQCommonSubmissionProperties {
4009
- /**
4010
- * External case identifier
4011
- */
4012
- caseReference: string;
4013
- /**
4014
- * The date the LPA provided a response to the case
4015
- */
4016
- lpaQuestionnaireSubmittedDate: string | null;
4017
- /**
4018
- * Provided information on site accessibility
4019
- */
4020
- siteAccessDetails: string[] | null;
4021
- /**
4022
- * Provided information on site health and safety
4023
- */
4024
- siteSafetyDetails: string[] | null;
3682
+ serviceUserType: 'Appellant' | 'Agent';
3683
+ [k: string]: unknown;
3684
+ }[]
3685
+ ];
3686
+ [k: string]: unknown;
3687
+ }
3688
+ /**
3689
+ * Schema defining any properties for advertisement appeals
3690
+ */
3691
+ export interface AdvertSpecificProperties {
4025
3692
  /**
4026
- * A list of related case references known to the appellant and the LPA
3693
+ * Indicates if the appellant has land owners permission
4027
3694
  */
4028
- nearbyCaseReferences: string[] | null;
3695
+ hasLandownersPermission: boolean | null;
4029
3696
  /**
4030
- * A list of neighbouring site addresses
3697
+ * A list of advertisements for the appeal
4031
3698
  */
4032
- neighbouringSiteAddresses:
3699
+ advertDetails:
4033
3700
  | {
3701
+ advertType:
3702
+ | '4-6 Sheet Non-Illuminated'
3703
+ | '4-6 Sheet Illuminated'
3704
+ | '12/16/32 Sheet Non-Illuminated'
3705
+ | '12/16/32 Sheet Illuminated'
3706
+ | '48/64/96 Sheet Non-Illuminated'
3707
+ | '48/64/96 Sheet Illuminated'
3708
+ | 'Fascia Projecting Signs Non-Illuminated'
3709
+ | 'Fascia Projecting Signs Illuminated'
3710
+ | 'Directional & Others Non-Illuminated'
3711
+ | 'Directional & Others Illuminated'
3712
+ | 'Monolith/Totem Signs Non-Illuminated'
3713
+ | 'Monolith/Totem Signs Illuminated'
3714
+ | 'Other'
3715
+ | null;
4034
3716
  /**
4035
- * First line of address of the site
4036
- */
4037
- neighbouringSiteAddressLine1: string;
4038
- /**
4039
- * Second line of address of the site
4040
- */
4041
- neighbouringSiteAddressLine2: string | null;
4042
- /**
4043
- * Town / City of the site address
4044
- */
4045
- neighbouringSiteAddressTown: string;
4046
- /**
4047
- * County of the site address
4048
- */
4049
- neighbouringSiteAddressCounty: string | null;
4050
- /**
4051
- * Postal code of the site address
4052
- */
4053
- neighbouringSiteAddressPostcode: string;
4054
- /**
4055
- * Provided information on site accessibility on this address
3717
+ * Is the advertisement in position?
4056
3718
  */
4057
- neighbouringSiteAccessDetails: string | null;
3719
+ isAdvertInPosition: boolean | null;
4058
3720
  /**
4059
- * Provided information on site health and safety on this address
3721
+ * Is the site on highway land?
4060
3722
  */
4061
- neighbouringSiteSafetyDetails: string | null;
3723
+ isSiteOnHighwayLand: boolean | null;
4062
3724
  [k: string]: unknown;
4063
3725
  }[]
4064
3726
  | null;
4065
- /**
4066
- * A general reason given for the need to visit any neighbours
4067
- */
4068
- reasonForNeighbourVisits?: string | null;
4069
3727
  [k: string]: unknown;
4070
3728
  }
4071
3729
 
3730
+ export type Name = string;
3731
+
3732
+ /**
3733
+ * Subset of Pins Data Model [Service User]
3734
+ */
3735
+ export interface InterestedParty {
3736
+ id?: number;
3737
+ interestedPartyNumber?: string;
3738
+ firstName?: string;
3739
+ lastName?: string;
3740
+ under18?: boolean;
3741
+ organisationName?: Name;
3742
+ jobTitle?: string;
3743
+ contactMethod?: 'email' | 'post';
3744
+ email?: string;
3745
+ phoneNumber?: string;
3746
+ address?: Address;
3747
+ [k: string]: unknown;
3748
+ }
3749
+ export interface Address {
3750
+ addressLine1: string;
3751
+ addressLine2?: string;
3752
+ town: string;
3753
+ postcode: string;
3754
+ country?: string;
3755
+ }
3756
+
4072
3757
  /**
4073
3758
  * Schema defining any HAS specific properties for LPAQ submissions
4074
3759
  */
@@ -4106,7 +3791,6 @@ export type LPAQHASSubmissionProperties = {
4106
3791
  */
4107
3792
  lpaStatement?: string | null;
4108
3793
  };
4109
-
4110
3794
  /**
4111
3795
  * Schema defining any S78 specific properties for LPAQ submissions
4112
3796
  */
@@ -4229,6 +3913,11 @@ export type LPAQS78SubmissionProperties = {
4229
3913
  * The expected date of the infrastructure levy
4230
3914
  */
4231
3915
  infrastructureLevyExpectedDate?: string | null;
3916
+ };
3917
+ /**
3918
+ * Schema defining LPA procedure preference properties
3919
+ */
3920
+ export type LPAProcedurePreferenceProperties = {
4232
3921
  /**
4233
3922
  * The procedure preference indicated by the LPA
4234
3923
  */
@@ -4242,181 +3931,17 @@ export type LPAQS78SubmissionProperties = {
4242
3931
  */
4243
3932
  lpaProcedurePreferenceDuration?: number | null;
4244
3933
  };
4245
-
4246
- /**
4247
- * Schema defining any HAS specific properties for LPAQ submissions
4248
- */
4249
- export type LPAQHASSubmissionProperties = {
4250
- /**
4251
- * Indicates if the LPA considers the appeal type appropriate
4252
- */
4253
- isCorrectAppealType?: boolean | null;
4254
- /**
4255
- * A list of affected listed building IDs from Historic England
4256
- */
4257
- affectedListedBuildingNumbers?: string[] | null;
4258
- /**
4259
- * Indicates if the site is in a green belt
4260
- */
4261
- isGreenBelt?: boolean | null;
4262
- /**
4263
- * Indicates if the site is in a conservation area
4264
- */
4265
- inConservationArea?: boolean | null;
4266
- /**
4267
- * New conditions details provided by the LPA
4268
- */
4269
- newConditionDetails?: string | null;
4270
- /**
4271
- * The methods used to notify relevant parties
4272
- */
4273
- notificationMethod?: string[] | null;
4274
- /**
4275
- * Indicates if the LPA has applied for costs
4276
- */
4277
- lpaCostsAppliedFor?: boolean | null;
4278
- /**
4279
- * A statement provided by the LPA, unused?
4280
- */
4281
- lpaStatement?: string | null;
4282
- };
4283
3934
  /**
4284
- * Schema defining any S78 specific properties for LPAQ submissions
3935
+ * Schema defining changed-listed-building-numbers
4285
3936
  */
4286
- export type LPAQS78SubmissionProperties = {
3937
+ export type ChangedListedBuildingNumbersProperties = {
4287
3938
  /**
4288
3939
  * A list of changed listed building IDs from Historic England
4289
3940
  */
4290
3941
  changedListedBuildingNumbers?: string[] | null;
4291
- /**
4292
- * A grant or loan has been made to preserve the listed building
4293
- */
4294
- preserveGrantLoan?: boolean | null;
4295
- /**
4296
- * Are Historic England to be consulted?
4297
- */
4298
- consultHistoricEngland?: boolean | null;
4299
- /**
4300
- * Indicates that a scheduled monument is affected
4301
- */
4302
- affectsScheduledMonument?: boolean | null;
4303
- /**
4304
- * Indicates the existence of protected species
4305
- */
4306
- hasProtectedSpecies?: boolean | null;
4307
- /**
4308
- * Indicates an area of outstanding beauty (National Landscape)
4309
- */
4310
- isAonbNationalLandscape?: boolean | null;
4311
- /**
4312
- * The designated site names
4313
- */
4314
- designatedSitesNames?: string[] | null;
4315
- /**
4316
- * Indicates a TPO (tree preservation order)
4317
- */
4318
- hasTreePreservationOrder?: boolean | null;
4319
- /**
4320
- * Indicates a traveller site
4321
- */
4322
- isGypsyOrTravellerSite?: boolean | null;
4323
- /**
4324
- * Indicates a PROW (public right of way)
4325
- */
4326
- isPublicRightOfWay?: boolean | null;
4327
- /**
4328
- * The impact schedule from EIA
4329
- */
4330
- eiaEnvironmentalImpactSchedule?: 'schedule-1' | 'schedule-2' | null;
4331
- /**
4332
- * The development description from EIA
4333
- */
4334
- eiaDevelopmentDescription?:
4335
- | 'agriculture-aquaculture'
4336
- | 'change-extensions'
4337
- | 'chemical-industry'
4338
- | 'energy-industry'
4339
- | 'extractive-industry'
4340
- | 'food-industry'
4341
- | 'infrastructure-projects'
4342
- | 'mineral-industry'
4343
- | 'other-projects'
4344
- | 'production-processing-of-metals'
4345
- | 'rubber-industry'
4346
- | 'textile-industries'
4347
- | 'tourism-leisure'
4348
- | null;
4349
- /**
4350
- * The sensitive area details from EIA
4351
- */
4352
- eiaSensitiveAreaDetails?: string | null;
4353
- /**
4354
- * EIA specific threshold
4355
- */
4356
- eiaColumnTwoThreshold?: boolean | null;
4357
- /**
4358
- * EIA screening opinion
4359
- */
4360
- eiaScreeningOpinion?: boolean | null;
4361
- /**
4362
- * EIA environmental statement required
4363
- */
4364
- eiaRequiresEnvironmentalStatement?: boolean | null;
4365
- /**
4366
- * EIA completed environmental statement required
4367
- */
4368
- eiaCompletedEnvironmentalStatement?: boolean | null;
4369
- /**
4370
- * Indicates statutory consultees
4371
- */
4372
- hasStatutoryConsultees?: boolean | null;
4373
- /**
4374
- * The details of the bodies consulted
4375
- */
4376
- consultedBodiesDetails?: string | null;
4377
- /**
4378
- * Indicates consultation responses
4379
- */
4380
- hasConsultationResponses?: boolean | null;
4381
- /**
4382
- * Indicates emerging plans
4383
- */
4384
- hasEmergingPlan?: boolean | null;
4385
- /**
4386
- * Indicates supplementary planning documents
4387
- */
4388
- hasSupplementaryPlanningDocs?: boolean | null;
4389
- /**
4390
- * Indicates the existence of an infrastructure levy
4391
- */
4392
- hasInfrastructureLevy?: boolean | null;
4393
- /**
4394
- * Indicates if the infrastructure levy is formally adopted
4395
- */
4396
- isInfrastructureLevyFormallyAdopted?: boolean | null;
4397
- /**
4398
- * The date of the infrastructure levy adoption
4399
- */
4400
- infrastructureLevyAdoptedDate?: string | null;
4401
- /**
4402
- * The expected date of the infrastructure levy
4403
- */
4404
- infrastructureLevyExpectedDate?: string | null;
4405
- /**
4406
- * The procedure preference indicated by the LPA
4407
- */
4408
- lpaProcedurePreference?: 'written' | 'hearing' | 'inquiry' | null;
4409
- /**
4410
- * The procedure details preference indicated by the LPA
4411
- */
4412
- lpaProcedurePreferenceDetails?: string | null;
4413
- /**
4414
- * The duration of enquiry indicated by the LPA
4415
- */
4416
- lpaProcedurePreferenceDuration?: number | null;
4417
3942
  };
4418
3943
  /**
4419
- * Schema defining any cas advert specific properties for LPAQ submissions
3944
+ * Schema defining any advert specific properties for LPAQ submissions
4420
3945
  */
4421
3946
  export type LPAQCasAdvertSubmissionProperties = {
4422
3947
  /**
@@ -4447,18 +3972,6 @@ export type LPAQCasAdvertSubmissionProperties = {
4447
3972
  * Indicates emerging plans
4448
3973
  */
4449
3974
  hasEmergingPlan?: boolean | null;
4450
- /**
4451
- * The procedure preference indicated by the LPA
4452
- */
4453
- lpaProcedurePreference?: 'written' | 'hearing' | 'inquiry' | null;
4454
- /**
4455
- * The procedure details preference indicated by the LPA
4456
- */
4457
- lpaProcedurePreferenceDetails?: string | null;
4458
- /**
4459
- * The duration of enquiry indicated by the LPA
4460
- */
4461
- lpaProcedurePreferenceDuration?: number | null;
4462
3975
  /**
4463
3976
  * Indicates if the site is in an area of special control for adverts
4464
3977
  */
@@ -4486,12 +3999,22 @@ export interface LPAQuestionnaireCommand {
4486
3999
  caseType?: 'W' | 'Y';
4487
4000
  } & LPAQCommonSubmissionProperties &
4488
4001
  LPAQHASSubmissionProperties &
4489
- LPAQS78SubmissionProperties)
4002
+ LPAQS78SubmissionProperties &
4003
+ LPAProcedurePreferenceProperties &
4004
+ ChangedListedBuildingNumbersProperties)
4005
+ | ({
4006
+ caseType?: 'ZA';
4007
+ } & LPAQCommonSubmissionProperties &
4008
+ LPAQHASSubmissionProperties &
4009
+ LPAProcedurePreferenceProperties &
4010
+ LPAQCasAdvertSubmissionProperties)
4490
4011
  | ({
4491
- caseType?: 'H' | 'ZA';
4012
+ caseType?: 'H';
4492
4013
  } & LPAQCommonSubmissionProperties &
4493
4014
  LPAQHASSubmissionProperties &
4494
- LPAQCasAdvertSubmissionProperties);
4015
+ LPAQCasAdvertSubmissionProperties &
4016
+ LPAProcedurePreferenceProperties &
4017
+ ChangedListedBuildingNumbersProperties);
4495
4018
  documents: {
4496
4019
  /**
4497
4020
  * The unique identifier for the document