@planning-inspectorate/data-model 1.11.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 (131) hide show
  1. package/.azure/ci.yml +60 -0
  2. package/.azure/release.yml +57 -0
  3. package/.github/dependabot.yml +11 -0
  4. package/.husky/install.mjs +7 -0
  5. package/.husky/pre-commit +1 -0
  6. package/.prettierignore +11 -0
  7. package/.prettierrc +19 -0
  8. package/LICENSE +21 -0
  9. package/README.md +237 -0
  10. package/commitlint.config.js +8 -0
  11. package/docs/README.md +85 -0
  12. package/docs/appeal-document.md +776 -0
  13. package/docs/appeal-event-estimate.md +108 -0
  14. package/docs/appeal-event.md +404 -0
  15. package/docs/appeal-has.md +1960 -0
  16. package/docs/appeal-representation.md +375 -0
  17. package/docs/appeal-s78.md +3607 -0
  18. package/docs/appeal.md +1879 -0
  19. package/docs/case-schedule.md +8 -0
  20. package/docs/dart-response.md +1413 -0
  21. package/docs/employee.md +70 -0
  22. package/docs/entraid.md +108 -0
  23. package/docs/folder.md +147 -0
  24. package/docs/gettimesheets-response.md +188 -0
  25. package/docs/interested-party.md +284 -0
  26. package/docs/listed-building.md +113 -0
  27. package/docs/listed-buildings.md +113 -0
  28. package/docs/nsip-document.md +966 -0
  29. package/docs/nsip-exam-timetable-defs-event.md +223 -0
  30. package/docs/nsip-exam-timetable-defs-line-item.md +51 -0
  31. package/docs/nsip-exam-timetable-defs.md +3 -0
  32. package/docs/nsip-exam-timetable-submission.md +113 -0
  33. package/docs/nsip-exam-timetable.md +352 -0
  34. package/docs/nsip-project-update.md +163 -0
  35. package/docs/nsip-project.md +2098 -0
  36. package/docs/nsip-representation-defs-attachment.md +133 -0
  37. package/docs/nsip-representation-defs.md +3 -0
  38. package/docs/nsip-representation.md +448 -0
  39. package/docs/nsip-subscription.md +193 -0
  40. package/docs/pins-inspector.md +184 -0
  41. package/docs/pins-lpa.md +260 -0
  42. package/docs/s51-advice.md +460 -0
  43. package/docs/service-user.md +575 -0
  44. package/eslint.config.js +21 -0
  45. package/jsconfig.json +12 -0
  46. package/package.json +55 -0
  47. package/pins_data_model/__init__.py +0 -0
  48. package/pins_data_model/gen_models.py +51 -0
  49. package/pins_data_model/load_schemas.py +51 -0
  50. package/pins_data_model/models/__init__.py +0 -0
  51. package/pins_data_model/models/model_appeal_document.py +294 -0
  52. package/pins_data_model/models/model_appeal_event.py +117 -0
  53. package/pins_data_model/models/model_appeal_event_estimate.py +37 -0
  54. package/pins_data_model/models/model_appeal_has.py +585 -0
  55. package/pins_data_model/models/model_appeal_representation.py +132 -0
  56. package/pins_data_model/models/model_appeal_s78.py +864 -0
  57. package/pins_data_model/models/model_case_schedule.py +11 -0
  58. package/pins_data_model/models/model_dart_response.py +292 -0
  59. package/pins_data_model/models/model_entraid.py +37 -0
  60. package/pins_data_model/models/model_folder.py +56 -0
  61. package/pins_data_model/models/model_gettimesheets_response.py +45 -0
  62. package/pins_data_model/models/model_listed_building.py +33 -0
  63. package/pins_data_model/models/model_listed_buildings.py +33 -0
  64. package/pins_data_model/models/model_nsip_document.py +199 -0
  65. package/pins_data_model/models/model_nsip_exam_timetable.py +90 -0
  66. package/pins_data_model/models/model_nsip_project.py +488 -0
  67. package/pins_data_model/models/model_nsip_project_update.py +60 -0
  68. package/pins_data_model/models/model_nsip_representation.py +83 -0
  69. package/pins_data_model/models/model_nsip_subscription.py +60 -0
  70. package/pins_data_model/models/model_pins_inspector.py +53 -0
  71. package/pins_data_model/models/model_pins_lpa.py +69 -0
  72. package/pins_data_model/models/model_s51_advice.py +109 -0
  73. package/pins_data_model/models/model_service_user.py +121 -0
  74. package/requirements.txt +2 -0
  75. package/schemas/__init__.py +0 -0
  76. package/schemas/appeal-document.schema.json +250 -0
  77. package/schemas/appeal-event-estimate.schema.json +31 -0
  78. package/schemas/appeal-event.schema.json +123 -0
  79. package/schemas/appeal-has.schema.json +576 -0
  80. package/schemas/appeal-representation.schema.json +131 -0
  81. package/schemas/appeal-s78.schema.json +1060 -0
  82. package/schemas/commands/__init__.py +0 -0
  83. package/schemas/commands/appeal-common-submission.schema.json +202 -0
  84. package/schemas/commands/appeal-has-submission.schema.json +82 -0
  85. package/schemas/commands/appeal-representation-submission.schema.json +192 -0
  86. package/schemas/commands/appeal-s78-submission.schema.json +100 -0
  87. package/schemas/commands/appellant-submission.schema.json +164 -0
  88. package/schemas/commands/interested-party.schema.json +80 -0
  89. package/schemas/commands/lpa-questionnaire-common.schema.json +110 -0
  90. package/schemas/commands/lpa-questionnaire-has.schema.json +69 -0
  91. package/schemas/commands/lpa-questionnaire-s78.schema.json +218 -0
  92. package/schemas/commands/lpa-questionnaire.schema.json +125 -0
  93. package/schemas/commands/new-deadline-submission.schema.json +59 -0
  94. package/schemas/commands/nsip-exam-timetable-submission.schema.json +27 -0
  95. package/schemas/commands/register-nsip-subscription.schema.json +32 -0
  96. package/schemas/commands/register-representation.schema.json +51 -0
  97. package/schemas/dart-response.schema.json +350 -0
  98. package/schemas/entraid.schema.json +31 -0
  99. package/schemas/folder.schema.json +49 -0
  100. package/schemas/gettimesheets-response.schema.json +46 -0
  101. package/schemas/listed-building.schema.json +31 -0
  102. package/schemas/listed-buildings.schema.json +31 -0
  103. package/schemas/nsip-document.schema.json +235 -0
  104. package/schemas/nsip-exam-timetable.schema.json +101 -0
  105. package/schemas/nsip-project-update.schema.json +49 -0
  106. package/schemas/nsip-project.schema.json +539 -0
  107. package/schemas/nsip-representation.schema.json +110 -0
  108. package/schemas/nsip-subscription.schema.json +52 -0
  109. package/schemas/pins-inspector.schema.json +47 -0
  110. package/schemas/pins-lpa.schema.json +63 -0
  111. package/schemas/s51-advice.schema.json +113 -0
  112. package/schemas/service-user.schema.json +152 -0
  113. package/setup.py +15 -0
  114. package/src/enums.cjs +632 -0
  115. package/src/enums.d.ts +573 -0
  116. package/src/enums.js +573 -0
  117. package/src/gen-docs.js +34 -0
  118. package/src/gen-enums.js +119 -0
  119. package/src/gen-types.js +70 -0
  120. package/src/index.cjs +746 -0
  121. package/src/index.d.ts +18 -0
  122. package/src/index.js +34 -0
  123. package/src/lib/load.js +78 -0
  124. package/src/schemas.d.ts +4570 -0
  125. package/tests/appeals/appeal-event.test.js +62 -0
  126. package/tests/appeals/commands/appeal-representation-submission.test.js +107 -0
  127. package/tests/appeals/commands/has-questionnaire.test.js +92 -0
  128. package/tests/appeals/commands/has-submission.test.js +113 -0
  129. package/tests/appeals/commands/s78-questionnaire.test.js +96 -0
  130. package/tests/appeals/commands/s78-submission.test.js +119 -0
  131. package/tests/schemas.test.js +97 -0
package/docs/appeal.md ADDED
@@ -0,0 +1,1879 @@
1
+ ## Appeal Case Type
2
+
3
+ `object` ([Appeal Case](appeal.md))
4
+
5
+ # Appeal Case Properties
6
+
7
+ | Property | Type | Required | Nullable | Defined by |
8
+ | :------------------------------------------------------------------------------ | :-------- | :------- | :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------- |
9
+ | [caseId](#caseid) | `integer` | Required | can be null | [Appeal Case](appeal-properties-caseid.md "appeal.schema.json#/properties/caseId") |
10
+ | [caseReference](#casereference) | `string` | Required | cannot be null | [Appeal Case](appeal-properties-casereference.md "appeal.schema.json#/properties/caseReference") |
11
+ | [caseStatus](#casestatus) | `string` | Required | cannot be null | [Appeal Case](appeal-properties-casestatus.md "appeal.schema.json#/properties/caseStatus") |
12
+ | [caseType](#casetype) | `string` | Required | cannot be null | [Appeal Case](appeal-properties-casetype.md "appeal.schema.json#/properties/caseType") |
13
+ | [caseProcedure](#caseprocedure) | `string` | Required | cannot be null | [Appeal Case](appeal-properties-caseprocedure.md "appeal.schema.json#/properties/caseProcedure") |
14
+ | [lpaCode](#lpacode) | `string` | Required | cannot be null | [Appeal Case](appeal-properties-lpacode.md "appeal.schema.json#/properties/lpaCode") |
15
+ | [caseOfficerId](#caseofficerid) | `string` | Required | can be null | [Appeal Case](appeal-properties-caseofficerid.md "appeal.schema.json#/properties/caseOfficerId") |
16
+ | [inspectorId](#inspectorid) | `string` | Required | can be null | [Appeal Case](appeal-properties-inspectorid.md "appeal.schema.json#/properties/inspectorId") |
17
+ | [allocationLevel](#allocationlevel) | `string` | Required | can be null | [Appeal Case](appeal-properties-allocationlevel.md "appeal.schema.json#/properties/allocationLevel") |
18
+ | [allocationBand](#allocationband) | `number` | Required | can be null | [Appeal Case](appeal-properties-allocationband.md "appeal.schema.json#/properties/allocationBand") |
19
+ | [caseSpecialisms](#casespecialisms) | `array` | Required | can be null | [Appeal Case](appeal-properties-casespecialisms.md "appeal.schema.json#/properties/caseSpecialisms") |
20
+ | [caseSubmittedDate](#casesubmitteddate) | `string` | Required | cannot be null | [Appeal Case](appeal-properties-casesubmitteddate.md "appeal.schema.json#/properties/caseSubmittedDate") |
21
+ | [caseCreatedDate](#casecreateddate) | `string` | Required | cannot be null | [Appeal Case](appeal-properties-casecreateddate.md "appeal.schema.json#/properties/caseCreatedDate") |
22
+ | [caseUpdatedDate](#caseupdateddate) | `string` | Required | cannot be null | [Appeal Case](appeal-properties-caseupdateddate.md "appeal.schema.json#/properties/caseUpdatedDate") |
23
+ | [caseValidDate](#casevaliddate) | `string` | Required | can be null | [Appeal Case](appeal-properties-casevaliddate.md "appeal.schema.json#/properties/caseValidDate") |
24
+ | [caseValidationDate](#casevalidationdate) | `string` | Required | can be null | [Appeal Case](appeal-properties-casevalidationdate.md "appeal.schema.json#/properties/caseValidationDate") |
25
+ | [caseValidationOutcome](#casevalidationoutcome) | `string` | Required | can be null | [Appeal Case](appeal-properties-casevalidationoutcome.md "appeal.schema.json#/properties/caseValidationOutcome") |
26
+ | [caseValidationInvalidDetails](#casevalidationinvaliddetails) | `array` | Required | can be null | [Appeal Case](appeal-properties-casevalidationinvaliddetails.md "appeal.schema.json#/properties/caseValidationInvalidDetails") |
27
+ | [caseValidationIncompleteDetails](#casevalidationincompletedetails) | `array` | Required | can be null | [Appeal Case](appeal-properties-casevalidationincompletedetails.md "appeal.schema.json#/properties/caseValidationIncompleteDetails") |
28
+ | [caseExtensionDate](#caseextensiondate) | `string` | Required | can be null | [Appeal Case](appeal-properties-caseextensiondate.md "appeal.schema.json#/properties/caseExtensionDate") |
29
+ | [caseStartedDate](#casestarteddate) | `string` | Required | can be null | [Appeal Case](appeal-properties-casestarteddate.md "appeal.schema.json#/properties/caseStartedDate") |
30
+ | [casePublishedDate](#casepublisheddate) | `string` | Required | can be null | [Appeal Case](appeal-properties-casepublisheddate.md "appeal.schema.json#/properties/casePublishedDate") |
31
+ | [linkedCaseStatus](#linkedcasestatus) | `string` | Required | can be null | [Appeal Case](appeal-properties-linkedcasestatus.md "appeal.schema.json#/properties/linkedCaseStatus") |
32
+ | [leadCaseReference](#leadcasereference) | `string` | Required | can be null | [Appeal Case](appeal-properties-leadcasereference.md "appeal.schema.json#/properties/leadCaseReference") |
33
+ | [lpaQuestionnaireDueDate](#lpaquestionnaireduedate) | `string` | Required | can be null | [Appeal Case](appeal-properties-lpaquestionnaireduedate.md "appeal.schema.json#/properties/lpaQuestionnaireDueDate") |
34
+ | [lpaQuestionnaireSubmittedDate](#lpaquestionnairesubmitteddate) | `string` | Required | can be null | [Appeal Case](appeal-properties-lpaquestionnairesubmitteddate.md "appeal.schema.json#/properties/lpaQuestionnaireSubmittedDate") |
35
+ | [lpaQuestionnaireCreatedDate](#lpaquestionnairecreateddate) | `string` | Required | can be null | [Appeal Case](appeal-properties-lpaquestionnairecreateddate.md "appeal.schema.json#/properties/lpaQuestionnaireCreatedDate") |
36
+ | [lpaQuestionnairePublishedDate](#lpaquestionnairepublisheddate) | `string` | Required | can be null | [Appeal Case](appeal-properties-lpaquestionnairepublisheddate.md "appeal.schema.json#/properties/lpaQuestionnairePublishedDate") |
37
+ | [lpaQuestionnaireValidationOutcome](#lpaquestionnairevalidationoutcome) | `string` | Required | can be null | [Appeal Case](appeal-properties-lpaquestionnairevalidationoutcome.md "appeal.schema.json#/properties/lpaQuestionnaireValidationOutcome") |
38
+ | [lpaQuestionnaireValidationOutcomeDate](#lpaquestionnairevalidationoutcomedate) | `string` | Required | can be null | [Appeal Case](appeal-properties-lpaquestionnairevalidationoutcomedate.md "appeal.schema.json#/properties/lpaQuestionnaireValidationOutcomeDate") |
39
+ | [lpaQuestionnaireValidationDetails](#lpaquestionnairevalidationdetails) | `array` | Required | can be null | [Appeal Case](appeal-properties-lpaquestionnairevalidationdetails.md "appeal.schema.json#/properties/lpaQuestionnaireValidationDetails") |
40
+ | [lpaStatement](#lpastatement) | `string` | Required | can be null | [Appeal Case](appeal-properties-lpastatement.md "appeal.schema.json#/properties/lpaStatement") |
41
+ | [caseWithdrawnDate](#casewithdrawndate) | `string` | Required | can be null | [Appeal Case](appeal-properties-casewithdrawndate.md "appeal.schema.json#/properties/caseWithdrawnDate") |
42
+ | [caseTransferredDate](#casetransferreddate) | `string` | Required | can be null | [Appeal Case](appeal-properties-casetransferreddate.md "appeal.schema.json#/properties/caseTransferredDate") |
43
+ | [caseClosedDate](#casecloseddate) | `string` | Required | can be null | [Appeal Case](appeal-properties-casecloseddate.md "appeal.schema.json#/properties/caseClosedDate") |
44
+ | [caseDecisionOutcomeDate](#casedecisionoutcomedate) | `string` | Required | can be null | [Appeal Case](appeal-properties-casedecisionoutcomedate.md "appeal.schema.json#/properties/caseDecisionOutcomeDate") |
45
+ | [caseDecisionPublishedDate](#casedecisionpublisheddate) | `string` | Required | can be null | [Appeal Case](appeal-properties-casedecisionpublisheddate.md "appeal.schema.json#/properties/caseDecisionPublishedDate") |
46
+ | [caseDecisionOutcome](#casedecisionoutcome) | `string` | Required | can be null | [Appeal Case](appeal-properties-casedecisionoutcome.md "appeal.schema.json#/properties/caseDecisionOutcome") |
47
+ | [caseCompletedDate](#casecompleteddate) | `string` | Required | can be null | [Appeal Case](appeal-properties-casecompleteddate.md "appeal.schema.json#/properties/caseCompletedDate") |
48
+ | [enforcementNotice](#enforcementnotice) | `boolean` | Required | can be null | [Appeal Case](appeal-properties-enforcementnotice.md "appeal.schema.json#/properties/enforcementNotice") |
49
+ | [applicationReference](#applicationreference) | `string` | Required | cannot be null | [Appeal Case](appeal-properties-applicationreference.md "appeal.schema.json#/properties/applicationReference") |
50
+ | [applicationDate](#applicationdate) | `string` | Required | cannot be null | [Appeal Case](appeal-properties-applicationdate.md "appeal.schema.json#/properties/applicationDate") |
51
+ | [applicationDecision](#applicationdecision) | `string` | Required | cannot be null | [Appeal Case](appeal-properties-applicationdecision.md "appeal.schema.json#/properties/applicationDecision") |
52
+ | [applicationDecisionDate](#applicationdecisiondate) | `string` | Required | can be null | [Appeal Case](appeal-properties-applicationdecisiondate.md "appeal.schema.json#/properties/applicationDecisionDate") |
53
+ | [caseSubmissionDueDate](#casesubmissionduedate) | `string` | Required | can be null | [Appeal Case](appeal-properties-casesubmissionduedate.md "appeal.schema.json#/properties/caseSubmissionDueDate") |
54
+ | [siteAddressLine1](#siteaddressline1) | `string` | Required | cannot be null | [Appeal Case](appeal-properties-siteaddressline1.md "appeal.schema.json#/properties/siteAddressLine1") |
55
+ | [siteAddressLine2](#siteaddressline2) | `string` | Required | can be null | [Appeal Case](appeal-properties-siteaddressline2.md "appeal.schema.json#/properties/siteAddressLine2") |
56
+ | [siteAddressTown](#siteaddresstown) | `string` | Required | cannot be null | [Appeal Case](appeal-properties-siteaddresstown.md "appeal.schema.json#/properties/siteAddressTown") |
57
+ | [siteAddressCounty](#siteaddresscounty) | `string` | Required | can be null | [Appeal Case](appeal-properties-siteaddresscounty.md "appeal.schema.json#/properties/siteAddressCounty") |
58
+ | [siteAddressPostcode](#siteaddresspostcode) | `string` | Required | cannot be null | [Appeal Case](appeal-properties-siteaddresspostcode.md "appeal.schema.json#/properties/siteAddressPostcode") |
59
+ | [siteAccessDetails](#siteaccessdetails) | `array` | Required | can be null | [Appeal Case](appeal-properties-siteaccessdetails.md "appeal.schema.json#/properties/siteAccessDetails") |
60
+ | [siteSafetyDetails](#sitesafetydetails) | `array` | Required | can be null | [Appeal Case](appeal-properties-sitesafetydetails.md "appeal.schema.json#/properties/siteSafetyDetails") |
61
+ | [siteAreaSquareMetres](#siteareasquaremetres) | `number` | Required | can be null | [Appeal Case](appeal-properties-siteareasquaremetres.md "appeal.schema.json#/properties/siteAreaSquareMetres") |
62
+ | [floorSpaceSquareMetres](#floorspacesquaremetres) | `number` | Required | can be null | [Appeal Case](appeal-properties-floorspacesquaremetres.md "appeal.schema.json#/properties/floorSpaceSquareMetres") |
63
+ | [isCorrectAppealType](#iscorrectappealtype) | `boolean` | Required | can be null | [Appeal Case](appeal-properties-iscorrectappealtype.md "appeal.schema.json#/properties/isCorrectAppealType") |
64
+ | [isGreenBelt](#isgreenbelt) | `boolean` | Required | can be null | [Appeal Case](appeal-properties-isgreenbelt.md "appeal.schema.json#/properties/isGreenBelt") |
65
+ | [inConservationArea](#inconservationarea) | `boolean` | Required | can be null | [Appeal Case](appeal-properties-inconservationarea.md "appeal.schema.json#/properties/inConservationArea") |
66
+ | [ownsAllLand](#ownsallland) | `boolean` | Required | can be null | [Appeal Case](appeal-properties-ownsallland.md "appeal.schema.json#/properties/ownsAllLand") |
67
+ | [ownsSomeLand](#ownssomeland) | `boolean` | Required | can be null | [Appeal Case](appeal-properties-ownssomeland.md "appeal.schema.json#/properties/ownsSomeLand") |
68
+ | [knowsOtherOwners](#knowsotherowners) | `string` | Required | can be null | [Appeal Case](appeal-properties-knowsotherowners.md "appeal.schema.json#/properties/knowsOtherOwners") |
69
+ | [knowsAllOwners](#knowsallowners) | `string` | Required | can be null | [Appeal Case](appeal-properties-knowsallowners.md "appeal.schema.json#/properties/knowsAllOwners") |
70
+ | [advertisedAppeal](#advertisedappeal) | `boolean` | Required | can be null | [Appeal Case](appeal-properties-advertisedappeal.md "appeal.schema.json#/properties/advertisedAppeal") |
71
+ | [notificationMethod](#notificationmethod) | `array` | Required | can be null | [Appeal Case](appeal-properties-notificationmethod.md "appeal.schema.json#/properties/notificationMethod") |
72
+ | [ownersInformed](#ownersinformed) | `boolean` | Required | can be null | [Appeal Case](appeal-properties-ownersinformed.md "appeal.schema.json#/properties/ownersInformed") |
73
+ | [originalDevelopmentDescription](#originaldevelopmentdescription) | `string` | Required | can be null | [Appeal Case](appeal-properties-originaldevelopmentdescription.md "appeal.schema.json#/properties/originalDevelopmentDescription") |
74
+ | [changedDevelopmentDescription](#changeddevelopmentdescription) | `boolean` | Required | can be null | [Appeal Case](appeal-properties-changeddevelopmentdescription.md "appeal.schema.json#/properties/changedDevelopmentDescription") |
75
+ | [newConditionDetails](#newconditiondetails) | `string` | Required | can be null | [Appeal Case](appeal-properties-newconditiondetails.md "appeal.schema.json#/properties/newConditionDetails") |
76
+ | [nearbyCaseReferences](#nearbycasereferences) | `array` | Required | can be null | [Appeal Case](appeal-properties-nearbycasereferences.md "appeal.schema.json#/properties/nearbyCaseReferences") |
77
+ | [neighbouringSiteAddresses](#neighbouringsiteaddresses) | `array` | Required | can be null | [Appeal Case](appeal-properties-neighbouringsiteaddresses.md "appeal.schema.json#/properties/neighbouringSiteAddresses") |
78
+ | [affectedListedBuildingNumbers](#affectedlistedbuildingnumbers) | `array` | Required | can be null | [Appeal Case](appeal-properties-affectedlistedbuildingnumbers.md "appeal.schema.json#/properties/affectedListedBuildingNumbers") |
79
+ | [appellantCostsAppliedFor](#appellantcostsappliedfor) | `boolean` | Required | can be null | [Appeal Case](appeal-properties-appellantcostsappliedfor.md "appeal.schema.json#/properties/appellantCostsAppliedFor") |
80
+ | [lpaCostsAppliedFor](#lpacostsappliedfor) | `boolean` | Required | can be null | [Appeal Case](appeal-properties-lpacostsappliedfor.md "appeal.schema.json#/properties/lpaCostsAppliedFor") |
81
+ | Additional Properties | Any | Optional | can be null | |
82
+
83
+ ## caseId
84
+
85
+ Internal case identifier
86
+
87
+ `caseId`
88
+
89
+ * is required
90
+
91
+ * Type: `integer`
92
+
93
+ * can be null
94
+
95
+ * defined in: [Appeal Case](appeal-properties-caseid.md "appeal.schema.json#/properties/caseId")
96
+
97
+ ### caseId Type
98
+
99
+ `integer`
100
+
101
+ ### caseId Examples
102
+
103
+ ```json
104
+ 1200
105
+ ```
106
+
107
+ ## caseReference
108
+
109
+ External case identifier
110
+
111
+ `caseReference`
112
+
113
+ * is required
114
+
115
+ * Type: `string`
116
+
117
+ * cannot be null
118
+
119
+ * defined in: [Appeal Case](appeal-properties-casereference.md "appeal.schema.json#/properties/caseReference")
120
+
121
+ ### caseReference Type
122
+
123
+ `string`
124
+
125
+ ### caseReference Examples
126
+
127
+ ```json
128
+ "7002471"
129
+ ```
130
+
131
+ ## caseStatus
132
+
133
+ The processing status for the appeal
134
+
135
+ `caseStatus`
136
+
137
+ * is required
138
+
139
+ * Type: `string`
140
+
141
+ * cannot be null
142
+
143
+ * defined in: [Appeal Case](appeal-properties-casestatus.md "appeal.schema.json#/properties/caseStatus")
144
+
145
+ ### caseStatus Type
146
+
147
+ `string`
148
+
149
+ ### caseStatus Constraints
150
+
151
+ **enum**: the value of this property must be equal to one of the following values:
152
+
153
+ | Value | Explanation |
154
+ | :---------------------- | :---------- |
155
+ | `"assign_case_officer"` | |
156
+ | `"validation"` | |
157
+ | `"ready_to_start"` | |
158
+ | `"lpa_questionnaire"` | |
159
+ | `"issue_determination"` | |
160
+ | `"complete"` | |
161
+ | `"invalid"` | |
162
+ | `"closed"` | |
163
+ | `"withdrawn"` | |
164
+ | `"awaiting_transfer"` | |
165
+ | `"transferred"` | |
166
+
167
+ ## caseType
168
+
169
+ The internal code for an appeal type, e.g. D (Householder)
170
+
171
+ `caseType`
172
+
173
+ * is required
174
+
175
+ * Type: `string`
176
+
177
+ * cannot be null
178
+
179
+ * defined in: [Appeal Case](appeal-properties-casetype.md "appeal.schema.json#/properties/caseType")
180
+
181
+ ### caseType Type
182
+
183
+ `string`
184
+
185
+ ### caseType Constraints
186
+
187
+ **enum**: the value of this property must be equal to one of the following values:
188
+
189
+ | Value | Explanation |
190
+ | :---- | :---------- |
191
+ | `"C"` | |
192
+ | `"D"` | |
193
+ | `"F"` | |
194
+ | `"G"` | |
195
+ | `"H"` | |
196
+ | `"L"` | |
197
+ | `"Q"` | |
198
+ | `"S"` | |
199
+ | `"V"` | |
200
+ | `"W"` | |
201
+ | `"X"` | |
202
+ | `"Y"` | |
203
+ | `"Z"` | |
204
+
205
+ ## caseProcedure
206
+
207
+ The type of procedure for the appeal
208
+
209
+ `caseProcedure`
210
+
211
+ * is required
212
+
213
+ * Type: `string`
214
+
215
+ * cannot be null
216
+
217
+ * defined in: [Appeal Case](appeal-properties-caseprocedure.md "appeal.schema.json#/properties/caseProcedure")
218
+
219
+ ### caseProcedure Type
220
+
221
+ `string`
222
+
223
+ ### caseProcedure Constraints
224
+
225
+ **enum**: the value of this property must be equal to one of the following values:
226
+
227
+ | Value | Explanation |
228
+ | :---------- | :---------- |
229
+ | `"written"` | |
230
+ | `"hearing"` | |
231
+ | `"inquiry"` | |
232
+
233
+ ## lpaCode
234
+
235
+ A unique identifier for the Local Planning Authority
236
+
237
+ > Uses the internal PINS code identifying LPAs
238
+
239
+ `lpaCode`
240
+
241
+ * is required
242
+
243
+ * Type: `string`
244
+
245
+ * cannot be null
246
+
247
+ * defined in: [Appeal Case](appeal-properties-lpacode.md "appeal.schema.json#/properties/lpaCode")
248
+
249
+ ### lpaCode Type
250
+
251
+ `string`
252
+
253
+ ### lpaCode Examples
254
+
255
+ ```json
256
+ "Q9999"
257
+ ```
258
+
259
+ ## caseOfficerId
260
+
261
+ Unique identifier for the case officer assigned to the case
262
+
263
+ > This is the user in Entra ID
264
+
265
+ `caseOfficerId`
266
+
267
+ * is required
268
+
269
+ * Type: `string`
270
+
271
+ * can be null
272
+
273
+ * defined in: [Appeal Case](appeal-properties-caseofficerid.md "appeal.schema.json#/properties/caseOfficerId")
274
+
275
+ ### caseOfficerId Type
276
+
277
+ `string`
278
+
279
+ ## inspectorId
280
+
281
+ Unique identifier for the inspector assigned to the case
282
+
283
+ > This is the user in Entra ID
284
+
285
+ `inspectorId`
286
+
287
+ * is required
288
+
289
+ * Type: `string`
290
+
291
+ * can be null
292
+
293
+ * defined in: [Appeal Case](appeal-properties-inspectorid.md "appeal.schema.json#/properties/inspectorId")
294
+
295
+ ### inspectorId Type
296
+
297
+ `string`
298
+
299
+ ## allocationLevel
300
+
301
+ A level used for allocation purposes
302
+
303
+ `allocationLevel`
304
+
305
+ * is required
306
+
307
+ * Type: `string`
308
+
309
+ * can be null
310
+
311
+ * defined in: [Appeal Case](appeal-properties-allocationlevel.md "appeal.schema.json#/properties/allocationLevel")
312
+
313
+ ### allocationLevel Type
314
+
315
+ `string`
316
+
317
+ ### allocationLevel Constraints
318
+
319
+ **enum**: the value of this property must be equal to one of the following values:
320
+
321
+ | Value | Explanation |
322
+ | :---- | :---------- |
323
+ | `"A"` | |
324
+ | `"B"` | |
325
+ | `"C"` | |
326
+ | `"D"` | |
327
+ | `"E"` | |
328
+ | `"F"` | |
329
+ | `"G"` | |
330
+ | `"H"` | |
331
+
332
+ ## allocationBand
333
+
334
+ A band used for allocation purposes
335
+
336
+ > Linked to the level, e.g. 1\[E,F,G,H], 2\[C,D], 3\[A,B]
337
+
338
+ `allocationBand`
339
+
340
+ * is required
341
+
342
+ * Type: `number`
343
+
344
+ * can be null
345
+
346
+ * defined in: [Appeal Case](appeal-properties-allocationband.md "appeal.schema.json#/properties/allocationBand")
347
+
348
+ ### allocationBand Type
349
+
350
+ `number`
351
+
352
+ ### allocationBand Constraints
353
+
354
+ **enum**: the value of this property must be equal to one of the following values:
355
+
356
+ | Value | Explanation |
357
+ | :---- | :---------- |
358
+ | `1` | |
359
+ | `2` | |
360
+ | `3` | |
361
+
362
+ ## caseSpecialisms
363
+
364
+ A list of specialisms for allocation purposes
365
+
366
+ `caseSpecialisms`
367
+
368
+ * is required
369
+
370
+ * Type: `string[]`
371
+
372
+ * can be null
373
+
374
+ * defined in: [Appeal Case](appeal-properties-casespecialisms.md "appeal.schema.json#/properties/caseSpecialisms")
375
+
376
+ ### caseSpecialisms Type
377
+
378
+ `string[]`
379
+
380
+ ### caseSpecialisms Examples
381
+
382
+ ```json
383
+ "Access"
384
+ ```
385
+
386
+ ```json
387
+ "Listed building and enforcement"
388
+ ```
389
+
390
+ ```json
391
+ "Roads and traffics"
392
+ ```
393
+
394
+ ```json
395
+ "Natural heritage"
396
+ ```
397
+
398
+ ```json
399
+ "Schedule 1"
400
+ ```
401
+
402
+ ## caseSubmittedDate
403
+
404
+ The date the appeal was submitted by the appellant
405
+
406
+ `caseSubmittedDate`
407
+
408
+ * is required
409
+
410
+ * Type: `string`
411
+
412
+ * cannot be null
413
+
414
+ * defined in: [Appeal Case](appeal-properties-casesubmitteddate.md "appeal.schema.json#/properties/caseSubmittedDate")
415
+
416
+ ### caseSubmittedDate Type
417
+
418
+ `string`
419
+
420
+ ### caseSubmittedDate Constraints
421
+
422
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
423
+
424
+ ### caseSubmittedDate Examples
425
+
426
+ ```json
427
+ "2023-07-27T20:30:00.000Z"
428
+ ```
429
+
430
+ ## caseCreatedDate
431
+
432
+ The date the appeal was received
433
+
434
+ `caseCreatedDate`
435
+
436
+ * is required
437
+
438
+ * Type: `string`
439
+
440
+ * cannot be null
441
+
442
+ * defined in: [Appeal Case](appeal-properties-casecreateddate.md "appeal.schema.json#/properties/caseCreatedDate")
443
+
444
+ ### caseCreatedDate Type
445
+
446
+ `string`
447
+
448
+ ### caseCreatedDate Constraints
449
+
450
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
451
+
452
+ ### caseCreatedDate Examples
453
+
454
+ ```json
455
+ "2023-07-27T20:30:00.000Z"
456
+ ```
457
+
458
+ ## caseUpdatedDate
459
+
460
+ The date the appeal was last updated in the back-office
461
+
462
+ `caseUpdatedDate`
463
+
464
+ * is required
465
+
466
+ * Type: `string`
467
+
468
+ * cannot be null
469
+
470
+ * defined in: [Appeal Case](appeal-properties-caseupdateddate.md "appeal.schema.json#/properties/caseUpdatedDate")
471
+
472
+ ### caseUpdatedDate Type
473
+
474
+ `string`
475
+
476
+ ### caseUpdatedDate Constraints
477
+
478
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
479
+
480
+ ### caseUpdatedDate Examples
481
+
482
+ ```json
483
+ "2023-07-27T20:30:00.000Z"
484
+ ```
485
+
486
+ ## caseValidDate
487
+
488
+ The date since when the appeal was considered valid
489
+
490
+ `caseValidDate`
491
+
492
+ * is required
493
+
494
+ * Type: `string`
495
+
496
+ * can be null
497
+
498
+ * defined in: [Appeal Case](appeal-properties-casevaliddate.md "appeal.schema.json#/properties/caseValidDate")
499
+
500
+ ### caseValidDate Type
501
+
502
+ `string`
503
+
504
+ ### caseValidDate Constraints
505
+
506
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
507
+
508
+ ### caseValidDate Examples
509
+
510
+ ```json
511
+ "2023-07-27T20:30:00.000Z"
512
+ ```
513
+
514
+ ## caseValidationDate
515
+
516
+ The date the appeal was validated in the back-office
517
+
518
+ `caseValidationDate`
519
+
520
+ * is required
521
+
522
+ * Type: `string`
523
+
524
+ * can be null
525
+
526
+ * defined in: [Appeal Case](appeal-properties-casevalidationdate.md "appeal.schema.json#/properties/caseValidationDate")
527
+
528
+ ### caseValidationDate Type
529
+
530
+ `string`
531
+
532
+ ### caseValidationDate Constraints
533
+
534
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
535
+
536
+ ### caseValidationDate Examples
537
+
538
+ ```json
539
+ "2023-07-27T20:30:00.000Z"
540
+ ```
541
+
542
+ ## caseValidationOutcome
543
+
544
+ The outcome of the validation action
545
+
546
+ `caseValidationOutcome`
547
+
548
+ * is required
549
+
550
+ * Type: `string`
551
+
552
+ * can be null
553
+
554
+ * defined in: [Appeal Case](appeal-properties-casevalidationoutcome.md "appeal.schema.json#/properties/caseValidationOutcome")
555
+
556
+ ### caseValidationOutcome Type
557
+
558
+ `string`
559
+
560
+ ### caseValidationOutcome Constraints
561
+
562
+ **enum**: the value of this property must be equal to one of the following values:
563
+
564
+ | Value | Explanation |
565
+ | :------------- | :---------- |
566
+ | `"valid"` | |
567
+ | `"invalid"` | |
568
+ | `"incomplete"` | |
569
+ | `null` | |
570
+
571
+ ## caseValidationInvalidDetails
572
+
573
+ A list of reasons why the appeal is invalid
574
+
575
+ > The list will contain items only if the caseValidationOutcome is invalid
576
+
577
+ `caseValidationInvalidDetails`
578
+
579
+ * is required
580
+
581
+ * Type: `string[]`
582
+
583
+ * can be null
584
+
585
+ * defined in: [Appeal Case](appeal-properties-casevalidationinvaliddetails.md "appeal.schema.json#/properties/caseValidationInvalidDetails")
586
+
587
+ ### caseValidationInvalidDetails Type
588
+
589
+ `string[]`
590
+
591
+ ## caseValidationIncompleteDetails
592
+
593
+ A list of reasons why the appeal is incomplete
594
+
595
+ > The list will contain items only if the caseValidationOutcome is incomplete
596
+
597
+ `caseValidationIncompleteDetails`
598
+
599
+ * is required
600
+
601
+ * Type: `string[]`
602
+
603
+ * can be null
604
+
605
+ * defined in: [Appeal Case](appeal-properties-casevalidationincompletedetails.md "appeal.schema.json#/properties/caseValidationIncompleteDetails")
606
+
607
+ ### caseValidationIncompleteDetails Type
608
+
609
+ `string[]`
610
+
611
+ ## caseExtensionDate
612
+
613
+ When the validation outcome is incomplete, an extension may be granted to provide missing information
614
+
615
+ `caseExtensionDate`
616
+
617
+ * is required
618
+
619
+ * Type: `string`
620
+
621
+ * can be null
622
+
623
+ * defined in: [Appeal Case](appeal-properties-caseextensiondate.md "appeal.schema.json#/properties/caseExtensionDate")
624
+
625
+ ### caseExtensionDate Type
626
+
627
+ `string`
628
+
629
+ ### caseExtensionDate Constraints
630
+
631
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
632
+
633
+ ### caseExtensionDate Examples
634
+
635
+ ```json
636
+ "2023-07-27T20:30:00.000Z"
637
+ ```
638
+
639
+ ## caseStartedDate
640
+
641
+ A date indicating when the case was started, resulting in the creation of a timetable
642
+
643
+ `caseStartedDate`
644
+
645
+ * is required
646
+
647
+ * Type: `string`
648
+
649
+ * can be null
650
+
651
+ * defined in: [Appeal Case](appeal-properties-casestarteddate.md "appeal.schema.json#/properties/caseStartedDate")
652
+
653
+ ### caseStartedDate Type
654
+
655
+ `string`
656
+
657
+ ### caseStartedDate Constraints
658
+
659
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
660
+
661
+ ### caseStartedDate Examples
662
+
663
+ ```json
664
+ "2023-07-27T20:30:00.000Z"
665
+ ```
666
+
667
+ ## casePublishedDate
668
+
669
+ A date indicating when the case was published
670
+
671
+ `casePublishedDate`
672
+
673
+ * is required
674
+
675
+ * Type: `string`
676
+
677
+ * can be null
678
+
679
+ * defined in: [Appeal Case](appeal-properties-casepublisheddate.md "appeal.schema.json#/properties/casePublishedDate")
680
+
681
+ ### casePublishedDate Type
682
+
683
+ `string`
684
+
685
+ ### casePublishedDate Constraints
686
+
687
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
688
+
689
+ ### casePublishedDate Examples
690
+
691
+ ```json
692
+ "2023-07-27T20:30:00.000Z"
693
+ ```
694
+
695
+ ## linkedCaseStatus
696
+
697
+ Indicates if the case is linked, and the type of relationship
698
+
699
+ `linkedCaseStatus`
700
+
701
+ * is required
702
+
703
+ * Type: `string`
704
+
705
+ * can be null
706
+
707
+ * defined in: [Appeal Case](appeal-properties-linkedcasestatus.md "appeal.schema.json#/properties/linkedCaseStatus")
708
+
709
+ ### linkedCaseStatus Type
710
+
711
+ `string`
712
+
713
+ ### linkedCaseStatus Constraints
714
+
715
+ **enum**: the value of this property must be equal to one of the following values:
716
+
717
+ | Value | Explanation |
718
+ | :-------- | :---------- |
719
+ | `"lead"` | |
720
+ | `"child"` | |
721
+ | `null` | |
722
+
723
+ ## leadCaseReference
724
+
725
+ The reference of the lead case, if the case is a child case
726
+
727
+ `leadCaseReference`
728
+
729
+ * is required
730
+
731
+ * Type: `string`
732
+
733
+ * can be null
734
+
735
+ * defined in: [Appeal Case](appeal-properties-leadcasereference.md "appeal.schema.json#/properties/leadCaseReference")
736
+
737
+ ### leadCaseReference Type
738
+
739
+ `string`
740
+
741
+ ### leadCaseReference Examples
742
+
743
+ ```json
744
+ "7002471"
745
+ ```
746
+
747
+ ## lpaQuestionnaireDueDate
748
+
749
+ If the case is started and has a timetable, a deadline for the LPA to provide a response
750
+
751
+ `lpaQuestionnaireDueDate`
752
+
753
+ * is required
754
+
755
+ * Type: `string`
756
+
757
+ * can be null
758
+
759
+ * defined in: [Appeal Case](appeal-properties-lpaquestionnaireduedate.md "appeal.schema.json#/properties/lpaQuestionnaireDueDate")
760
+
761
+ ### lpaQuestionnaireDueDate Type
762
+
763
+ `string`
764
+
765
+ ### lpaQuestionnaireDueDate Constraints
766
+
767
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
768
+
769
+ ### lpaQuestionnaireDueDate Examples
770
+
771
+ ```json
772
+ "2023-07-27T20:30:00.000Z"
773
+ ```
774
+
775
+ ## lpaQuestionnaireSubmittedDate
776
+
777
+ The date the LPA provided a response to the case
778
+
779
+ `lpaQuestionnaireSubmittedDate`
780
+
781
+ * is required
782
+
783
+ * Type: `string`
784
+
785
+ * can be null
786
+
787
+ * defined in: [Appeal Case](appeal-properties-lpaquestionnairesubmitteddate.md "appeal.schema.json#/properties/lpaQuestionnaireSubmittedDate")
788
+
789
+ ### lpaQuestionnaireSubmittedDate Type
790
+
791
+ `string`
792
+
793
+ ### lpaQuestionnaireSubmittedDate Constraints
794
+
795
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
796
+
797
+ ### lpaQuestionnaireSubmittedDate Examples
798
+
799
+ ```json
800
+ "2023-07-27T20:30:00.000Z"
801
+ ```
802
+
803
+ ## lpaQuestionnaireCreatedDate
804
+
805
+ The date the LPA response was receeived
806
+
807
+ `lpaQuestionnaireCreatedDate`
808
+
809
+ * is required
810
+
811
+ * Type: `string`
812
+
813
+ * can be null
814
+
815
+ * defined in: [Appeal Case](appeal-properties-lpaquestionnairecreateddate.md "appeal.schema.json#/properties/lpaQuestionnaireCreatedDate")
816
+
817
+ ### lpaQuestionnaireCreatedDate Type
818
+
819
+ `string`
820
+
821
+ ### lpaQuestionnaireCreatedDate Constraints
822
+
823
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
824
+
825
+ ### lpaQuestionnaireCreatedDate Examples
826
+
827
+ ```json
828
+ "2023-07-27T20:30:00.000Z"
829
+ ```
830
+
831
+ ## lpaQuestionnairePublishedDate
832
+
833
+ The date indicating when the questionnaire review was completed and the questionnaire published
834
+
835
+ `lpaQuestionnairePublishedDate`
836
+
837
+ * is required
838
+
839
+ * Type: `string`
840
+
841
+ * can be null
842
+
843
+ * defined in: [Appeal Case](appeal-properties-lpaquestionnairepublisheddate.md "appeal.schema.json#/properties/lpaQuestionnairePublishedDate")
844
+
845
+ ### lpaQuestionnairePublishedDate Type
846
+
847
+ `string`
848
+
849
+ ### lpaQuestionnairePublishedDate Constraints
850
+
851
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
852
+
853
+ ### lpaQuestionnairePublishedDate Examples
854
+
855
+ ```json
856
+ "2023-07-27T20:30:00.000Z"
857
+ ```
858
+
859
+ ## lpaQuestionnaireValidationOutcome
860
+
861
+ The outcome of the validation action
862
+
863
+ `lpaQuestionnaireValidationOutcome`
864
+
865
+ * is required
866
+
867
+ * Type: `string`
868
+
869
+ * can be null
870
+
871
+ * defined in: [Appeal Case](appeal-properties-lpaquestionnairevalidationoutcome.md "appeal.schema.json#/properties/lpaQuestionnaireValidationOutcome")
872
+
873
+ ### lpaQuestionnaireValidationOutcome Type
874
+
875
+ `string`
876
+
877
+ ### lpaQuestionnaireValidationOutcome Constraints
878
+
879
+ **enum**: the value of this property must be equal to one of the following values:
880
+
881
+ | Value | Explanation |
882
+ | :------------- | :---------- |
883
+ | `"complete"` | |
884
+ | `"incomplete"` | |
885
+ | `null` | |
886
+
887
+ ## lpaQuestionnaireValidationOutcomeDate
888
+
889
+ The date the LPA response was validated
890
+
891
+ `lpaQuestionnaireValidationOutcomeDate`
892
+
893
+ * is required
894
+
895
+ * Type: `string`
896
+
897
+ * can be null
898
+
899
+ * defined in: [Appeal Case](appeal-properties-lpaquestionnairevalidationoutcomedate.md "appeal.schema.json#/properties/lpaQuestionnaireValidationOutcomeDate")
900
+
901
+ ### lpaQuestionnaireValidationOutcomeDate Type
902
+
903
+ `string`
904
+
905
+ ### lpaQuestionnaireValidationOutcomeDate Constraints
906
+
907
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
908
+
909
+ ### lpaQuestionnaireValidationOutcomeDate Examples
910
+
911
+ ```json
912
+ "2023-07-27T20:30:00.000Z"
913
+ ```
914
+
915
+ ## lpaQuestionnaireValidationDetails
916
+
917
+ A list of reasons why the questionnaire is incomplete
918
+
919
+ > The list will contain items only if the lpaQuestionnaireValidationOutcome is incomplete
920
+
921
+ `lpaQuestionnaireValidationDetails`
922
+
923
+ * is required
924
+
925
+ * Type: `string[]`
926
+
927
+ * can be null
928
+
929
+ * defined in: [Appeal Case](appeal-properties-lpaquestionnairevalidationdetails.md "appeal.schema.json#/properties/lpaQuestionnaireValidationDetails")
930
+
931
+ ### lpaQuestionnaireValidationDetails Type
932
+
933
+ `string[]`
934
+
935
+ ## lpaStatement
936
+
937
+ A statement provided by the LPA
938
+
939
+ `lpaStatement`
940
+
941
+ * is required
942
+
943
+ * Type: `string`
944
+
945
+ * can be null
946
+
947
+ * defined in: [Appeal Case](appeal-properties-lpastatement.md "appeal.schema.json#/properties/lpaStatement")
948
+
949
+ ### lpaStatement Type
950
+
951
+ `string`
952
+
953
+ ### lpaStatement Examples
954
+
955
+ ```json
956
+ "We refused the application because of ..."
957
+ ```
958
+
959
+ ## caseWithdrawnDate
960
+
961
+ The date the appeal was withdrawn by the appellant
962
+
963
+ `caseWithdrawnDate`
964
+
965
+ * is required
966
+
967
+ * Type: `string`
968
+
969
+ * can be null
970
+
971
+ * defined in: [Appeal Case](appeal-properties-casewithdrawndate.md "appeal.schema.json#/properties/caseWithdrawnDate")
972
+
973
+ ### caseWithdrawnDate Type
974
+
975
+ `string`
976
+
977
+ ### caseWithdrawnDate Constraints
978
+
979
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
980
+
981
+ ### caseWithdrawnDate Examples
982
+
983
+ ```json
984
+ "2023-07-27T20:30:00.000Z"
985
+ ```
986
+
987
+ ## caseTransferredDate
988
+
989
+ The date the appeal was transferred to a new case of a different type
990
+
991
+ `caseTransferredDate`
992
+
993
+ * is required
994
+
995
+ * Type: `string`
996
+
997
+ * can be null
998
+
999
+ * defined in: [Appeal Case](appeal-properties-casetransferreddate.md "appeal.schema.json#/properties/caseTransferredDate")
1000
+
1001
+ ### caseTransferredDate Type
1002
+
1003
+ `string`
1004
+
1005
+ ### caseTransferredDate Constraints
1006
+
1007
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
1008
+
1009
+ ### caseTransferredDate Examples
1010
+
1011
+ ```json
1012
+ "2023-07-27T20:30:00.000Z"
1013
+ ```
1014
+
1015
+ ## caseClosedDate
1016
+
1017
+ The date the appeal was closed and the appellant requested to resubmit
1018
+
1019
+ `caseClosedDate`
1020
+
1021
+ * is required
1022
+
1023
+ * Type: `string`
1024
+
1025
+ * can be null
1026
+
1027
+ * defined in: [Appeal Case](appeal-properties-casecloseddate.md "appeal.schema.json#/properties/caseClosedDate")
1028
+
1029
+ ### caseClosedDate Type
1030
+
1031
+ `string`
1032
+
1033
+ ### caseClosedDate Constraints
1034
+
1035
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
1036
+
1037
+ ### caseClosedDate Examples
1038
+
1039
+ ```json
1040
+ "2023-07-27T20:30:00.000Z"
1041
+ ```
1042
+
1043
+ ## caseDecisionOutcomeDate
1044
+
1045
+ The date of the appeal decision
1046
+
1047
+ `caseDecisionOutcomeDate`
1048
+
1049
+ * is required
1050
+
1051
+ * Type: `string`
1052
+
1053
+ * can be null
1054
+
1055
+ * defined in: [Appeal Case](appeal-properties-casedecisionoutcomedate.md "appeal.schema.json#/properties/caseDecisionOutcomeDate")
1056
+
1057
+ ### caseDecisionOutcomeDate Type
1058
+
1059
+ `string`
1060
+
1061
+ ### caseDecisionOutcomeDate Constraints
1062
+
1063
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
1064
+
1065
+ ### caseDecisionOutcomeDate Examples
1066
+
1067
+ ```json
1068
+ "2023-07-27T20:30:00.000Z"
1069
+ ```
1070
+
1071
+ ## caseDecisionPublishedDate
1072
+
1073
+ The date the appeal decision was published
1074
+
1075
+ `caseDecisionPublishedDate`
1076
+
1077
+ * is required
1078
+
1079
+ * Type: `string`
1080
+
1081
+ * can be null
1082
+
1083
+ * defined in: [Appeal Case](appeal-properties-casedecisionpublisheddate.md "appeal.schema.json#/properties/caseDecisionPublishedDate")
1084
+
1085
+ ### caseDecisionPublishedDate Type
1086
+
1087
+ `string`
1088
+
1089
+ ### caseDecisionPublishedDate Constraints
1090
+
1091
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
1092
+
1093
+ ### caseDecisionPublishedDate Examples
1094
+
1095
+ ```json
1096
+ "2023-07-27T20:30:00.000Z"
1097
+ ```
1098
+
1099
+ ## caseDecisionOutcome
1100
+
1101
+ The final outcome for the decision
1102
+
1103
+ `caseDecisionOutcome`
1104
+
1105
+ * is required
1106
+
1107
+ * Type: `string`
1108
+
1109
+ * can be null
1110
+
1111
+ * defined in: [Appeal Case](appeal-properties-casedecisionoutcome.md "appeal.schema.json#/properties/caseDecisionOutcome")
1112
+
1113
+ ### caseDecisionOutcome Type
1114
+
1115
+ `string`
1116
+
1117
+ ### caseDecisionOutcome Constraints
1118
+
1119
+ **enum**: the value of this property must be equal to one of the following values:
1120
+
1121
+ | Value | Explanation |
1122
+ | :----------------- | :---------- |
1123
+ | `"allowed"` | |
1124
+ | `"split_decision"` | |
1125
+ | `"dismissed"` | |
1126
+ | `"invalid"` | |
1127
+ | `null` | |
1128
+
1129
+ ## caseCompletedDate
1130
+
1131
+ The date the appeal decision letter
1132
+
1133
+ `caseCompletedDate`
1134
+
1135
+ * is required
1136
+
1137
+ * Type: `string`
1138
+
1139
+ * can be null
1140
+
1141
+ * defined in: [Appeal Case](appeal-properties-casecompleteddate.md "appeal.schema.json#/properties/caseCompletedDate")
1142
+
1143
+ ### caseCompletedDate Type
1144
+
1145
+ `string`
1146
+
1147
+ ### caseCompletedDate Constraints
1148
+
1149
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
1150
+
1151
+ ### caseCompletedDate Examples
1152
+
1153
+ ```json
1154
+ "2023-07-27T20:30:00.000Z"
1155
+ ```
1156
+
1157
+ ## enforcementNotice
1158
+
1159
+ Indicates if an enforcement notice is the reason for the appeal
1160
+
1161
+ `enforcementNotice`
1162
+
1163
+ * is required
1164
+
1165
+ * Type: `boolean`
1166
+
1167
+ * can be null
1168
+
1169
+ * defined in: [Appeal Case](appeal-properties-enforcementnotice.md "appeal.schema.json#/properties/enforcementNotice")
1170
+
1171
+ ### enforcementNotice Type
1172
+
1173
+ `boolean`
1174
+
1175
+ ## applicationReference
1176
+
1177
+ The unique identifier of the LPA application
1178
+
1179
+ `applicationReference`
1180
+
1181
+ * is required
1182
+
1183
+ * Type: `string`
1184
+
1185
+ * cannot be null
1186
+
1187
+ * defined in: [Appeal Case](appeal-properties-applicationreference.md "appeal.schema.json#/properties/applicationReference")
1188
+
1189
+ ### applicationReference Type
1190
+
1191
+ `string`
1192
+
1193
+ ### applicationReference Examples
1194
+
1195
+ ```json
1196
+ "43010/APP/1/290572"
1197
+ ```
1198
+
1199
+ ## applicationDate
1200
+
1201
+ The date of the original LPA application
1202
+
1203
+ `applicationDate`
1204
+
1205
+ * is required
1206
+
1207
+ * Type: `string`
1208
+
1209
+ * cannot be null
1210
+
1211
+ * defined in: [Appeal Case](appeal-properties-applicationdate.md "appeal.schema.json#/properties/applicationDate")
1212
+
1213
+ ### applicationDate Type
1214
+
1215
+ `string`
1216
+
1217
+ ### applicationDate Constraints
1218
+
1219
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
1220
+
1221
+ ### applicationDate Examples
1222
+
1223
+ ```json
1224
+ "2023-07-27T20:30:00.000Z"
1225
+ ```
1226
+
1227
+ ## applicationDecision
1228
+
1229
+ The outcome of the original LPA decision
1230
+
1231
+ `applicationDecision`
1232
+
1233
+ * is required
1234
+
1235
+ * Type: `string`
1236
+
1237
+ * cannot be null
1238
+
1239
+ * defined in: [Appeal Case](appeal-properties-applicationdecision.md "appeal.schema.json#/properties/applicationDecision")
1240
+
1241
+ ### applicationDecision Type
1242
+
1243
+ `string`
1244
+
1245
+ ### applicationDecision Constraints
1246
+
1247
+ **enum**: the value of this property must be equal to one of the following values:
1248
+
1249
+ | Value | Explanation |
1250
+ | :--------------- | :---------- |
1251
+ | `"granted"` | |
1252
+ | `"refused"` | |
1253
+ | `"not_received"` | |
1254
+
1255
+ ## applicationDecisionDate
1256
+
1257
+ The date of the original LPA decision
1258
+
1259
+ `applicationDecisionDate`
1260
+
1261
+ * is required
1262
+
1263
+ * Type: `string`
1264
+
1265
+ * can be null
1266
+
1267
+ * defined in: [Appeal Case](appeal-properties-applicationdecisiondate.md "appeal.schema.json#/properties/applicationDecisionDate")
1268
+
1269
+ ### applicationDecisionDate Type
1270
+
1271
+ `string`
1272
+
1273
+ ### applicationDecisionDate Constraints
1274
+
1275
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
1276
+
1277
+ ### applicationDecisionDate Examples
1278
+
1279
+ ```json
1280
+ "2023-07-27T20:30:00.000Z"
1281
+ ```
1282
+
1283
+ ## caseSubmissionDueDate
1284
+
1285
+ The statutory deadline for submitting an appeal from the original LPA decision date
1286
+
1287
+ > Calculated from the applicationDecisionDate
1288
+
1289
+ `caseSubmissionDueDate`
1290
+
1291
+ * is required
1292
+
1293
+ * Type: `string`
1294
+
1295
+ * can be null
1296
+
1297
+ * defined in: [Appeal Case](appeal-properties-casesubmissionduedate.md "appeal.schema.json#/properties/caseSubmissionDueDate")
1298
+
1299
+ ### caseSubmissionDueDate Type
1300
+
1301
+ `string`
1302
+
1303
+ ### caseSubmissionDueDate Constraints
1304
+
1305
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
1306
+
1307
+ ### caseSubmissionDueDate Examples
1308
+
1309
+ ```json
1310
+ "2023-07-27T20:30:00.000Z"
1311
+ ```
1312
+
1313
+ ## siteAddressLine1
1314
+
1315
+ First line of address for the appeal site
1316
+
1317
+ `siteAddressLine1`
1318
+
1319
+ * is required
1320
+
1321
+ * Type: `string`
1322
+
1323
+ * cannot be null
1324
+
1325
+ * defined in: [Appeal Case](appeal-properties-siteaddressline1.md "appeal.schema.json#/properties/siteAddressLine1")
1326
+
1327
+ ### siteAddressLine1 Type
1328
+
1329
+ `string`
1330
+
1331
+ ### siteAddressLine1 Examples
1332
+
1333
+ ```json
1334
+ "96 The Avenue"
1335
+ ```
1336
+
1337
+ ## siteAddressLine2
1338
+
1339
+ Second line of address for the appeal site
1340
+
1341
+ `siteAddressLine2`
1342
+
1343
+ * is required
1344
+
1345
+ * Type: `string`
1346
+
1347
+ * can be null
1348
+
1349
+ * defined in: [Appeal Case](appeal-properties-siteaddressline2.md "appeal.schema.json#/properties/siteAddressLine2")
1350
+
1351
+ ### siteAddressLine2 Type
1352
+
1353
+ `string`
1354
+
1355
+ ## siteAddressTown
1356
+
1357
+ Town / City of the site address
1358
+
1359
+ `siteAddressTown`
1360
+
1361
+ * is required
1362
+
1363
+ * Type: `string`
1364
+
1365
+ * cannot be null
1366
+
1367
+ * defined in: [Appeal Case](appeal-properties-siteaddresstown.md "appeal.schema.json#/properties/siteAddressTown")
1368
+
1369
+ ### siteAddressTown Type
1370
+
1371
+ `string`
1372
+
1373
+ ### siteAddressTown Examples
1374
+
1375
+ ```json
1376
+ "Maidstone"
1377
+ ```
1378
+
1379
+ ## siteAddressCounty
1380
+
1381
+ County of the site address
1382
+
1383
+ `siteAddressCounty`
1384
+
1385
+ * is required
1386
+
1387
+ * Type: `string`
1388
+
1389
+ * can be null
1390
+
1391
+ * defined in: [Appeal Case](appeal-properties-siteaddresscounty.md "appeal.schema.json#/properties/siteAddressCounty")
1392
+
1393
+ ### siteAddressCounty Type
1394
+
1395
+ `string`
1396
+
1397
+ ### siteAddressCounty Examples
1398
+
1399
+ ```json
1400
+ "Kent"
1401
+ ```
1402
+
1403
+ ## siteAddressPostcode
1404
+
1405
+ Postal code of the site address
1406
+
1407
+ `siteAddressPostcode`
1408
+
1409
+ * is required
1410
+
1411
+ * Type: `string`
1412
+
1413
+ * cannot be null
1414
+
1415
+ * defined in: [Appeal Case](appeal-properties-siteaddresspostcode.md "appeal.schema.json#/properties/siteAddressPostcode")
1416
+
1417
+ ### siteAddressPostcode Type
1418
+
1419
+ `string`
1420
+
1421
+ ### siteAddressPostcode Examples
1422
+
1423
+ ```json
1424
+ "MD21 5XY"
1425
+ ```
1426
+
1427
+ ## siteAccessDetails
1428
+
1429
+ Provided information on site accessibility
1430
+
1431
+ `siteAccessDetails`
1432
+
1433
+ * is required
1434
+
1435
+ * Type: `string[]`
1436
+
1437
+ * can be null
1438
+
1439
+ * defined in: [Appeal Case](appeal-properties-siteaccessdetails.md "appeal.schema.json#/properties/siteAccessDetails")
1440
+
1441
+ ### siteAccessDetails Type
1442
+
1443
+ `string[]`
1444
+
1445
+ ## siteSafetyDetails
1446
+
1447
+ Provided information on site health and safety
1448
+
1449
+ `siteSafetyDetails`
1450
+
1451
+ * is required
1452
+
1453
+ * Type: `string[]`
1454
+
1455
+ * can be null
1456
+
1457
+ * defined in: [Appeal Case](appeal-properties-sitesafetydetails.md "appeal.schema.json#/properties/siteSafetyDetails")
1458
+
1459
+ ### siteSafetyDetails Type
1460
+
1461
+ `string[]`
1462
+
1463
+ ## siteAreaSquareMetres
1464
+
1465
+ The site area, in square meters
1466
+
1467
+ `siteAreaSquareMetres`
1468
+
1469
+ * is required
1470
+
1471
+ * Type: `number`
1472
+
1473
+ * can be null
1474
+
1475
+ * defined in: [Appeal Case](appeal-properties-siteareasquaremetres.md "appeal.schema.json#/properties/siteAreaSquareMetres")
1476
+
1477
+ ### siteAreaSquareMetres Type
1478
+
1479
+ `number`
1480
+
1481
+ ### siteAreaSquareMetres Constraints
1482
+
1483
+ **multiple of**: the value of this number must be a multiple of: `0.1`
1484
+
1485
+ ### siteAreaSquareMetres Examples
1486
+
1487
+ ```json
1488
+ 45.7
1489
+ ```
1490
+
1491
+ ## floorSpaceSquareMetres
1492
+
1493
+ The floor space, in square meters
1494
+
1495
+ `floorSpaceSquareMetres`
1496
+
1497
+ * is required
1498
+
1499
+ * Type: `number`
1500
+
1501
+ * can be null
1502
+
1503
+ * defined in: [Appeal Case](appeal-properties-floorspacesquaremetres.md "appeal.schema.json#/properties/floorSpaceSquareMetres")
1504
+
1505
+ ### floorSpaceSquareMetres Type
1506
+
1507
+ `number`
1508
+
1509
+ ### floorSpaceSquareMetres Constraints
1510
+
1511
+ **multiple of**: the value of this number must be a multiple of: `0.1`
1512
+
1513
+ ### floorSpaceSquareMetres Examples
1514
+
1515
+ ```json
1516
+ 3.5
1517
+ ```
1518
+
1519
+ ## isCorrectAppealType
1520
+
1521
+ Indicates if the LPA considers the appeal type appropriate
1522
+
1523
+ `isCorrectAppealType`
1524
+
1525
+ * is required
1526
+
1527
+ * Type: `boolean`
1528
+
1529
+ * can be null
1530
+
1531
+ * defined in: [Appeal Case](appeal-properties-iscorrectappealtype.md "appeal.schema.json#/properties/isCorrectAppealType")
1532
+
1533
+ ### isCorrectAppealType Type
1534
+
1535
+ `boolean`
1536
+
1537
+ ## isGreenBelt
1538
+
1539
+ Indicates if the site is in a green belt
1540
+
1541
+ `isGreenBelt`
1542
+
1543
+ * is required
1544
+
1545
+ * Type: `boolean`
1546
+
1547
+ * can be null
1548
+
1549
+ * defined in: [Appeal Case](appeal-properties-isgreenbelt.md "appeal.schema.json#/properties/isGreenBelt")
1550
+
1551
+ ### isGreenBelt Type
1552
+
1553
+ `boolean`
1554
+
1555
+ ## inConservationArea
1556
+
1557
+ Indicates if the site is in a conservation area
1558
+
1559
+ `inConservationArea`
1560
+
1561
+ * is required
1562
+
1563
+ * Type: `boolean`
1564
+
1565
+ * can be null
1566
+
1567
+ * defined in: [Appeal Case](appeal-properties-inconservationarea.md "appeal.schema.json#/properties/inConservationArea")
1568
+
1569
+ ### inConservationArea Type
1570
+
1571
+ `boolean`
1572
+
1573
+ ## ownsAllLand
1574
+
1575
+ Indicates if the appellant has complete ownership of the site
1576
+
1577
+ `ownsAllLand`
1578
+
1579
+ * is required
1580
+
1581
+ * Type: `boolean`
1582
+
1583
+ * can be null
1584
+
1585
+ * defined in: [Appeal Case](appeal-properties-ownsallland.md "appeal.schema.json#/properties/ownsAllLand")
1586
+
1587
+ ### ownsAllLand Type
1588
+
1589
+ `boolean`
1590
+
1591
+ ## ownsSomeLand
1592
+
1593
+ Indicates if the appellant has partial ownership of the site
1594
+
1595
+ `ownsSomeLand`
1596
+
1597
+ * is required
1598
+
1599
+ * Type: `boolean`
1600
+
1601
+ * can be null
1602
+
1603
+ * defined in: [Appeal Case](appeal-properties-ownssomeland.md "appeal.schema.json#/properties/ownsSomeLand")
1604
+
1605
+ ### ownsSomeLand Type
1606
+
1607
+ `boolean`
1608
+
1609
+ ## knowsOtherOwners
1610
+
1611
+ Indicates if the appellant knows other owners of the site
1612
+
1613
+ `knowsOtherOwners`
1614
+
1615
+ * is required
1616
+
1617
+ * Type: `string`
1618
+
1619
+ * can be null
1620
+
1621
+ * defined in: [Appeal Case](appeal-properties-knowsotherowners.md "appeal.schema.json#/properties/knowsOtherOwners")
1622
+
1623
+ ### knowsOtherOwners Type
1624
+
1625
+ `string`
1626
+
1627
+ ### knowsOtherOwners Constraints
1628
+
1629
+ **enum**: the value of this property must be equal to one of the following values:
1630
+
1631
+ | Value | Explanation |
1632
+ | :------- | :---------- |
1633
+ | `"Yes"` | |
1634
+ | `"No"` | |
1635
+ | `"Some"` | |
1636
+ | `null` | |
1637
+
1638
+ ## knowsAllOwners
1639
+
1640
+ Indicates if the appellant knows all owners of the site
1641
+
1642
+ `knowsAllOwners`
1643
+
1644
+ * is required
1645
+
1646
+ * Type: `string`
1647
+
1648
+ * can be null
1649
+
1650
+ * defined in: [Appeal Case](appeal-properties-knowsallowners.md "appeal.schema.json#/properties/knowsAllOwners")
1651
+
1652
+ ### knowsAllOwners Type
1653
+
1654
+ `string`
1655
+
1656
+ ### knowsAllOwners Constraints
1657
+
1658
+ **enum**: the value of this property must be equal to one of the following values:
1659
+
1660
+ | Value | Explanation |
1661
+ | :------- | :---------- |
1662
+ | `"Yes"` | |
1663
+ | `"No"` | |
1664
+ | `"Some"` | |
1665
+ | `null` | |
1666
+
1667
+ ## advertisedAppeal
1668
+
1669
+ Indicates if the appellant has advertised the appeal to the LPA decision
1670
+
1671
+ `advertisedAppeal`
1672
+
1673
+ * is required
1674
+
1675
+ * Type: `boolean`
1676
+
1677
+ * can be null
1678
+
1679
+ * defined in: [Appeal Case](appeal-properties-advertisedappeal.md "appeal.schema.json#/properties/advertisedAppeal")
1680
+
1681
+ ### advertisedAppeal Type
1682
+
1683
+ `boolean`
1684
+
1685
+ ## notificationMethod
1686
+
1687
+ The methods used to notify relevant parties
1688
+
1689
+ `notificationMethod`
1690
+
1691
+ * is required
1692
+
1693
+ * Type: `string[]`
1694
+
1695
+ * can be null
1696
+
1697
+ * defined in: [Appeal Case](appeal-properties-notificationmethod.md "appeal.schema.json#/properties/notificationMethod")
1698
+
1699
+ ### notificationMethod Type
1700
+
1701
+ `string[]`
1702
+
1703
+ ## ownersInformed
1704
+
1705
+ Indicates if the appellant has informed other owners of the site
1706
+
1707
+ `ownersInformed`
1708
+
1709
+ * is required
1710
+
1711
+ * Type: `boolean`
1712
+
1713
+ * can be null
1714
+
1715
+ * defined in: [Appeal Case](appeal-properties-ownersinformed.md "appeal.schema.json#/properties/ownersInformed")
1716
+
1717
+ ### ownersInformed Type
1718
+
1719
+ `boolean`
1720
+
1721
+ ## originalDevelopmentDescription
1722
+
1723
+ The original description of the development, as provided by the appellant
1724
+
1725
+ `originalDevelopmentDescription`
1726
+
1727
+ * is required
1728
+
1729
+ * Type: `string`
1730
+
1731
+ * can be null
1732
+
1733
+ * defined in: [Appeal Case](appeal-properties-originaldevelopmentdescription.md "appeal.schema.json#/properties/originalDevelopmentDescription")
1734
+
1735
+ ### originalDevelopmentDescription Type
1736
+
1737
+ `string`
1738
+
1739
+ ### originalDevelopmentDescription Examples
1740
+
1741
+ ```json
1742
+ "Replacement of an existing gate to access the property"
1743
+ ```
1744
+
1745
+ ## changedDevelopmentDescription
1746
+
1747
+ Indicates that the LPA has changed the development description
1748
+
1749
+ `changedDevelopmentDescription`
1750
+
1751
+ * is required
1752
+
1753
+ * Type: `boolean`
1754
+
1755
+ * can be null
1756
+
1757
+ * defined in: [Appeal Case](appeal-properties-changeddevelopmentdescription.md "appeal.schema.json#/properties/changedDevelopmentDescription")
1758
+
1759
+ ### changedDevelopmentDescription Type
1760
+
1761
+ `boolean`
1762
+
1763
+ ## newConditionDetails
1764
+
1765
+ New conditions details provided by the LPA
1766
+
1767
+ `newConditionDetails`
1768
+
1769
+ * is required
1770
+
1771
+ * Type: `string`
1772
+
1773
+ * can be null
1774
+
1775
+ * defined in: [Appeal Case](appeal-properties-newconditiondetails.md "appeal.schema.json#/properties/newConditionDetails")
1776
+
1777
+ ### newConditionDetails Type
1778
+
1779
+ `string`
1780
+
1781
+ ### newConditionDetails Examples
1782
+
1783
+ ```json
1784
+ "Since the original application, a number of things have changed..."
1785
+ ```
1786
+
1787
+ ## nearbyCaseReferences
1788
+
1789
+ A list of related case references known to the appellant and the LPA
1790
+
1791
+ `nearbyCaseReferences`
1792
+
1793
+ * is required
1794
+
1795
+ * Type: `string[]`
1796
+
1797
+ * can be null
1798
+
1799
+ * defined in: [Appeal Case](appeal-properties-nearbycasereferences.md "appeal.schema.json#/properties/nearbyCaseReferences")
1800
+
1801
+ ### nearbyCaseReferences Type
1802
+
1803
+ `string[]`
1804
+
1805
+ ## neighbouringSiteAddresses
1806
+
1807
+ A list of neighbouring site addresses
1808
+
1809
+ `neighbouringSiteAddresses`
1810
+
1811
+ * is required
1812
+
1813
+ * Type: `object[]` ([Details](appeal-properties-neighbouringsiteaddresses-items.md))
1814
+
1815
+ * can be null
1816
+
1817
+ * defined in: [Appeal Case](appeal-properties-neighbouringsiteaddresses.md "appeal.schema.json#/properties/neighbouringSiteAddresses")
1818
+
1819
+ ### neighbouringSiteAddresses Type
1820
+
1821
+ `object[]` ([Details](appeal-properties-neighbouringsiteaddresses-items.md))
1822
+
1823
+ ## affectedListedBuildingNumbers
1824
+
1825
+ A list of affected listed building IDs from Historic England
1826
+
1827
+ `affectedListedBuildingNumbers`
1828
+
1829
+ * is required
1830
+
1831
+ * Type: `string[]`
1832
+
1833
+ * can be null
1834
+
1835
+ * defined in: [Appeal Case](appeal-properties-affectedlistedbuildingnumbers.md "appeal.schema.json#/properties/affectedListedBuildingNumbers")
1836
+
1837
+ ### affectedListedBuildingNumbers Type
1838
+
1839
+ `string[]`
1840
+
1841
+ ## appellantCostsAppliedFor
1842
+
1843
+ Indicates if the appellant has applied for costs
1844
+
1845
+ `appellantCostsAppliedFor`
1846
+
1847
+ * is required
1848
+
1849
+ * Type: `boolean`
1850
+
1851
+ * can be null
1852
+
1853
+ * defined in: [Appeal Case](appeal-properties-appellantcostsappliedfor.md "appeal.schema.json#/properties/appellantCostsAppliedFor")
1854
+
1855
+ ### appellantCostsAppliedFor Type
1856
+
1857
+ `boolean`
1858
+
1859
+ ## lpaCostsAppliedFor
1860
+
1861
+ Indicates if the appellant has applied for costs
1862
+
1863
+ `lpaCostsAppliedFor`
1864
+
1865
+ * is required
1866
+
1867
+ * Type: `boolean`
1868
+
1869
+ * can be null
1870
+
1871
+ * defined in: [Appeal Case](appeal-properties-lpacostsappliedfor.md "appeal.schema.json#/properties/lpaCostsAppliedFor")
1872
+
1873
+ ### lpaCostsAppliedFor Type
1874
+
1875
+ `boolean`
1876
+
1877
+ ## Additional Properties
1878
+
1879
+ Additional properties are allowed and do not have to follow a specific schema