-
Notifications
You must be signed in to change notification settings - Fork 19
/
patron-notice-policy.json
299 lines (299 loc) · 8.56 KB
/
patron-notice-policy.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"additionalProperties": false,
"description": "Patron notice policy",
"properties": {
"id": {
"type": "string",
"description": "Patron notice policy id, UUID"
},
"name": {
"type": "string",
"description": "Patron notice policy name"
},
"description": {
"type": "string",
"description": "Patron notice policy description"
},
"active": {
"type": "boolean",
"description": "A flag to determine if a patron notice policy is active"
},
"metadata": {
"description": "Metadata about creation and changes to policy, provided by the server (client should not provide)",
"type": "object",
"$ref": "raml-util/schemas/metadata.schema"
},
"loanNotices": {
"type": "array",
"description": "List of loan notices",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Notice name"
},
"templateId": {
"type": "string",
"description": "Template id, UUID"
},
"templateName": {
"type": "string",
"description": "Template name"
},
"format": {
"type": "string",
"description": "Notice format, send through email, sms etc.",
"enum": [
"Email",
"SMS",
"Print"
]
},
"frequency": {
"type": "string",
"description": "Frequency, send it once or more",
"enum": [
"One time",
"Recurring"
]
},
"realTime": {
"type": "boolean",
"description": "Is this real time event"
},
"sendOptions": {
"type": "object",
"description": "Notice sending options",
"additionalProperties": false,
"properties": {
"sendHow": {
"type": "string",
"description": "Defines how notice should be sent, before, after or upon",
"enum": [
"Upon At",
"Before",
"After"
]
},
"sendWhen": {
"type": "string",
"description": "Triggering event",
"enum": [
"Due date",
"Renewed",
"Check in",
"Check out",
"Manual due date change",
"Item recalled",
"Aged to lost"
]
},
"sendBy": {
"type": "object",
"description": "Delay before the first attempt to send a notice",
"$ref": "interval.json"
},
"sendEvery": {
"type": "object",
"description": "Interval between attempts to send a recurring notice",
"$ref": "interval.json"
}
},
"required": [
"sendWhen"
]
}
},
"required": [
"templateId",
"format",
"realTime"
]
}
},
"feeFineNotices": {
"type": "array",
"description": "List of fee/fine notices",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Notice name"
},
"templateId": {
"type": "string",
"description": "Template id, UUID"
},
"templateName": {
"type": "string",
"description": "Template name"
},
"format": {
"type": "string",
"description": "Notice format, send through email, sms etc.",
"enum": [
"Email",
"SMS",
"Print"
]
},
"frequency": {
"type": "string",
"description": "Frequency, send it once or more",
"enum": [
"One time",
"Recurring"
]
},
"realTime": {
"type": "boolean",
"description": "Is this real time event"
},
"sendOptions": {
"type": "object",
"description": "Notice sending options",
"additionalProperties": false,
"properties": {
"sendHow": {
"type": "string",
"description": "Defines how notice should be sent: after or upon",
"enum": [
"Upon At",
"After"
]
},
"sendWhen": {
"type": "string",
"description": "Triggering event",
"enum": [
"Overdue fine returned",
"Overdue fine renewed",
"Aged to lost - fine charged",
"Aged to lost & item returned - fine adjusted",
"Aged to lost & item replaced - fine adjusted"
]
},
"sendBy": {
"type": "object",
"description": "Delay before the first attempt to send a notice",
"$ref": "interval.json"
},
"sendEvery": {
"type": "object",
"description": "Interval between attempts to send a recurring notice",
"$ref": "interval.json"
}
},
"required": [
"sendWhen"
]
}
},
"required": [
"templateId",
"format",
"realTime"
]
}
},
"requestNotices": {
"type": "array",
"description": "List of request notice",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Notice name"
},
"templateId": {
"type": "string",
"description": "Template id, UUID"
},
"templateName": {
"type": "string",
"description": "Template name"
},
"format": {
"type": "string",
"description": "Notice format, send through email, sms etc.",
"enum": [
"Email",
"SMS",
"Print"
]
},
"frequency": {
"type": "string",
"description": "Frequency, send it once or more",
"enum": [
"One time",
"Recurring"
]
},
"realTime": {
"type": "boolean",
"description": "Is this real time event"
},
"sendOptions": {
"type": "object",
"description": "Notice sending options",
"additionalProperties": false,
"properties": {
"sendHow": {
"type": "string",
"description": "Defines how notice should be sent, before, after or upon",
"enum": [
"Upon At",
"Before",
"After"
]
},
"sendWhen": {
"type": "string",
"description": "User initiated and time driven events for request related notices",
"enum": [
"Recall request",
"Hold request",
"Request expiration",
"Paging request",
"Available",
"Hold expiration",
"Request cancellation"
]
},
"sendBy": {
"type": "object",
"description": "Delay before the first attempt to send a notice",
"$ref": "interval.json"
},
"sendEvery": {
"type": "object",
"description": "Interval between attempts to send a recurring notice",
"$ref": "interval.json"
}
},
"required": [
"sendWhen"
]
}
},
"required": [
"templateId",
"format",
"realTime"
]
}
}
},
"required": [
"name"
]
}