@planning-inspectorate/data-model 2.48.1 → 2.50.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/README.md +23 -1
- package/docs/address.md +366 -0
- package/docs/appeal-has.md +10 -7
- package/docs/applications-application-defs-address.md +108 -0
- package/docs/applications-application-defs-contact.md +98 -0
- package/docs/applications-application-defs-organisation.md +117 -0
- package/docs/applications-application-defs.md +3 -0
- package/docs/{application-update.md → applications-application-update.md} +22 -22
- package/docs/applications-application.md +2250 -0
- package/docs/applications-notify-email-defs-contact.md +93 -0
- package/docs/applications-notify-email-defs.md +3 -0
- package/docs/applications-notify-email.md +458 -0
- package/docs/applications-representation-definitions-contact.md +93 -0
- package/docs/applications-representation-definitions-representationdocument.md +152 -0
- package/docs/applications-representation-definitions.md +3 -0
- package/docs/applications-representation.md +834 -0
- package/package.json +1 -1
- package/pins_data_model/models/model_address.py +69 -0
- package/pins_data_model/models/model_appeal_has.py +3 -0
- package/pins_data_model/models/model_applications_application.py +518 -0
- package/pins_data_model/models/model_applications_application_update.py +55 -0
- package/pins_data_model/models/model_applications_notify_email.py +124 -0
- package/pins_data_model/models/model_applications_representation.py +207 -0
- package/schemas/address.schema.json +87 -0
- package/schemas/appeal-has.schema.json +2 -2
- package/schemas/{application-update.schema.json → applications-application-update.schema.json} +1 -1
- package/schemas/applications-application.schema.json +539 -0
- package/schemas/applications-notify-email.schema.json +118 -0
- package/schemas/applications-representation.schema.json +202 -0
- package/src/enums.cjs +147 -7
- package/src/enums.d.ts +131 -6
- package/src/enums.js +131 -6
- package/src/index.cjs +147 -7
- package/src/schemas.d.ts +679 -2
- package/tests/appeals/appeal-has.test.js +34 -0
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
## Contact Type
|
|
2
|
+
|
|
3
|
+
`object` ([Details](applications-notify-email-defs-contact.md))
|
|
4
|
+
|
|
5
|
+
# Contact Properties
|
|
6
|
+
|
|
7
|
+
| Property | Type | Required | Nullable | Defined by |
|
|
8
|
+
| :---------------------------------------------------- | :------- | :------- | :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
9
|
+
| [contactId](#contactid) | `string` | Required | cannot be null | [Email Notification Record Schema](applications-notify-email-defs-contact-properties-contactid.md "applications-notify-email.schema.json#/$defs/Contact/properties/contactId") |
|
|
10
|
+
| [contactPreference](#contactpreference) | `string` | Optional | can be null | [Email Notification Record Schema](applications-notify-email-defs-contact-properties-contactpreference.md "applications-notify-email.schema.json#/$defs/Contact/properties/contactPreference") |
|
|
11
|
+
| [writtenRepOrgName](#writtenreporgname) | `string` | Optional | can be null | [Email Notification Record Schema](applications-notify-email-defs-contact-properties-writtenreporgname.md "applications-notify-email.schema.json#/$defs/Contact/properties/writtenRepOrgName") |
|
|
12
|
+
| [writtenRepJobTitleorRole](#writtenrepjobtitleorrole) | `string` | Optional | can be null | [Email Notification Record Schema](applications-notify-email-defs-contact-properties-writtenrepjobtitleorrole.md "applications-notify-email.schema.json#/$defs/Contact/properties/writtenRepJobTitleorRole") |
|
|
13
|
+
|
|
14
|
+
## contactId
|
|
15
|
+
|
|
16
|
+
Source PK for Contact
|
|
17
|
+
|
|
18
|
+
`contactId`
|
|
19
|
+
|
|
20
|
+
* is required
|
|
21
|
+
|
|
22
|
+
* Type: `string`
|
|
23
|
+
|
|
24
|
+
* cannot be null
|
|
25
|
+
|
|
26
|
+
* defined in: [Email Notification Record Schema](applications-notify-email-defs-contact-properties-contactid.md "applications-notify-email.schema.json#/$defs/Contact/properties/contactId")
|
|
27
|
+
|
|
28
|
+
### contactId Type
|
|
29
|
+
|
|
30
|
+
`string`
|
|
31
|
+
|
|
32
|
+
## contactPreference
|
|
33
|
+
|
|
34
|
+
Preferred contact method
|
|
35
|
+
|
|
36
|
+
`contactPreference`
|
|
37
|
+
|
|
38
|
+
* is optional
|
|
39
|
+
|
|
40
|
+
* Type: `string`
|
|
41
|
+
|
|
42
|
+
* can be null
|
|
43
|
+
|
|
44
|
+
* defined in: [Email Notification Record Schema](applications-notify-email-defs-contact-properties-contactpreference.md "applications-notify-email.schema.json#/$defs/Contact/properties/contactPreference")
|
|
45
|
+
|
|
46
|
+
### contactPreference Type
|
|
47
|
+
|
|
48
|
+
`string`
|
|
49
|
+
|
|
50
|
+
### contactPreference Constraints
|
|
51
|
+
|
|
52
|
+
**enum**: the value of this property must be equal to one of the following values:
|
|
53
|
+
|
|
54
|
+
| Value | Explanation |
|
|
55
|
+
| :-------- | :---------- |
|
|
56
|
+
| `"email"` | |
|
|
57
|
+
| `"post"` | |
|
|
58
|
+
|
|
59
|
+
## writtenRepOrgName
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
`writtenRepOrgName`
|
|
64
|
+
|
|
65
|
+
* is optional
|
|
66
|
+
|
|
67
|
+
* Type: `string`
|
|
68
|
+
|
|
69
|
+
* can be null
|
|
70
|
+
|
|
71
|
+
* defined in: [Email Notification Record Schema](applications-notify-email-defs-contact-properties-writtenreporgname.md "applications-notify-email.schema.json#/$defs/Contact/properties/writtenRepOrgName")
|
|
72
|
+
|
|
73
|
+
### writtenRepOrgName Type
|
|
74
|
+
|
|
75
|
+
`string`
|
|
76
|
+
|
|
77
|
+
## writtenRepJobTitleorRole
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
`writtenRepJobTitleorRole`
|
|
82
|
+
|
|
83
|
+
* is optional
|
|
84
|
+
|
|
85
|
+
* Type: `string`
|
|
86
|
+
|
|
87
|
+
* can be null
|
|
88
|
+
|
|
89
|
+
* defined in: [Email Notification Record Schema](applications-notify-email-defs-contact-properties-writtenrepjobtitleorrole.md "applications-notify-email.schema.json#/$defs/Contact/properties/writtenRepJobTitleorRole")
|
|
90
|
+
|
|
91
|
+
### writtenRepJobTitleorRole Type
|
|
92
|
+
|
|
93
|
+
`string`
|
|
@@ -0,0 +1,458 @@
|
|
|
1
|
+
## Email Notification Record Schema Type
|
|
2
|
+
|
|
3
|
+
`object` ([Email Notification Record Schema](applications-notify-email.md))
|
|
4
|
+
|
|
5
|
+
# Email Notification Record Schema Properties
|
|
6
|
+
|
|
7
|
+
| Property | Type | Required | Nullable | Defined by |
|
|
8
|
+
| :---------------------------------- | :-------- | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
9
|
+
| [id](#id) | `string` | Required | cannot be null | [Email Notification Record Schema](applications-notify-email-properties-id.md "applications-notify-email.schema.json#/properties/id") |
|
|
10
|
+
| [notifyId](#notifyid) | `string` | Optional | can be null | [Email Notification Record Schema](applications-notify-email-properties-notifyid.md "applications-notify-email.schema.json#/properties/notifyId") |
|
|
11
|
+
| [reference](#reference) | `string` | Optional | cannot be null | [Email Notification Record Schema](applications-notify-email-properties-reference.md "applications-notify-email.schema.json#/properties/reference") |
|
|
12
|
+
| [caseReference](#casereference) | `string` | Required | cannot be null | [Email Notification Record Schema](applications-notify-email-properties-casereference.md "applications-notify-email.schema.json#/properties/caseReference") |
|
|
13
|
+
| [caseId](#caseid) | `string` | Required | cannot be null | [Email Notification Record Schema](applications-notify-email-properties-caseid.md "applications-notify-email.schema.json#/properties/caseId") |
|
|
14
|
+
| [caseType](#casetype) | `string` | Required | cannot be null | [Email Notification Record Schema](applications-notify-email-properties-casetype.md "applications-notify-email.schema.json#/properties/caseType") |
|
|
15
|
+
| [createdDate](#createddate) | `string` | Optional | can be null | [Email Notification Record Schema](applications-notify-email-properties-createddate.md "applications-notify-email.schema.json#/properties/createdDate") |
|
|
16
|
+
| [createdBy](#createdby) | `string` | Optional | can be null | [Email Notification Record Schema](applications-notify-email-properties-createdby.md "applications-notify-email.schema.json#/properties/createdBy") |
|
|
17
|
+
| [completedDate](#completeddate) | `string` | Optional | can be null | [Email Notification Record Schema](applications-notify-email-properties-completeddate.md "applications-notify-email.schema.json#/properties/completedDate") |
|
|
18
|
+
| [email](#email) | `string` | Optional | can be null | [Email Notification Record Schema](applications-notify-email-properties-email.md "applications-notify-email.schema.json#/properties/email") |
|
|
19
|
+
| [contact](#contact) | `array` | Optional | can be null | [Email Notification Record Schema](applications-notify-email-properties-contact.md "applications-notify-email.schema.json#/properties/contact") |
|
|
20
|
+
| [lpaCode](#lpacode) | `string` | Required | cannot be null | [Email Notification Record Schema](applications-notify-email-properties-lpacode.md "applications-notify-email.schema.json#/properties/lpaCode") |
|
|
21
|
+
| [emailStatus](#emailstatus) | `string` | Optional | cannot be null | [Email Notification Record Schema](applications-notify-email-properties-emailstatus.md "applications-notify-email.schema.json#/properties/emailStatus") |
|
|
22
|
+
| [templateId](#templateid) | `string` | Optional | can be null | [Email Notification Record Schema](applications-notify-email-properties-templateid.md "applications-notify-email.schema.json#/properties/templateId") |
|
|
23
|
+
| [templateVersion](#templateversion) | `integer` | Optional | can be null | [Email Notification Record Schema](applications-notify-email-properties-templateversion.md "applications-notify-email.schema.json#/properties/templateVersion") |
|
|
24
|
+
| [body](#body) | `string` | Optional | can be null | [Email Notification Record Schema](applications-notify-email-properties-body.md "applications-notify-email.schema.json#/properties/body") |
|
|
25
|
+
| [subject](#subject) | `string` | Optional | can be null | [Email Notification Record Schema](applications-notify-email-properties-subject.md "applications-notify-email.schema.json#/properties/subject") |
|
|
26
|
+
| Additional Properties | Any | Optional | can be null | |
|
|
27
|
+
|
|
28
|
+
## id
|
|
29
|
+
|
|
30
|
+
Internal Identifier UUID
|
|
31
|
+
|
|
32
|
+
`id`
|
|
33
|
+
|
|
34
|
+
* is required
|
|
35
|
+
|
|
36
|
+
* Type: `string`
|
|
37
|
+
|
|
38
|
+
* cannot be null
|
|
39
|
+
|
|
40
|
+
* defined in: [Email Notification Record Schema](applications-notify-email-properties-id.md "applications-notify-email.schema.json#/properties/id")
|
|
41
|
+
|
|
42
|
+
### id Type
|
|
43
|
+
|
|
44
|
+
`string`
|
|
45
|
+
|
|
46
|
+
## notifyId
|
|
47
|
+
|
|
48
|
+
Id used by Notify
|
|
49
|
+
|
|
50
|
+
`notifyId`
|
|
51
|
+
|
|
52
|
+
* is optional
|
|
53
|
+
|
|
54
|
+
* Type: `string`
|
|
55
|
+
|
|
56
|
+
* can be null
|
|
57
|
+
|
|
58
|
+
* defined in: [Email Notification Record Schema](applications-notify-email-properties-notifyid.md "applications-notify-email.schema.json#/properties/notifyId")
|
|
59
|
+
|
|
60
|
+
### notifyId Type
|
|
61
|
+
|
|
62
|
+
`string`
|
|
63
|
+
|
|
64
|
+
## reference
|
|
65
|
+
|
|
66
|
+
Reference passed to notify (used to identify the case or representation it relates to)
|
|
67
|
+
|
|
68
|
+
`reference`
|
|
69
|
+
|
|
70
|
+
* is optional
|
|
71
|
+
|
|
72
|
+
* Type: `string`
|
|
73
|
+
|
|
74
|
+
* cannot be null
|
|
75
|
+
|
|
76
|
+
* defined in: [Email Notification Record Schema](applications-notify-email-properties-reference.md "applications-notify-email.schema.json#/properties/reference")
|
|
77
|
+
|
|
78
|
+
### reference Type
|
|
79
|
+
|
|
80
|
+
`string`
|
|
81
|
+
|
|
82
|
+
## caseReference
|
|
83
|
+
|
|
84
|
+
Business Key for the related case
|
|
85
|
+
|
|
86
|
+
`caseReference`
|
|
87
|
+
|
|
88
|
+
* is required
|
|
89
|
+
|
|
90
|
+
* Type: `string`
|
|
91
|
+
|
|
92
|
+
* cannot be null
|
|
93
|
+
|
|
94
|
+
* defined in: [Email Notification Record Schema](applications-notify-email-properties-casereference.md "applications-notify-email.schema.json#/properties/caseReference")
|
|
95
|
+
|
|
96
|
+
### caseReference Type
|
|
97
|
+
|
|
98
|
+
`string`
|
|
99
|
+
|
|
100
|
+
## caseId
|
|
101
|
+
|
|
102
|
+
The unique ID for the case this notification belongs to.
|
|
103
|
+
|
|
104
|
+
`caseId`
|
|
105
|
+
|
|
106
|
+
* is required
|
|
107
|
+
|
|
108
|
+
* Type: `string`
|
|
109
|
+
|
|
110
|
+
* cannot be null
|
|
111
|
+
|
|
112
|
+
* defined in: [Email Notification Record Schema](applications-notify-email-properties-caseid.md "applications-notify-email.schema.json#/properties/caseId")
|
|
113
|
+
|
|
114
|
+
### caseId Type
|
|
115
|
+
|
|
116
|
+
`string`
|
|
117
|
+
|
|
118
|
+
## caseType
|
|
119
|
+
|
|
120
|
+
The type of case this notification is for.
|
|
121
|
+
|
|
122
|
+
`caseType`
|
|
123
|
+
|
|
124
|
+
* is required
|
|
125
|
+
|
|
126
|
+
* Type: `string`
|
|
127
|
+
|
|
128
|
+
* cannot be null
|
|
129
|
+
|
|
130
|
+
* defined in: [Email Notification Record Schema](applications-notify-email-properties-casetype.md "applications-notify-email.schema.json#/properties/caseType")
|
|
131
|
+
|
|
132
|
+
### caseType Type
|
|
133
|
+
|
|
134
|
+
`string`
|
|
135
|
+
|
|
136
|
+
## createdDate
|
|
137
|
+
|
|
138
|
+
Date the email was created
|
|
139
|
+
|
|
140
|
+
`createdDate`
|
|
141
|
+
|
|
142
|
+
* is optional
|
|
143
|
+
|
|
144
|
+
* Type: `string`
|
|
145
|
+
|
|
146
|
+
* can be null
|
|
147
|
+
|
|
148
|
+
* defined in: [Email Notification Record Schema](applications-notify-email-properties-createddate.md "applications-notify-email.schema.json#/properties/createdDate")
|
|
149
|
+
|
|
150
|
+
### createdDate Type
|
|
151
|
+
|
|
152
|
+
`string`
|
|
153
|
+
|
|
154
|
+
### createdDate Constraints
|
|
155
|
+
|
|
156
|
+
**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")
|
|
157
|
+
|
|
158
|
+
## createdBy
|
|
159
|
+
|
|
160
|
+
Name of the person that triggered the email (only applies when done manually)
|
|
161
|
+
|
|
162
|
+
`createdBy`
|
|
163
|
+
|
|
164
|
+
* is optional
|
|
165
|
+
|
|
166
|
+
* Type: `string`
|
|
167
|
+
|
|
168
|
+
* can be null
|
|
169
|
+
|
|
170
|
+
* defined in: [Email Notification Record Schema](applications-notify-email-properties-createdby.md "applications-notify-email.schema.json#/properties/createdBy")
|
|
171
|
+
|
|
172
|
+
### createdBy Type
|
|
173
|
+
|
|
174
|
+
`string`
|
|
175
|
+
|
|
176
|
+
## completedDate
|
|
177
|
+
|
|
178
|
+
When the email completed (succeeded or failed)
|
|
179
|
+
|
|
180
|
+
`completedDate`
|
|
181
|
+
|
|
182
|
+
* is optional
|
|
183
|
+
|
|
184
|
+
* Type: `string`
|
|
185
|
+
|
|
186
|
+
* can be null
|
|
187
|
+
|
|
188
|
+
* defined in: [Email Notification Record Schema](applications-notify-email-properties-completeddate.md "applications-notify-email.schema.json#/properties/completedDate")
|
|
189
|
+
|
|
190
|
+
### completedDate Type
|
|
191
|
+
|
|
192
|
+
`string`
|
|
193
|
+
|
|
194
|
+
### completedDate Constraints
|
|
195
|
+
|
|
196
|
+
**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")
|
|
197
|
+
|
|
198
|
+
## email
|
|
199
|
+
|
|
200
|
+
Email address sent to if unable to be linked to an LPA or Contact
|
|
201
|
+
|
|
202
|
+
`email`
|
|
203
|
+
|
|
204
|
+
* is optional
|
|
205
|
+
|
|
206
|
+
* Type: `string`
|
|
207
|
+
|
|
208
|
+
* can be null
|
|
209
|
+
|
|
210
|
+
* defined in: [Email Notification Record Schema](applications-notify-email-properties-email.md "applications-notify-email.schema.json#/properties/email")
|
|
211
|
+
|
|
212
|
+
### email Type
|
|
213
|
+
|
|
214
|
+
`string`
|
|
215
|
+
|
|
216
|
+
### email Constraints
|
|
217
|
+
|
|
218
|
+
**email**: the string must be an email address, according to [RFC 5322, section 3.4.1](https://tools.ietf.org/html/rfc5322 "check the specification")
|
|
219
|
+
|
|
220
|
+
## contact
|
|
221
|
+
|
|
222
|
+
Contact(s) the email was sent to
|
|
223
|
+
|
|
224
|
+
`contact`
|
|
225
|
+
|
|
226
|
+
* is optional
|
|
227
|
+
|
|
228
|
+
* Type: `object[]` ([Details](applications-notify-email-defs-contact.md))
|
|
229
|
+
|
|
230
|
+
* can be null
|
|
231
|
+
|
|
232
|
+
* defined in: [Email Notification Record Schema](applications-notify-email-properties-contact.md "applications-notify-email.schema.json#/properties/contact")
|
|
233
|
+
|
|
234
|
+
### contact Type
|
|
235
|
+
|
|
236
|
+
`object[]` ([Details](applications-notify-email-defs-contact.md))
|
|
237
|
+
|
|
238
|
+
## lpaCode
|
|
239
|
+
|
|
240
|
+
Planning Body code
|
|
241
|
+
|
|
242
|
+
`lpaCode`
|
|
243
|
+
|
|
244
|
+
* is required
|
|
245
|
+
|
|
246
|
+
* Type: `string`
|
|
247
|
+
|
|
248
|
+
* cannot be null
|
|
249
|
+
|
|
250
|
+
* defined in: [Email Notification Record Schema](applications-notify-email-properties-lpacode.md "applications-notify-email.schema.json#/properties/lpaCode")
|
|
251
|
+
|
|
252
|
+
### lpaCode Type
|
|
253
|
+
|
|
254
|
+
`string`
|
|
255
|
+
|
|
256
|
+
## emailStatus
|
|
257
|
+
|
|
258
|
+
Outcome of the email (status)
|
|
259
|
+
|
|
260
|
+
`emailStatus`
|
|
261
|
+
|
|
262
|
+
* is optional
|
|
263
|
+
|
|
264
|
+
* Type: `string`
|
|
265
|
+
|
|
266
|
+
* cannot be null
|
|
267
|
+
|
|
268
|
+
* defined in: [Email Notification Record Schema](applications-notify-email-properties-emailstatus.md "applications-notify-email.schema.json#/properties/emailStatus")
|
|
269
|
+
|
|
270
|
+
### emailStatus Type
|
|
271
|
+
|
|
272
|
+
`string`
|
|
273
|
+
|
|
274
|
+
### emailStatus Constraints
|
|
275
|
+
|
|
276
|
+
**enum**: the value of this property must be equal to one of the following values:
|
|
277
|
+
|
|
278
|
+
| Value | Explanation |
|
|
279
|
+
| :-------------------- | :---------- |
|
|
280
|
+
| `"Sending"` | |
|
|
281
|
+
| `"Delivered"` | |
|
|
282
|
+
| `"Permanent failure"` | |
|
|
283
|
+
| `"Temporary failure"` | |
|
|
284
|
+
| `"Technical failure"` | |
|
|
285
|
+
|
|
286
|
+
## templateId
|
|
287
|
+
|
|
288
|
+
The id of the template sent in Notify
|
|
289
|
+
|
|
290
|
+
`templateId`
|
|
291
|
+
|
|
292
|
+
* is optional
|
|
293
|
+
|
|
294
|
+
* Type: `string`
|
|
295
|
+
|
|
296
|
+
* can be null
|
|
297
|
+
|
|
298
|
+
* defined in: [Email Notification Record Schema](applications-notify-email-properties-templateid.md "applications-notify-email.schema.json#/properties/templateId")
|
|
299
|
+
|
|
300
|
+
### templateId Type
|
|
301
|
+
|
|
302
|
+
`string`
|
|
303
|
+
|
|
304
|
+
## templateVersion
|
|
305
|
+
|
|
306
|
+
The version of the template sent
|
|
307
|
+
|
|
308
|
+
`templateVersion`
|
|
309
|
+
|
|
310
|
+
* is optional
|
|
311
|
+
|
|
312
|
+
* Type: `integer`
|
|
313
|
+
|
|
314
|
+
* can be null
|
|
315
|
+
|
|
316
|
+
* defined in: [Email Notification Record Schema](applications-notify-email-properties-templateversion.md "applications-notify-email.schema.json#/properties/templateVersion")
|
|
317
|
+
|
|
318
|
+
### templateVersion Type
|
|
319
|
+
|
|
320
|
+
`integer`
|
|
321
|
+
|
|
322
|
+
## body
|
|
323
|
+
|
|
324
|
+
The full HTML/plain text body of the email
|
|
325
|
+
|
|
326
|
+
`body`
|
|
327
|
+
|
|
328
|
+
* is optional
|
|
329
|
+
|
|
330
|
+
* Type: `string`
|
|
331
|
+
|
|
332
|
+
* can be null
|
|
333
|
+
|
|
334
|
+
* defined in: [Email Notification Record Schema](applications-notify-email-properties-body.md "applications-notify-email.schema.json#/properties/body")
|
|
335
|
+
|
|
336
|
+
### body Type
|
|
337
|
+
|
|
338
|
+
`string`
|
|
339
|
+
|
|
340
|
+
## subject
|
|
341
|
+
|
|
342
|
+
The full HTML/plain text subject of the email
|
|
343
|
+
|
|
344
|
+
`subject`
|
|
345
|
+
|
|
346
|
+
* is optional
|
|
347
|
+
|
|
348
|
+
* Type: `string`
|
|
349
|
+
|
|
350
|
+
* can be null
|
|
351
|
+
|
|
352
|
+
* defined in: [Email Notification Record Schema](applications-notify-email-properties-subject.md "applications-notify-email.schema.json#/properties/subject")
|
|
353
|
+
|
|
354
|
+
### subject Type
|
|
355
|
+
|
|
356
|
+
`string`
|
|
357
|
+
|
|
358
|
+
## Additional Properties
|
|
359
|
+
|
|
360
|
+
Additional properties are allowed and do not have to follow a specific schema
|
|
361
|
+
|
|
362
|
+
# Email Notification Record Schema Definitions
|
|
363
|
+
|
|
364
|
+
## Definitions group Contact
|
|
365
|
+
|
|
366
|
+
Reference this group by using
|
|
367
|
+
|
|
368
|
+
```json
|
|
369
|
+
{"$ref":"applications-notify-email.schema.json#/$defs/Contact"}
|
|
370
|
+
```
|
|
371
|
+
|
|
372
|
+
| Property | Type | Required | Nullable | Defined by |
|
|
373
|
+
| :---------------------------------------------------- | :------- | :------- | :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
374
|
+
| [contactId](#contactid) | `string` | Required | cannot be null | [Email Notification Record Schema](applications-notify-email-defs-contact-properties-contactid.md "applications-notify-email.schema.json#/$defs/Contact/properties/contactId") |
|
|
375
|
+
| [contactPreference](#contactpreference) | `string` | Optional | can be null | [Email Notification Record Schema](applications-notify-email-defs-contact-properties-contactpreference.md "applications-notify-email.schema.json#/$defs/Contact/properties/contactPreference") |
|
|
376
|
+
| [writtenRepOrgName](#writtenreporgname) | `string` | Optional | can be null | [Email Notification Record Schema](applications-notify-email-defs-contact-properties-writtenreporgname.md "applications-notify-email.schema.json#/$defs/Contact/properties/writtenRepOrgName") |
|
|
377
|
+
| [writtenRepJobTitleorRole](#writtenrepjobtitleorrole) | `string` | Optional | can be null | [Email Notification Record Schema](applications-notify-email-defs-contact-properties-writtenrepjobtitleorrole.md "applications-notify-email.schema.json#/$defs/Contact/properties/writtenRepJobTitleorRole") |
|
|
378
|
+
|
|
379
|
+
### contactId
|
|
380
|
+
|
|
381
|
+
Source PK for Contact
|
|
382
|
+
|
|
383
|
+
`contactId`
|
|
384
|
+
|
|
385
|
+
* is required
|
|
386
|
+
|
|
387
|
+
* Type: `string`
|
|
388
|
+
|
|
389
|
+
* cannot be null
|
|
390
|
+
|
|
391
|
+
* defined in: [Email Notification Record Schema](applications-notify-email-defs-contact-properties-contactid.md "applications-notify-email.schema.json#/$defs/Contact/properties/contactId")
|
|
392
|
+
|
|
393
|
+
#### contactId Type
|
|
394
|
+
|
|
395
|
+
`string`
|
|
396
|
+
|
|
397
|
+
### contactPreference
|
|
398
|
+
|
|
399
|
+
Preferred contact method
|
|
400
|
+
|
|
401
|
+
`contactPreference`
|
|
402
|
+
|
|
403
|
+
* is optional
|
|
404
|
+
|
|
405
|
+
* Type: `string`
|
|
406
|
+
|
|
407
|
+
* can be null
|
|
408
|
+
|
|
409
|
+
* defined in: [Email Notification Record Schema](applications-notify-email-defs-contact-properties-contactpreference.md "applications-notify-email.schema.json#/$defs/Contact/properties/contactPreference")
|
|
410
|
+
|
|
411
|
+
#### contactPreference Type
|
|
412
|
+
|
|
413
|
+
`string`
|
|
414
|
+
|
|
415
|
+
#### contactPreference Constraints
|
|
416
|
+
|
|
417
|
+
**enum**: the value of this property must be equal to one of the following values:
|
|
418
|
+
|
|
419
|
+
| Value | Explanation |
|
|
420
|
+
| :-------- | :---------- |
|
|
421
|
+
| `"email"` | |
|
|
422
|
+
| `"post"` | |
|
|
423
|
+
|
|
424
|
+
### writtenRepOrgName
|
|
425
|
+
|
|
426
|
+
|
|
427
|
+
|
|
428
|
+
`writtenRepOrgName`
|
|
429
|
+
|
|
430
|
+
* is optional
|
|
431
|
+
|
|
432
|
+
* Type: `string`
|
|
433
|
+
|
|
434
|
+
* can be null
|
|
435
|
+
|
|
436
|
+
* defined in: [Email Notification Record Schema](applications-notify-email-defs-contact-properties-writtenreporgname.md "applications-notify-email.schema.json#/$defs/Contact/properties/writtenRepOrgName")
|
|
437
|
+
|
|
438
|
+
#### writtenRepOrgName Type
|
|
439
|
+
|
|
440
|
+
`string`
|
|
441
|
+
|
|
442
|
+
### writtenRepJobTitleorRole
|
|
443
|
+
|
|
444
|
+
|
|
445
|
+
|
|
446
|
+
`writtenRepJobTitleorRole`
|
|
447
|
+
|
|
448
|
+
* is optional
|
|
449
|
+
|
|
450
|
+
* Type: `string`
|
|
451
|
+
|
|
452
|
+
* can be null
|
|
453
|
+
|
|
454
|
+
* defined in: [Email Notification Record Schema](applications-notify-email-defs-contact-properties-writtenrepjobtitleorrole.md "applications-notify-email.schema.json#/$defs/Contact/properties/writtenRepJobTitleorRole")
|
|
455
|
+
|
|
456
|
+
#### writtenRepJobTitleorRole Type
|
|
457
|
+
|
|
458
|
+
`string`
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
## contact Type
|
|
2
|
+
|
|
3
|
+
`object` ([Details](applications-representation-definitions-contact.md))
|
|
4
|
+
|
|
5
|
+
# contact Properties
|
|
6
|
+
|
|
7
|
+
| Property | Type | Required | Nullable | Defined by |
|
|
8
|
+
| :---------------------------------------------------- | :------- | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
9
|
+
| [contactId](#contactid) | `string` | Required | cannot be null | [Casework Representation Schema](applications-representation-definitions-contact-properties-contactid.md "applications-representation.schema.json#/definitions/contact/properties/contactId") |
|
|
10
|
+
| [contactPreference](#contactpreference) | `string` | Optional | can be null | [Casework Representation Schema](applications-representation-definitions-contact-properties-contactpreference.md "applications-representation.schema.json#/definitions/contact/properties/contactPreference") |
|
|
11
|
+
| [writtenRepOrgName](#writtenreporgname) | `string` | Optional | can be null | [Casework Representation Schema](applications-representation-definitions-contact-properties-writtenreporgname.md "applications-representation.schema.json#/definitions/contact/properties/writtenRepOrgName") |
|
|
12
|
+
| [writtenRepJobTitleorRole](#writtenrepjobtitleorrole) | `string` | Optional | can be null | [Casework Representation Schema](applications-representation-definitions-contact-properties-writtenrepjobtitleorrole.md "applications-representation.schema.json#/definitions/contact/properties/writtenRepJobTitleorRole") |
|
|
13
|
+
|
|
14
|
+
## contactId
|
|
15
|
+
|
|
16
|
+
Source PK for Contact
|
|
17
|
+
|
|
18
|
+
`contactId`
|
|
19
|
+
|
|
20
|
+
* is required
|
|
21
|
+
|
|
22
|
+
* Type: `string`
|
|
23
|
+
|
|
24
|
+
* cannot be null
|
|
25
|
+
|
|
26
|
+
* defined in: [Casework Representation Schema](applications-representation-definitions-contact-properties-contactid.md "applications-representation.schema.json#/definitions/contact/properties/contactId")
|
|
27
|
+
|
|
28
|
+
### contactId Type
|
|
29
|
+
|
|
30
|
+
`string`
|
|
31
|
+
|
|
32
|
+
## contactPreference
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
`contactPreference`
|
|
37
|
+
|
|
38
|
+
* is optional
|
|
39
|
+
|
|
40
|
+
* Type: `string`
|
|
41
|
+
|
|
42
|
+
* can be null
|
|
43
|
+
|
|
44
|
+
* defined in: [Casework Representation Schema](applications-representation-definitions-contact-properties-contactpreference.md "applications-representation.schema.json#/definitions/contact/properties/contactPreference")
|
|
45
|
+
|
|
46
|
+
### contactPreference Type
|
|
47
|
+
|
|
48
|
+
`string`
|
|
49
|
+
|
|
50
|
+
### contactPreference Constraints
|
|
51
|
+
|
|
52
|
+
**enum**: the value of this property must be equal to one of the following values:
|
|
53
|
+
|
|
54
|
+
| Value | Explanation |
|
|
55
|
+
| :-------- | :---------- |
|
|
56
|
+
| `"email"` | |
|
|
57
|
+
| `"post"` | |
|
|
58
|
+
|
|
59
|
+
## writtenRepOrgName
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
`writtenRepOrgName`
|
|
64
|
+
|
|
65
|
+
* is optional
|
|
66
|
+
|
|
67
|
+
* Type: `string`
|
|
68
|
+
|
|
69
|
+
* can be null
|
|
70
|
+
|
|
71
|
+
* defined in: [Casework Representation Schema](applications-representation-definitions-contact-properties-writtenreporgname.md "applications-representation.schema.json#/definitions/contact/properties/writtenRepOrgName")
|
|
72
|
+
|
|
73
|
+
### writtenRepOrgName Type
|
|
74
|
+
|
|
75
|
+
`string`
|
|
76
|
+
|
|
77
|
+
## writtenRepJobTitleorRole
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
`writtenRepJobTitleorRole`
|
|
82
|
+
|
|
83
|
+
* is optional
|
|
84
|
+
|
|
85
|
+
* Type: `string`
|
|
86
|
+
|
|
87
|
+
* can be null
|
|
88
|
+
|
|
89
|
+
* defined in: [Casework Representation Schema](applications-representation-definitions-contact-properties-writtenrepjobtitleorrole.md "applications-representation.schema.json#/definitions/contact/properties/writtenRepJobTitleorRole")
|
|
90
|
+
|
|
91
|
+
### writtenRepJobTitleorRole Type
|
|
92
|
+
|
|
93
|
+
`string`
|