@planning-inspectorate/data-model 1.18.1 → 1.20.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/.github/dependabot.yml +5 -0
- package/docs/README.md +20 -0
- package/docs/nsip-project-defs-invoice.md +267 -0
- package/docs/nsip-project-defs-meeting.md +122 -0
- package/docs/nsip-project-defs.md +3 -0
- package/docs/nsip-project.md +1889 -7
- package/package.json +4 -4
- package/pins_data_model/models/model_appeal_document.py +1 -1
- package/pins_data_model/models/model_appeal_event.py +1 -1
- package/pins_data_model/models/model_appeal_event_estimate.py +1 -1
- package/pins_data_model/models/model_appeal_has.py +1 -1
- package/pins_data_model/models/model_appeal_representation.py +1 -1
- package/pins_data_model/models/model_appeal_s78.py +1 -1
- package/pins_data_model/models/model_dart_response.py +1 -1
- package/pins_data_model/models/model_entraid.py +1 -1
- package/pins_data_model/models/model_folder.py +1 -1
- package/pins_data_model/models/model_gettimesheets_response.py +1 -1
- package/pins_data_model/models/model_listed_building.py +1 -1
- package/pins_data_model/models/model_listed_buildings.py +1 -1
- package/pins_data_model/models/model_nsip_document.py +1 -1
- package/pins_data_model/models/model_nsip_exam_timetable.py +1 -1
- package/pins_data_model/models/model_nsip_project.py +535 -3
- package/pins_data_model/models/model_nsip_project_update.py +1 -1
- package/pins_data_model/models/model_nsip_representation.py +1 -1
- package/pins_data_model/models/model_nsip_subscription.py +1 -1
- package/pins_data_model/models/model_pins_inspector.py +1 -1
- package/pins_data_model/models/model_pins_lpa.py +1 -1
- package/pins_data_model/models/model_s51_advice.py +1 -1
- package/pins_data_model/models/model_service_user.py +1 -1
- package/schemas/commands/lpa-questionnaire-cas-advert.schema.json +95 -0
- package/schemas/commands/lpa-questionnaire.schema.json +3 -1
- package/schemas/nsip-project.schema.json +420 -2
- package/src/enums.cjs +678 -581
- package/src/enums.d.ts +668 -583
- package/src/enums.js +668 -583
- package/src/index.cjs +678 -581
- package/src/lib/gen-enums.js +1 -1
- package/src/schemas.d.ts +408 -4
- package/tests/appeals/commands/adverts-questionnaire.test.js +15 -9
- package/tests/appeals/commands/cas-adverts-questionnaire.test.js +98 -0
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
|
+
"$id": "commands/lpa-questionnaire-cas-advert.schema.json",
|
|
4
|
+
"title": "LPAQ cas advert submission properties",
|
|
5
|
+
"description": "Schema defining any cas advert specific properties for LPAQ submissions",
|
|
6
|
+
"type": "object",
|
|
7
|
+
"additionalProperties": true,
|
|
8
|
+
"required": [
|
|
9
|
+
"affectsScheduledMonument",
|
|
10
|
+
"hasProtectedSpecies",
|
|
11
|
+
"isAonbNationalLandscape",
|
|
12
|
+
"designatedSitesNames",
|
|
13
|
+
"hasStatutoryConsultees",
|
|
14
|
+
"consultedBodiesDetails",
|
|
15
|
+
"hasEmergingPlan",
|
|
16
|
+
"lpaProcedurePreference",
|
|
17
|
+
"lpaProcedurePreferenceDetails",
|
|
18
|
+
"lpaProcedurePreferenceDuration",
|
|
19
|
+
"isSiteInAreaOfSpecialControlAdverts",
|
|
20
|
+
"wasApplicationRefusedDueToHighwayOrTraffic",
|
|
21
|
+
"didAppellantSubmitCompletePhotosAndPlans"
|
|
22
|
+
],
|
|
23
|
+
"allOf": [
|
|
24
|
+
{
|
|
25
|
+
"properties": {
|
|
26
|
+
"affectsScheduledMonument": {
|
|
27
|
+
"type": ["boolean", "null"],
|
|
28
|
+
"description": "Indicates that a scheduled monument is affected",
|
|
29
|
+
"$comment": "Only available in S78 cases"
|
|
30
|
+
},
|
|
31
|
+
"hasProtectedSpecies": {
|
|
32
|
+
"type": ["boolean", "null"],
|
|
33
|
+
"description": "Indicates the existence of protected species",
|
|
34
|
+
"$comment": "Only available in S78 cases"
|
|
35
|
+
},
|
|
36
|
+
"isAonbNationalLandscape": {
|
|
37
|
+
"type": ["boolean", "null"],
|
|
38
|
+
"description": "Indicates an area of outstanding beauty (National Landscape)",
|
|
39
|
+
"$comment": "Only available in S78 cases"
|
|
40
|
+
},
|
|
41
|
+
"designatedSitesNames": {
|
|
42
|
+
"type": ["array", "null"],
|
|
43
|
+
"items": {
|
|
44
|
+
"type": "string",
|
|
45
|
+
"examples": ["SSSI", "cSAC", "SAC", "pSPA", "SPA", "user entered value"]
|
|
46
|
+
},
|
|
47
|
+
"description": "The designated site names",
|
|
48
|
+
"$comment": "Only available in S78 cases"
|
|
49
|
+
},
|
|
50
|
+
"hasStatutoryConsultees": {
|
|
51
|
+
"type": ["boolean", "null"],
|
|
52
|
+
"description": "Indicates statutory consultees",
|
|
53
|
+
"$comment": "Only available in S78 cases"
|
|
54
|
+
},
|
|
55
|
+
"consultedBodiesDetails": {
|
|
56
|
+
"type": ["string", "null"],
|
|
57
|
+
"description": "The details of the bodies consulted"
|
|
58
|
+
},
|
|
59
|
+
"hasEmergingPlan": {
|
|
60
|
+
"type": ["boolean", "null"],
|
|
61
|
+
"description": "Indicates emerging plans",
|
|
62
|
+
"$comment": "Only available in S78 cases"
|
|
63
|
+
},
|
|
64
|
+
"lpaProcedurePreference": {
|
|
65
|
+
"type": ["string", "null"],
|
|
66
|
+
"enum": ["written", "hearing", "inquiry", null],
|
|
67
|
+
"description": "The procedure preference indicated by the LPA",
|
|
68
|
+
"$comment": "Only available in S78 cases"
|
|
69
|
+
},
|
|
70
|
+
"lpaProcedurePreferenceDetails": {
|
|
71
|
+
"type": ["string", "null"],
|
|
72
|
+
"description": "The procedure details preference indicated by the LPA",
|
|
73
|
+
"$comment": "Only available in S78 cases"
|
|
74
|
+
},
|
|
75
|
+
"lpaProcedurePreferenceDuration": {
|
|
76
|
+
"type": ["number", "null"],
|
|
77
|
+
"description": "The duration of enquiry indicated by the LPA",
|
|
78
|
+
"$comment": "Only available in S78 cases"
|
|
79
|
+
},
|
|
80
|
+
"isSiteInAreaOfSpecialControlAdverts": {
|
|
81
|
+
"type": ["boolean", "null"],
|
|
82
|
+
"description": "Indicates if the site is in an area of special control for adverts"
|
|
83
|
+
},
|
|
84
|
+
"wasApplicationRefusedDueToHighwayOrTraffic": {
|
|
85
|
+
"type": ["boolean", "null"],
|
|
86
|
+
"description": "Indicates if the application was refused because of highway or traffic public safety?"
|
|
87
|
+
},
|
|
88
|
+
"didAppellantSubmitCompletePhotosAndPlans": {
|
|
89
|
+
"type": ["boolean", "null"],
|
|
90
|
+
"description": "Indicates if the appellant submitted complete and accurate photographs and plans"
|
|
91
|
+
}
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
]
|
|
95
|
+
}
|
|
@@ -33,7 +33,9 @@
|
|
|
33
33
|
"$comment": "Adverts + CAS Adverts - TBD - may need separate schemas",
|
|
34
34
|
"allOf": [
|
|
35
35
|
{ "properties": { "caseType": { "enum": ["H", "ZA"] } } },
|
|
36
|
-
{ "$ref": "lpa-questionnaire-common.schema.json" }
|
|
36
|
+
{ "$ref": "lpa-questionnaire-common.schema.json" },
|
|
37
|
+
{ "$ref": "lpa-questionnaire-has.schema.json" },
|
|
38
|
+
{ "$ref": "lpa-questionnaire-cas-advert.schema.json" }
|
|
37
39
|
]
|
|
38
40
|
}
|
|
39
41
|
]
|
|
@@ -105,8 +105,18 @@
|
|
|
105
105
|
},
|
|
106
106
|
"decision": {
|
|
107
107
|
"type": ["string", "null"],
|
|
108
|
-
"description": "Decision: approved/refused/split-decision",
|
|
109
|
-
"enum": [
|
|
108
|
+
"description": "Decision outcome: approved/refused/split-decision/granted/partially_consented/quashed/redetermination/withdrawn",
|
|
109
|
+
"enum": [
|
|
110
|
+
"approved",
|
|
111
|
+
"refused",
|
|
112
|
+
"split-decision",
|
|
113
|
+
"granted",
|
|
114
|
+
"partially_consented",
|
|
115
|
+
"quashed",
|
|
116
|
+
"redetermination",
|
|
117
|
+
"withdrawn",
|
|
118
|
+
null
|
|
119
|
+
]
|
|
110
120
|
},
|
|
111
121
|
"publishStatus": {
|
|
112
122
|
"type": ["string", "null"],
|
|
@@ -534,6 +544,414 @@
|
|
|
534
544
|
"type": ["boolean", "null"],
|
|
535
545
|
"description": "Is this an application for a material change?",
|
|
536
546
|
"examples": [true, false]
|
|
547
|
+
},
|
|
548
|
+
"courtDecisionDate": {
|
|
549
|
+
"type": ["string", "null"],
|
|
550
|
+
"description": "Date of court decision",
|
|
551
|
+
"format": "date-time",
|
|
552
|
+
"examples": ["2023-07-27T20:30:00.000Z"]
|
|
553
|
+
},
|
|
554
|
+
"courtDecisionOutcomeText": {
|
|
555
|
+
"type": ["string", "null"],
|
|
556
|
+
"description": "Court decision outcome text; values include 'upheld','partially_upheld','quashed','other:<Text>'",
|
|
557
|
+
"examples": ["upheld"]
|
|
558
|
+
},
|
|
559
|
+
"decisionChallengeSubmissionDate": {
|
|
560
|
+
"type": ["string", "null"],
|
|
561
|
+
"description": "Date of decision challenge submission",
|
|
562
|
+
"format": "date-time",
|
|
563
|
+
"examples": ["2023-07-27T20:30:00.000Z"]
|
|
564
|
+
},
|
|
565
|
+
"recommendation": {
|
|
566
|
+
"type": ["string", "null"],
|
|
567
|
+
"description": "Recommendation",
|
|
568
|
+
"enum": ["recommend_consent", "recommend_partial_consent", "recommend_refusal", null],
|
|
569
|
+
"examples": ["recommend_consent"]
|
|
570
|
+
},
|
|
571
|
+
"inceptionMeetingDate": {
|
|
572
|
+
"type": ["string", "null"],
|
|
573
|
+
"description": "Date of inception meeting",
|
|
574
|
+
"format": "date-time",
|
|
575
|
+
"examples": ["2023-07-27T20:30:00.000Z"]
|
|
576
|
+
},
|
|
577
|
+
"draftDocumentSubmissionDate": {
|
|
578
|
+
"type": ["string", "null"],
|
|
579
|
+
"description": "Date for submission of draft documents",
|
|
580
|
+
"format": "date-time",
|
|
581
|
+
"examples": ["2023-07-27T20:30:00.000Z"]
|
|
582
|
+
},
|
|
583
|
+
"programmeDocumentSubmissionDate": {
|
|
584
|
+
"type": ["string", "null"],
|
|
585
|
+
"description": "Programme document submission date",
|
|
586
|
+
"format": "date-time",
|
|
587
|
+
"examples": ["2023-07-27T20:30:00.000Z"]
|
|
588
|
+
},
|
|
589
|
+
"tier": {
|
|
590
|
+
"type": ["string", "null"],
|
|
591
|
+
"description": "Tier",
|
|
592
|
+
"enum": ["basic", "standard", "enhanced", null],
|
|
593
|
+
"examples": ["basic"]
|
|
594
|
+
},
|
|
595
|
+
"s61SummaryURI": {
|
|
596
|
+
"type": ["string", "null"],
|
|
597
|
+
"description": "Link to s61 summary",
|
|
598
|
+
"examples": ["s61.sharepoint.com/"]
|
|
599
|
+
},
|
|
600
|
+
"estimatedScopingSubmissionDate": {
|
|
601
|
+
"type": ["string", "null"],
|
|
602
|
+
"description": "Estimated scoping submission date",
|
|
603
|
+
"format": "date-time",
|
|
604
|
+
"examples": ["2023-07-27T20:30:00.000Z"]
|
|
605
|
+
},
|
|
606
|
+
"consultationMilestoneAdequacyDate": {
|
|
607
|
+
"type": ["string", "null"],
|
|
608
|
+
"description": "Adequacy of Consultation Milestone",
|
|
609
|
+
"format": "date-time",
|
|
610
|
+
"examples": ["2023-07-27T20:30:00.000Z"]
|
|
611
|
+
},
|
|
612
|
+
"planProcessEvidence": {
|
|
613
|
+
"type": ["boolean", "null"],
|
|
614
|
+
"description": "Evidence plan process",
|
|
615
|
+
"examples": [true]
|
|
616
|
+
},
|
|
617
|
+
"issuesTracker": {
|
|
618
|
+
"type": ["string", "null"],
|
|
619
|
+
"description": "Issues tracker",
|
|
620
|
+
"examples": ["tracker.sharepoint.com/"]
|
|
621
|
+
},
|
|
622
|
+
"essentialFastTrackComponents": {
|
|
623
|
+
"type": ["boolean", "null"],
|
|
624
|
+
"description": "Essential fast track components",
|
|
625
|
+
"examples": [true]
|
|
626
|
+
},
|
|
627
|
+
"principalAreaDisagreementSummaryStmt": {
|
|
628
|
+
"type": ["string", "null"],
|
|
629
|
+
"description": "Principal area disagreement summary statement (PADSS)",
|
|
630
|
+
"enum": ["submitted_by_applicant", "awaiting_submission", "not_applicable", null],
|
|
631
|
+
"examples": ["submitted_by_applicant"]
|
|
632
|
+
},
|
|
633
|
+
"principalAreaDisagreementSummaryStmtSubmittedDate": {
|
|
634
|
+
"type": ["string", "null"],
|
|
635
|
+
"description": "Principal area disagreement summary statement (PADSS) Submitted date",
|
|
636
|
+
"format": "date-time",
|
|
637
|
+
"examples": ["2023-07-27T20:30:00.000Z"]
|
|
638
|
+
},
|
|
639
|
+
"policyComplianceDocument": {
|
|
640
|
+
"type": ["string", "null"],
|
|
641
|
+
"description": "Policy compliance document (PCD)",
|
|
642
|
+
"enum": ["submitted_by_applicant", "awaiting_submission", "not_applicable", null],
|
|
643
|
+
"examples": ["submitted_by_applicant"]
|
|
644
|
+
},
|
|
645
|
+
"policyComplianceDocumentSubmittedDate": {
|
|
646
|
+
"type": ["string", "null"],
|
|
647
|
+
"description": "Policy compliance document (PCD) Submitted Date",
|
|
648
|
+
"format": "date-time",
|
|
649
|
+
"examples": ["2023-07-27T20:30:00.000Z"]
|
|
650
|
+
},
|
|
651
|
+
"designApproachDocument": {
|
|
652
|
+
"type": ["string", "null"],
|
|
653
|
+
"description": "Design approach document (DAD)",
|
|
654
|
+
"enum": ["submitted_by_applicant", "awaiting_submission", "not_applicable", null],
|
|
655
|
+
"examples": ["submitted_by_applicant"]
|
|
656
|
+
},
|
|
657
|
+
"designApproachDocumentSubmittedDate": {
|
|
658
|
+
"type": ["string", "null"],
|
|
659
|
+
"description": "Design approach document (DAD) Submitted Date",
|
|
660
|
+
"format": "date-time",
|
|
661
|
+
"examples": ["2023-07-27T20:30:00.000Z"]
|
|
662
|
+
},
|
|
663
|
+
"matureOutlineControlDocument": {
|
|
664
|
+
"type": ["string", "null"],
|
|
665
|
+
"description": "Mature outline control documents",
|
|
666
|
+
"enum": ["submitted_by_applicant", "awaiting_submission", "not_applicable", null],
|
|
667
|
+
"examples": ["submitted_by_applicant"]
|
|
668
|
+
},
|
|
669
|
+
"matureOutlineControlDocumentSubmittedDate": {
|
|
670
|
+
"type": ["string", "null"],
|
|
671
|
+
"description": "Mature outline control documents Submitted Date",
|
|
672
|
+
"format": "date-time",
|
|
673
|
+
"examples": ["2023-07-27T20:30:00.000Z"]
|
|
674
|
+
},
|
|
675
|
+
"caAndTpEvidence": {
|
|
676
|
+
"type": ["string", "null"],
|
|
677
|
+
"description": "CA and TP evidence",
|
|
678
|
+
"enum": ["submitted_by_applicant", "awaiting_submission", "not_applicable", null],
|
|
679
|
+
"examples": ["submitted_by_applicant"]
|
|
680
|
+
},
|
|
681
|
+
"caAndTpEvidenceSubmittedDate": {
|
|
682
|
+
"type": ["string", "null"],
|
|
683
|
+
"description": "CA and TP evidence Submitted Date",
|
|
684
|
+
"format": "date-time",
|
|
685
|
+
"examples": ["2023-07-27T20:30:00.000Z"]
|
|
686
|
+
},
|
|
687
|
+
"publicSectorEqualityDuty": {
|
|
688
|
+
"type": ["string", "null"],
|
|
689
|
+
"description": "Public sector equality duty (PSED)",
|
|
690
|
+
"enum": ["submitted_by_applicant", "awaiting_submission", "not_applicable", null],
|
|
691
|
+
"examples": ["submitted_by_applicant"]
|
|
692
|
+
},
|
|
693
|
+
"publicSectorEqualityDutySubmittedDate": {
|
|
694
|
+
"type": ["string", "null"],
|
|
695
|
+
"description": "Public sector equality duty (PSED) Submitted Date",
|
|
696
|
+
"format": "date-time",
|
|
697
|
+
"examples": ["2023-07-27T20:30:00.000Z"]
|
|
698
|
+
},
|
|
699
|
+
"fastTrackAdmissionDocument": {
|
|
700
|
+
"type": ["string", "null"],
|
|
701
|
+
"description": "Fast track admission document",
|
|
702
|
+
"enum": ["submitted_by_applicant", "awaiting_submission", "not_applicable", null],
|
|
703
|
+
"examples": ["submitted_by_applicant"]
|
|
704
|
+
},
|
|
705
|
+
"fastTrackAdmissionDocumentSubmittedDate": {
|
|
706
|
+
"type": ["string", "null"],
|
|
707
|
+
"description": "Fast track admission document Submitted Date",
|
|
708
|
+
"format": "date-time",
|
|
709
|
+
"examples": ["2023-07-27T20:30:00.000Z"]
|
|
710
|
+
},
|
|
711
|
+
"multipartyApplicationCheckDocument": {
|
|
712
|
+
"type": ["string", "null"],
|
|
713
|
+
"description": "Multiparty application readiness gate-check (trial)",
|
|
714
|
+
"enum": ["submitted_by_applicant", "awaiting_submission", "not_applicable", null],
|
|
715
|
+
"examples": ["submitted_by_applicant"]
|
|
716
|
+
},
|
|
717
|
+
"multipartyApplicationCheckDocumentSubmittedDate": {
|
|
718
|
+
"type": ["string", "null"],
|
|
719
|
+
"description": "Multiparty application readiness gate-check Submitted Date (trial)",
|
|
720
|
+
"format": "date-time",
|
|
721
|
+
"examples": ["2023-07-27T20:30:00.000Z"]
|
|
722
|
+
},
|
|
723
|
+
"programmeDocumentURI": {
|
|
724
|
+
"type": ["string", "null"],
|
|
725
|
+
"description": "Link to programme document",
|
|
726
|
+
"examples": ["progdoc.sharepoint.com/"]
|
|
727
|
+
},
|
|
728
|
+
"updatedProgrammeDocumentReceivedDate": {
|
|
729
|
+
"type": ["string", "null"],
|
|
730
|
+
"description": "Date updated programme document is received",
|
|
731
|
+
"format": "date-time",
|
|
732
|
+
"examples": ["2023-07-27T20:30:00.000Z"]
|
|
733
|
+
},
|
|
734
|
+
"programmeDocumentReviewedByEstDate": {
|
|
735
|
+
"type": ["string", "null"],
|
|
736
|
+
"description": "Date programme document reviewed by EST",
|
|
737
|
+
"format": "date-time",
|
|
738
|
+
"examples": ["2023-07-27T20:30:00.000Z"]
|
|
739
|
+
},
|
|
740
|
+
"caseTeamIssuedCommentsDate": {
|
|
741
|
+
"type": ["string", "null"],
|
|
742
|
+
"description": "Date case team issued comments on programme document",
|
|
743
|
+
"format": "date-time",
|
|
744
|
+
"examples": ["2023-07-27T20:30:00.000Z"]
|
|
745
|
+
},
|
|
746
|
+
"subProjectType": {
|
|
747
|
+
"type": ["string", "null"],
|
|
748
|
+
"description": "Project type",
|
|
749
|
+
"enum": [
|
|
750
|
+
"energy_from_waste",
|
|
751
|
+
"gas_power_station",
|
|
752
|
+
"hydrogen_power_station",
|
|
753
|
+
"nuclear",
|
|
754
|
+
"offshore_wind",
|
|
755
|
+
"onshore_wind",
|
|
756
|
+
"solar",
|
|
757
|
+
null
|
|
758
|
+
],
|
|
759
|
+
"examples": ["solar"]
|
|
760
|
+
},
|
|
761
|
+
"newMaturity": {
|
|
762
|
+
"type": ["string", "null"],
|
|
763
|
+
"description": "New maturity",
|
|
764
|
+
"enum": ["a", "b", "c", "d", "e", "f", "g", null],
|
|
765
|
+
"examples": ["a"]
|
|
766
|
+
},
|
|
767
|
+
"statutoryConsultationPeriodEndDate": {
|
|
768
|
+
"type": ["string", "null"],
|
|
769
|
+
"description": "Statutory consultation period end date",
|
|
770
|
+
"format": "date-time",
|
|
771
|
+
"examples": ["2023-07-27T20:30:00.000Z"]
|
|
772
|
+
},
|
|
773
|
+
"submissionOfDraftDocumentsDate": {
|
|
774
|
+
"type": ["string", "null"],
|
|
775
|
+
"description": "Date for submission of draft documents",
|
|
776
|
+
"format": "date-time",
|
|
777
|
+
"examples": ["2023-07-27T20:30:00.000Z"]
|
|
778
|
+
},
|
|
779
|
+
"numberBand2Inspectors": {
|
|
780
|
+
"type": ["number", "null"],
|
|
781
|
+
"description": "Number of band 2 inspectors",
|
|
782
|
+
"examples": [1]
|
|
783
|
+
},
|
|
784
|
+
"numberBand3Inspectors": {
|
|
785
|
+
"type": ["number", "null"],
|
|
786
|
+
"description": "Number of band 3 inspectors",
|
|
787
|
+
"examples": [2]
|
|
788
|
+
},
|
|
789
|
+
"memLastUpdated": {
|
|
790
|
+
"type": ["string", "null"],
|
|
791
|
+
"description": "MEM (last updated)",
|
|
792
|
+
"format": "date-time",
|
|
793
|
+
"examples": ["2023-07-27T20:30:00.000Z"]
|
|
794
|
+
},
|
|
795
|
+
"additionalComments": {
|
|
796
|
+
"type": ["string", "null"],
|
|
797
|
+
"description": "Additional comments",
|
|
798
|
+
"examples": ["Very likely to change tier from standard to basic after April 2025"]
|
|
799
|
+
},
|
|
800
|
+
"operationsLeadIds": {
|
|
801
|
+
"type": "array",
|
|
802
|
+
"items": {
|
|
803
|
+
"type": "string",
|
|
804
|
+
"description": "Maps to [Employee].[EmployeeID]."
|
|
805
|
+
},
|
|
806
|
+
"description": "Maps to [Employee].[EmployeeID].",
|
|
807
|
+
"examples": [["9bee96d2-00fe-4269-9d01-8c66", "9bee96d2-00fe-4269-9d01-8c22"]]
|
|
808
|
+
},
|
|
809
|
+
"operationsManagerIds": {
|
|
810
|
+
"type": "array",
|
|
811
|
+
"items": {
|
|
812
|
+
"type": "string",
|
|
813
|
+
"description": "Maps to [Employee].[EmployeeID]."
|
|
814
|
+
},
|
|
815
|
+
"description": "New NSIP role, Maps to [Employee].[EmployeeID]",
|
|
816
|
+
"examples": [["9bee96d2-00fe-4269-9d01-8c66", "9bee96d2-00fe-4269-9d01-8c22"]]
|
|
817
|
+
},
|
|
818
|
+
"caseManagerIds": {
|
|
819
|
+
"type": "array",
|
|
820
|
+
"items": {
|
|
821
|
+
"type": "string",
|
|
822
|
+
"description": "Maps to [Employee].[EmployeeID]."
|
|
823
|
+
},
|
|
824
|
+
"description": "Maps to [Employee].[EmployeeID].",
|
|
825
|
+
"examples": [["9bee96d2-00fe-4269-9d01-8c66", "9bee96d2-00fe-4269-9d01-8c22"]]
|
|
826
|
+
},
|
|
827
|
+
"leadInspectorIds": {
|
|
828
|
+
"type": "array",
|
|
829
|
+
"items": {
|
|
830
|
+
"type": "string",
|
|
831
|
+
"description": "Maps to [Employee].[EmployeeID]."
|
|
832
|
+
},
|
|
833
|
+
"description": "Maps to [Employee].[EmployeeID].",
|
|
834
|
+
"examples": [["9bee96d2-00fe-4269-9d01-8c66", "9bee96d2-00fe-4269-9d01-8c22"]]
|
|
835
|
+
},
|
|
836
|
+
"environmentalServicesOfficerIds": {
|
|
837
|
+
"type": "array",
|
|
838
|
+
"items": {
|
|
839
|
+
"type": "string",
|
|
840
|
+
"description": "Maps to [Employee].[EmployeeID]."
|
|
841
|
+
},
|
|
842
|
+
"description": "Maps to [Employee].[EmployeeID].",
|
|
843
|
+
"examples": [["9bee96d2-00fe-4269-9d01-8c66", "9bee96d2-00fe-4269-9d01-8c22"]]
|
|
844
|
+
},
|
|
845
|
+
"legalOfficerIds": {
|
|
846
|
+
"type": "array",
|
|
847
|
+
"items": {
|
|
848
|
+
"type": "string",
|
|
849
|
+
"description": "Maps to [Employee].[EmployeeID]."
|
|
850
|
+
},
|
|
851
|
+
"description": "Maps to [Employee].[EmployeeID].",
|
|
852
|
+
"examples": [["9bee96d2-00fe-4269-9d01-8c66", "9bee96d2-00fe-4269-9d01-8c22"]]
|
|
853
|
+
},
|
|
854
|
+
"meetings": {
|
|
855
|
+
"type": "array",
|
|
856
|
+
"description": "Collection of meetings associated with this project",
|
|
857
|
+
"items": {
|
|
858
|
+
"$ref": "#/$defs/meeting"
|
|
859
|
+
}
|
|
860
|
+
},
|
|
861
|
+
"invoices": {
|
|
862
|
+
"type": "array",
|
|
863
|
+
"description": "Collection of invoices associated with this project",
|
|
864
|
+
"items": {
|
|
865
|
+
"$ref": "#/$defs/invoice"
|
|
866
|
+
}
|
|
867
|
+
}
|
|
868
|
+
},
|
|
869
|
+
"$defs": {
|
|
870
|
+
"meeting": {
|
|
871
|
+
"type": "object",
|
|
872
|
+
"additionalProperties": true,
|
|
873
|
+
"description": "A meeting related to the project",
|
|
874
|
+
"properties": {
|
|
875
|
+
"meetingAgenda": {
|
|
876
|
+
"type": ["string", "null"],
|
|
877
|
+
"description": "Meeting agenda",
|
|
878
|
+
"examples": ["Flood Risk Assessment (FRA)"]
|
|
879
|
+
},
|
|
880
|
+
"planningInspectorateRole": {
|
|
881
|
+
"type": ["string", "null"],
|
|
882
|
+
"description": "Planning Inspectorate role",
|
|
883
|
+
"enum": ["facilitator", "advisor", "observer", null],
|
|
884
|
+
"examples": ["facilitator"]
|
|
885
|
+
},
|
|
886
|
+
"meetingDate": {
|
|
887
|
+
"type": ["string", "null"],
|
|
888
|
+
"description": "Meeting date",
|
|
889
|
+
"format": "date-time",
|
|
890
|
+
"examples": ["2023-07-27T20:30:00.000Z"]
|
|
891
|
+
},
|
|
892
|
+
"meetingType": {
|
|
893
|
+
"type": ["string", "null"],
|
|
894
|
+
"description": "Type of Meeting"
|
|
895
|
+
}
|
|
896
|
+
}
|
|
897
|
+
},
|
|
898
|
+
"invoice": {
|
|
899
|
+
"type": "object",
|
|
900
|
+
"additionalProperties": true,
|
|
901
|
+
"description": "An invoice related to the project",
|
|
902
|
+
"required": ["invoiceNumber", "amountDue"],
|
|
903
|
+
"properties": {
|
|
904
|
+
"invoiceStage": {
|
|
905
|
+
"type": ["string", "null"],
|
|
906
|
+
"description": "Invoice stage",
|
|
907
|
+
"enum": ["pre_acceptance", "acceptance", "pre_examination", "initial_examination", "final_examination", null],
|
|
908
|
+
"examples": ["pre_acceptance"]
|
|
909
|
+
},
|
|
910
|
+
"invoiceNumber": {
|
|
911
|
+
"type": "string",
|
|
912
|
+
"description": "Invoice number",
|
|
913
|
+
"examples": ["1800004419"]
|
|
914
|
+
},
|
|
915
|
+
"amountDue": {
|
|
916
|
+
"type": "number",
|
|
917
|
+
"description": "Amount due",
|
|
918
|
+
"examples": [500]
|
|
919
|
+
},
|
|
920
|
+
"paymentDueDate": {
|
|
921
|
+
"type": ["string", "null"],
|
|
922
|
+
"description": "Payment due date",
|
|
923
|
+
"format": "date-time",
|
|
924
|
+
"examples": ["2023-07-27T20:30:00.000Z"]
|
|
925
|
+
},
|
|
926
|
+
"invoicedDate": {
|
|
927
|
+
"type": ["string", "null"],
|
|
928
|
+
"description": "Invoiced date",
|
|
929
|
+
"format": "date-time",
|
|
930
|
+
"examples": ["2023-07-27T20:30:00.000Z"]
|
|
931
|
+
},
|
|
932
|
+
"paymentDate": {
|
|
933
|
+
"type": ["string", "null"],
|
|
934
|
+
"description": "Date of payment",
|
|
935
|
+
"format": "date-time",
|
|
936
|
+
"examples": ["2023-07-27T20:30:00.000Z"]
|
|
937
|
+
},
|
|
938
|
+
"refundCreditNoteNumber": {
|
|
939
|
+
"type": ["string", "null"],
|
|
940
|
+
"description": "Refund credit note number",
|
|
941
|
+
"examples": ["1800004419"]
|
|
942
|
+
},
|
|
943
|
+
"refundAmount": {
|
|
944
|
+
"type": ["number", "null"],
|
|
945
|
+
"description": "Amount refunded",
|
|
946
|
+
"examples": [200]
|
|
947
|
+
},
|
|
948
|
+
"refundIssueDate": {
|
|
949
|
+
"type": ["string", "null"],
|
|
950
|
+
"description": "Refund issue date",
|
|
951
|
+
"format": "date-time",
|
|
952
|
+
"examples": ["2023-07-27T20:30:00.000Z"]
|
|
953
|
+
}
|
|
954
|
+
}
|
|
537
955
|
}
|
|
538
956
|
}
|
|
539
957
|
}
|