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