@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
@@ -0,0 +1,1413 @@
1
+ ## DaRT API response Type
2
+
3
+ `object` ([DaRT API response](dart-response.md))
4
+
5
+ # DaRT API response Properties
6
+
7
+ | Property | Type | Required | Nullable | Defined by |
8
+ | :------------------------------------------------------------------ | :-------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------- |
9
+ | [caseId](#caseid) | `integer` | Optional | cannot be null | [DaRT API response](dart-response-properties-caseid.md "dart-response.schema.json#/properties/caseId") |
10
+ | [caseReference](#casereference) | `integer` | Required | cannot be null | [DaRT API response](dart-response-properties-casereference.md "dart-response.schema.json#/properties/caseReference") |
11
+ | [caseStatus](#casestatus) | `string` | Optional | cannot be null | [DaRT API response](dart-response-properties-casestatus.md "dart-response.schema.json#/properties/caseStatus") |
12
+ | [caseType](#casetype) | `string` | Optional | cannot be null | [DaRT API response](dart-response-properties-casetype.md "dart-response.schema.json#/properties/caseType") |
13
+ | [caseProcedure](#caseprocedure) | `string` | Optional | can be null | [DaRT API response](dart-response-properties-caseprocedure.md "dart-response.schema.json#/properties/caseProcedure") |
14
+ | [lpaCode](#lpacode) | `string` | Optional | can be null | [DaRT API response](dart-response-properties-lpacode.md "dart-response.schema.json#/properties/lpaCode") |
15
+ | [lpaName](#lpaname) | `string` | Optional | can be null | [DaRT API response](dart-response-properties-lpaname.md "dart-response.schema.json#/properties/lpaName") |
16
+ | [allocationLevel](#allocationlevel) | `string` | Optional | can be null | [DaRT API response](dart-response-properties-allocationlevel.md "dart-response.schema.json#/properties/allocationLevel") |
17
+ | [allocationBand](#allocationband) | `string` | Optional | can be null | [DaRT API response](dart-response-properties-allocationband.md "dart-response.schema.json#/properties/allocationBand") |
18
+ | [caseSpecialisms](#casespecialisms) | `array` | Optional | can be null | [DaRT API response](dart-response-properties-casespecialisms.md "dart-response.schema.json#/properties/caseSpecialisms") |
19
+ | [caseSubmittedDate](#casesubmitteddate) | `string` | Optional | cannot be null | [DaRT API response](dart-response-properties-casesubmitteddate.md "dart-response.schema.json#/properties/caseSubmittedDate") |
20
+ | [caseCreatedDate](#casecreateddate) | `string` | Optional | cannot be null | [DaRT API response](dart-response-properties-casecreateddate.md "dart-response.schema.json#/properties/caseCreatedDate") |
21
+ | [caseUpdatedDate](#caseupdateddate) | `string` | Optional | cannot be null | [DaRT API response](dart-response-properties-caseupdateddate.md "dart-response.schema.json#/properties/caseUpdatedDate") |
22
+ | [caseValidDate](#casevaliddate) | `string` | Optional | can be null | [DaRT API response](dart-response-properties-casevaliddate.md "dart-response.schema.json#/properties/caseValidDate") |
23
+ | [caseValidationDate](#casevalidationdate) | `string` | Optional | can be null | [DaRT API response](dart-response-properties-casevalidationdate.md "dart-response.schema.json#/properties/caseValidationDate") |
24
+ | [caseValidationOutcome](#casevalidationoutcome) | `string` | Optional | can be null | [DaRT API response](dart-response-properties-casevalidationoutcome.md "dart-response.schema.json#/properties/caseValidationOutcome") |
25
+ | [caseValidationInvalidDetails](#casevalidationinvaliddetails) | `array` | Optional | can be null | [DaRT API response](dart-response-properties-casevalidationinvaliddetails.md "dart-response.schema.json#/properties/caseValidationInvalidDetails") |
26
+ | [caseValidationIncompleteDetails](#casevalidationincompletedetails) | `array` | Optional | can be null | [DaRT API response](dart-response-properties-casevalidationincompletedetails.md "dart-response.schema.json#/properties/caseValidationIncompleteDetails") |
27
+ | [caseExtensionDate](#caseextensiondate) | `string` | Optional | can be null | [DaRT API response](dart-response-properties-caseextensiondate.md "dart-response.schema.json#/properties/caseExtensionDate") |
28
+ | [caseStartedDate](#casestarteddate) | `string` | Optional | can be null | [DaRT API response](dart-response-properties-casestarteddate.md "dart-response.schema.json#/properties/caseStartedDate") |
29
+ | [casePublishedDate](#casepublisheddate) | `string` | Optional | can be null | [DaRT API response](dart-response-properties-casepublisheddate.md "dart-response.schema.json#/properties/casePublishedDate") |
30
+ | [linkedCaseStatus](#linkedcasestatus) | `string` | Optional | can be null | [DaRT API response](dart-response-properties-linkedcasestatus.md "dart-response.schema.json#/properties/linkedCaseStatus") |
31
+ | [leadCaseReference](#leadcasereference) | `string` | Optional | can be null | [DaRT API response](dart-response-properties-leadcasereference.md "dart-response.schema.json#/properties/leadCaseReference") |
32
+ | [caseWithdrawnDate](#casewithdrawndate) | `string` | Optional | can be null | [DaRT API response](dart-response-properties-casewithdrawndate.md "dart-response.schema.json#/properties/caseWithdrawnDate") |
33
+ | [caseTransferredDate](#casetransferreddate) | `string` | Optional | can be null | [DaRT API response](dart-response-properties-casetransferreddate.md "dart-response.schema.json#/properties/caseTransferredDate") |
34
+ | [transferredCaseClosedDate](#transferredcasecloseddate) | `string` | Optional | can be null | [DaRT API response](dart-response-properties-transferredcasecloseddate.md "dart-response.schema.json#/properties/transferredCaseClosedDate") |
35
+ | [caseDecisionOutcomeDate](#casedecisionoutcomedate) | `string` | Optional | can be null | [DaRT API response](dart-response-properties-casedecisionoutcomedate.md "dart-response.schema.json#/properties/caseDecisionOutcomeDate") |
36
+ | [caseDecisionPublishedDate](#casedecisionpublisheddate) | `string` | Optional | can be null | [DaRT API response](dart-response-properties-casedecisionpublisheddate.md "dart-response.schema.json#/properties/caseDecisionPublishedDate") |
37
+ | [caseDecisionOutcome](#casedecisionoutcome) | `string` | Optional | can be null | [DaRT API response](dart-response-properties-casedecisionoutcome.md "dart-response.schema.json#/properties/caseDecisionOutcome") |
38
+ | [caseCompletedDate](#casecompleteddate) | `string` | Optional | can be null | [DaRT API response](dart-response-properties-casecompleteddate.md "dart-response.schema.json#/properties/caseCompletedDate") |
39
+ | [enforcementNotice](#enforcementnotice) | `boolean` | Optional | can be null | [DaRT API response](dart-response-properties-enforcementnotice.md "dart-response.schema.json#/properties/enforcementNotice") |
40
+ | [applicationReference](#applicationreference) | `string` | Required | cannot be null | [DaRT API response](dart-response-properties-applicationreference.md "dart-response.schema.json#/properties/applicationReference") |
41
+ | [applicationDate](#applicationdate) | `string` | Optional | cannot be null | [DaRT API response](dart-response-properties-applicationdate.md "dart-response.schema.json#/properties/applicationDate") |
42
+ | [applicationDecision](#applicationdecision) | `string` | Optional | cannot be null | [DaRT API response](dart-response-properties-applicationdecision.md "dart-response.schema.json#/properties/applicationDecision") |
43
+ | [lpaDecisionDate](#lpadecisiondate) | `string` | Optional | can be null | [DaRT API response](dart-response-properties-lpadecisiondate.md "dart-response.schema.json#/properties/lpaDecisionDate") |
44
+ | [caseSubmissionDueDate](#casesubmissionduedate) | `string` | Optional | can be null | [DaRT API response](dart-response-properties-casesubmissionduedate.md "dart-response.schema.json#/properties/caseSubmissionDueDate") |
45
+ | [siteAddressLine1](#siteaddressline1) | `string` | Optional | can be null | [DaRT API response](dart-response-properties-siteaddressline1.md "dart-response.schema.json#/properties/siteAddressLine1") |
46
+ | [siteAddressLine2](#siteaddressline2) | `string` | Optional | can be null | [DaRT API response](dart-response-properties-siteaddressline2.md "dart-response.schema.json#/properties/siteAddressLine2") |
47
+ | [siteAddressTown](#siteaddresstown) | `string` | Optional | can be null | [DaRT API response](dart-response-properties-siteaddresstown.md "dart-response.schema.json#/properties/siteAddressTown") |
48
+ | [siteAddressCounty](#siteaddresscounty) | `string` | Optional | can be null | [DaRT API response](dart-response-properties-siteaddresscounty.md "dart-response.schema.json#/properties/siteAddressCounty") |
49
+ | [siteAddressPostcode](#siteaddresspostcode) | `string` | Optional | can be null | [DaRT API response](dart-response-properties-siteaddresspostcode.md "dart-response.schema.json#/properties/siteAddressPostcode") |
50
+ | [isCorrectAppealType](#iscorrectappealtype) | `boolean` | Optional | can be null | [DaRT API response](dart-response-properties-iscorrectappealtype.md "dart-response.schema.json#/properties/isCorrectAppealType") |
51
+ | [originalDevelopmentDescription](#originaldevelopmentdescription) | `string` | Optional | can be null | [DaRT API response](dart-response-properties-originaldevelopmentdescription.md "dart-response.schema.json#/properties/originalDevelopmentDescription") |
52
+ | [changedDevelopmentDescription](#changeddevelopmentdescription) | `boolean` | Optional | can be null | [DaRT API response](dart-response-properties-changeddevelopmentdescription.md "dart-response.schema.json#/properties/changedDevelopmentDescription") |
53
+ | [newConditionDetails](#newconditiondetails) | `string` | Optional | can be null | [DaRT API response](dart-response-properties-newconditiondetails.md "dart-response.schema.json#/properties/newConditionDetails") |
54
+ | [nearbyCaseReferences](#nearbycasereferences) | `array` | Optional | can be null | [DaRT API response](dart-response-properties-nearbycasereferences.md "dart-response.schema.json#/properties/nearbyCaseReferences") |
55
+ | [neighbouringSiteAddresses](#neighbouringsiteaddresses) | `array` | Optional | can be null | [DaRT API response](dart-response-properties-neighbouringsiteaddresses.md "dart-response.schema.json#/properties/neighbouringSiteAddresses") |
56
+ | [affectedListedBuildingNumbers](#affectedlistedbuildingnumbers) | `array` | Optional | can be null | [DaRT API response](dart-response-properties-affectedlistedbuildingnumbers.md "dart-response.schema.json#/properties/affectedListedBuildingNumbers") |
57
+ | [appellantCostsAppliedFor](#appellantcostsappliedfor) | `boolean` | Optional | can be null | [DaRT API response](dart-response-properties-appellantcostsappliedfor.md "dart-response.schema.json#/properties/appellantCostsAppliedFor") |
58
+ | [lpaCostsAppliedFor](#lpacostsappliedfor) | `boolean` | Optional | can be null | [DaRT API response](dart-response-properties-lpacostsappliedfor.md "dart-response.schema.json#/properties/lpaCostsAppliedFor") |
59
+ | [appellantName](#appellantname) | `string` | Optional | cannot be null | [DaRT API response](dart-response-properties-appellantname.md "dart-response.schema.json#/properties/appellantName") |
60
+ | [typeOfEvent](#typeofevent) | `string` | Optional | can be null | [DaRT API response](dart-response-properties-typeofevent.md "dart-response.schema.json#/properties/typeOfEvent") |
61
+ | [startDateOfTheEvent](#startdateoftheevent) | `string` | Optional | can be null | [DaRT API response](dart-response-properties-startdateoftheevent.md "dart-response.schema.json#/properties/startDateOfTheEvent") |
62
+ | [inspectorName](#inspectorname) | `string` | Optional | can be null | [DaRT API response](dart-response-properties-inspectorname.md "dart-response.schema.json#/properties/inspectorName") |
63
+ | [caseOfficerName](#caseofficername) | `string` | Optional | can be null | [DaRT API response](dart-response-properties-caseofficername.md "dart-response.schema.json#/properties/caseOfficerName") |
64
+ | [inspectorQualifications](#inspectorqualifications) | `string` | Optional | can be null | [DaRT API response](dart-response-properties-inspectorqualifications.md "dart-response.schema.json#/properties/inspectorQualifications") |
65
+ | Additional Properties | Any | Optional | can be null | |
66
+
67
+ ## caseId
68
+
69
+ Internal case identifier
70
+
71
+ `caseId`
72
+
73
+ * is optional
74
+
75
+ * Type: `integer`
76
+
77
+ * cannot be null
78
+
79
+ * defined in: [DaRT API response](dart-response-properties-caseid.md "dart-response.schema.json#/properties/caseId")
80
+
81
+ ### caseId Type
82
+
83
+ `integer`
84
+
85
+ ### caseId Examples
86
+
87
+ ```json
88
+ "2744"
89
+ ```
90
+
91
+ ## caseReference
92
+
93
+ External case identifier
94
+
95
+ `caseReference`
96
+
97
+ * is required
98
+
99
+ * Type: `integer`
100
+
101
+ * cannot be null
102
+
103
+ * defined in: [DaRT API response](dart-response-properties-casereference.md "dart-response.schema.json#/properties/caseReference")
104
+
105
+ ### caseReference Type
106
+
107
+ `integer`
108
+
109
+ ### caseReference Examples
110
+
111
+ ```json
112
+ "6002744"
113
+ ```
114
+
115
+ ## caseStatus
116
+
117
+ The processing state for the case
118
+
119
+ `caseStatus`
120
+
121
+ * is optional
122
+
123
+ * Type: `string`
124
+
125
+ * cannot be null
126
+
127
+ * defined in: [DaRT API response](dart-response-properties-casestatus.md "dart-response.schema.json#/properties/caseStatus")
128
+
129
+ ### caseStatus Type
130
+
131
+ `string`
132
+
133
+ ### caseStatus Examples
134
+
135
+ ```json
136
+ "lpa_questionnaire"
137
+ ```
138
+
139
+ ## caseType
140
+
141
+ The internal code for a type of case
142
+
143
+ `caseType`
144
+
145
+ * is optional
146
+
147
+ * Type: `string`
148
+
149
+ * cannot be null
150
+
151
+ * defined in: [DaRT API response](dart-response-properties-casetype.md "dart-response.schema.json#/properties/caseType")
152
+
153
+ ### caseType Type
154
+
155
+ `string`
156
+
157
+ ### caseType Examples
158
+
159
+ ```json
160
+ "w"
161
+ ```
162
+
163
+ ## caseProcedure
164
+
165
+ The type of procedure for the case
166
+
167
+ `caseProcedure`
168
+
169
+ * is optional
170
+
171
+ * Type: `string`
172
+
173
+ * can be null
174
+
175
+ * defined in: [DaRT API response](dart-response-properties-caseprocedure.md "dart-response.schema.json#/properties/caseProcedure")
176
+
177
+ ### caseProcedure Type
178
+
179
+ `string`
180
+
181
+ ### caseProcedure Examples
182
+
183
+ ```json
184
+ "W"
185
+ ```
186
+
187
+ ## lpaCode
188
+
189
+ PINS internal code for LPA
190
+
191
+ `lpaCode`
192
+
193
+ * is optional
194
+
195
+ * Type: `string`
196
+
197
+ * can be null
198
+
199
+ * defined in: [DaRT API response](dart-response-properties-lpacode.md "dart-response.schema.json#/properties/lpaCode")
200
+
201
+ ### lpaCode Type
202
+
203
+ `string`
204
+
205
+ ### lpaCode Examples
206
+
207
+ ```json
208
+ "DORS"
209
+ ```
210
+
211
+ ## lpaName
212
+
213
+ Name of the LPA
214
+
215
+ `lpaName`
216
+
217
+ * is optional
218
+
219
+ * Type: `string`
220
+
221
+ * can be null
222
+
223
+ * defined in: [DaRT API response](dart-response-properties-lpaname.md "dart-response.schema.json#/properties/lpaName")
224
+
225
+ ### lpaName Type
226
+
227
+ `string`
228
+
229
+ ### lpaName Examples
230
+
231
+ ```json
232
+ "example"
233
+ ```
234
+
235
+ ## allocationLevel
236
+
237
+ A case level used for allocation purposes
238
+
239
+ `allocationLevel`
240
+
241
+ * is optional
242
+
243
+ * Type: `string`
244
+
245
+ * can be null
246
+
247
+ * defined in: [DaRT API response](dart-response-properties-allocationlevel.md "dart-response.schema.json#/properties/allocationLevel")
248
+
249
+ ### allocationLevel Type
250
+
251
+ `string`
252
+
253
+ ### allocationLevel Examples
254
+
255
+ ```json
256
+ "H"
257
+ ```
258
+
259
+ ## allocationBand
260
+
261
+ A band used for allocation purposes
262
+
263
+ `allocationBand`
264
+
265
+ * is optional
266
+
267
+ * Type: `string`
268
+
269
+ * can be null
270
+
271
+ * defined in: [DaRT API response](dart-response-properties-allocationband.md "dart-response.schema.json#/properties/allocationBand")
272
+
273
+ ### allocationBand Type
274
+
275
+ `string`
276
+
277
+ ### allocationBand Examples
278
+
279
+ ```json
280
+ "1"
281
+ ```
282
+
283
+ ## caseSpecialisms
284
+
285
+ A list of case specialisms for allocation purposes
286
+
287
+ `caseSpecialisms`
288
+
289
+ * is optional
290
+
291
+ * Type: `string[]`
292
+
293
+ * can be null
294
+
295
+ * defined in: [DaRT API response](dart-response-properties-casespecialisms.md "dart-response.schema.json#/properties/caseSpecialisms")
296
+
297
+ ### caseSpecialisms Type
298
+
299
+ `string[]`
300
+
301
+ ### caseSpecialisms Examples
302
+
303
+ ```json
304
+ "General allocation"
305
+ ```
306
+
307
+ ```json
308
+ "Housing orders"
309
+ ```
310
+
311
+ ```json
312
+ "Waste"
313
+ ```
314
+
315
+ ## caseSubmittedDate
316
+
317
+ The date the case was submitted by the appellant
318
+
319
+ `caseSubmittedDate`
320
+
321
+ * is optional
322
+
323
+ * Type: `string`
324
+
325
+ * cannot be null
326
+
327
+ * defined in: [DaRT API response](dart-response-properties-casesubmitteddate.md "dart-response.schema.json#/properties/caseSubmittedDate")
328
+
329
+ ### caseSubmittedDate Type
330
+
331
+ `string`
332
+
333
+ ### caseSubmittedDate Examples
334
+
335
+ ```json
336
+ "025-01-02T16:20:07.753Z"
337
+ ```
338
+
339
+ ## caseCreatedDate
340
+
341
+ The date the case was received
342
+
343
+ `caseCreatedDate`
344
+
345
+ * is optional
346
+
347
+ * Type: `string`
348
+
349
+ * cannot be null
350
+
351
+ * defined in: [DaRT API response](dart-response-properties-casecreateddate.md "dart-response.schema.json#/properties/caseCreatedDate")
352
+
353
+ ### caseCreatedDate Type
354
+
355
+ `string`
356
+
357
+ ### caseCreatedDate Examples
358
+
359
+ ```json
360
+ "025-01-02T16:20:07.753Z"
361
+ ```
362
+
363
+ ## caseUpdatedDate
364
+
365
+ The date the case was last updated in the back-office
366
+
367
+ `caseUpdatedDate`
368
+
369
+ * is optional
370
+
371
+ * Type: `string`
372
+
373
+ * cannot be null
374
+
375
+ * defined in: [DaRT API response](dart-response-properties-caseupdateddate.md "dart-response.schema.json#/properties/caseUpdatedDate")
376
+
377
+ ### caseUpdatedDate Type
378
+
379
+ `string`
380
+
381
+ ### caseUpdatedDate Examples
382
+
383
+ ```json
384
+ "025-01-02T16:20:07.753Z"
385
+ ```
386
+
387
+ ## caseValidDate
388
+
389
+ The date since when the case was considered valid
390
+
391
+ `caseValidDate`
392
+
393
+ * is optional
394
+
395
+ * Type: `string`
396
+
397
+ * can be null
398
+
399
+ * defined in: [DaRT API response](dart-response-properties-casevaliddate.md "dart-response.schema.json#/properties/caseValidDate")
400
+
401
+ ### caseValidDate Type
402
+
403
+ `string`
404
+
405
+ ### caseValidDate Examples
406
+
407
+ ```json
408
+ "025-01-02T16:20:07.753Z"
409
+ ```
410
+
411
+ ## caseValidationDate
412
+
413
+ The date the case was validated in the back-office
414
+
415
+ `caseValidationDate`
416
+
417
+ * is optional
418
+
419
+ * Type: `string`
420
+
421
+ * can be null
422
+
423
+ * defined in: [DaRT API response](dart-response-properties-casevalidationdate.md "dart-response.schema.json#/properties/caseValidationDate")
424
+
425
+ ### caseValidationDate Type
426
+
427
+ `string`
428
+
429
+ ### caseValidationDate Examples
430
+
431
+ ```json
432
+ "025-01-02T16:20:07.753Z"
433
+ ```
434
+
435
+ ## caseValidationOutcome
436
+
437
+ The outcome of the validation action
438
+
439
+ `caseValidationOutcome`
440
+
441
+ * is optional
442
+
443
+ * Type: `string`
444
+
445
+ * can be null
446
+
447
+ * defined in: [DaRT API response](dart-response-properties-casevalidationoutcome.md "dart-response.schema.json#/properties/caseValidationOutcome")
448
+
449
+ ### caseValidationOutcome Type
450
+
451
+ `string`
452
+
453
+ ### caseValidationOutcome Examples
454
+
455
+ ```json
456
+ "valid"
457
+ ```
458
+
459
+ ## caseValidationInvalidDetails
460
+
461
+ A list of reasons why the appeal is invalid
462
+
463
+ > The list will contain items only if the caseValidationOutcome is invalid
464
+
465
+ `caseValidationInvalidDetails`
466
+
467
+ * is optional
468
+
469
+ * Type: `string[]`
470
+
471
+ * can be null
472
+
473
+ * defined in: [DaRT API response](dart-response-properties-casevalidationinvaliddetails.md "dart-response.schema.json#/properties/caseValidationInvalidDetails")
474
+
475
+ ### caseValidationInvalidDetails Type
476
+
477
+ `string[]`
478
+
479
+ ### caseValidationInvalidDetails Examples
480
+
481
+ ```json
482
+ "Appeal has not been submitted on time"
483
+ ```
484
+
485
+ ```json
486
+ "Documents have not been submitted on time"
487
+ ```
488
+
489
+ ```json
490
+ "Other: scddsfv"
491
+ ```
492
+
493
+ ## caseValidationIncompleteDetails
494
+
495
+ A list of reasons why the appeal is incomplete
496
+
497
+ > The list will contain items only if the caseValidationOutcome is incomplete
498
+
499
+ `caseValidationIncompleteDetails`
500
+
501
+ * is optional
502
+
503
+ * Type: `string[]`
504
+
505
+ * can be null
506
+
507
+ * defined in: [DaRT API response](dart-response-properties-casevalidationincompletedetails.md "dart-response.schema.json#/properties/caseValidationIncompleteDetails")
508
+
509
+ ### caseValidationIncompleteDetails Type
510
+
511
+ `string[]`
512
+
513
+ ### caseValidationIncompleteDetails Examples
514
+
515
+ ```json
516
+ "Appellant name is not the same on the application form and appeal form"
517
+ ```
518
+
519
+ ```json
520
+ "LPA's decision notice is missing"
521
+ ```
522
+
523
+ ## caseExtensionDate
524
+
525
+ When the validation outcome is incomplete, an extension may be granted to provide missing information
526
+
527
+ `caseExtensionDate`
528
+
529
+ * is optional
530
+
531
+ * Type: `string`
532
+
533
+ * can be null
534
+
535
+ * defined in: [DaRT API response](dart-response-properties-caseextensiondate.md "dart-response.schema.json#/properties/caseExtensionDate")
536
+
537
+ ### caseExtensionDate Type
538
+
539
+ `string`
540
+
541
+ ### caseExtensionDate Examples
542
+
543
+ ```json
544
+ "2025-01-10T00:00:00.000Z"
545
+ ```
546
+
547
+ ## caseStartedDate
548
+
549
+ A date indicating when the case was started, resulting in the creation of a timetable
550
+
551
+ `caseStartedDate`
552
+
553
+ * is optional
554
+
555
+ * Type: `string`
556
+
557
+ * can be null
558
+
559
+ * defined in: [DaRT API response](dart-response-properties-casestarteddate.md "dart-response.schema.json#/properties/caseStartedDate")
560
+
561
+ ### caseStartedDate Type
562
+
563
+ `string`
564
+
565
+ ### caseStartedDate Examples
566
+
567
+ ```json
568
+ "2025-01-10T00:00:00.000Z"
569
+ ```
570
+
571
+ ## casePublishedDate
572
+
573
+ A date indicating when the case was published
574
+
575
+ `casePublishedDate`
576
+
577
+ * is optional
578
+
579
+ * Type: `string`
580
+
581
+ * can be null
582
+
583
+ * defined in: [DaRT API response](dart-response-properties-casepublisheddate.md "dart-response.schema.json#/properties/casePublishedDate")
584
+
585
+ ### casePublishedDate Type
586
+
587
+ `string`
588
+
589
+ ### casePublishedDate Examples
590
+
591
+ ```json
592
+ "2025-01-10T00:00:00.000Z"
593
+ ```
594
+
595
+ ## linkedCaseStatus
596
+
597
+ Indicates if the case is linked, and the type of relationship
598
+
599
+ `linkedCaseStatus`
600
+
601
+ * is optional
602
+
603
+ * Type: `string`
604
+
605
+ * can be null
606
+
607
+ * defined in: [DaRT API response](dart-response-properties-linkedcasestatus.md "dart-response.schema.json#/properties/linkedCaseStatus")
608
+
609
+ ### linkedCaseStatus Type
610
+
611
+ `string`
612
+
613
+ ### linkedCaseStatus Examples
614
+
615
+ ```json
616
+ "child"
617
+ ```
618
+
619
+ ## leadCaseReference
620
+
621
+ The reference of the lead case, if the case is a child case
622
+
623
+ `leadCaseReference`
624
+
625
+ * is optional
626
+
627
+ * Type: `string`
628
+
629
+ * can be null
630
+
631
+ * defined in: [DaRT API response](dart-response-properties-leadcasereference.md "dart-response.schema.json#/properties/leadCaseReference")
632
+
633
+ ### leadCaseReference Type
634
+
635
+ `string`
636
+
637
+ ### leadCaseReference Examples
638
+
639
+ ```json
640
+ "6002745"
641
+ ```
642
+
643
+ ## caseWithdrawnDate
644
+
645
+ The date the case was withdrawn by the appellant
646
+
647
+ `caseWithdrawnDate`
648
+
649
+ * is optional
650
+
651
+ * Type: `string`
652
+
653
+ * can be null
654
+
655
+ * defined in: [DaRT API response](dart-response-properties-casewithdrawndate.md "dart-response.schema.json#/properties/caseWithdrawnDate")
656
+
657
+ ### caseWithdrawnDate Type
658
+
659
+ `string`
660
+
661
+ ### caseWithdrawnDate Examples
662
+
663
+ ```json
664
+ "2025-01-10T00:00:00.000Z"
665
+ ```
666
+
667
+ ## caseTransferredDate
668
+
669
+ The date the case was transferred to a new case of a different type
670
+
671
+ `caseTransferredDate`
672
+
673
+ * is optional
674
+
675
+ * Type: `string`
676
+
677
+ * can be null
678
+
679
+ * defined in: [DaRT API response](dart-response-properties-casetransferreddate.md "dart-response.schema.json#/properties/caseTransferredDate")
680
+
681
+ ### caseTransferredDate Type
682
+
683
+ `string`
684
+
685
+ ### caseTransferredDate Examples
686
+
687
+ ```json
688
+ "2025-01-10T00:00:00.000Z"
689
+ ```
690
+
691
+ ## transferredCaseClosedDate
692
+
693
+ The date the case was closed and the appellant requested to resubmit
694
+
695
+ `transferredCaseClosedDate`
696
+
697
+ * is optional
698
+
699
+ * Type: `string`
700
+
701
+ * can be null
702
+
703
+ * defined in: [DaRT API response](dart-response-properties-transferredcasecloseddate.md "dart-response.schema.json#/properties/transferredCaseClosedDate")
704
+
705
+ ### transferredCaseClosedDate Type
706
+
707
+ `string`
708
+
709
+ ### transferredCaseClosedDate Examples
710
+
711
+ ```json
712
+ "2025-01-10T00:00:00.000Z"
713
+ ```
714
+
715
+ ## caseDecisionOutcomeDate
716
+
717
+ The date of the case decision
718
+
719
+ `caseDecisionOutcomeDate`
720
+
721
+ * is optional
722
+
723
+ * Type: `string`
724
+
725
+ * can be null
726
+
727
+ * defined in: [DaRT API response](dart-response-properties-casedecisionoutcomedate.md "dart-response.schema.json#/properties/caseDecisionOutcomeDate")
728
+
729
+ ### caseDecisionOutcomeDate Type
730
+
731
+ `string`
732
+
733
+ ### caseDecisionOutcomeDate Examples
734
+
735
+ ```json
736
+ "2025-01-10T00:00:00.000Z"
737
+ ```
738
+
739
+ ## caseDecisionPublishedDate
740
+
741
+ The date the case decision was published
742
+
743
+ `caseDecisionPublishedDate`
744
+
745
+ * is optional
746
+
747
+ * Type: `string`
748
+
749
+ * can be null
750
+
751
+ * defined in: [DaRT API response](dart-response-properties-casedecisionpublisheddate.md "dart-response.schema.json#/properties/caseDecisionPublishedDate")
752
+
753
+ ### caseDecisionPublishedDate Type
754
+
755
+ `string`
756
+
757
+ ### caseDecisionPublishedDate Examples
758
+
759
+ ```json
760
+ "2025-01-10T00:00:00.000Z"
761
+ ```
762
+
763
+ ## caseDecisionOutcome
764
+
765
+ The final outcome for the decision
766
+
767
+ `caseDecisionOutcome`
768
+
769
+ * is optional
770
+
771
+ * Type: `string`
772
+
773
+ * can be null
774
+
775
+ * defined in: [DaRT API response](dart-response-properties-casedecisionoutcome.md "dart-response.schema.json#/properties/caseDecisionOutcome")
776
+
777
+ ### caseDecisionOutcome Type
778
+
779
+ `string`
780
+
781
+ ### caseDecisionOutcome Examples
782
+
783
+ ```json
784
+ "allowed"
785
+ ```
786
+
787
+ ## caseCompletedDate
788
+
789
+ The date the case decision letter
790
+
791
+ `caseCompletedDate`
792
+
793
+ * is optional
794
+
795
+ * Type: `string`
796
+
797
+ * can be null
798
+
799
+ * defined in: [DaRT API response](dart-response-properties-casecompleteddate.md "dart-response.schema.json#/properties/caseCompletedDate")
800
+
801
+ ### caseCompletedDate Type
802
+
803
+ `string`
804
+
805
+ ### caseCompletedDate Examples
806
+
807
+ ```json
808
+ "2025-01-10T00:00:00.000Z"
809
+ ```
810
+
811
+ ## enforcementNotice
812
+
813
+ Indicates if an enforcement notice is the reason for the appeal
814
+
815
+ `enforcementNotice`
816
+
817
+ * is optional
818
+
819
+ * Type: `boolean`
820
+
821
+ * can be null
822
+
823
+ * defined in: [DaRT API response](dart-response-properties-enforcementnotice.md "dart-response.schema.json#/properties/enforcementNotice")
824
+
825
+ ### enforcementNotice Type
826
+
827
+ `boolean`
828
+
829
+ ## applicationReference
830
+
831
+ The unique identifier of the LPA application
832
+
833
+ `applicationReference`
834
+
835
+ * is required
836
+
837
+ * Type: `string`
838
+
839
+ * cannot be null
840
+
841
+ * defined in: [DaRT API response](dart-response-properties-applicationreference.md "dart-response.schema.json#/properties/applicationReference")
842
+
843
+ ### applicationReference Type
844
+
845
+ `string`
846
+
847
+ ### applicationReference Examples
848
+
849
+ ```json
850
+ "21824/APP/0/203130"
851
+ ```
852
+
853
+ ## applicationDate
854
+
855
+ The date of the original LPA application
856
+
857
+ `applicationDate`
858
+
859
+ * is optional
860
+
861
+ * Type: `string`
862
+
863
+ * cannot be null
864
+
865
+ * defined in: [DaRT API response](dart-response-properties-applicationdate.md "dart-response.schema.json#/properties/applicationDate")
866
+
867
+ ### applicationDate Type
868
+
869
+ `string`
870
+
871
+ ### applicationDate Examples
872
+
873
+ ```json
874
+ "2025-01-10T00:00:00.000Z"
875
+ ```
876
+
877
+ ## applicationDecision
878
+
879
+ The outcome of the original LPA decision
880
+
881
+ `applicationDecision`
882
+
883
+ * is optional
884
+
885
+ * Type: `string`
886
+
887
+ * cannot be null
888
+
889
+ * defined in: [DaRT API response](dart-response-properties-applicationdecision.md "dart-response.schema.json#/properties/applicationDecision")
890
+
891
+ ### applicationDecision Type
892
+
893
+ `string`
894
+
895
+ ### applicationDecision Examples
896
+
897
+ ```json
898
+ "refused"
899
+ ```
900
+
901
+ ## lpaDecisionDate
902
+
903
+ The date of the original LPA decision
904
+
905
+ `lpaDecisionDate`
906
+
907
+ * is optional
908
+
909
+ * Type: `string`
910
+
911
+ * can be null
912
+
913
+ * defined in: [DaRT API response](dart-response-properties-lpadecisiondate.md "dart-response.schema.json#/properties/lpaDecisionDate")
914
+
915
+ ### lpaDecisionDate Type
916
+
917
+ `string`
918
+
919
+ ### lpaDecisionDate Examples
920
+
921
+ ```json
922
+ "2025-01-10T00:00:00.000Z"
923
+ ```
924
+
925
+ ## caseSubmissionDueDate
926
+
927
+ The statutory deadline for submitting an appeal from the original LPA decision date
928
+
929
+ `caseSubmissionDueDate`
930
+
931
+ * is optional
932
+
933
+ * Type: `string`
934
+
935
+ * can be null
936
+
937
+ * defined in: [DaRT API response](dart-response-properties-casesubmissionduedate.md "dart-response.schema.json#/properties/caseSubmissionDueDate")
938
+
939
+ ### caseSubmissionDueDate Type
940
+
941
+ `string`
942
+
943
+ ### caseSubmissionDueDate Examples
944
+
945
+ ```json
946
+ "2025-01-10T00:00:00.000Z"
947
+ ```
948
+
949
+ ## siteAddressLine1
950
+
951
+ First line of case site address
952
+
953
+ `siteAddressLine1`
954
+
955
+ * is optional
956
+
957
+ * Type: `string`
958
+
959
+ * can be null
960
+
961
+ * defined in: [DaRT API response](dart-response-properties-siteaddressline1.md "dart-response.schema.json#/properties/siteAddressLine1")
962
+
963
+ ### siteAddressLine1 Type
964
+
965
+ `string`
966
+
967
+ ### siteAddressLine1 Examples
968
+
969
+ ```json
970
+ "21 The Pavement"
971
+ ```
972
+
973
+ ## siteAddressLine2
974
+
975
+ Second line of case site address
976
+
977
+ `siteAddressLine2`
978
+
979
+ * is optional
980
+
981
+ * Type: `string`
982
+
983
+ * can be null
984
+
985
+ * defined in: [DaRT API response](dart-response-properties-siteaddressline2.md "dart-response.schema.json#/properties/siteAddressLine2")
986
+
987
+ ### siteAddressLine2 Type
988
+
989
+ `string`
990
+
991
+ ### siteAddressLine2 Examples
992
+
993
+ ```json
994
+ "Shotesham Road"
995
+ ```
996
+
997
+ ## siteAddressTown
998
+
999
+ Town / City of the site address
1000
+
1001
+ `siteAddressTown`
1002
+
1003
+ * is optional
1004
+
1005
+ * Type: `string`
1006
+
1007
+ * can be null
1008
+
1009
+ * defined in: [DaRT API response](dart-response-properties-siteaddresstown.md "dart-response.schema.json#/properties/siteAddressTown")
1010
+
1011
+ ### siteAddressTown Type
1012
+
1013
+ `string`
1014
+
1015
+ ### siteAddressTown Examples
1016
+
1017
+ ```json
1018
+ "Bristol"
1019
+ ```
1020
+
1021
+ ## siteAddressCounty
1022
+
1023
+ County of the site address
1024
+
1025
+ `siteAddressCounty`
1026
+
1027
+ * is optional
1028
+
1029
+ * Type: `string`
1030
+
1031
+ * can be null
1032
+
1033
+ * defined in: [DaRT API response](dart-response-properties-siteaddresscounty.md "dart-response.schema.json#/properties/siteAddressCounty")
1034
+
1035
+ ### siteAddressCounty Type
1036
+
1037
+ `string`
1038
+
1039
+ ### siteAddressCounty Examples
1040
+
1041
+ ```json
1042
+ "Wandsworth"
1043
+ ```
1044
+
1045
+ ## siteAddressPostcode
1046
+
1047
+ Postal code of the site address
1048
+
1049
+ `siteAddressPostcode`
1050
+
1051
+ * is optional
1052
+
1053
+ * Type: `string`
1054
+
1055
+ * can be null
1056
+
1057
+ * defined in: [DaRT API response](dart-response-properties-siteaddresspostcode.md "dart-response.schema.json#/properties/siteAddressPostcode")
1058
+
1059
+ ### siteAddressPostcode Type
1060
+
1061
+ `string`
1062
+
1063
+ ### siteAddressPostcode Examples
1064
+
1065
+ ```json
1066
+ "SW4 0HY"
1067
+ ```
1068
+
1069
+ ## isCorrectAppealType
1070
+
1071
+ Indicates if the LPA considers the appeal type appropriate
1072
+
1073
+ `isCorrectAppealType`
1074
+
1075
+ * is optional
1076
+
1077
+ * Type: `boolean`
1078
+
1079
+ * can be null
1080
+
1081
+ * defined in: [DaRT API response](dart-response-properties-iscorrectappealtype.md "dart-response.schema.json#/properties/isCorrectAppealType")
1082
+
1083
+ ### isCorrectAppealType Type
1084
+
1085
+ `boolean`
1086
+
1087
+ ### isCorrectAppealType Examples
1088
+
1089
+ ```json
1090
+ "True"
1091
+ ```
1092
+
1093
+ ## originalDevelopmentDescription
1094
+
1095
+ The original description of the development, as provided by the appellant
1096
+
1097
+ `originalDevelopmentDescription`
1098
+
1099
+ * is optional
1100
+
1101
+ * Type: `string`
1102
+
1103
+ * can be null
1104
+
1105
+ * defined in: [DaRT API response](dart-response-properties-originaldevelopmentdescription.md "dart-response.schema.json#/properties/originalDevelopmentDescription")
1106
+
1107
+ ### originalDevelopmentDescription Type
1108
+
1109
+ `string`
1110
+
1111
+ ### originalDevelopmentDescription Examples
1112
+
1113
+ ```json
1114
+ "Replacement of an existing gate to access the property"
1115
+ ```
1116
+
1117
+ ## changedDevelopmentDescription
1118
+
1119
+ Indicates that the LPA has changed the development description
1120
+
1121
+ `changedDevelopmentDescription`
1122
+
1123
+ * is optional
1124
+
1125
+ * Type: `boolean`
1126
+
1127
+ * can be null
1128
+
1129
+ * defined in: [DaRT API response](dart-response-properties-changeddevelopmentdescription.md "dart-response.schema.json#/properties/changedDevelopmentDescription")
1130
+
1131
+ ### changedDevelopmentDescription Type
1132
+
1133
+ `boolean`
1134
+
1135
+ ### changedDevelopmentDescription Examples
1136
+
1137
+ ```json
1138
+ "True"
1139
+ ```
1140
+
1141
+ ## newConditionDetails
1142
+
1143
+ Since the original application, a number of things have changed.
1144
+
1145
+ `newConditionDetails`
1146
+
1147
+ * is optional
1148
+
1149
+ * Type: `string`
1150
+
1151
+ * can be null
1152
+
1153
+ * defined in: [DaRT API response](dart-response-properties-newconditiondetails.md "dart-response.schema.json#/properties/newConditionDetails")
1154
+
1155
+ ### newConditionDetails Type
1156
+
1157
+ `string`
1158
+
1159
+ ### newConditionDetails Examples
1160
+
1161
+ ```json
1162
+ "example"
1163
+ ```
1164
+
1165
+ ## nearbyCaseReferences
1166
+
1167
+ A list of related case references known to the appellant and the LPA
1168
+
1169
+ `nearbyCaseReferences`
1170
+
1171
+ * is optional
1172
+
1173
+ * Type: `string[]`
1174
+
1175
+ * can be null
1176
+
1177
+ * defined in: [DaRT API response](dart-response-properties-nearbycasereferences.md "dart-response.schema.json#/properties/nearbyCaseReferences")
1178
+
1179
+ ### nearbyCaseReferences Type
1180
+
1181
+ `string[]`
1182
+
1183
+ ## neighbouringSiteAddresses
1184
+
1185
+ A list of neighbouring site addresses
1186
+
1187
+ `neighbouringSiteAddresses`
1188
+
1189
+ * is optional
1190
+
1191
+ * Type: `object[]` ([Details](dart-response-properties-neighbouringsiteaddresses-items.md))
1192
+
1193
+ * can be null
1194
+
1195
+ * defined in: [DaRT API response](dart-response-properties-neighbouringsiteaddresses.md "dart-response.schema.json#/properties/neighbouringSiteAddresses")
1196
+
1197
+ ### neighbouringSiteAddresses Type
1198
+
1199
+ `object[]` ([Details](dart-response-properties-neighbouringsiteaddresses-items.md))
1200
+
1201
+ ## affectedListedBuildingNumbers
1202
+
1203
+ A list of affected listed building IDs from Historic England
1204
+
1205
+ `affectedListedBuildingNumbers`
1206
+
1207
+ * is optional
1208
+
1209
+ * Type: `string[]`
1210
+
1211
+ * can be null
1212
+
1213
+ * defined in: [DaRT API response](dart-response-properties-affectedlistedbuildingnumbers.md "dart-response.schema.json#/properties/affectedListedBuildingNumbers")
1214
+
1215
+ ### affectedListedBuildingNumbers Type
1216
+
1217
+ `string[]`
1218
+
1219
+ ## appellantCostsAppliedFor
1220
+
1221
+ Indicates if the appellant has applied for costs
1222
+
1223
+ `appellantCostsAppliedFor`
1224
+
1225
+ * is optional
1226
+
1227
+ * Type: `boolean`
1228
+
1229
+ * can be null
1230
+
1231
+ * defined in: [DaRT API response](dart-response-properties-appellantcostsappliedfor.md "dart-response.schema.json#/properties/appellantCostsAppliedFor")
1232
+
1233
+ ### appellantCostsAppliedFor Type
1234
+
1235
+ `boolean`
1236
+
1237
+ ### appellantCostsAppliedFor Examples
1238
+
1239
+ ```json
1240
+ "True"
1241
+ ```
1242
+
1243
+ ## lpaCostsAppliedFor
1244
+
1245
+ Indicates if the LPA has applied for costs
1246
+
1247
+ `lpaCostsAppliedFor`
1248
+
1249
+ * is optional
1250
+
1251
+ * Type: `boolean`
1252
+
1253
+ * can be null
1254
+
1255
+ * defined in: [DaRT API response](dart-response-properties-lpacostsappliedfor.md "dart-response.schema.json#/properties/lpaCostsAppliedFor")
1256
+
1257
+ ### lpaCostsAppliedFor Type
1258
+
1259
+ `boolean`
1260
+
1261
+ ### lpaCostsAppliedFor Examples
1262
+
1263
+ ```json
1264
+ "False"
1265
+ ```
1266
+
1267
+ ## appellantName
1268
+
1269
+ Name of the appellant
1270
+
1271
+ `appellantName`
1272
+
1273
+ * is optional
1274
+
1275
+ * Type: `string`
1276
+
1277
+ * cannot be null
1278
+
1279
+ * defined in: [DaRT API response](dart-response-properties-appellantname.md "dart-response.schema.json#/properties/appellantName")
1280
+
1281
+ ### appellantName Type
1282
+
1283
+ `string`
1284
+
1285
+ ### appellantName Examples
1286
+
1287
+ ```json
1288
+ "example"
1289
+ ```
1290
+
1291
+ ## typeOfEvent
1292
+
1293
+ The type of event
1294
+
1295
+ `typeOfEvent`
1296
+
1297
+ * is optional
1298
+
1299
+ * Type: `string`
1300
+
1301
+ * can be null
1302
+
1303
+ * defined in: [DaRT API response](dart-response-properties-typeofevent.md "dart-response.schema.json#/properties/typeOfEvent")
1304
+
1305
+ ### typeOfEvent Type
1306
+
1307
+ `string`
1308
+
1309
+ ### typeOfEvent Examples
1310
+
1311
+ ```json
1312
+ "site_visit_access_required"
1313
+ ```
1314
+
1315
+ ## startDateOfTheEvent
1316
+
1317
+ Event start date and time
1318
+
1319
+ `startDateOfTheEvent`
1320
+
1321
+ * is optional
1322
+
1323
+ * Type: `string`
1324
+
1325
+ * can be null
1326
+
1327
+ * defined in: [DaRT API response](dart-response-properties-startdateoftheevent.md "dart-response.schema.json#/properties/startDateOfTheEvent")
1328
+
1329
+ ### startDateOfTheEvent Type
1330
+
1331
+ `string`
1332
+
1333
+ ### startDateOfTheEvent Examples
1334
+
1335
+ ```json
1336
+ "2025-01-10T00:00:00.000Z"
1337
+ ```
1338
+
1339
+ ## inspectorName
1340
+
1341
+ Name of inspector allocated to case
1342
+
1343
+ `inspectorName`
1344
+
1345
+ * is optional
1346
+
1347
+ * Type: `string`
1348
+
1349
+ * can be null
1350
+
1351
+ * defined in: [DaRT API response](dart-response-properties-inspectorname.md "dart-response.schema.json#/properties/inspectorName")
1352
+
1353
+ ### inspectorName Type
1354
+
1355
+ `string`
1356
+
1357
+ ### inspectorName Examples
1358
+
1359
+ ```json
1360
+ "In Spector"
1361
+ ```
1362
+
1363
+ ## caseOfficerName
1364
+
1365
+ name of case officer assigned to case
1366
+
1367
+ `caseOfficerName`
1368
+
1369
+ * is optional
1370
+
1371
+ * Type: `string`
1372
+
1373
+ * can be null
1374
+
1375
+ * defined in: [DaRT API response](dart-response-properties-caseofficername.md "dart-response.schema.json#/properties/caseOfficerName")
1376
+
1377
+ ### caseOfficerName Type
1378
+
1379
+ `string`
1380
+
1381
+ ### caseOfficerName Examples
1382
+
1383
+ ```json
1384
+ "example"
1385
+ ```
1386
+
1387
+ ## inspectorQualifications
1388
+
1389
+ The qualifications of the inspector
1390
+
1391
+ `inspectorQualifications`
1392
+
1393
+ * is optional
1394
+
1395
+ * Type: `string`
1396
+
1397
+ * can be null
1398
+
1399
+ * defined in: [DaRT API response](dart-response-properties-inspectorqualifications.md "dart-response.schema.json#/properties/inspectorQualifications")
1400
+
1401
+ ### inspectorQualifications Type
1402
+
1403
+ `string`
1404
+
1405
+ ### inspectorQualifications Examples
1406
+
1407
+ ```json
1408
+ "example"
1409
+ ```
1410
+
1411
+ ## Additional Properties
1412
+
1413
+ Additional properties are allowed and do not have to follow a specific schema