@planning-inspectorate/data-model 2.39.0 → 2.41.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/.env.example +6 -0
- package/docs/README.md +4 -0
- package/docs/appeal-has-definitions-significantchangesaffectingapplication.md +15 -0
- package/docs/appeal-has-definitions.md +3 -0
- package/docs/appeal-has.md +178 -108
- package/load-test/appeals/README.md +35 -0
- package/load-test/appeals/generate-appeals-messages.js +456 -0
- package/load-test/appeals/run-load-script.js +58 -0
- package/load-test/service-bus-client.js +89 -0
- package/package.json +4 -1
- package/pins_data_model/models/model_appeal_has.py +61 -11
- package/schemas/appeal-has.schema.json +44 -0
- package/schemas/commands/appeals-components/lpa-questionnaire-has.schema.json +17 -0
- package/src/schemas.d.ts +31 -0
- package/tests/appeals/appeal-has.test.js +40 -1
package/.env.example
ADDED
package/docs/README.md
CHANGED
|
@@ -60,6 +60,10 @@
|
|
|
60
60
|
|
|
61
61
|
* [Untitled object in Appeal HAS Case](./appeal-has-properties-advertdetails-items.md) – `appeal-has.schema.json#/properties/advertDetails/items`
|
|
62
62
|
|
|
63
|
+
* [Untitled object in Appeal HAS Case](./appeal-has-properties-significantchangesaffectingapplicationappellant-items.md) – `appeal-has.schema.json#/properties/significantChangesAffectingApplicationAppellant/items`
|
|
64
|
+
|
|
65
|
+
* [Untitled object in Appeal HAS Case](./appeal-has-properties-significantchangesaffectingapplicationlpa-items.md) – `appeal-has.schema.json#/properties/significantChangesAffectingApplicationLpa/items`
|
|
66
|
+
|
|
63
67
|
* [Untitled object in Appeal S78 Case](./appeal-s78-properties-neighbouringsiteaddresses-items.md) – `appeal-s78.schema.json#/properties/neighbouringSiteAddresses/items`
|
|
64
68
|
|
|
65
69
|
* [Untitled object in Appeal S78 Case](./appeal-s78-properties-advertdetails-items.md) – `appeal-s78.schema.json#/properties/advertDetails/items`
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
## SignificantChangesAffectingApplication Type
|
|
2
|
+
|
|
3
|
+
`string`
|
|
4
|
+
|
|
5
|
+
## SignificantChangesAffectingApplication Constraints
|
|
6
|
+
|
|
7
|
+
**enum**: the value of this property must be equal to one of the following values:
|
|
8
|
+
|
|
9
|
+
| Value | Explanation |
|
|
10
|
+
| :--------------------------- | :---------- |
|
|
11
|
+
| `"adopted-a-new-local-plan"` | |
|
|
12
|
+
| `"national-policy-change"` | |
|
|
13
|
+
| `"court-judgement"` | |
|
|
14
|
+
| `"other"` | |
|
|
15
|
+
| `null` | |
|
package/docs/appeal-has.md
CHANGED
|
@@ -10,114 +10,117 @@ any of
|
|
|
10
10
|
|
|
11
11
|
# Appeal HAS Case Properties
|
|
12
12
|
|
|
13
|
-
| Property
|
|
14
|
-
|
|
|
15
|
-
| [caseId](#caseid)
|
|
16
|
-
| [caseReference](#casereference)
|
|
17
|
-
| [submissionId](#submissionid)
|
|
18
|
-
| [caseStatus](#casestatus)
|
|
19
|
-
| [caseType](#casetype)
|
|
20
|
-
| [caseProcedure](#caseprocedure)
|
|
21
|
-
| [lpaCode](#lpacode)
|
|
22
|
-
| [caseOfficerId](#caseofficerid)
|
|
23
|
-
| [inspectorId](#inspectorid)
|
|
24
|
-
| [allocationLevel](#allocationlevel)
|
|
25
|
-
| [allocationBand](#allocationband)
|
|
26
|
-
| [caseSpecialisms](#casespecialisms)
|
|
27
|
-
| [caseSubmittedDate](#casesubmitteddate)
|
|
28
|
-
| [caseCreatedDate](#casecreateddate)
|
|
29
|
-
| [caseUpdatedDate](#caseupdateddate)
|
|
30
|
-
| [caseValidDate](#casevaliddate)
|
|
31
|
-
| [caseValidationDate](#casevalidationdate)
|
|
32
|
-
| [caseValidationOutcome](#casevalidationoutcome)
|
|
33
|
-
| [caseValidationInvalidDetails](#casevalidationinvaliddetails)
|
|
34
|
-
| [caseValidationIncompleteDetails](#casevalidationincompletedetails)
|
|
35
|
-
| [caseExtensionDate](#caseextensiondate)
|
|
36
|
-
| [caseStartedDate](#casestarteddate)
|
|
37
|
-
| [casePublishedDate](#casepublisheddate)
|
|
38
|
-
| [linkedCaseStatus](#linkedcasestatus)
|
|
39
|
-
| [leadCaseReference](#leadcasereference)
|
|
40
|
-
| [lpaQuestionnaireDueDate](#lpaquestionnaireduedate)
|
|
41
|
-
| [lpaQuestionnaireSubmittedDate](#lpaquestionnairesubmitteddate)
|
|
42
|
-
| [lpaQuestionnaireCreatedDate](#lpaquestionnairecreateddate)
|
|
43
|
-
| [lpaQuestionnairePublishedDate](#lpaquestionnairepublisheddate)
|
|
44
|
-
| [lpaQuestionnaireValidationOutcome](#lpaquestionnairevalidationoutcome)
|
|
45
|
-
| [lpaQuestionnaireValidationOutcomeDate](#lpaquestionnairevalidationoutcomedate)
|
|
46
|
-
| [lpaQuestionnaireValidationDetails](#lpaquestionnairevalidationdetails)
|
|
47
|
-
| [lpaStatement](#lpastatement)
|
|
48
|
-
| [caseWithdrawnDate](#casewithdrawndate)
|
|
49
|
-
| [caseTransferredDate](#casetransferreddate)
|
|
50
|
-
| [transferredCaseClosedDate](#transferredcasecloseddate)
|
|
51
|
-
| [caseDecisionOutcomeDate](#casedecisionoutcomedate)
|
|
52
|
-
| [caseDecisionPublishedDate](#casedecisionpublisheddate)
|
|
53
|
-
| [caseDecisionOutcome](#casedecisionoutcome)
|
|
54
|
-
| [caseCompletedDate](#casecompleteddate)
|
|
55
|
-
| [enforcementNotice](#enforcementnotice)
|
|
56
|
-
| [applicationReference](#applicationreference)
|
|
57
|
-
| [applicationDate](#applicationdate)
|
|
58
|
-
| [applicationDecision](#applicationdecision)
|
|
59
|
-
| [applicationDecisionDate](#applicationdecisiondate)
|
|
60
|
-
| [applicationDecisionDueDate](#applicationdecisionduedate)
|
|
61
|
-
| [caseSubmissionDueDate](#casesubmissionduedate)
|
|
62
|
-
| [siteAddressLine1](#siteaddressline1)
|
|
63
|
-
| [siteAddressLine2](#siteaddressline2)
|
|
64
|
-
| [siteAddressTown](#siteaddresstown)
|
|
65
|
-
| [siteAddressCounty](#siteaddresscounty)
|
|
66
|
-
| [siteAddressPostcode](#siteaddresspostcode)
|
|
67
|
-
| [siteAccessDetails](#siteaccessdetails)
|
|
68
|
-
| [siteSafetyDetails](#sitesafetydetails)
|
|
69
|
-
| [siteAreaSquareMetres](#siteareasquaremetres)
|
|
70
|
-
| [floorSpaceSquareMetres](#floorspacesquaremetres)
|
|
71
|
-
| [isCorrectAppealType](#iscorrectappealtype)
|
|
72
|
-
| [isGreenBelt](#isgreenbelt)
|
|
73
|
-
| [inConservationArea](#inconservationarea)
|
|
74
|
-
| [affectsScheduledMonument](#affectsscheduledmonument)
|
|
75
|
-
| [hasProtectedSpecies](#hasprotectedspecies)
|
|
76
|
-
| [isAonbNationalLandscape](#isaonbnationallandscape)
|
|
77
|
-
| [isSiteOnHighwayLand](#issiteonhighwayland)
|
|
78
|
-
| [designatedSitesNames](#designatedsitesnames)
|
|
79
|
-
| [hasInfrastructureLevy](#hasinfrastructurelevy)
|
|
80
|
-
| [isInfrastructureLevyFormallyAdopted](#isinfrastructurelevyformallyadopted)
|
|
81
|
-
| [infrastructureLevyAdoptedDate](#infrastructurelevyadopteddate)
|
|
82
|
-
| [infrastructureLevyExpectedDate](#infrastructurelevyexpecteddate)
|
|
83
|
-
| [lpaProcedurePreference](#lpaprocedurepreference)
|
|
84
|
-
| [lpaProcedurePreferenceDetails](#lpaprocedurepreferencedetails)
|
|
85
|
-
| [lpaProcedurePreferenceDuration](#lpaprocedurepreferenceduration)
|
|
86
|
-
| [caseworkReason](#caseworkreason)
|
|
87
|
-
| [importantInformation](#importantinformation)
|
|
88
|
-
| [jurisdiction](#jurisdiction)
|
|
89
|
-
| [redeterminedIndicator](#redeterminedindicator)
|
|
90
|
-
| [dateCostsReportDespatched](#datecostsreportdespatched)
|
|
91
|
-
| [dateNotRecoveredOrDerecovered](#datenotrecoveredorderecovered)
|
|
92
|
-
| [dateRecovered](#daterecovered)
|
|
93
|
-
| [originalCaseDecisionDate](#originalcasedecisiondate)
|
|
94
|
-
| [targetDate](#targetdate)
|
|
95
|
-
| [ownsAllLand](#ownsallland)
|
|
96
|
-
| [ownsSomeLand](#ownssomeland)
|
|
97
|
-
| [knowsOtherOwners](#knowsotherowners)
|
|
98
|
-
| [knowsAllOwners](#knowsallowners)
|
|
99
|
-
| [advertisedAppeal](#advertisedappeal)
|
|
100
|
-
| [notificationMethod](#notificationmethod)
|
|
101
|
-
| [ownersInformed](#ownersinformed)
|
|
102
|
-
| [originalDevelopmentDescription](#originaldevelopmentdescription)
|
|
103
|
-
| [changedDevelopmentDescription](#changeddevelopmentdescription)
|
|
104
|
-
| [newConditionDetails](#newconditiondetails)
|
|
105
|
-
| [nearbyCaseReferences](#nearbycasereferences)
|
|
106
|
-
| [neighbouringSiteAddresses](#neighbouringsiteaddresses)
|
|
107
|
-
| [reasonForNeighbourVisits](#reasonforneighbourvisits)
|
|
108
|
-
| [affectedListedBuildingNumbers](#affectedlistedbuildingnumbers)
|
|
109
|
-
| [appellantCostsAppliedFor](#appellantcostsappliedfor)
|
|
110
|
-
| [lpaCostsAppliedFor](#lpacostsappliedfor)
|
|
111
|
-
| [typeOfPlanningApplication](#typeofplanningapplication)
|
|
112
|
-
| [siteGridReferenceEasting](#sitegridreferenceeasting)
|
|
113
|
-
| [siteGridReferenceNorthing](#sitegridreferencenorthing)
|
|
114
|
-
| [hasLandownersPermission](#haslandownerspermission)
|
|
115
|
-
| [wasApplicationRefusedDueToHighwayOrTraffic](#wasapplicationrefusedduetohighwayortraffic)
|
|
116
|
-
| [didAppellantSubmitCompletePhotosAndPlans](#didappellantsubmitcompletephotosandplans)
|
|
117
|
-
| [isSiteInAreaOfSpecialControlAdverts](#issiteinareaofspecialcontroladverts)
|
|
118
|
-
| [advertDetails](#advertdetails)
|
|
119
|
-
| [padsSapId](#padssapid)
|
|
120
|
-
|
|
|
13
|
+
| Property | Type | Required | Nullable | Defined by |
|
|
14
|
+
| :-------------------------------------------------------------------------------------------------- | :-------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
15
|
+
| [caseId](#caseid) | `integer` | Required | can be null | [Appeal HAS Case](appeal-has-properties-caseid.md "appeal-has.schema.json#/properties/caseId") |
|
|
16
|
+
| [caseReference](#casereference) | `string` | Required | cannot be null | [Appeal HAS Case](appeal-has-properties-casereference.md "appeal-has.schema.json#/properties/caseReference") |
|
|
17
|
+
| [submissionId](#submissionid) | `string` | Optional | can be null | [Appeal HAS Case](appeal-has-properties-submissionid.md "appeal-has.schema.json#/properties/submissionId") |
|
|
18
|
+
| [caseStatus](#casestatus) | `string` | Required | cannot be null | [Appeal HAS Case](appeal-has-properties-casestatus.md "appeal-has.schema.json#/properties/caseStatus") |
|
|
19
|
+
| [caseType](#casetype) | `string` | Required | cannot be null | [Appeal HAS Case](appeal-has-properties-casetype.md "appeal-has.schema.json#/properties/caseType") |
|
|
20
|
+
| [caseProcedure](#caseprocedure) | `string` | Required | cannot be null | [Appeal HAS Case](appeal-has-properties-caseprocedure.md "appeal-has.schema.json#/properties/caseProcedure") |
|
|
21
|
+
| [lpaCode](#lpacode) | `string` | Required | cannot be null | [Appeal HAS Case](appeal-has-properties-lpacode.md "appeal-has.schema.json#/properties/lpaCode") |
|
|
22
|
+
| [caseOfficerId](#caseofficerid) | `string` | Required | can be null | [Appeal HAS Case](appeal-has-properties-caseofficerid.md "appeal-has.schema.json#/properties/caseOfficerId") |
|
|
23
|
+
| [inspectorId](#inspectorid) | `string` | Required | can be null | [Appeal HAS Case](appeal-has-properties-inspectorid.md "appeal-has.schema.json#/properties/inspectorId") |
|
|
24
|
+
| [allocationLevel](#allocationlevel) | `string` | Required | can be null | [Appeal HAS Case](appeal-has-properties-allocationlevel.md "appeal-has.schema.json#/properties/allocationLevel") |
|
|
25
|
+
| [allocationBand](#allocationband) | `number` | Required | can be null | [Appeal HAS Case](appeal-has-properties-allocationband.md "appeal-has.schema.json#/properties/allocationBand") |
|
|
26
|
+
| [caseSpecialisms](#casespecialisms) | `array` | Required | can be null | [Appeal HAS Case](appeal-has-properties-casespecialisms.md "appeal-has.schema.json#/properties/caseSpecialisms") |
|
|
27
|
+
| [caseSubmittedDate](#casesubmitteddate) | `string` | Required | cannot be null | [Appeal HAS Case](appeal-has-properties-casesubmitteddate.md "appeal-has.schema.json#/properties/caseSubmittedDate") |
|
|
28
|
+
| [caseCreatedDate](#casecreateddate) | `string` | Required | cannot be null | [Appeal HAS Case](appeal-has-properties-casecreateddate.md "appeal-has.schema.json#/properties/caseCreatedDate") |
|
|
29
|
+
| [caseUpdatedDate](#caseupdateddate) | `string` | Required | cannot be null | [Appeal HAS Case](appeal-has-properties-caseupdateddate.md "appeal-has.schema.json#/properties/caseUpdatedDate") |
|
|
30
|
+
| [caseValidDate](#casevaliddate) | `string` | Required | can be null | [Appeal HAS Case](appeal-has-properties-casevaliddate.md "appeal-has.schema.json#/properties/caseValidDate") |
|
|
31
|
+
| [caseValidationDate](#casevalidationdate) | `string` | Required | can be null | [Appeal HAS Case](appeal-has-properties-casevalidationdate.md "appeal-has.schema.json#/properties/caseValidationDate") |
|
|
32
|
+
| [caseValidationOutcome](#casevalidationoutcome) | `string` | Required | can be null | [Appeal HAS Case](appeal-has-properties-casevalidationoutcome.md "appeal-has.schema.json#/properties/caseValidationOutcome") |
|
|
33
|
+
| [caseValidationInvalidDetails](#casevalidationinvaliddetails) | `array` | Required | can be null | [Appeal HAS Case](appeal-has-properties-casevalidationinvaliddetails.md "appeal-has.schema.json#/properties/caseValidationInvalidDetails") |
|
|
34
|
+
| [caseValidationIncompleteDetails](#casevalidationincompletedetails) | `array` | Required | can be null | [Appeal HAS Case](appeal-has-properties-casevalidationincompletedetails.md "appeal-has.schema.json#/properties/caseValidationIncompleteDetails") |
|
|
35
|
+
| [caseExtensionDate](#caseextensiondate) | `string` | Required | can be null | [Appeal HAS Case](appeal-has-properties-caseextensiondate.md "appeal-has.schema.json#/properties/caseExtensionDate") |
|
|
36
|
+
| [caseStartedDate](#casestarteddate) | `string` | Required | can be null | [Appeal HAS Case](appeal-has-properties-casestarteddate.md "appeal-has.schema.json#/properties/caseStartedDate") |
|
|
37
|
+
| [casePublishedDate](#casepublisheddate) | `string` | Required | can be null | [Appeal HAS Case](appeal-has-properties-casepublisheddate.md "appeal-has.schema.json#/properties/casePublishedDate") |
|
|
38
|
+
| [linkedCaseStatus](#linkedcasestatus) | `string` | Required | can be null | [Appeal HAS Case](appeal-has-properties-linkedcasestatus.md "appeal-has.schema.json#/properties/linkedCaseStatus") |
|
|
39
|
+
| [leadCaseReference](#leadcasereference) | `string` | Required | can be null | [Appeal HAS Case](appeal-has-properties-leadcasereference.md "appeal-has.schema.json#/properties/leadCaseReference") |
|
|
40
|
+
| [lpaQuestionnaireDueDate](#lpaquestionnaireduedate) | `string` | Required | can be null | [Appeal HAS Case](appeal-has-properties-lpaquestionnaireduedate.md "appeal-has.schema.json#/properties/lpaQuestionnaireDueDate") |
|
|
41
|
+
| [lpaQuestionnaireSubmittedDate](#lpaquestionnairesubmitteddate) | `string` | Required | can be null | [Appeal HAS Case](appeal-has-properties-lpaquestionnairesubmitteddate.md "appeal-has.schema.json#/properties/lpaQuestionnaireSubmittedDate") |
|
|
42
|
+
| [lpaQuestionnaireCreatedDate](#lpaquestionnairecreateddate) | `string` | Required | can be null | [Appeal HAS Case](appeal-has-properties-lpaquestionnairecreateddate.md "appeal-has.schema.json#/properties/lpaQuestionnaireCreatedDate") |
|
|
43
|
+
| [lpaQuestionnairePublishedDate](#lpaquestionnairepublisheddate) | `string` | Required | can be null | [Appeal HAS Case](appeal-has-properties-lpaquestionnairepublisheddate.md "appeal-has.schema.json#/properties/lpaQuestionnairePublishedDate") |
|
|
44
|
+
| [lpaQuestionnaireValidationOutcome](#lpaquestionnairevalidationoutcome) | `string` | Required | can be null | [Appeal HAS Case](appeal-has-properties-lpaquestionnairevalidationoutcome.md "appeal-has.schema.json#/properties/lpaQuestionnaireValidationOutcome") |
|
|
45
|
+
| [lpaQuestionnaireValidationOutcomeDate](#lpaquestionnairevalidationoutcomedate) | `string` | Required | can be null | [Appeal HAS Case](appeal-has-properties-lpaquestionnairevalidationoutcomedate.md "appeal-has.schema.json#/properties/lpaQuestionnaireValidationOutcomeDate") |
|
|
46
|
+
| [lpaQuestionnaireValidationDetails](#lpaquestionnairevalidationdetails) | `array` | Required | can be null | [Appeal HAS Case](appeal-has-properties-lpaquestionnairevalidationdetails.md "appeal-has.schema.json#/properties/lpaQuestionnaireValidationDetails") |
|
|
47
|
+
| [lpaStatement](#lpastatement) | `string` | Required | can be null | [Appeal HAS Case](appeal-has-properties-lpastatement.md "appeal-has.schema.json#/properties/lpaStatement") |
|
|
48
|
+
| [caseWithdrawnDate](#casewithdrawndate) | `string` | Required | can be null | [Appeal HAS Case](appeal-has-properties-casewithdrawndate.md "appeal-has.schema.json#/properties/caseWithdrawnDate") |
|
|
49
|
+
| [caseTransferredDate](#casetransferreddate) | `string` | Required | can be null | [Appeal HAS Case](appeal-has-properties-casetransferreddate.md "appeal-has.schema.json#/properties/caseTransferredDate") |
|
|
50
|
+
| [transferredCaseClosedDate](#transferredcasecloseddate) | `string` | Required | can be null | [Appeal HAS Case](appeal-has-properties-transferredcasecloseddate.md "appeal-has.schema.json#/properties/transferredCaseClosedDate") |
|
|
51
|
+
| [caseDecisionOutcomeDate](#casedecisionoutcomedate) | `string` | Required | can be null | [Appeal HAS Case](appeal-has-properties-casedecisionoutcomedate.md "appeal-has.schema.json#/properties/caseDecisionOutcomeDate") |
|
|
52
|
+
| [caseDecisionPublishedDate](#casedecisionpublisheddate) | `string` | Required | can be null | [Appeal HAS Case](appeal-has-properties-casedecisionpublisheddate.md "appeal-has.schema.json#/properties/caseDecisionPublishedDate") |
|
|
53
|
+
| [caseDecisionOutcome](#casedecisionoutcome) | `string` | Required | can be null | [Appeal HAS Case](appeal-has-properties-casedecisionoutcome.md "appeal-has.schema.json#/properties/caseDecisionOutcome") |
|
|
54
|
+
| [caseCompletedDate](#casecompleteddate) | `string` | Required | can be null | [Appeal HAS Case](appeal-has-properties-casecompleteddate.md "appeal-has.schema.json#/properties/caseCompletedDate") |
|
|
55
|
+
| [enforcementNotice](#enforcementnotice) | `boolean` | Required | can be null | [Appeal HAS Case](appeal-has-properties-enforcementnotice.md "appeal-has.schema.json#/properties/enforcementNotice") |
|
|
56
|
+
| [applicationReference](#applicationreference) | `string` | Required | cannot be null | [Appeal HAS Case](appeal-has-properties-applicationreference.md "appeal-has.schema.json#/properties/applicationReference") |
|
|
57
|
+
| [applicationDate](#applicationdate) | `string` | Required | cannot be null | [Appeal HAS Case](appeal-has-properties-applicationdate.md "appeal-has.schema.json#/properties/applicationDate") |
|
|
58
|
+
| [applicationDecision](#applicationdecision) | `string` | Required | cannot be null | [Appeal HAS Case](appeal-has-properties-applicationdecision.md "appeal-has.schema.json#/properties/applicationDecision") |
|
|
59
|
+
| [applicationDecisionDate](#applicationdecisiondate) | `string` | Required | can be null | [Appeal HAS Case](appeal-has-properties-applicationdecisiondate.md "appeal-has.schema.json#/properties/applicationDecisionDate") |
|
|
60
|
+
| [applicationDecisionDueDate](#applicationdecisionduedate) | `string` | Optional | can be null | [Appeal HAS Case](appeal-has-properties-applicationdecisionduedate.md "appeal-has.schema.json#/properties/applicationDecisionDueDate") |
|
|
61
|
+
| [caseSubmissionDueDate](#casesubmissionduedate) | `string` | Required | can be null | [Appeal HAS Case](appeal-has-properties-casesubmissionduedate.md "appeal-has.schema.json#/properties/caseSubmissionDueDate") |
|
|
62
|
+
| [siteAddressLine1](#siteaddressline1) | `string` | Optional | can be null | [Appeal HAS Case](appeal-has-properties-siteaddressline1.md "appeal-has.schema.json#/properties/siteAddressLine1") |
|
|
63
|
+
| [siteAddressLine2](#siteaddressline2) | `string` | Optional | can be null | [Appeal HAS Case](appeal-has-properties-siteaddressline2.md "appeal-has.schema.json#/properties/siteAddressLine2") |
|
|
64
|
+
| [siteAddressTown](#siteaddresstown) | `string` | Optional | can be null | [Appeal HAS Case](appeal-has-properties-siteaddresstown.md "appeal-has.schema.json#/properties/siteAddressTown") |
|
|
65
|
+
| [siteAddressCounty](#siteaddresscounty) | `string` | Optional | can be null | [Appeal HAS Case](appeal-has-properties-siteaddresscounty.md "appeal-has.schema.json#/properties/siteAddressCounty") |
|
|
66
|
+
| [siteAddressPostcode](#siteaddresspostcode) | `string` | Optional | can be null | [Appeal HAS Case](appeal-has-properties-siteaddresspostcode.md "appeal-has.schema.json#/properties/siteAddressPostcode") |
|
|
67
|
+
| [siteAccessDetails](#siteaccessdetails) | `array` | Required | can be null | [Appeal HAS Case](appeal-has-properties-siteaccessdetails.md "appeal-has.schema.json#/properties/siteAccessDetails") |
|
|
68
|
+
| [siteSafetyDetails](#sitesafetydetails) | `array` | Required | can be null | [Appeal HAS Case](appeal-has-properties-sitesafetydetails.md "appeal-has.schema.json#/properties/siteSafetyDetails") |
|
|
69
|
+
| [siteAreaSquareMetres](#siteareasquaremetres) | `number` | Required | can be null | [Appeal HAS Case](appeal-has-properties-siteareasquaremetres.md "appeal-has.schema.json#/properties/siteAreaSquareMetres") |
|
|
70
|
+
| [floorSpaceSquareMetres](#floorspacesquaremetres) | `number` | Required | can be null | [Appeal HAS Case](appeal-has-properties-floorspacesquaremetres.md "appeal-has.schema.json#/properties/floorSpaceSquareMetres") |
|
|
71
|
+
| [isCorrectAppealType](#iscorrectappealtype) | `boolean` | Required | can be null | [Appeal HAS Case](appeal-has-properties-iscorrectappealtype.md "appeal-has.schema.json#/properties/isCorrectAppealType") |
|
|
72
|
+
| [isGreenBelt](#isgreenbelt) | `boolean` | Required | can be null | [Appeal HAS Case](appeal-has-properties-isgreenbelt.md "appeal-has.schema.json#/properties/isGreenBelt") |
|
|
73
|
+
| [inConservationArea](#inconservationarea) | `boolean` | Required | can be null | [Appeal HAS Case](appeal-has-properties-inconservationarea.md "appeal-has.schema.json#/properties/inConservationArea") |
|
|
74
|
+
| [affectsScheduledMonument](#affectsscheduledmonument) | `boolean` | Optional | can be null | [Appeal HAS Case](appeal-has-properties-affectsscheduledmonument.md "appeal-has.schema.json#/properties/affectsScheduledMonument") |
|
|
75
|
+
| [hasProtectedSpecies](#hasprotectedspecies) | `boolean` | Optional | can be null | [Appeal HAS Case](appeal-has-properties-hasprotectedspecies.md "appeal-has.schema.json#/properties/hasProtectedSpecies") |
|
|
76
|
+
| [isAonbNationalLandscape](#isaonbnationallandscape) | `boolean` | Optional | can be null | [Appeal HAS Case](appeal-has-properties-isaonbnationallandscape.md "appeal-has.schema.json#/properties/isAonbNationalLandscape") |
|
|
77
|
+
| [isSiteOnHighwayLand](#issiteonhighwayland) | `boolean` | Optional | can be null | [Appeal HAS Case](appeal-has-properties-issiteonhighwayland.md "appeal-has.schema.json#/properties/isSiteOnHighwayLand") |
|
|
78
|
+
| [designatedSitesNames](#designatedsitesnames) | `array` | Optional | can be null | [Appeal HAS Case](appeal-has-properties-designatedsitesnames.md "appeal-has.schema.json#/properties/designatedSitesNames") |
|
|
79
|
+
| [hasInfrastructureLevy](#hasinfrastructurelevy) | `boolean` | Optional | can be null | [Appeal HAS Case](appeal-has-properties-hasinfrastructurelevy.md "appeal-has.schema.json#/properties/hasInfrastructureLevy") |
|
|
80
|
+
| [isInfrastructureLevyFormallyAdopted](#isinfrastructurelevyformallyadopted) | `boolean` | Optional | can be null | [Appeal HAS Case](appeal-has-properties-isinfrastructurelevyformallyadopted.md "appeal-has.schema.json#/properties/isInfrastructureLevyFormallyAdopted") |
|
|
81
|
+
| [infrastructureLevyAdoptedDate](#infrastructurelevyadopteddate) | `string` | Optional | can be null | [Appeal HAS Case](appeal-has-properties-infrastructurelevyadopteddate.md "appeal-has.schema.json#/properties/infrastructureLevyAdoptedDate") |
|
|
82
|
+
| [infrastructureLevyExpectedDate](#infrastructurelevyexpecteddate) | `string` | Optional | can be null | [Appeal HAS Case](appeal-has-properties-infrastructurelevyexpecteddate.md "appeal-has.schema.json#/properties/infrastructureLevyExpectedDate") |
|
|
83
|
+
| [lpaProcedurePreference](#lpaprocedurepreference) | `string` | Optional | can be null | [Appeal HAS Case](appeal-has-properties-lpaprocedurepreference.md "appeal-has.schema.json#/properties/lpaProcedurePreference") |
|
|
84
|
+
| [lpaProcedurePreferenceDetails](#lpaprocedurepreferencedetails) | `string` | Optional | can be null | [Appeal HAS Case](appeal-has-properties-lpaprocedurepreferencedetails.md "appeal-has.schema.json#/properties/lpaProcedurePreferenceDetails") |
|
|
85
|
+
| [lpaProcedurePreferenceDuration](#lpaprocedurepreferenceduration) | `number` | Optional | can be null | [Appeal HAS Case](appeal-has-properties-lpaprocedurepreferenceduration.md "appeal-has.schema.json#/properties/lpaProcedurePreferenceDuration") |
|
|
86
|
+
| [caseworkReason](#caseworkreason) | `string` | Optional | can be null | [Appeal HAS Case](appeal-has-properties-caseworkreason.md "appeal-has.schema.json#/properties/caseworkReason") |
|
|
87
|
+
| [importantInformation](#importantinformation) | `string` | Optional | can be null | [Appeal HAS Case](appeal-has-properties-importantinformation.md "appeal-has.schema.json#/properties/importantInformation") |
|
|
88
|
+
| [jurisdiction](#jurisdiction) | `string` | Optional | can be null | [Appeal HAS Case](appeal-has-properties-jurisdiction.md "appeal-has.schema.json#/properties/jurisdiction") |
|
|
89
|
+
| [redeterminedIndicator](#redeterminedindicator) | `boolean` | Optional | can be null | [Appeal HAS Case](appeal-has-properties-redeterminedindicator.md "appeal-has.schema.json#/properties/redeterminedIndicator") |
|
|
90
|
+
| [dateCostsReportDespatched](#datecostsreportdespatched) | `string` | Optional | can be null | [Appeal HAS Case](appeal-has-properties-datecostsreportdespatched.md "appeal-has.schema.json#/properties/dateCostsReportDespatched") |
|
|
91
|
+
| [dateNotRecoveredOrDerecovered](#datenotrecoveredorderecovered) | `string` | Optional | can be null | [Appeal HAS Case](appeal-has-properties-datenotrecoveredorderecovered.md "appeal-has.schema.json#/properties/dateNotRecoveredOrDerecovered") |
|
|
92
|
+
| [dateRecovered](#daterecovered) | `string` | Optional | can be null | [Appeal HAS Case](appeal-has-properties-daterecovered.md "appeal-has.schema.json#/properties/dateRecovered") |
|
|
93
|
+
| [originalCaseDecisionDate](#originalcasedecisiondate) | `string` | Optional | can be null | [Appeal HAS Case](appeal-has-properties-originalcasedecisiondate.md "appeal-has.schema.json#/properties/originalCaseDecisionDate") |
|
|
94
|
+
| [targetDate](#targetdate) | `string` | Optional | can be null | [Appeal HAS Case](appeal-has-properties-targetdate.md "appeal-has.schema.json#/properties/targetDate") |
|
|
95
|
+
| [ownsAllLand](#ownsallland) | `boolean` | Required | can be null | [Appeal HAS Case](appeal-has-properties-ownsallland.md "appeal-has.schema.json#/properties/ownsAllLand") |
|
|
96
|
+
| [ownsSomeLand](#ownssomeland) | `boolean` | Required | can be null | [Appeal HAS Case](appeal-has-properties-ownssomeland.md "appeal-has.schema.json#/properties/ownsSomeLand") |
|
|
97
|
+
| [knowsOtherOwners](#knowsotherowners) | `string` | Required | can be null | [Appeal HAS Case](appeal-has-properties-knowsotherowners.md "appeal-has.schema.json#/properties/knowsOtherOwners") |
|
|
98
|
+
| [knowsAllOwners](#knowsallowners) | `string` | Required | can be null | [Appeal HAS Case](appeal-has-properties-knowsallowners.md "appeal-has.schema.json#/properties/knowsAllOwners") |
|
|
99
|
+
| [advertisedAppeal](#advertisedappeal) | `boolean` | Required | can be null | [Appeal HAS Case](appeal-has-properties-advertisedappeal.md "appeal-has.schema.json#/properties/advertisedAppeal") |
|
|
100
|
+
| [notificationMethod](#notificationmethod) | `array` | Required | can be null | [Appeal HAS Case](appeal-has-properties-notificationmethod.md "appeal-has.schema.json#/properties/notificationMethod") |
|
|
101
|
+
| [ownersInformed](#ownersinformed) | `boolean` | Required | can be null | [Appeal HAS Case](appeal-has-properties-ownersinformed.md "appeal-has.schema.json#/properties/ownersInformed") |
|
|
102
|
+
| [originalDevelopmentDescription](#originaldevelopmentdescription) | `string` | Required | can be null | [Appeal HAS Case](appeal-has-properties-originaldevelopmentdescription.md "appeal-has.schema.json#/properties/originalDevelopmentDescription") |
|
|
103
|
+
| [changedDevelopmentDescription](#changeddevelopmentdescription) | `boolean` | Required | can be null | [Appeal HAS Case](appeal-has-properties-changeddevelopmentdescription.md "appeal-has.schema.json#/properties/changedDevelopmentDescription") |
|
|
104
|
+
| [newConditionDetails](#newconditiondetails) | `string` | Required | can be null | [Appeal HAS Case](appeal-has-properties-newconditiondetails.md "appeal-has.schema.json#/properties/newConditionDetails") |
|
|
105
|
+
| [nearbyCaseReferences](#nearbycasereferences) | `array` | Required | can be null | [Appeal HAS Case](appeal-has-properties-nearbycasereferences.md "appeal-has.schema.json#/properties/nearbyCaseReferences") |
|
|
106
|
+
| [neighbouringSiteAddresses](#neighbouringsiteaddresses) | `array` | Required | can be null | [Appeal HAS Case](appeal-has-properties-neighbouringsiteaddresses.md "appeal-has.schema.json#/properties/neighbouringSiteAddresses") |
|
|
107
|
+
| [reasonForNeighbourVisits](#reasonforneighbourvisits) | `string` | Optional | can be null | [Appeal HAS Case](appeal-has-properties-reasonforneighbourvisits.md "appeal-has.schema.json#/properties/reasonForNeighbourVisits") |
|
|
108
|
+
| [affectedListedBuildingNumbers](#affectedlistedbuildingnumbers) | `array` | Required | can be null | [Appeal HAS Case](appeal-has-properties-affectedlistedbuildingnumbers.md "appeal-has.schema.json#/properties/affectedListedBuildingNumbers") |
|
|
109
|
+
| [appellantCostsAppliedFor](#appellantcostsappliedfor) | `boolean` | Required | can be null | [Appeal HAS Case](appeal-has-properties-appellantcostsappliedfor.md "appeal-has.schema.json#/properties/appellantCostsAppliedFor") |
|
|
110
|
+
| [lpaCostsAppliedFor](#lpacostsappliedfor) | `boolean` | Required | can be null | [Appeal HAS Case](appeal-has-properties-lpacostsappliedfor.md "appeal-has.schema.json#/properties/lpaCostsAppliedFor") |
|
|
111
|
+
| [typeOfPlanningApplication](#typeofplanningapplication) | `string` | Optional | can be null | [Appeal HAS Case](appeal-has-properties-typeofplanningapplication.md "appeal-has.schema.json#/properties/typeOfPlanningApplication") |
|
|
112
|
+
| [siteGridReferenceEasting](#sitegridreferenceeasting) | `string` | Optional | can be null | [Appeal HAS Case](appeal-has-properties-sitegridreferenceeasting.md "appeal-has.schema.json#/properties/siteGridReferenceEasting") |
|
|
113
|
+
| [siteGridReferenceNorthing](#sitegridreferencenorthing) | `string` | Optional | can be null | [Appeal HAS Case](appeal-has-properties-sitegridreferencenorthing.md "appeal-has.schema.json#/properties/siteGridReferenceNorthing") |
|
|
114
|
+
| [hasLandownersPermission](#haslandownerspermission) | `boolean` | Optional | can be null | [Appeal HAS Case](appeal-has-properties-haslandownerspermission.md "appeal-has.schema.json#/properties/hasLandownersPermission") |
|
|
115
|
+
| [wasApplicationRefusedDueToHighwayOrTraffic](#wasapplicationrefusedduetohighwayortraffic) | `boolean` | Optional | can be null | [Appeal HAS Case](appeal-has-properties-wasapplicationrefusedduetohighwayortraffic.md "appeal-has.schema.json#/properties/wasApplicationRefusedDueToHighwayOrTraffic") |
|
|
116
|
+
| [didAppellantSubmitCompletePhotosAndPlans](#didappellantsubmitcompletephotosandplans) | `boolean` | Optional | can be null | [Appeal HAS Case](appeal-has-properties-didappellantsubmitcompletephotosandplans.md "appeal-has.schema.json#/properties/didAppellantSubmitCompletePhotosAndPlans") |
|
|
117
|
+
| [isSiteInAreaOfSpecialControlAdverts](#issiteinareaofspecialcontroladverts) | `boolean` | Optional | can be null | [Appeal HAS Case](appeal-has-properties-issiteinareaofspecialcontroladverts.md "appeal-has.schema.json#/properties/isSiteInAreaOfSpecialControlAdverts") |
|
|
118
|
+
| [advertDetails](#advertdetails) | `array` | Optional | can be null | [Appeal HAS Case](appeal-has-properties-advertdetails.md "appeal-has.schema.json#/properties/advertDetails") |
|
|
119
|
+
| [padsSapId](#padssapid) | `string` | Optional | can be null | [Appeal HAS Case](appeal-has-properties-padssapid.md "appeal-has.schema.json#/properties/padsSapId") |
|
|
120
|
+
| [reasonForAppealAppellant](#reasonforappealappellant) | `string` | Optional | can be null | [Appeal HAS Case](appeal-has-properties-reasonforappealappellant.md "appeal-has.schema.json#/properties/reasonForAppealAppellant") |
|
|
121
|
+
| [significantChangesAffectingApplicationAppellant](#significantchangesaffectingapplicationappellant) | `array` | Optional | can be null | [Appeal HAS Case](appeal-has-properties-significantchangesaffectingapplicationappellant.md "appeal-has.schema.json#/properties/significantChangesAffectingApplicationAppellant") |
|
|
122
|
+
| [significantChangesAffectingApplicationLpa](#significantchangesaffectingapplicationlpa) | `array` | Optional | can be null | [Appeal HAS Case](appeal-has-properties-significantchangesaffectingapplicationlpa.md "appeal-has.schema.json#/properties/significantChangesAffectingApplicationLpa") |
|
|
123
|
+
| Additional Properties | Any | Optional | can be null | |
|
|
121
124
|
|
|
122
125
|
## caseId
|
|
123
126
|
|
|
@@ -2672,6 +2675,73 @@ padsSapId for PADS inspectors
|
|
|
2672
2675
|
|
|
2673
2676
|
`string`
|
|
2674
2677
|
|
|
2678
|
+
## reasonForAppealAppellant
|
|
2679
|
+
|
|
2680
|
+
Reason for appeal as provided by the appellant
|
|
2681
|
+
|
|
2682
|
+
`reasonForAppealAppellant`
|
|
2683
|
+
|
|
2684
|
+
* is optional
|
|
2685
|
+
|
|
2686
|
+
* Type: `string`
|
|
2687
|
+
|
|
2688
|
+
* can be null
|
|
2689
|
+
|
|
2690
|
+
* defined in: [Appeal HAS Case](appeal-has-properties-reasonforappealappellant.md "appeal-has.schema.json#/properties/reasonForAppealAppellant")
|
|
2691
|
+
|
|
2692
|
+
### reasonForAppealAppellant Type
|
|
2693
|
+
|
|
2694
|
+
`string`
|
|
2695
|
+
|
|
2696
|
+
## significantChangesAffectingApplicationAppellant
|
|
2697
|
+
|
|
2698
|
+
Significant changes affecting the application as reported by the appellant
|
|
2699
|
+
|
|
2700
|
+
`significantChangesAffectingApplicationAppellant`
|
|
2701
|
+
|
|
2702
|
+
* is optional
|
|
2703
|
+
|
|
2704
|
+
* Type: `object[]` ([Details](appeal-has-properties-significantchangesaffectingapplicationappellant-items.md))
|
|
2705
|
+
|
|
2706
|
+
* can be null
|
|
2707
|
+
|
|
2708
|
+
* defined in: [Appeal HAS Case](appeal-has-properties-significantchangesaffectingapplicationappellant.md "appeal-has.schema.json#/properties/significantChangesAffectingApplicationAppellant")
|
|
2709
|
+
|
|
2710
|
+
### significantChangesAffectingApplicationAppellant Type
|
|
2711
|
+
|
|
2712
|
+
`object[]` ([Details](appeal-has-properties-significantchangesaffectingapplicationappellant-items.md))
|
|
2713
|
+
|
|
2714
|
+
## significantChangesAffectingApplicationLpa
|
|
2715
|
+
|
|
2716
|
+
Significant changes affecting the application as reported by the LPA
|
|
2717
|
+
|
|
2718
|
+
`significantChangesAffectingApplicationLpa`
|
|
2719
|
+
|
|
2720
|
+
* is optional
|
|
2721
|
+
|
|
2722
|
+
* Type: `object[]` ([Details](appeal-has-properties-significantchangesaffectingapplicationlpa-items.md))
|
|
2723
|
+
|
|
2724
|
+
* can be null
|
|
2725
|
+
|
|
2726
|
+
* defined in: [Appeal HAS Case](appeal-has-properties-significantchangesaffectingapplicationlpa.md "appeal-has.schema.json#/properties/significantChangesAffectingApplicationLpa")
|
|
2727
|
+
|
|
2728
|
+
### significantChangesAffectingApplicationLpa Type
|
|
2729
|
+
|
|
2730
|
+
`object[]` ([Details](appeal-has-properties-significantchangesaffectingapplicationlpa-items.md))
|
|
2731
|
+
|
|
2675
2732
|
## Additional Properties
|
|
2676
2733
|
|
|
2677
2734
|
Additional properties are allowed and do not have to follow a specific schema
|
|
2735
|
+
|
|
2736
|
+
# Appeal HAS Case Definitions
|
|
2737
|
+
|
|
2738
|
+
## Definitions group SignificantChangesAffectingApplication
|
|
2739
|
+
|
|
2740
|
+
Reference this group by using
|
|
2741
|
+
|
|
2742
|
+
```json
|
|
2743
|
+
{"$ref":"appeal-has.schema.json#/definitions/SignificantChangesAffectingApplication"}
|
|
2744
|
+
```
|
|
2745
|
+
|
|
2746
|
+
| Property | Type | Required | Nullable | Defined by |
|
|
2747
|
+
| :------- | :--- | :------- | :------- | :--------- |
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# Appeals Load Test Script
|
|
2
|
+
|
|
3
|
+
This script is designed to allow load testing of service bus message consumers without the capacity of the sender being a limiting factor. The service bus client/strategy is hopefully resuable for other services in future
|
|
4
|
+
|
|
5
|
+
`load-test-appeals` sends a specified quantity of appeal case messages with service users and documents to service bus
|
|
6
|
+
|
|
7
|
+
This was written as a quick solution to provide ODW with the ability to run a load test without having to generate actual appeals within the Appeals Service, as generating them Appeals side proved too slow
|
|
8
|
+
|
|
9
|
+
## Requirements
|
|
10
|
+
|
|
11
|
+
- node
|
|
12
|
+
- Azure VPN
|
|
13
|
+
- Azure CLI interface
|
|
14
|
+
- Your user has the ability to send messages manually on the given service bus topic
|
|
15
|
+
- Unsure if this can be run in WSL currently as az login seems to fail
|
|
16
|
+
|
|
17
|
+
## Setup
|
|
18
|
+
|
|
19
|
+
`npm ci`
|
|
20
|
+
|
|
21
|
+
Create an .env file in the route of the project based on the example
|
|
22
|
+
|
|
23
|
+
- LOAD_TEST_SIMULATE_SENDING: (true|false) logs to console if true rather than sending, usful for checking data before sending
|
|
24
|
+
- LOAD_TEST_SERVICE_BUS_NAMESPACE: the fully qualified namespace of the service bus instance
|
|
25
|
+
- APPEALS_LOAD_TEST_CASE_TYPE: (HAS|S78) the case type topic to send on
|
|
26
|
+
- APPEALS_LOAD_TEST_CASE_COUNT: how many appeals to generate
|
|
27
|
+
- APPEALS_LOAD_TEST_DOCUMENTS_PER_CASE: how many documents to generate for each case
|
|
28
|
+
- APPEALS_LOAD_TEST_BATCH_SIZE: how many appeals are sent to service bus in one go, used to improve the speed in which messages can be sent to service bus
|
|
29
|
+
|
|
30
|
+
## Run
|
|
31
|
+
|
|
32
|
+
- set the env vars as needed, retrieve the correct Service Bus namespace from Azure
|
|
33
|
+
- connect to Azure VPN
|
|
34
|
+
- `az login` - login as yourself and connect to test env subscription
|
|
35
|
+
- `npm run load-test-appeals`
|