@ogcio/building-blocks-sdk 0.2.98 → 0.2.100

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 (41) hide show
  1. package/.release-please-manifest.json +1 -1
  2. package/CHANGELOG.md +14 -0
  3. package/dist/client/clients/journey/index.d.ts +36 -9
  4. package/dist/client/clients/journey/index.d.ts.map +1 -1
  5. package/dist/client/clients/journey/schema.d.ts +31 -8
  6. package/dist/client/clients/journey/schema.d.ts.map +1 -1
  7. package/dist/client/clients/messaging-public-api/citizen/index.d.ts +602 -0
  8. package/dist/client/clients/messaging-public-api/citizen/index.d.ts.map +1 -0
  9. package/dist/client/clients/messaging-public-api/citizen/index.js +34 -0
  10. package/dist/client/clients/messaging-public-api/citizen/index.js.map +1 -0
  11. package/dist/client/clients/messaging-public-api/index.d.ts +18 -0
  12. package/dist/client/clients/messaging-public-api/index.d.ts.map +1 -0
  13. package/dist/client/clients/messaging-public-api/index.js +15 -0
  14. package/dist/client/clients/messaging-public-api/index.js.map +1 -0
  15. package/dist/client/clients/messaging-public-api/organisation/index.d.ts +621 -0
  16. package/dist/client/clients/messaging-public-api/organisation/index.d.ts.map +1 -0
  17. package/dist/client/clients/messaging-public-api/organisation/index.js +49 -0
  18. package/dist/client/clients/messaging-public-api/organisation/index.js.map +1 -0
  19. package/dist/client/clients/messaging-public-api/schema.d.ts +2464 -0
  20. package/dist/client/clients/messaging-public-api/schema.d.ts.map +1 -0
  21. package/dist/client/clients/messaging-public-api/schema.js +2 -0
  22. package/dist/client/clients/messaging-public-api/schema.js.map +1 -0
  23. package/dist/clients-configurations/clients-configuration.json +17 -1
  24. package/dist/index.d.ts.map +1 -1
  25. package/dist/index.js +2 -0
  26. package/dist/index.js.map +1 -1
  27. package/dist/types/index.d.ts +9 -3
  28. package/dist/types/index.d.ts.map +1 -1
  29. package/dist/types/index.js +2 -1
  30. package/dist/types/index.js.map +1 -1
  31. package/package.json +1 -1
  32. package/src/client/clients/journey/open-api-definition.json +221 -33
  33. package/src/client/clients/journey/schema.ts +31 -8
  34. package/src/client/clients/messaging-public-api/citizen/index.ts +57 -0
  35. package/src/client/clients/messaging-public-api/index.ts +35 -0
  36. package/src/client/clients/messaging-public-api/open-api-definition.json +4539 -0
  37. package/src/client/clients/messaging-public-api/organisation/index.ts +79 -0
  38. package/src/client/clients/messaging-public-api/schema.ts +2463 -0
  39. package/src/clients-configurations/clients-configuration.json +17 -1
  40. package/src/index.ts +7 -0
  41. package/src/types/index.ts +9 -0
package/src/client/clients/messaging-public-api/open-api-definition.json ADDED
@@ -0,0 +1,4539 @@
1
+ {
2
+ "openapi": "3.0.3",
3
+ "info": {
4
+ "title": "GovIE Messaging Public API",
5
+ "description": "Public facing APIs to access Life Events Building Blocks features",
6
+ "version": "0.1.0"
7
+ },
8
+ "components": {
9
+ "securitySchemes": {
10
+ "bearerAuth": {
11
+ "type": "http",
12
+ "scheme": "bearer",
13
+ "bearerFormat": "JWT"
14
+ }
15
+ },
16
+ "schemas": {}
17
+ },
18
+ "paths": {
19
+ "/api/v1/citizens/messages/{messageId}": {
20
+ "get": {
21
+ "tags": [
22
+ "Citizens Messages"
23
+ ],
24
+ "description": "Get a single message by id for the authenticated citizen",
25
+ "parameters": [
26
+ {
27
+ "schema": {
28
+ "type": "string",
29
+ "enum": [
30
+ "true",
31
+ "false",
32
+ "1",
33
+ "0"
34
+ ]
35
+ },
36
+ "example": "true",
37
+ "in": "query",
38
+ "name": "includeMetadata",
39
+ "required": false,
40
+ "description": "Include stored gateway metadata for the message"
41
+ },
42
+ {
43
+ "schema": {
44
+ "type": "string",
45
+ "format": "uuid"
46
+ },
47
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
48
+ "in": "path",
49
+ "name": "messageId",
50
+ "required": true,
51
+ "description": "Unique identifier of the message to retrieve"
52
+ }
53
+ ],
54
+ "security": [
55
+ {
56
+ "bearerAuth": []
57
+ }
58
+ ],
59
+ "responses": {
60
+ "200": {
61
+ "description": "Default Response",
62
+ "content": {
63
+ "application/json": {
64
+ "schema": {
65
+ "type": "object",
66
+ "required": [
67
+ "data"
68
+ ],
69
+ "properties": {
70
+ "data": {
71
+ "type": "object",
72
+ "required": [
73
+ "subject",
74
+ "createdAt",
75
+ "threadName",
76
+ "organisationId",
77
+ "recipientUserId",
78
+ "excerpt",
79
+ "plainText",
80
+ "richText",
81
+ "isSeen",
82
+ "security",
83
+ "attachments",
84
+ "externalId"
85
+ ],
86
+ "properties": {
87
+ "subject": {
88
+ "type": "string",
89
+ "description": "Subject",
90
+ "example": "Welcome to MessagingIE"
91
+ },
92
+ "createdAt": {
93
+ "type": "string",
94
+ "format": "date-time",
95
+ "description": "Creation date time",
96
+ "example": "2025-11-25T14:30:00Z"
97
+ },
98
+ "threadName": {
99
+ "anyOf": [
100
+ {
101
+ "type": "string"
102
+ },
103
+ {
104
+ "type": "null"
105
+ }
106
+ ],
107
+ "description": "Thread name the message belongs to, if any",
108
+ "example": "Support Thread"
109
+ },
110
+ "organisationId": {
111
+ "type": "string",
112
+ "description": "Organisation sender id",
113
+ "example": "f6a7b8c9-d0e1-2345-f123-456789012345"
114
+ },
115
+ "recipientUserId": {
116
+ "type": "string",
117
+ "description": "Unique id of the recipient",
118
+ "example": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
119
+ },
120
+ "excerpt": {
121
+ "anyOf": [
122
+ {
123
+ "type": "string"
124
+ },
125
+ {
126
+ "type": "null"
127
+ }
128
+ ],
129
+ "description": "Short excerpt of the message body, if available",
130
+ "example": "Dear John Doe, Welcome..."
131
+ },
132
+ "plainText": {
133
+ "type": "string",
134
+ "description": "Plain text body",
135
+ "example": "Dear John Doe, Welcome to MessagingIE."
136
+ },
137
+ "richText": {
138
+ "anyOf": [
139
+ {
140
+ "type": "string"
141
+ },
142
+ {
143
+ "type": "null"
144
+ }
145
+ ],
146
+ "description": "HTML-formatted body of the message, if available",
147
+ "example": "<p>Dear <strong>John Doe</strong>...</p>"
148
+ },
149
+ "isSeen": {
150
+ "type": "boolean",
151
+ "description": "Whether the message has been seen",
152
+ "example": false
153
+ },
154
+ "security": {
155
+ "enum": [
156
+ "public",
157
+ "confidential"
158
+ ],
159
+ "description": "Security classification of the message",
160
+ "example": "confidential"
161
+ },
162
+ "attachments": {
163
+ "type": "array",
164
+ "items": {
165
+ "type": "string",
166
+ "description": "Attachment identifier",
167
+ "example": "c3d4e5f6-a7b8-9012-cdef-123456789012"
168
+ },
169
+ "description": "Attachment identifiers",
170
+ "example": []
171
+ },
172
+ "externalId": {
173
+ "anyOf": [
174
+ {
175
+ "type": "string"
176
+ },
177
+ {
178
+ "type": "null"
179
+ }
180
+ ],
181
+ "description": "External reference identifier for the message, if any",
182
+ "example": "ext-ref-001"
183
+ },
184
+ "metadata": {
185
+ "anyOf": [
186
+ {
187
+ "type": "object",
188
+ "properties": {
189
+ "journey": {
190
+ "type": "object",
191
+ "required": [
192
+ "submissionId"
193
+ ],
194
+ "properties": {
195
+ "journeyId": {
196
+ "type": "string",
197
+ "minLength": 1,
198
+ "description": "Identifier of the journey that triggered this message",
199
+ "examples": [
200
+ "11111111-1111-1111-1111-111111111111"
201
+ ]
202
+ },
203
+ "submissionId": {
204
+ "type": "string",
205
+ "minLength": 1,
206
+ "description": "Identifier of the journey submission linked to this message",
207
+ "examples": [
208
+ "22222222-2222-2222-2222-222222222222"
209
+ ]
210
+ }
211
+ },
212
+ "additionalProperties": false,
213
+ "description": "Journey context associated with this message",
214
+ "examples": [
215
+ {
216
+ "submissionId": "22222222-2222-2222-2222-222222222222"
217
+ }
218
+ ]
219
+ }
220
+ },
221
+ "additionalProperties": false,
222
+ "minProperties": 1,
223
+ "description": "Gateway-level metadata associated with a message",
224
+ "examples": [
225
+ {
226
+ "journey": {
227
+ "submissionId": "22222222-2222-2222-2222-222222222222"
228
+ }
229
+ }
230
+ ]
231
+ },
232
+ {
233
+ "type": "null"
234
+ }
235
+ ],
236
+ "description": "Optional gateway metadata associated with the message",
237
+ "example": null
238
+ }
239
+ },
240
+ "description": "Full detail of a single message for an authenticated citizen",
241
+ "example": {
242
+ "subject": "Welcome to MessagingIE",
243
+ "createdAt": "2025-11-25T14:30:00Z",
244
+ "threadName": null,
245
+ "organisationId": "f6a7b8c9-d0e1-2345-f123-456789012345",
246
+ "recipientUserId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
247
+ "excerpt": "Dear John Doe, Welcome...",
248
+ "plainText": "Dear John Doe, Welcome to MessagingIE.",
249
+ "richText": null,
250
+ "isSeen": false,
251
+ "security": "confidential",
252
+ "attachments": [],
253
+ "externalId": null
254
+ }
255
+ },
256
+ "metadata": {
257
+ "type": "object",
258
+ "properties": {
259
+ "links": {
260
+ "type": "object",
261
+ "required": [
262
+ "self",
263
+ "first",
264
+ "last",
265
+ "pages"
266
+ ],
267
+ "properties": {
268
+ "self": {
269
+ "type": "object",
270
+ "properties": {
271
+ "href": {
272
+ "type": "string",
273
+ "description": "URL pointing to the request itself"
274
+ }
275
+ },
276
+ "description": "Object containing the URL link",
277
+ "example": {
278
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=20&limit=20"
279
+ }
280
+ },
281
+ "next": {
282
+ "type": "object",
283
+ "properties": {
284
+ "href": {
285
+ "type": "string",
286
+ "description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted"
287
+ }
288
+ },
289
+ "description": "Object containing the URL link",
290
+ "example": {
291
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=40&limit=20"
292
+ }
293
+ },
294
+ "prev": {
295
+ "type": "object",
296
+ "properties": {
297
+ "href": {
298
+ "type": "string",
299
+ "description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted"
300
+ }
301
+ },
302
+ "description": "Object containing the URL link",
303
+ "example": {
304
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=0&limit=20"
305
+ }
306
+ },
307
+ "first": {
308
+ "type": "object",
309
+ "properties": {
310
+ "href": {
311
+ "type": "string",
312
+ "description": "URL pointing to the first page of results in a paginated response"
313
+ }
314
+ },
315
+ "description": "Object containing the URL link",
316
+ "example": {
317
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=0&limit=20"
318
+ }
319
+ },
320
+ "last": {
321
+ "type": "object",
322
+ "properties": {
323
+ "href": {
324
+ "type": "string",
325
+ "description": "URL pointing to the last page of results in a paginated response"
326
+ }
327
+ },
328
+ "description": "Object containing the URL link",
329
+ "example": {
330
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=120&limit=20"
331
+ }
332
+ },
333
+ "pages": {
334
+ "type": "object",
335
+ "description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
336
+ "additionalProperties": {
337
+ "type": "object",
338
+ "properties": {
339
+ "href": {
340
+ "type": "string"
341
+ }
342
+ },
343
+ "description": "Object containing the URL link",
344
+ "examples": [
345
+ {
346
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=0&limit=20"
347
+ }
348
+ ]
349
+ },
350
+ "example": {
351
+ "page1": {
352
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=0&limit=20"
353
+ },
354
+ "page2": {
355
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=20&limit=20"
356
+ }
357
+ }
358
+ }
359
+ },
360
+ "description": "Object containing the links to the related endpoints"
361
+ },
362
+ "totalCount": {
363
+ "type": "number",
364
+ "description": "Number representing the total number of available items",
365
+ "example": 150
366
+ }
367
+ }
368
+ }
369
+ }
370
+ }
371
+ }
372
+ }
373
+ },
374
+ "400": {
375
+ "description": "Default Response",
376
+ "content": {
377
+ "application/json": {
378
+ "schema": {
379
+ "type": "object",
380
+ "required": [
381
+ "code",
382
+ "detail",
383
+ "requestId",
384
+ "name",
385
+ "statusCode"
386
+ ],
387
+ "properties": {
388
+ "code": {
389
+ "type": "string",
390
+ "description": "Code used to categorize the error"
391
+ },
392
+ "detail": {
393
+ "type": "string",
394
+ "description": "Description of the error"
395
+ },
396
+ "requestId": {
397
+ "type": "string",
398
+ "description": "Unique request id. This one will be used to troubleshoot the problems"
399
+ },
400
+ "name": {
401
+ "type": "string",
402
+ "description": "Name of the error type"
403
+ },
404
+ "validation": {
405
+ "type": "array",
406
+ "items": {
407
+ "type": "object",
408
+ "required": [
409
+ "fieldName",
410
+ "message"
411
+ ],
412
+ "properties": {
413
+ "fieldName": {
414
+ "type": "string"
415
+ },
416
+ "message": {
417
+ "type": "string"
418
+ }
419
+ }
420
+ },
421
+ "description": "List of the validation errors"
422
+ },
423
+ "validationContext": {
424
+ "type": "string"
425
+ },
426
+ "statusCode": {
427
+ "type": "number"
428
+ }
429
+ }
430
+ }
431
+ }
432
+ }
433
+ },
434
+ "401": {
435
+ "description": "Default Response",
436
+ "content": {
437
+ "application/json": {
438
+ "schema": {
439
+ "type": "object",
440
+ "required": [
441
+ "code",
442
+ "detail",
443
+ "requestId",
444
+ "name",
445
+ "statusCode"
446
+ ],
447
+ "properties": {
448
+ "code": {
449
+ "type": "string",
450
+ "description": "Code used to categorize the error"
451
+ },
452
+ "detail": {
453
+ "type": "string",
454
+ "description": "Description of the error"
455
+ },
456
+ "requestId": {
457
+ "type": "string",
458
+ "description": "Unique request id. This one will be used to troubleshoot the problems"
459
+ },
460
+ "name": {
461
+ "type": "string",
462
+ "description": "Name of the error type"
463
+ },
464
+ "validation": {
465
+ "type": "array",
466
+ "items": {
467
+ "type": "object",
468
+ "required": [
469
+ "fieldName",
470
+ "message"
471
+ ],
472
+ "properties": {
473
+ "fieldName": {
474
+ "type": "string"
475
+ },
476
+ "message": {
477
+ "type": "string"
478
+ }
479
+ }
480
+ },
481
+ "description": "List of the validation errors"
482
+ },
483
+ "validationContext": {
484
+ "type": "string"
485
+ },
486
+ "statusCode": {
487
+ "type": "number"
488
+ }
489
+ }
490
+ }
491
+ }
492
+ }
493
+ },
494
+ "403": {
495
+ "description": "Default Response",
496
+ "content": {
497
+ "application/json": {
498
+ "schema": {
499
+ "type": "object",
500
+ "required": [
501
+ "code",
502
+ "detail",
503
+ "requestId",
504
+ "name",
505
+ "statusCode"
506
+ ],
507
+ "properties": {
508
+ "code": {
509
+ "type": "string",
510
+ "description": "Code used to categorize the error"
511
+ },
512
+ "detail": {
513
+ "type": "string",
514
+ "description": "Description of the error"
515
+ },
516
+ "requestId": {
517
+ "type": "string",
518
+ "description": "Unique request id. This one will be used to troubleshoot the problems"
519
+ },
520
+ "name": {
521
+ "type": "string",
522
+ "description": "Name of the error type"
523
+ },
524
+ "validation": {
525
+ "type": "array",
526
+ "items": {
527
+ "type": "object",
528
+ "required": [
529
+ "fieldName",
530
+ "message"
531
+ ],
532
+ "properties": {
533
+ "fieldName": {
534
+ "type": "string"
535
+ },
536
+ "message": {
537
+ "type": "string"
538
+ }
539
+ }
540
+ },
541
+ "description": "List of the validation errors"
542
+ },
543
+ "validationContext": {
544
+ "type": "string"
545
+ },
546
+ "statusCode": {
547
+ "type": "number"
548
+ }
549
+ }
550
+ }
551
+ }
552
+ }
553
+ },
554
+ "404": {
555
+ "description": "Default Response",
556
+ "content": {
557
+ "application/json": {
558
+ "schema": {
559
+ "type": "object",
560
+ "required": [
561
+ "code",
562
+ "detail",
563
+ "requestId",
564
+ "name",
565
+ "statusCode"
566
+ ],
567
+ "properties": {
568
+ "code": {
569
+ "type": "string",
570
+ "description": "Code used to categorize the error"
571
+ },
572
+ "detail": {
573
+ "type": "string",
574
+ "description": "Description of the error"
575
+ },
576
+ "requestId": {
577
+ "type": "string",
578
+ "description": "Unique request id. This one will be used to troubleshoot the problems"
579
+ },
580
+ "name": {
581
+ "type": "string",
582
+ "description": "Name of the error type"
583
+ },
584
+ "validation": {
585
+ "type": "array",
586
+ "items": {
587
+ "type": "object",
588
+ "required": [
589
+ "fieldName",
590
+ "message"
591
+ ],
592
+ "properties": {
593
+ "fieldName": {
594
+ "type": "string"
595
+ },
596
+ "message": {
597
+ "type": "string"
598
+ }
599
+ }
600
+ },
601
+ "description": "List of the validation errors"
602
+ },
603
+ "validationContext": {
604
+ "type": "string"
605
+ },
606
+ "statusCode": {
607
+ "type": "number"
608
+ }
609
+ }
610
+ }
611
+ }
612
+ }
613
+ },
614
+ "422": {
615
+ "description": "Default Response",
616
+ "content": {
617
+ "application/json": {
618
+ "schema": {
619
+ "type": "object",
620
+ "required": [
621
+ "code",
622
+ "detail",
623
+ "requestId",
624
+ "name",
625
+ "statusCode"
626
+ ],
627
+ "properties": {
628
+ "code": {
629
+ "type": "string",
630
+ "description": "Code used to categorize the error"
631
+ },
632
+ "detail": {
633
+ "type": "string",
634
+ "description": "Description of the error"
635
+ },
636
+ "requestId": {
637
+ "type": "string",
638
+ "description": "Unique request id. This one will be used to troubleshoot the problems"
639
+ },
640
+ "name": {
641
+ "type": "string",
642
+ "description": "Name of the error type"
643
+ },
644
+ "validation": {
645
+ "type": "array",
646
+ "items": {
647
+ "type": "object",
648
+ "required": [
649
+ "fieldName",
650
+ "message"
651
+ ],
652
+ "properties": {
653
+ "fieldName": {
654
+ "type": "string"
655
+ },
656
+ "message": {
657
+ "type": "string"
658
+ }
659
+ }
660
+ },
661
+ "description": "List of the validation errors"
662
+ },
663
+ "validationContext": {
664
+ "type": "string"
665
+ },
666
+ "statusCode": {
667
+ "type": "number"
668
+ }
669
+ }
670
+ }
671
+ }
672
+ }
673
+ },
674
+ "500": {
675
+ "description": "Default Response",
676
+ "content": {
677
+ "application/json": {
678
+ "schema": {
679
+ "type": "object",
680
+ "required": [
681
+ "code",
682
+ "detail",
683
+ "requestId",
684
+ "name",
685
+ "statusCode"
686
+ ],
687
+ "properties": {
688
+ "code": {
689
+ "type": "string",
690
+ "description": "Code used to categorize the error"
691
+ },
692
+ "detail": {
693
+ "type": "string",
694
+ "description": "Description of the error"
695
+ },
696
+ "requestId": {
697
+ "type": "string",
698
+ "description": "Unique request id. This one will be used to troubleshoot the problems"
699
+ },
700
+ "name": {
701
+ "type": "string",
702
+ "description": "Name of the error type"
703
+ },
704
+ "validation": {
705
+ "type": "array",
706
+ "items": {
707
+ "type": "object",
708
+ "required": [
709
+ "fieldName",
710
+ "message"
711
+ ],
712
+ "properties": {
713
+ "fieldName": {
714
+ "type": "string"
715
+ },
716
+ "message": {
717
+ "type": "string"
718
+ }
719
+ }
720
+ },
721
+ "description": "List of the validation errors"
722
+ },
723
+ "validationContext": {
724
+ "type": "string"
725
+ },
726
+ "statusCode": {
727
+ "type": "number"
728
+ }
729
+ }
730
+ }
731
+ }
732
+ }
733
+ },
734
+ "502": {
735
+ "description": "Default Response",
736
+ "content": {
737
+ "application/json": {
738
+ "schema": {
739
+ "type": "object",
740
+ "required": [
741
+ "code",
742
+ "detail",
743
+ "requestId",
744
+ "name",
745
+ "statusCode"
746
+ ],
747
+ "properties": {
748
+ "code": {
749
+ "type": "string",
750
+ "description": "Code used to categorize the error"
751
+ },
752
+ "detail": {
753
+ "type": "string",
754
+ "description": "Description of the error"
755
+ },
756
+ "requestId": {
757
+ "type": "string",
758
+ "description": "Unique request id. This one will be used to troubleshoot the problems"
759
+ },
760
+ "name": {
761
+ "type": "string",
762
+ "description": "Name of the error type"
763
+ },
764
+ "validation": {
765
+ "type": "array",
766
+ "items": {
767
+ "type": "object",
768
+ "required": [
769
+ "fieldName",
770
+ "message"
771
+ ],
772
+ "properties": {
773
+ "fieldName": {
774
+ "type": "string"
775
+ },
776
+ "message": {
777
+ "type": "string"
778
+ }
779
+ }
780
+ },
781
+ "description": "List of the validation errors"
782
+ },
783
+ "validationContext": {
784
+ "type": "string"
785
+ },
786
+ "statusCode": {
787
+ "type": "number"
788
+ }
789
+ }
790
+ }
791
+ }
792
+ }
793
+ }
794
+ }
795
+ }
796
+ },
797
+ "/api/v1/citizens/messages/": {
798
+ "get": {
799
+ "tags": [
800
+ "Citizens Messages"
801
+ ],
802
+ "description": "Get paginated messages for the authenticated citizen",
803
+ "parameters": [
804
+ {
805
+ "schema": {
806
+ "type": "string",
807
+ "pattern": "^[0-9][0-9]*|undefined$",
808
+ "default": "0"
809
+ },
810
+ "in": "query",
811
+ "name": "offset",
812
+ "required": false,
813
+ "description": "Indicates where to start fetching data or how many records to skip, defining the initial position within the list"
814
+ },
815
+ {
816
+ "schema": {
817
+ "type": "string",
818
+ "default": "20",
819
+ "pattern": "^([1-9]|100)|undefined$"
820
+ },
821
+ "in": "query",
822
+ "name": "limit",
823
+ "required": false,
824
+ "description": "Indicates the maximum number (100) of items that will be returned in a single request"
825
+ },
826
+ {
827
+ "schema": {
828
+ "type": "string"
829
+ },
830
+ "example": "Welcome",
831
+ "in": "query",
832
+ "name": "search",
833
+ "required": false,
834
+ "description": "Filter by subject text"
835
+ },
836
+ {
837
+ "schema": {
838
+ "type": "string",
839
+ "minLength": 1
840
+ },
841
+ "example": "sub-uuid-456",
842
+ "in": "query",
843
+ "name": "submissionId",
844
+ "required": false,
845
+ "description": "Return only messages linked to the given journey submission"
846
+ },
847
+ {
848
+ "schema": {
849
+ "type": "string",
850
+ "enum": [
851
+ "true",
852
+ "false",
853
+ "1",
854
+ "0"
855
+ ]
856
+ },
857
+ "example": "true",
858
+ "in": "query",
859
+ "name": "isSeen",
860
+ "required": false,
861
+ "description": "Filter by message seen status"
862
+ },
863
+ {
864
+ "schema": {
865
+ "type": "string",
866
+ "format": "date-time"
867
+ },
868
+ "example": "2025-11-01T00:00:00Z",
869
+ "in": "query",
870
+ "name": "deletedAfterDateTime",
871
+ "required": false,
872
+ "description": "Return messages deleted after this timestamp"
873
+ },
874
+ {
875
+ "schema": {
876
+ "type": "string",
877
+ "enum": [
878
+ "true",
879
+ "false",
880
+ "1",
881
+ "0"
882
+ ]
883
+ },
884
+ "example": "true",
885
+ "in": "query",
886
+ "name": "includeMetadata",
887
+ "required": false,
888
+ "description": "Include stored gateway metadata for each message"
889
+ }
890
+ ],
891
+ "security": [
892
+ {
893
+ "bearerAuth": []
894
+ }
895
+ ],
896
+ "responses": {
897
+ "200": {
898
+ "description": "Default Response",
899
+ "content": {
900
+ "application/json": {
901
+ "schema": {
902
+ "type": "object",
903
+ "required": [
904
+ "data"
905
+ ],
906
+ "properties": {
907
+ "data": {
908
+ "type": "array",
909
+ "items": {
910
+ "type": "object",
911
+ "required": [
912
+ "id",
913
+ "subject",
914
+ "createdAt",
915
+ "threadName",
916
+ "organisationId",
917
+ "recipientUserId",
918
+ "attachmentsCount"
919
+ ],
920
+ "properties": {
921
+ "id": {
922
+ "type": "string",
923
+ "description": "Unique Id of the message",
924
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
925
+ },
926
+ "subject": {
927
+ "type": "string",
928
+ "description": "Subject",
929
+ "example": "Welcome to MessagingIE"
930
+ },
931
+ "createdAt": {
932
+ "type": "string",
933
+ "format": "date-time",
934
+ "description": "Creation date time",
935
+ "example": "2025-11-25T14:30:00Z"
936
+ },
937
+ "threadName": {
938
+ "anyOf": [
939
+ {
940
+ "type": "string"
941
+ },
942
+ {
943
+ "type": "null"
944
+ }
945
+ ],
946
+ "description": "Thread name the message belongs to, if any",
947
+ "example": "Support Thread"
948
+ },
949
+ "organisationId": {
950
+ "type": "string",
951
+ "description": "Organisation sender id",
952
+ "example": "f6a7b8c9-d0e1-2345-f123-456789012345"
953
+ },
954
+ "recipientUserId": {
955
+ "type": "string",
956
+ "description": "Unique id of the recipient",
957
+ "example": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
958
+ },
959
+ "attachmentsCount": {
960
+ "type": "number",
961
+ "description": "Number of attachments",
962
+ "example": 0
963
+ },
964
+ "metadata": {
965
+ "anyOf": [
966
+ {
967
+ "type": "object",
968
+ "properties": {
969
+ "journey": {
970
+ "type": "object",
971
+ "required": [
972
+ "submissionId"
973
+ ],
974
+ "properties": {
975
+ "journeyId": {
976
+ "type": "string",
977
+ "minLength": 1,
978
+ "description": "Identifier of the journey that triggered this message",
979
+ "examples": [
980
+ "11111111-1111-1111-1111-111111111111"
981
+ ]
982
+ },
983
+ "submissionId": {
984
+ "type": "string",
985
+ "minLength": 1,
986
+ "description": "Identifier of the journey submission linked to this message",
987
+ "examples": [
988
+ "22222222-2222-2222-2222-222222222222"
989
+ ]
990
+ }
991
+ },
992
+ "additionalProperties": false,
993
+ "description": "Journey context associated with this message",
994
+ "examples": [
995
+ {
996
+ "submissionId": "22222222-2222-2222-2222-222222222222"
997
+ }
998
+ ]
999
+ }
1000
+ },
1001
+ "additionalProperties": false,
1002
+ "minProperties": 1,
1003
+ "description": "Gateway-level metadata associated with a message",
1004
+ "examples": [
1005
+ {
1006
+ "journey": {
1007
+ "submissionId": "22222222-2222-2222-2222-222222222222"
1008
+ }
1009
+ }
1010
+ ]
1011
+ },
1012
+ {
1013
+ "type": "null"
1014
+ }
1015
+ ],
1016
+ "description": "Optional gateway metadata associated with the message",
1017
+ "example": null
1018
+ }
1019
+ },
1020
+ "description": "A summary item representing a message in a citizen's message list",
1021
+ "example": {
1022
+ "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
1023
+ "subject": "Welcome to MessagingIE",
1024
+ "createdAt": "2025-11-25T14:30:00Z",
1025
+ "threadName": null,
1026
+ "organisationId": "f6a7b8c9-d0e1-2345-f123-456789012345",
1027
+ "recipientUserId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
1028
+ "attachmentsCount": 0
1029
+ }
1030
+ }
1031
+ },
1032
+ "metadata": {
1033
+ "type": "object",
1034
+ "properties": {
1035
+ "links": {
1036
+ "type": "object",
1037
+ "required": [
1038
+ "self",
1039
+ "first",
1040
+ "last",
1041
+ "pages"
1042
+ ],
1043
+ "properties": {
1044
+ "self": {
1045
+ "type": "object",
1046
+ "properties": {
1047
+ "href": {
1048
+ "type": "string",
1049
+ "description": "URL pointing to the request itself"
1050
+ }
1051
+ },
1052
+ "description": "Object containing the URL link",
1053
+ "example": {
1054
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=20&limit=20"
1055
+ }
1056
+ },
1057
+ "next": {
1058
+ "type": "object",
1059
+ "properties": {
1060
+ "href": {
1061
+ "type": "string",
1062
+ "description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted"
1063
+ }
1064
+ },
1065
+ "description": "Object containing the URL link",
1066
+ "example": {
1067
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=40&limit=20"
1068
+ }
1069
+ },
1070
+ "prev": {
1071
+ "type": "object",
1072
+ "properties": {
1073
+ "href": {
1074
+ "type": "string",
1075
+ "description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted"
1076
+ }
1077
+ },
1078
+ "description": "Object containing the URL link",
1079
+ "example": {
1080
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=0&limit=20"
1081
+ }
1082
+ },
1083
+ "first": {
1084
+ "type": "object",
1085
+ "properties": {
1086
+ "href": {
1087
+ "type": "string",
1088
+ "description": "URL pointing to the first page of results in a paginated response"
1089
+ }
1090
+ },
1091
+ "description": "Object containing the URL link",
1092
+ "example": {
1093
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=0&limit=20"
1094
+ }
1095
+ },
1096
+ "last": {
1097
+ "type": "object",
1098
+ "properties": {
1099
+ "href": {
1100
+ "type": "string",
1101
+ "description": "URL pointing to the last page of results in a paginated response"
1102
+ }
1103
+ },
1104
+ "description": "Object containing the URL link",
1105
+ "example": {
1106
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=120&limit=20"
1107
+ }
1108
+ },
1109
+ "pages": {
1110
+ "type": "object",
1111
+ "description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
1112
+ "additionalProperties": {
1113
+ "type": "object",
1114
+ "properties": {
1115
+ "href": {
1116
+ "type": "string"
1117
+ }
1118
+ },
1119
+ "description": "Object containing the URL link",
1120
+ "examples": [
1121
+ {
1122
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=0&limit=20"
1123
+ }
1124
+ ]
1125
+ },
1126
+ "example": {
1127
+ "page1": {
1128
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=0&limit=20"
1129
+ },
1130
+ "page2": {
1131
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=20&limit=20"
1132
+ }
1133
+ }
1134
+ }
1135
+ },
1136
+ "description": "Object containing the links to the related endpoints"
1137
+ },
1138
+ "totalCount": {
1139
+ "type": "number",
1140
+ "description": "Number representing the total number of available items",
1141
+ "example": 150
1142
+ }
1143
+ }
1144
+ }
1145
+ }
1146
+ }
1147
+ }
1148
+ }
1149
+ },
1150
+ "400": {
1151
+ "description": "Default Response",
1152
+ "content": {
1153
+ "application/json": {
1154
+ "schema": {
1155
+ "type": "object",
1156
+ "required": [
1157
+ "code",
1158
+ "detail",
1159
+ "requestId",
1160
+ "name",
1161
+ "statusCode"
1162
+ ],
1163
+ "properties": {
1164
+ "code": {
1165
+ "type": "string",
1166
+ "description": "Code used to categorize the error"
1167
+ },
1168
+ "detail": {
1169
+ "type": "string",
1170
+ "description": "Description of the error"
1171
+ },
1172
+ "requestId": {
1173
+ "type": "string",
1174
+ "description": "Unique request id. This one will be used to troubleshoot the problems"
1175
+ },
1176
+ "name": {
1177
+ "type": "string",
1178
+ "description": "Name of the error type"
1179
+ },
1180
+ "validation": {
1181
+ "type": "array",
1182
+ "items": {
1183
+ "type": "object",
1184
+ "required": [
1185
+ "fieldName",
1186
+ "message"
1187
+ ],
1188
+ "properties": {
1189
+ "fieldName": {
1190
+ "type": "string"
1191
+ },
1192
+ "message": {
1193
+ "type": "string"
1194
+ }
1195
+ }
1196
+ },
1197
+ "description": "List of the validation errors"
1198
+ },
1199
+ "validationContext": {
1200
+ "type": "string"
1201
+ },
1202
+ "statusCode": {
1203
+ "type": "number"
1204
+ }
1205
+ }
1206
+ }
1207
+ }
1208
+ }
1209
+ },
1210
+ "401": {
1211
+ "description": "Default Response",
1212
+ "content": {
1213
+ "application/json": {
1214
+ "schema": {
1215
+ "type": "object",
1216
+ "required": [
1217
+ "code",
1218
+ "detail",
1219
+ "requestId",
1220
+ "name",
1221
+ "statusCode"
1222
+ ],
1223
+ "properties": {
1224
+ "code": {
1225
+ "type": "string",
1226
+ "description": "Code used to categorize the error"
1227
+ },
1228
+ "detail": {
1229
+ "type": "string",
1230
+ "description": "Description of the error"
1231
+ },
1232
+ "requestId": {
1233
+ "type": "string",
1234
+ "description": "Unique request id. This one will be used to troubleshoot the problems"
1235
+ },
1236
+ "name": {
1237
+ "type": "string",
1238
+ "description": "Name of the error type"
1239
+ },
1240
+ "validation": {
1241
+ "type": "array",
1242
+ "items": {
1243
+ "type": "object",
1244
+ "required": [
1245
+ "fieldName",
1246
+ "message"
1247
+ ],
1248
+ "properties": {
1249
+ "fieldName": {
1250
+ "type": "string"
1251
+ },
1252
+ "message": {
1253
+ "type": "string"
1254
+ }
1255
+ }
1256
+ },
1257
+ "description": "List of the validation errors"
1258
+ },
1259
+ "validationContext": {
1260
+ "type": "string"
1261
+ },
1262
+ "statusCode": {
1263
+ "type": "number"
1264
+ }
1265
+ }
1266
+ }
1267
+ }
1268
+ }
1269
+ },
1270
+ "403": {
1271
+ "description": "Default Response",
1272
+ "content": {
1273
+ "application/json": {
1274
+ "schema": {
1275
+ "type": "object",
1276
+ "required": [
1277
+ "code",
1278
+ "detail",
1279
+ "requestId",
1280
+ "name",
1281
+ "statusCode"
1282
+ ],
1283
+ "properties": {
1284
+ "code": {
1285
+ "type": "string",
1286
+ "description": "Code used to categorize the error"
1287
+ },
1288
+ "detail": {
1289
+ "type": "string",
1290
+ "description": "Description of the error"
1291
+ },
1292
+ "requestId": {
1293
+ "type": "string",
1294
+ "description": "Unique request id. This one will be used to troubleshoot the problems"
1295
+ },
1296
+ "name": {
1297
+ "type": "string",
1298
+ "description": "Name of the error type"
1299
+ },
1300
+ "validation": {
1301
+ "type": "array",
1302
+ "items": {
1303
+ "type": "object",
1304
+ "required": [
1305
+ "fieldName",
1306
+ "message"
1307
+ ],
1308
+ "properties": {
1309
+ "fieldName": {
1310
+ "type": "string"
1311
+ },
1312
+ "message": {
1313
+ "type": "string"
1314
+ }
1315
+ }
1316
+ },
1317
+ "description": "List of the validation errors"
1318
+ },
1319
+ "validationContext": {
1320
+ "type": "string"
1321
+ },
1322
+ "statusCode": {
1323
+ "type": "number"
1324
+ }
1325
+ }
1326
+ }
1327
+ }
1328
+ }
1329
+ },
1330
+ "422": {
1331
+ "description": "Default Response",
1332
+ "content": {
1333
+ "application/json": {
1334
+ "schema": {
1335
+ "type": "object",
1336
+ "required": [
1337
+ "code",
1338
+ "detail",
1339
+ "requestId",
1340
+ "name",
1341
+ "statusCode"
1342
+ ],
1343
+ "properties": {
1344
+ "code": {
1345
+ "type": "string",
1346
+ "description": "Code used to categorize the error"
1347
+ },
1348
+ "detail": {
1349
+ "type": "string",
1350
+ "description": "Description of the error"
1351
+ },
1352
+ "requestId": {
1353
+ "type": "string",
1354
+ "description": "Unique request id. This one will be used to troubleshoot the problems"
1355
+ },
1356
+ "name": {
1357
+ "type": "string",
1358
+ "description": "Name of the error type"
1359
+ },
1360
+ "validation": {
1361
+ "type": "array",
1362
+ "items": {
1363
+ "type": "object",
1364
+ "required": [
1365
+ "fieldName",
1366
+ "message"
1367
+ ],
1368
+ "properties": {
1369
+ "fieldName": {
1370
+ "type": "string"
1371
+ },
1372
+ "message": {
1373
+ "type": "string"
1374
+ }
1375
+ }
1376
+ },
1377
+ "description": "List of the validation errors"
1378
+ },
1379
+ "validationContext": {
1380
+ "type": "string"
1381
+ },
1382
+ "statusCode": {
1383
+ "type": "number"
1384
+ }
1385
+ }
1386
+ }
1387
+ }
1388
+ }
1389
+ },
1390
+ "500": {
1391
+ "description": "Default Response",
1392
+ "content": {
1393
+ "application/json": {
1394
+ "schema": {
1395
+ "type": "object",
1396
+ "required": [
1397
+ "code",
1398
+ "detail",
1399
+ "requestId",
1400
+ "name",
1401
+ "statusCode"
1402
+ ],
1403
+ "properties": {
1404
+ "code": {
1405
+ "type": "string",
1406
+ "description": "Code used to categorize the error"
1407
+ },
1408
+ "detail": {
1409
+ "type": "string",
1410
+ "description": "Description of the error"
1411
+ },
1412
+ "requestId": {
1413
+ "type": "string",
1414
+ "description": "Unique request id. This one will be used to troubleshoot the problems"
1415
+ },
1416
+ "name": {
1417
+ "type": "string",
1418
+ "description": "Name of the error type"
1419
+ },
1420
+ "validation": {
1421
+ "type": "array",
1422
+ "items": {
1423
+ "type": "object",
1424
+ "required": [
1425
+ "fieldName",
1426
+ "message"
1427
+ ],
1428
+ "properties": {
1429
+ "fieldName": {
1430
+ "type": "string"
1431
+ },
1432
+ "message": {
1433
+ "type": "string"
1434
+ }
1435
+ }
1436
+ },
1437
+ "description": "List of the validation errors"
1438
+ },
1439
+ "validationContext": {
1440
+ "type": "string"
1441
+ },
1442
+ "statusCode": {
1443
+ "type": "number"
1444
+ }
1445
+ }
1446
+ }
1447
+ }
1448
+ }
1449
+ },
1450
+ "502": {
1451
+ "description": "Default Response",
1452
+ "content": {
1453
+ "application/json": {
1454
+ "schema": {
1455
+ "type": "object",
1456
+ "required": [
1457
+ "code",
1458
+ "detail",
1459
+ "requestId",
1460
+ "name",
1461
+ "statusCode"
1462
+ ],
1463
+ "properties": {
1464
+ "code": {
1465
+ "type": "string",
1466
+ "description": "Code used to categorize the error"
1467
+ },
1468
+ "detail": {
1469
+ "type": "string",
1470
+ "description": "Description of the error"
1471
+ },
1472
+ "requestId": {
1473
+ "type": "string",
1474
+ "description": "Unique request id. This one will be used to troubleshoot the problems"
1475
+ },
1476
+ "name": {
1477
+ "type": "string",
1478
+ "description": "Name of the error type"
1479
+ },
1480
+ "validation": {
1481
+ "type": "array",
1482
+ "items": {
1483
+ "type": "object",
1484
+ "required": [
1485
+ "fieldName",
1486
+ "message"
1487
+ ],
1488
+ "properties": {
1489
+ "fieldName": {
1490
+ "type": "string"
1491
+ },
1492
+ "message": {
1493
+ "type": "string"
1494
+ }
1495
+ }
1496
+ },
1497
+ "description": "List of the validation errors"
1498
+ },
1499
+ "validationContext": {
1500
+ "type": "string"
1501
+ },
1502
+ "statusCode": {
1503
+ "type": "number"
1504
+ }
1505
+ }
1506
+ }
1507
+ }
1508
+ }
1509
+ }
1510
+ }
1511
+ }
1512
+ },
1513
+ "/api/v1/citizens/messages/consent": {
1514
+ "post": {
1515
+ "tags": [
1516
+ "Citizens Messages"
1517
+ ],
1518
+ "description": "Persist consent for normalized message metadata",
1519
+ "requestBody": {
1520
+ "required": true,
1521
+ "content": {
1522
+ "application/json": {
1523
+ "schema": {
1524
+ "type": "object",
1525
+ "required": [
1526
+ "organizationId",
1527
+ "metadata"
1528
+ ],
1529
+ "properties": {
1530
+ "organizationId": {
1531
+ "type": "string",
1532
+ "minLength": 1,
1533
+ "description": "Organisation identifier the consent applies to",
1534
+ "example": "testing-org"
1535
+ },
1536
+ "metadata": {
1537
+ "type": "object",
1538
+ "properties": {
1539
+ "journey": {
1540
+ "type": "object",
1541
+ "required": [
1542
+ "submissionId"
1543
+ ],
1544
+ "properties": {
1545
+ "journeyId": {
1546
+ "type": "string",
1547
+ "minLength": 1,
1548
+ "description": "Identifier of the journey that triggered this message",
1549
+ "example": "11111111-1111-1111-1111-111111111111"
1550
+ },
1551
+ "submissionId": {
1552
+ "type": "string",
1553
+ "minLength": 1,
1554
+ "description": "Identifier of the journey submission linked to this message",
1555
+ "example": "22222222-2222-2222-2222-222222222222"
1556
+ }
1557
+ },
1558
+ "additionalProperties": false,
1559
+ "description": "Journey context associated with this message",
1560
+ "example": {
1561
+ "submissionId": "22222222-2222-2222-2222-222222222222"
1562
+ }
1563
+ }
1564
+ },
1565
+ "additionalProperties": false,
1566
+ "minProperties": 1,
1567
+ "description": "Gateway-level metadata associated with a message",
1568
+ "example": {
1569
+ "journey": {
1570
+ "submissionId": "22222222-2222-2222-2222-222222222222"
1571
+ }
1572
+ }
1573
+ }
1574
+ }
1575
+ }
1576
+ }
1577
+ }
1578
+ },
1579
+ "security": [
1580
+ {
1581
+ "bearerAuth": []
1582
+ }
1583
+ ],
1584
+ "responses": {
1585
+ "200": {
1586
+ "description": "Default Response",
1587
+ "content": {
1588
+ "application/json": {
1589
+ "schema": {
1590
+ "type": "object",
1591
+ "required": [
1592
+ "data"
1593
+ ],
1594
+ "properties": {
1595
+ "data": {
1596
+ "type": "object",
1597
+ "required": [
1598
+ "profileId",
1599
+ "metadata",
1600
+ "submittedAt"
1601
+ ],
1602
+ "properties": {
1603
+ "profileId": {
1604
+ "type": "string",
1605
+ "minLength": 1,
1606
+ "description": "Profile identifier of the citizen who gave consent",
1607
+ "example": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
1608
+ },
1609
+ "metadata": {
1610
+ "type": "object",
1611
+ "properties": {
1612
+ "journey": {
1613
+ "type": "object",
1614
+ "required": [
1615
+ "submissionId"
1616
+ ],
1617
+ "properties": {
1618
+ "journeyId": {
1619
+ "type": "string",
1620
+ "minLength": 1,
1621
+ "description": "Identifier of the journey that triggered this message",
1622
+ "example": "11111111-1111-1111-1111-111111111111"
1623
+ },
1624
+ "submissionId": {
1625
+ "type": "string",
1626
+ "minLength": 1,
1627
+ "description": "Identifier of the journey submission linked to this message",
1628
+ "example": "22222222-2222-2222-2222-222222222222"
1629
+ }
1630
+ },
1631
+ "additionalProperties": false,
1632
+ "description": "Journey context associated with this message",
1633
+ "example": {
1634
+ "submissionId": "22222222-2222-2222-2222-222222222222"
1635
+ }
1636
+ }
1637
+ },
1638
+ "additionalProperties": false,
1639
+ "minProperties": 1,
1640
+ "description": "Gateway-level metadata associated with a message",
1641
+ "example": {
1642
+ "journey": {
1643
+ "submissionId": "22222222-2222-2222-2222-222222222222"
1644
+ }
1645
+ }
1646
+ },
1647
+ "submittedAt": {
1648
+ "type": "string",
1649
+ "format": "date-time",
1650
+ "description": "ISO 8601 timestamp when consent was recorded",
1651
+ "example": "2025-11-25T14:30:00Z"
1652
+ }
1653
+ },
1654
+ "description": "Record of normalised message metadata consent submitted by an organisation",
1655
+ "example": {
1656
+ "profileId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
1657
+ "metadata": {
1658
+ "journey": {
1659
+ "submissionId": "22222222-2222-2222-2222-222222222222"
1660
+ }
1661
+ },
1662
+ "submittedAt": "2025-11-25T14:30:00Z"
1663
+ }
1664
+ },
1665
+ "metadata": {
1666
+ "type": "object",
1667
+ "properties": {
1668
+ "links": {
1669
+ "type": "object",
1670
+ "required": [
1671
+ "self",
1672
+ "first",
1673
+ "last",
1674
+ "pages"
1675
+ ],
1676
+ "properties": {
1677
+ "self": {
1678
+ "type": "object",
1679
+ "properties": {
1680
+ "href": {
1681
+ "type": "string",
1682
+ "description": "URL pointing to the request itself"
1683
+ }
1684
+ },
1685
+ "description": "Object containing the URL link",
1686
+ "example": {
1687
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=20&limit=20"
1688
+ }
1689
+ },
1690
+ "next": {
1691
+ "type": "object",
1692
+ "properties": {
1693
+ "href": {
1694
+ "type": "string",
1695
+ "description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted"
1696
+ }
1697
+ },
1698
+ "description": "Object containing the URL link",
1699
+ "example": {
1700
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=40&limit=20"
1701
+ }
1702
+ },
1703
+ "prev": {
1704
+ "type": "object",
1705
+ "properties": {
1706
+ "href": {
1707
+ "type": "string",
1708
+ "description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted"
1709
+ }
1710
+ },
1711
+ "description": "Object containing the URL link",
1712
+ "example": {
1713
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=0&limit=20"
1714
+ }
1715
+ },
1716
+ "first": {
1717
+ "type": "object",
1718
+ "properties": {
1719
+ "href": {
1720
+ "type": "string",
1721
+ "description": "URL pointing to the first page of results in a paginated response"
1722
+ }
1723
+ },
1724
+ "description": "Object containing the URL link",
1725
+ "example": {
1726
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=0&limit=20"
1727
+ }
1728
+ },
1729
+ "last": {
1730
+ "type": "object",
1731
+ "properties": {
1732
+ "href": {
1733
+ "type": "string",
1734
+ "description": "URL pointing to the last page of results in a paginated response"
1735
+ }
1736
+ },
1737
+ "description": "Object containing the URL link",
1738
+ "example": {
1739
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=120&limit=20"
1740
+ }
1741
+ },
1742
+ "pages": {
1743
+ "type": "object",
1744
+ "description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
1745
+ "additionalProperties": {
1746
+ "type": "object",
1747
+ "properties": {
1748
+ "href": {
1749
+ "type": "string"
1750
+ }
1751
+ },
1752
+ "description": "Object containing the URL link",
1753
+ "examples": [
1754
+ {
1755
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=0&limit=20"
1756
+ }
1757
+ ]
1758
+ },
1759
+ "example": {
1760
+ "page1": {
1761
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=0&limit=20"
1762
+ },
1763
+ "page2": {
1764
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=20&limit=20"
1765
+ }
1766
+ }
1767
+ }
1768
+ },
1769
+ "description": "Object containing the links to the related endpoints"
1770
+ },
1771
+ "totalCount": {
1772
+ "type": "number",
1773
+ "description": "Number representing the total number of available items",
1774
+ "example": 150
1775
+ }
1776
+ }
1777
+ }
1778
+ }
1779
+ }
1780
+ }
1781
+ }
1782
+ },
1783
+ "201": {
1784
+ "description": "Default Response",
1785
+ "content": {
1786
+ "application/json": {
1787
+ "schema": {
1788
+ "type": "object",
1789
+ "required": [
1790
+ "data"
1791
+ ],
1792
+ "properties": {
1793
+ "data": {
1794
+ "type": "object",
1795
+ "required": [
1796
+ "profileId",
1797
+ "metadata",
1798
+ "submittedAt"
1799
+ ],
1800
+ "properties": {
1801
+ "profileId": {
1802
+ "type": "string",
1803
+ "minLength": 1,
1804
+ "description": "Profile identifier of the citizen who gave consent",
1805
+ "example": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
1806
+ },
1807
+ "metadata": {
1808
+ "type": "object",
1809
+ "properties": {
1810
+ "journey": {
1811
+ "type": "object",
1812
+ "required": [
1813
+ "submissionId"
1814
+ ],
1815
+ "properties": {
1816
+ "journeyId": {
1817
+ "type": "string",
1818
+ "minLength": 1,
1819
+ "description": "Identifier of the journey that triggered this message",
1820
+ "example": "11111111-1111-1111-1111-111111111111"
1821
+ },
1822
+ "submissionId": {
1823
+ "type": "string",
1824
+ "minLength": 1,
1825
+ "description": "Identifier of the journey submission linked to this message",
1826
+ "example": "22222222-2222-2222-2222-222222222222"
1827
+ }
1828
+ },
1829
+ "additionalProperties": false,
1830
+ "description": "Journey context associated with this message",
1831
+ "example": {
1832
+ "submissionId": "22222222-2222-2222-2222-222222222222"
1833
+ }
1834
+ }
1835
+ },
1836
+ "additionalProperties": false,
1837
+ "minProperties": 1,
1838
+ "description": "Gateway-level metadata associated with a message",
1839
+ "example": {
1840
+ "journey": {
1841
+ "submissionId": "22222222-2222-2222-2222-222222222222"
1842
+ }
1843
+ }
1844
+ },
1845
+ "submittedAt": {
1846
+ "type": "string",
1847
+ "format": "date-time",
1848
+ "description": "ISO 8601 timestamp when consent was recorded",
1849
+ "example": "2025-11-25T14:30:00Z"
1850
+ }
1851
+ },
1852
+ "description": "Record of normalised message metadata consent submitted by an organisation",
1853
+ "example": {
1854
+ "profileId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
1855
+ "metadata": {
1856
+ "journey": {
1857
+ "submissionId": "22222222-2222-2222-2222-222222222222"
1858
+ }
1859
+ },
1860
+ "submittedAt": "2025-11-25T14:30:00Z"
1861
+ }
1862
+ },
1863
+ "metadata": {
1864
+ "type": "object",
1865
+ "properties": {
1866
+ "links": {
1867
+ "type": "object",
1868
+ "required": [
1869
+ "self",
1870
+ "first",
1871
+ "last",
1872
+ "pages"
1873
+ ],
1874
+ "properties": {
1875
+ "self": {
1876
+ "type": "object",
1877
+ "properties": {
1878
+ "href": {
1879
+ "type": "string",
1880
+ "description": "URL pointing to the request itself"
1881
+ }
1882
+ },
1883
+ "description": "Object containing the URL link",
1884
+ "example": {
1885
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=20&limit=20"
1886
+ }
1887
+ },
1888
+ "next": {
1889
+ "type": "object",
1890
+ "properties": {
1891
+ "href": {
1892
+ "type": "string",
1893
+ "description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted"
1894
+ }
1895
+ },
1896
+ "description": "Object containing the URL link",
1897
+ "example": {
1898
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=40&limit=20"
1899
+ }
1900
+ },
1901
+ "prev": {
1902
+ "type": "object",
1903
+ "properties": {
1904
+ "href": {
1905
+ "type": "string",
1906
+ "description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted"
1907
+ }
1908
+ },
1909
+ "description": "Object containing the URL link",
1910
+ "example": {
1911
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=0&limit=20"
1912
+ }
1913
+ },
1914
+ "first": {
1915
+ "type": "object",
1916
+ "properties": {
1917
+ "href": {
1918
+ "type": "string",
1919
+ "description": "URL pointing to the first page of results in a paginated response"
1920
+ }
1921
+ },
1922
+ "description": "Object containing the URL link",
1923
+ "example": {
1924
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=0&limit=20"
1925
+ }
1926
+ },
1927
+ "last": {
1928
+ "type": "object",
1929
+ "properties": {
1930
+ "href": {
1931
+ "type": "string",
1932
+ "description": "URL pointing to the last page of results in a paginated response"
1933
+ }
1934
+ },
1935
+ "description": "Object containing the URL link",
1936
+ "example": {
1937
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=120&limit=20"
1938
+ }
1939
+ },
1940
+ "pages": {
1941
+ "type": "object",
1942
+ "description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
1943
+ "additionalProperties": {
1944
+ "type": "object",
1945
+ "properties": {
1946
+ "href": {
1947
+ "type": "string"
1948
+ }
1949
+ },
1950
+ "description": "Object containing the URL link",
1951
+ "examples": [
1952
+ {
1953
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=0&limit=20"
1954
+ }
1955
+ ]
1956
+ },
1957
+ "example": {
1958
+ "page1": {
1959
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=0&limit=20"
1960
+ },
1961
+ "page2": {
1962
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=20&limit=20"
1963
+ }
1964
+ }
1965
+ }
1966
+ },
1967
+ "description": "Object containing the links to the related endpoints"
1968
+ },
1969
+ "totalCount": {
1970
+ "type": "number",
1971
+ "description": "Number representing the total number of available items",
1972
+ "example": 150
1973
+ }
1974
+ }
1975
+ }
1976
+ }
1977
+ }
1978
+ }
1979
+ }
1980
+ },
1981
+ "400": {
1982
+ "description": "Default Response",
1983
+ "content": {
1984
+ "application/json": {
1985
+ "schema": {
1986
+ "type": "object",
1987
+ "required": [
1988
+ "code",
1989
+ "detail",
1990
+ "requestId",
1991
+ "name",
1992
+ "statusCode"
1993
+ ],
1994
+ "properties": {
1995
+ "code": {
1996
+ "type": "string",
1997
+ "description": "Code used to categorize the error"
1998
+ },
1999
+ "detail": {
2000
+ "type": "string",
2001
+ "description": "Description of the error"
2002
+ },
2003
+ "requestId": {
2004
+ "type": "string",
2005
+ "description": "Unique request id. This one will be used to troubleshoot the problems"
2006
+ },
2007
+ "name": {
2008
+ "type": "string",
2009
+ "description": "Name of the error type"
2010
+ },
2011
+ "validation": {
2012
+ "type": "array",
2013
+ "items": {
2014
+ "type": "object",
2015
+ "required": [
2016
+ "fieldName",
2017
+ "message"
2018
+ ],
2019
+ "properties": {
2020
+ "fieldName": {
2021
+ "type": "string"
2022
+ },
2023
+ "message": {
2024
+ "type": "string"
2025
+ }
2026
+ }
2027
+ },
2028
+ "description": "List of the validation errors"
2029
+ },
2030
+ "validationContext": {
2031
+ "type": "string"
2032
+ },
2033
+ "statusCode": {
2034
+ "type": "number"
2035
+ }
2036
+ }
2037
+ }
2038
+ }
2039
+ }
2040
+ },
2041
+ "401": {
2042
+ "description": "Default Response",
2043
+ "content": {
2044
+ "application/json": {
2045
+ "schema": {
2046
+ "type": "object",
2047
+ "required": [
2048
+ "code",
2049
+ "detail",
2050
+ "requestId",
2051
+ "name",
2052
+ "statusCode"
2053
+ ],
2054
+ "properties": {
2055
+ "code": {
2056
+ "type": "string",
2057
+ "description": "Code used to categorize the error"
2058
+ },
2059
+ "detail": {
2060
+ "type": "string",
2061
+ "description": "Description of the error"
2062
+ },
2063
+ "requestId": {
2064
+ "type": "string",
2065
+ "description": "Unique request id. This one will be used to troubleshoot the problems"
2066
+ },
2067
+ "name": {
2068
+ "type": "string",
2069
+ "description": "Name of the error type"
2070
+ },
2071
+ "validation": {
2072
+ "type": "array",
2073
+ "items": {
2074
+ "type": "object",
2075
+ "required": [
2076
+ "fieldName",
2077
+ "message"
2078
+ ],
2079
+ "properties": {
2080
+ "fieldName": {
2081
+ "type": "string"
2082
+ },
2083
+ "message": {
2084
+ "type": "string"
2085
+ }
2086
+ }
2087
+ },
2088
+ "description": "List of the validation errors"
2089
+ },
2090
+ "validationContext": {
2091
+ "type": "string"
2092
+ },
2093
+ "statusCode": {
2094
+ "type": "number"
2095
+ }
2096
+ }
2097
+ }
2098
+ }
2099
+ }
2100
+ },
2101
+ "403": {
2102
+ "description": "Default Response",
2103
+ "content": {
2104
+ "application/json": {
2105
+ "schema": {
2106
+ "type": "object",
2107
+ "required": [
2108
+ "code",
2109
+ "detail",
2110
+ "requestId",
2111
+ "name",
2112
+ "statusCode"
2113
+ ],
2114
+ "properties": {
2115
+ "code": {
2116
+ "type": "string",
2117
+ "description": "Code used to categorize the error"
2118
+ },
2119
+ "detail": {
2120
+ "type": "string",
2121
+ "description": "Description of the error"
2122
+ },
2123
+ "requestId": {
2124
+ "type": "string",
2125
+ "description": "Unique request id. This one will be used to troubleshoot the problems"
2126
+ },
2127
+ "name": {
2128
+ "type": "string",
2129
+ "description": "Name of the error type"
2130
+ },
2131
+ "validation": {
2132
+ "type": "array",
2133
+ "items": {
2134
+ "type": "object",
2135
+ "required": [
2136
+ "fieldName",
2137
+ "message"
2138
+ ],
2139
+ "properties": {
2140
+ "fieldName": {
2141
+ "type": "string"
2142
+ },
2143
+ "message": {
2144
+ "type": "string"
2145
+ }
2146
+ }
2147
+ },
2148
+ "description": "List of the validation errors"
2149
+ },
2150
+ "validationContext": {
2151
+ "type": "string"
2152
+ },
2153
+ "statusCode": {
2154
+ "type": "number"
2155
+ }
2156
+ }
2157
+ }
2158
+ }
2159
+ }
2160
+ },
2161
+ "404": {
2162
+ "description": "Default Response",
2163
+ "content": {
2164
+ "application/json": {
2165
+ "schema": {
2166
+ "type": "object",
2167
+ "required": [
2168
+ "code",
2169
+ "detail",
2170
+ "requestId",
2171
+ "name",
2172
+ "statusCode"
2173
+ ],
2174
+ "properties": {
2175
+ "code": {
2176
+ "type": "string",
2177
+ "description": "Code used to categorize the error"
2178
+ },
2179
+ "detail": {
2180
+ "type": "string",
2181
+ "description": "Description of the error"
2182
+ },
2183
+ "requestId": {
2184
+ "type": "string",
2185
+ "description": "Unique request id. This one will be used to troubleshoot the problems"
2186
+ },
2187
+ "name": {
2188
+ "type": "string",
2189
+ "description": "Name of the error type"
2190
+ },
2191
+ "validation": {
2192
+ "type": "array",
2193
+ "items": {
2194
+ "type": "object",
2195
+ "required": [
2196
+ "fieldName",
2197
+ "message"
2198
+ ],
2199
+ "properties": {
2200
+ "fieldName": {
2201
+ "type": "string"
2202
+ },
2203
+ "message": {
2204
+ "type": "string"
2205
+ }
2206
+ }
2207
+ },
2208
+ "description": "List of the validation errors"
2209
+ },
2210
+ "validationContext": {
2211
+ "type": "string"
2212
+ },
2213
+ "statusCode": {
2214
+ "type": "number"
2215
+ }
2216
+ }
2217
+ }
2218
+ }
2219
+ }
2220
+ },
2221
+ "500": {
2222
+ "description": "Default Response",
2223
+ "content": {
2224
+ "application/json": {
2225
+ "schema": {
2226
+ "type": "object",
2227
+ "required": [
2228
+ "code",
2229
+ "detail",
2230
+ "requestId",
2231
+ "name",
2232
+ "statusCode"
2233
+ ],
2234
+ "properties": {
2235
+ "code": {
2236
+ "type": "string",
2237
+ "description": "Code used to categorize the error"
2238
+ },
2239
+ "detail": {
2240
+ "type": "string",
2241
+ "description": "Description of the error"
2242
+ },
2243
+ "requestId": {
2244
+ "type": "string",
2245
+ "description": "Unique request id. This one will be used to troubleshoot the problems"
2246
+ },
2247
+ "name": {
2248
+ "type": "string",
2249
+ "description": "Name of the error type"
2250
+ },
2251
+ "validation": {
2252
+ "type": "array",
2253
+ "items": {
2254
+ "type": "object",
2255
+ "required": [
2256
+ "fieldName",
2257
+ "message"
2258
+ ],
2259
+ "properties": {
2260
+ "fieldName": {
2261
+ "type": "string"
2262
+ },
2263
+ "message": {
2264
+ "type": "string"
2265
+ }
2266
+ }
2267
+ },
2268
+ "description": "List of the validation errors"
2269
+ },
2270
+ "validationContext": {
2271
+ "type": "string"
2272
+ },
2273
+ "statusCode": {
2274
+ "type": "number"
2275
+ }
2276
+ }
2277
+ }
2278
+ }
2279
+ }
2280
+ }
2281
+ }
2282
+ }
2283
+ },
2284
+ "/api/v1/organisations/messages/{messageId}/events": {
2285
+ "get": {
2286
+ "tags": [
2287
+ "Organisations Messages"
2288
+ ],
2289
+ "description": "Get complete event history for a message",
2290
+ "parameters": [
2291
+ {
2292
+ "schema": {
2293
+ "type": "string",
2294
+ "format": "uuid"
2295
+ },
2296
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
2297
+ "in": "path",
2298
+ "name": "messageId",
2299
+ "required": true,
2300
+ "description": "Unique identifier of the message whose history to retrieve"
2301
+ }
2302
+ ],
2303
+ "responses": {
2304
+ "200": {
2305
+ "description": "Default Response",
2306
+ "content": {
2307
+ "application/json": {
2308
+ "schema": {
2309
+ "type": "object",
2310
+ "required": [
2311
+ "data"
2312
+ ],
2313
+ "properties": {
2314
+ "data": {
2315
+ "type": "array",
2316
+ "items": {
2317
+ "type": "object",
2318
+ "required": [
2319
+ "messageId",
2320
+ "eventType",
2321
+ "eventStatus",
2322
+ "data",
2323
+ "createdAt"
2324
+ ],
2325
+ "properties": {
2326
+ "messageId": {
2327
+ "type": "string",
2328
+ "format": "uuid",
2329
+ "description": "Message id",
2330
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
2331
+ },
2332
+ "eventType": {
2333
+ "type": "string",
2334
+ "description": "Event type description",
2335
+ "example": "delivered"
2336
+ },
2337
+ "eventStatus": {
2338
+ "type": "string",
2339
+ "description": "Status for event type",
2340
+ "example": "success"
2341
+ },
2342
+ "data": {
2343
+ "anyOf": [
2344
+ {
2345
+ "type": "object",
2346
+ "required": [
2347
+ "messageId",
2348
+ "receiverFullName",
2349
+ "receiverPPSN",
2350
+ "receiverUserId",
2351
+ "subject",
2352
+ "language",
2353
+ "plainText",
2354
+ "transports",
2355
+ "scheduledAt",
2356
+ "organisationName",
2357
+ "security"
2358
+ ],
2359
+ "properties": {
2360
+ "messageId": {
2361
+ "type": "string",
2362
+ "description": "Unique id of the related message",
2363
+ "examples": [
2364
+ "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
2365
+ ]
2366
+ },
2367
+ "receiverFullName": {
2368
+ "type": "string",
2369
+ "description": "Full name of the recipient",
2370
+ "examples": [
2371
+ "John Doe"
2372
+ ]
2373
+ },
2374
+ "receiverPPSN": {
2375
+ "type": "string",
2376
+ "description": "PPSN of the recipient",
2377
+ "examples": [
2378
+ "1234567T"
2379
+ ]
2380
+ },
2381
+ "receiverUserId": {
2382
+ "type": "string",
2383
+ "description": "User id of recipient",
2384
+ "examples": [
2385
+ "b2c3d4e5-f6a7-8901-bcde-f12345678901"
2386
+ ]
2387
+ },
2388
+ "subject": {
2389
+ "type": "string",
2390
+ "description": "Subject of the related message",
2391
+ "examples": [
2392
+ "Welcome to MessagingIE"
2393
+ ]
2394
+ },
2395
+ "language": {
2396
+ "type": "string",
2397
+ "description": "Language of the related message",
2398
+ "examples": [
2399
+ "en"
2400
+ ]
2401
+ },
2402
+ "excerpt": {
2403
+ "type": "string",
2404
+ "description": "Excerpt of the related message",
2405
+ "examples": [
2406
+ "Dear John Doe, Welcome..."
2407
+ ]
2408
+ },
2409
+ "richText": {
2410
+ "type": "string",
2411
+ "description": "Rich text content of the related message",
2412
+ "examples": [
2413
+ "<p>Dear <strong>John Doe</strong>...</p>"
2414
+ ]
2415
+ },
2416
+ "plainText": {
2417
+ "type": "string",
2418
+ "description": "Plain text context of the related message",
2419
+ "examples": [
2420
+ "Dear John Doe, Welcome to MessagingIE."
2421
+ ]
2422
+ },
2423
+ "threadName": {
2424
+ "type": "string",
2425
+ "description": "Thread name of the related message",
2426
+ "examples": [
2427
+ "Support Thread"
2428
+ ]
2429
+ },
2430
+ "transports": {
2431
+ "type": "array",
2432
+ "items": {
2433
+ "type": "string",
2434
+ "description": "Transport channel name",
2435
+ "examples": [
2436
+ "email"
2437
+ ]
2438
+ },
2439
+ "description": "Selected transports to send the message",
2440
+ "examples": [
2441
+ [
2442
+ "email"
2443
+ ]
2444
+ ]
2445
+ },
2446
+ "scheduledAt": {
2447
+ "type": "string",
2448
+ "format": "date-time",
2449
+ "description": "Date and time which describes when the message has to be sent",
2450
+ "examples": [
2451
+ "2025-11-25T14:30:00Z"
2452
+ ]
2453
+ },
2454
+ "senderUserId": {
2455
+ "type": "string",
2456
+ "description": "Unique user id of the sender",
2457
+ "examples": [
2458
+ "c3d4e5f6-a7b8-9012-cdef-123456789012"
2459
+ ]
2460
+ },
2461
+ "senderFullName": {
2462
+ "type": "string",
2463
+ "description": "Full name of the sender",
2464
+ "examples": [
2465
+ "Jane Smith"
2466
+ ]
2467
+ },
2468
+ "senderPPSN": {
2469
+ "type": "string",
2470
+ "description": "PPSN of the sender",
2471
+ "examples": [
2472
+ "9876543A"
2473
+ ]
2474
+ },
2475
+ "senderApplicationId": {
2476
+ "type": "string",
2477
+ "description": "Unique id of the M2M application that sent the message",
2478
+ "examples": [
2479
+ "d4e5f6a7-b8c9-0123-def1-234567890123"
2480
+ ]
2481
+ },
2482
+ "organisationName": {
2483
+ "type": "string",
2484
+ "description": "Organisation related to the sender",
2485
+ "examples": [
2486
+ "Department of Social Protection"
2487
+ ]
2488
+ },
2489
+ "security": {
2490
+ "enum": [
2491
+ "public",
2492
+ "confidential"
2493
+ ],
2494
+ "description": "Security classification of the message: 'public' to show the original message in the sent email, 'confidential' to show the content only after login in MessagingIE",
2495
+ "examples": [
2496
+ "confidential"
2497
+ ]
2498
+ }
2499
+ },
2500
+ "description": "Event data for a message creation event",
2501
+ "examples": [
2502
+ {
2503
+ "messageId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
2504
+ "receiverFullName": "John Doe",
2505
+ "receiverPPSN": "1234567T",
2506
+ "receiverUserId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
2507
+ "subject": "Welcome to MessagingIE",
2508
+ "language": "en",
2509
+ "plainText": "Dear John Doe, Welcome to MessagingIE.",
2510
+ "transports": [
2511
+ "email"
2512
+ ],
2513
+ "scheduledAt": "2025-11-25T14:30:00Z",
2514
+ "organisationName": "Department of Social Protection",
2515
+ "security": "confidential"
2516
+ }
2517
+ ]
2518
+ },
2519
+ {
2520
+ "type": "object",
2521
+ "required": [
2522
+ "messageId",
2523
+ "jobId"
2524
+ ],
2525
+ "properties": {
2526
+ "messageId": {
2527
+ "type": "string",
2528
+ "description": "Unique id of the related message",
2529
+ "examples": [
2530
+ "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
2531
+ ]
2532
+ },
2533
+ "jobId": {
2534
+ "type": "string",
2535
+ "description": "Unique id of the job",
2536
+ "examples": [
2537
+ "e5f6a7b8-c9d0-1234-ef12-345678901234"
2538
+ ]
2539
+ }
2540
+ },
2541
+ "description": "Event data for a message scheduling event",
2542
+ "examples": [
2543
+ {
2544
+ "messageId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
2545
+ "jobId": "e5f6a7b8-c9d0-1234-ef12-345678901234"
2546
+ }
2547
+ ]
2548
+ },
2549
+ {
2550
+ "type": "object",
2551
+ "required": [
2552
+ "messageId"
2553
+ ],
2554
+ "properties": {
2555
+ "messageId": {
2556
+ "type": "string",
2557
+ "description": "Unique id of the related message",
2558
+ "examples": [
2559
+ "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
2560
+ ]
2561
+ }
2562
+ },
2563
+ "description": "Event data for a message error event",
2564
+ "examples": [
2565
+ {
2566
+ "messageId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
2567
+ }
2568
+ ]
2569
+ }
2570
+ ],
2571
+ "description": "Event-specific payload; shape depends on the event type (create, schedule, or error)",
2572
+ "example": {
2573
+ "messageId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
2574
+ "receiverFullName": "John Doe",
2575
+ "receiverPPSN": "1234567T",
2576
+ "receiverUserId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
2577
+ "subject": "Welcome to MessagingIE",
2578
+ "language": "en",
2579
+ "plainText": "Dear John Doe, Welcome to MessagingIE.",
2580
+ "transports": [
2581
+ "email"
2582
+ ],
2583
+ "scheduledAt": "2025-11-25T14:30:00Z",
2584
+ "organisationName": "Department of Social Protection",
2585
+ "security": "confidential"
2586
+ }
2587
+ },
2588
+ "createdAt": {
2589
+ "type": "string",
2590
+ "format": "date-time",
2591
+ "description": "Date and time which describes when the event has been recorded",
2592
+ "example": "2025-11-25T14:30:05Z"
2593
+ }
2594
+ },
2595
+ "description": "A single event from the full history of a message, including its type, status, and event-specific payload",
2596
+ "example": {
2597
+ "messageId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
2598
+ "eventType": "delivered",
2599
+ "eventStatus": "success",
2600
+ "data": {
2601
+ "messageId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
2602
+ "receiverFullName": "John Doe",
2603
+ "receiverPPSN": "1234567T",
2604
+ "receiverUserId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
2605
+ "subject": "Welcome to MessagingIE",
2606
+ "language": "en",
2607
+ "plainText": "Dear John Doe, Welcome to MessagingIE.",
2608
+ "transports": [
2609
+ "email"
2610
+ ],
2611
+ "scheduledAt": "2025-11-25T14:30:00Z",
2612
+ "organisationName": "Department of Social Protection",
2613
+ "security": "confidential"
2614
+ },
2615
+ "createdAt": "2025-11-25T14:30:05Z"
2616
+ }
2617
+ }
2618
+ },
2619
+ "metadata": {
2620
+ "type": "object",
2621
+ "properties": {
2622
+ "links": {
2623
+ "type": "object",
2624
+ "required": [
2625
+ "self",
2626
+ "first",
2627
+ "last",
2628
+ "pages"
2629
+ ],
2630
+ "properties": {
2631
+ "self": {
2632
+ "type": "object",
2633
+ "properties": {
2634
+ "href": {
2635
+ "type": "string",
2636
+ "description": "URL pointing to the request itself"
2637
+ }
2638
+ },
2639
+ "description": "Object containing the URL link",
2640
+ "example": {
2641
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=20&limit=20"
2642
+ }
2643
+ },
2644
+ "next": {
2645
+ "type": "object",
2646
+ "properties": {
2647
+ "href": {
2648
+ "type": "string",
2649
+ "description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted"
2650
+ }
2651
+ },
2652
+ "description": "Object containing the URL link",
2653
+ "example": {
2654
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=40&limit=20"
2655
+ }
2656
+ },
2657
+ "prev": {
2658
+ "type": "object",
2659
+ "properties": {
2660
+ "href": {
2661
+ "type": "string",
2662
+ "description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted"
2663
+ }
2664
+ },
2665
+ "description": "Object containing the URL link",
2666
+ "example": {
2667
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=0&limit=20"
2668
+ }
2669
+ },
2670
+ "first": {
2671
+ "type": "object",
2672
+ "properties": {
2673
+ "href": {
2674
+ "type": "string",
2675
+ "description": "URL pointing to the first page of results in a paginated response"
2676
+ }
2677
+ },
2678
+ "description": "Object containing the URL link",
2679
+ "example": {
2680
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=0&limit=20"
2681
+ }
2682
+ },
2683
+ "last": {
2684
+ "type": "object",
2685
+ "properties": {
2686
+ "href": {
2687
+ "type": "string",
2688
+ "description": "URL pointing to the last page of results in a paginated response"
2689
+ }
2690
+ },
2691
+ "description": "Object containing the URL link",
2692
+ "example": {
2693
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=120&limit=20"
2694
+ }
2695
+ },
2696
+ "pages": {
2697
+ "type": "object",
2698
+ "description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
2699
+ "additionalProperties": {
2700
+ "type": "object",
2701
+ "properties": {
2702
+ "href": {
2703
+ "type": "string"
2704
+ }
2705
+ },
2706
+ "description": "Object containing the URL link",
2707
+ "examples": [
2708
+ {
2709
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=0&limit=20"
2710
+ }
2711
+ ]
2712
+ },
2713
+ "example": {
2714
+ "page1": {
2715
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=0&limit=20"
2716
+ },
2717
+ "page2": {
2718
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=20&limit=20"
2719
+ }
2720
+ }
2721
+ }
2722
+ },
2723
+ "description": "Object containing the links to the related endpoints"
2724
+ },
2725
+ "totalCount": {
2726
+ "type": "number",
2727
+ "description": "Number representing the total number of available items",
2728
+ "example": 150
2729
+ }
2730
+ }
2731
+ }
2732
+ }
2733
+ }
2734
+ }
2735
+ }
2736
+ },
2737
+ "401": {
2738
+ "description": "Default Response",
2739
+ "content": {
2740
+ "application/json": {
2741
+ "schema": {
2742
+ "type": "object",
2743
+ "required": [
2744
+ "code",
2745
+ "detail",
2746
+ "requestId",
2747
+ "name",
2748
+ "statusCode"
2749
+ ],
2750
+ "properties": {
2751
+ "code": {
2752
+ "type": "string",
2753
+ "description": "Code used to categorize the error"
2754
+ },
2755
+ "detail": {
2756
+ "type": "string",
2757
+ "description": "Description of the error"
2758
+ },
2759
+ "requestId": {
2760
+ "type": "string",
2761
+ "description": "Unique request id. This one will be used to troubleshoot the problems"
2762
+ },
2763
+ "name": {
2764
+ "type": "string",
2765
+ "description": "Name of the error type"
2766
+ },
2767
+ "validation": {
2768
+ "type": "array",
2769
+ "items": {
2770
+ "type": "object",
2771
+ "required": [
2772
+ "fieldName",
2773
+ "message"
2774
+ ],
2775
+ "properties": {
2776
+ "fieldName": {
2777
+ "type": "string"
2778
+ },
2779
+ "message": {
2780
+ "type": "string"
2781
+ }
2782
+ }
2783
+ },
2784
+ "description": "List of the validation errors"
2785
+ },
2786
+ "validationContext": {
2787
+ "type": "string"
2788
+ },
2789
+ "statusCode": {
2790
+ "type": "number"
2791
+ }
2792
+ }
2793
+ }
2794
+ }
2795
+ }
2796
+ },
2797
+ "403": {
2798
+ "description": "Default Response",
2799
+ "content": {
2800
+ "application/json": {
2801
+ "schema": {
2802
+ "type": "object",
2803
+ "required": [
2804
+ "code",
2805
+ "detail",
2806
+ "requestId",
2807
+ "name",
2808
+ "statusCode"
2809
+ ],
2810
+ "properties": {
2811
+ "code": {
2812
+ "type": "string",
2813
+ "description": "Code used to categorize the error"
2814
+ },
2815
+ "detail": {
2816
+ "type": "string",
2817
+ "description": "Description of the error"
2818
+ },
2819
+ "requestId": {
2820
+ "type": "string",
2821
+ "description": "Unique request id. This one will be used to troubleshoot the problems"
2822
+ },
2823
+ "name": {
2824
+ "type": "string",
2825
+ "description": "Name of the error type"
2826
+ },
2827
+ "validation": {
2828
+ "type": "array",
2829
+ "items": {
2830
+ "type": "object",
2831
+ "required": [
2832
+ "fieldName",
2833
+ "message"
2834
+ ],
2835
+ "properties": {
2836
+ "fieldName": {
2837
+ "type": "string"
2838
+ },
2839
+ "message": {
2840
+ "type": "string"
2841
+ }
2842
+ }
2843
+ },
2844
+ "description": "List of the validation errors"
2845
+ },
2846
+ "validationContext": {
2847
+ "type": "string"
2848
+ },
2849
+ "statusCode": {
2850
+ "type": "number"
2851
+ }
2852
+ }
2853
+ }
2854
+ }
2855
+ }
2856
+ },
2857
+ "404": {
2858
+ "description": "Default Response",
2859
+ "content": {
2860
+ "application/json": {
2861
+ "schema": {
2862
+ "type": "object",
2863
+ "required": [
2864
+ "code",
2865
+ "detail",
2866
+ "requestId",
2867
+ "name",
2868
+ "statusCode"
2869
+ ],
2870
+ "properties": {
2871
+ "code": {
2872
+ "type": "string",
2873
+ "description": "Code used to categorize the error"
2874
+ },
2875
+ "detail": {
2876
+ "type": "string",
2877
+ "description": "Description of the error"
2878
+ },
2879
+ "requestId": {
2880
+ "type": "string",
2881
+ "description": "Unique request id. This one will be used to troubleshoot the problems"
2882
+ },
2883
+ "name": {
2884
+ "type": "string",
2885
+ "description": "Name of the error type"
2886
+ },
2887
+ "validation": {
2888
+ "type": "array",
2889
+ "items": {
2890
+ "type": "object",
2891
+ "required": [
2892
+ "fieldName",
2893
+ "message"
2894
+ ],
2895
+ "properties": {
2896
+ "fieldName": {
2897
+ "type": "string"
2898
+ },
2899
+ "message": {
2900
+ "type": "string"
2901
+ }
2902
+ }
2903
+ },
2904
+ "description": "List of the validation errors"
2905
+ },
2906
+ "validationContext": {
2907
+ "type": "string"
2908
+ },
2909
+ "statusCode": {
2910
+ "type": "number"
2911
+ }
2912
+ }
2913
+ }
2914
+ }
2915
+ }
2916
+ },
2917
+ "500": {
2918
+ "description": "Default Response",
2919
+ "content": {
2920
+ "application/json": {
2921
+ "schema": {
2922
+ "type": "object",
2923
+ "required": [
2924
+ "code",
2925
+ "detail",
2926
+ "requestId",
2927
+ "name",
2928
+ "statusCode"
2929
+ ],
2930
+ "properties": {
2931
+ "code": {
2932
+ "type": "string",
2933
+ "description": "Code used to categorize the error"
2934
+ },
2935
+ "detail": {
2936
+ "type": "string",
2937
+ "description": "Description of the error"
2938
+ },
2939
+ "requestId": {
2940
+ "type": "string",
2941
+ "description": "Unique request id. This one will be used to troubleshoot the problems"
2942
+ },
2943
+ "name": {
2944
+ "type": "string",
2945
+ "description": "Name of the error type"
2946
+ },
2947
+ "validation": {
2948
+ "type": "array",
2949
+ "items": {
2950
+ "type": "object",
2951
+ "required": [
2952
+ "fieldName",
2953
+ "message"
2954
+ ],
2955
+ "properties": {
2956
+ "fieldName": {
2957
+ "type": "string"
2958
+ },
2959
+ "message": {
2960
+ "type": "string"
2961
+ }
2962
+ }
2963
+ },
2964
+ "description": "List of the validation errors"
2965
+ },
2966
+ "validationContext": {
2967
+ "type": "string"
2968
+ },
2969
+ "statusCode": {
2970
+ "type": "number"
2971
+ }
2972
+ }
2973
+ }
2974
+ }
2975
+ }
2976
+ }
2977
+ }
2978
+ }
2979
+ },
2980
+ "/api/v1/organisations/messages/events": {
2981
+ "post": {
2982
+ "tags": [
2983
+ "Organisations Messages"
2984
+ ],
2985
+ "description": "Get latest event for a list of messages with pagination, filters, and HATEOAS links",
2986
+ "requestBody": {
2987
+ "required": true,
2988
+ "content": {
2989
+ "application/json": {
2990
+ "schema": {
2991
+ "type": "object",
2992
+ "properties": {
2993
+ "recipientEmail": {
2994
+ "type": "string",
2995
+ "format": "email",
2996
+ "description": "Filter events by recipient email address",
2997
+ "example": "john.doe@example.com"
2998
+ },
2999
+ "recipientId": {
3000
+ "type": "string",
3001
+ "description": "Filter events by recipient profile identifier",
3002
+ "example": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
3003
+ },
3004
+ "subjectContains": {
3005
+ "type": "string",
3006
+ "description": "Filter events where the subject contains this substring",
3007
+ "example": "Welcome"
3008
+ },
3009
+ "dateFrom": {
3010
+ "type": "string",
3011
+ "format": "date",
3012
+ "description": "Return events on or after this date (YYYY-MM-DD)",
3013
+ "example": "2025-11-01"
3014
+ },
3015
+ "dateTo": {
3016
+ "type": "string",
3017
+ "format": "date",
3018
+ "description": "Return events on or before this date (YYYY-MM-DD)",
3019
+ "example": "2025-11-30"
3020
+ },
3021
+ "status": {
3022
+ "enum": [
3023
+ "delivered",
3024
+ "scheduled",
3025
+ "opened",
3026
+ "failed"
3027
+ ],
3028
+ "description": "Filter events by status",
3029
+ "example": "delivered"
3030
+ }
3031
+ },
3032
+ "description": "Filter criteria for retrieving the latest message event"
3033
+ },
3034
+ "example": {
3035
+ "recipientEmail": "john.doe@example.com",
3036
+ "subjectContains": "Welcome",
3037
+ "dateFrom": "2025-11-01",
3038
+ "dateTo": "2025-11-30",
3039
+ "status": "delivered"
3040
+ }
3041
+ }
3042
+ },
3043
+ "description": "Filter criteria for retrieving the latest message event"
3044
+ },
3045
+ "parameters": [
3046
+ {
3047
+ "schema": {
3048
+ "type": "string",
3049
+ "pattern": "^[0-9][0-9]*|undefined$",
3050
+ "default": "0"
3051
+ },
3052
+ "in": "query",
3053
+ "name": "offset",
3054
+ "required": false,
3055
+ "description": "Indicates where to start fetching data or how many records to skip, defining the initial position within the list"
3056
+ },
3057
+ {
3058
+ "schema": {
3059
+ "type": "string",
3060
+ "default": "20",
3061
+ "pattern": "^([1-9]|100)|undefined$"
3062
+ },
3063
+ "in": "query",
3064
+ "name": "limit",
3065
+ "required": false,
3066
+ "description": "Indicates the maximum number (100) of items that will be returned in a single request"
3067
+ }
3068
+ ],
3069
+ "responses": {
3070
+ "200": {
3071
+ "description": "Default Response",
3072
+ "content": {
3073
+ "application/json": {
3074
+ "schema": {
3075
+ "type": "object",
3076
+ "required": [
3077
+ "data"
3078
+ ],
3079
+ "properties": {
3080
+ "data": {
3081
+ "type": "array",
3082
+ "items": {
3083
+ "type": "object",
3084
+ "required": [
3085
+ "id",
3086
+ "messageId",
3087
+ "subject",
3088
+ "receiverFullName",
3089
+ "eventType",
3090
+ "eventStatus",
3091
+ "scheduledAt"
3092
+ ],
3093
+ "properties": {
3094
+ "id": {
3095
+ "type": "string",
3096
+ "format": "uuid",
3097
+ "description": "Unique id of the event",
3098
+ "example": "e1f2e3f4-a5b6-7890-abcd-ef1234567890"
3099
+ },
3100
+ "messageId": {
3101
+ "type": "string",
3102
+ "format": "uuid",
3103
+ "description": "Unique id of the related message",
3104
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
3105
+ },
3106
+ "subject": {
3107
+ "type": "string",
3108
+ "description": "Subject of the related message",
3109
+ "example": "Welcome to MessagingIE"
3110
+ },
3111
+ "receiverFullName": {
3112
+ "type": "string",
3113
+ "description": "Full name of the recipient",
3114
+ "example": "John Doe"
3115
+ },
3116
+ "eventType": {
3117
+ "type": "string",
3118
+ "description": "Event type description",
3119
+ "example": "delivered"
3120
+ },
3121
+ "eventStatus": {
3122
+ "type": "string",
3123
+ "description": "Status for event type",
3124
+ "example": "success"
3125
+ },
3126
+ "scheduledAt": {
3127
+ "type": "string",
3128
+ "description": "Date and time which describes when the message has to be sent",
3129
+ "example": "2025-11-25T14:30:00Z"
3130
+ }
3131
+ },
3132
+ "description": "A message event with its current status and scheduling information",
3133
+ "example": {
3134
+ "id": "e1f2e3f4-a5b6-7890-abcd-ef1234567890",
3135
+ "messageId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
3136
+ "subject": "Welcome to MessagingIE",
3137
+ "receiverFullName": "John Doe",
3138
+ "eventType": "delivered",
3139
+ "eventStatus": "success",
3140
+ "scheduledAt": "2025-11-25T14:30:00Z"
3141
+ }
3142
+ }
3143
+ },
3144
+ "metadata": {
3145
+ "type": "object",
3146
+ "properties": {
3147
+ "links": {
3148
+ "type": "object",
3149
+ "required": [
3150
+ "self",
3151
+ "first",
3152
+ "last",
3153
+ "pages"
3154
+ ],
3155
+ "properties": {
3156
+ "self": {
3157
+ "type": "object",
3158
+ "properties": {
3159
+ "href": {
3160
+ "type": "string",
3161
+ "description": "URL pointing to the request itself"
3162
+ }
3163
+ },
3164
+ "description": "Object containing the URL link",
3165
+ "example": {
3166
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=20&limit=20"
3167
+ }
3168
+ },
3169
+ "next": {
3170
+ "type": "object",
3171
+ "properties": {
3172
+ "href": {
3173
+ "type": "string",
3174
+ "description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted"
3175
+ }
3176
+ },
3177
+ "description": "Object containing the URL link",
3178
+ "example": {
3179
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=40&limit=20"
3180
+ }
3181
+ },
3182
+ "prev": {
3183
+ "type": "object",
3184
+ "properties": {
3185
+ "href": {
3186
+ "type": "string",
3187
+ "description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted"
3188
+ }
3189
+ },
3190
+ "description": "Object containing the URL link",
3191
+ "example": {
3192
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=0&limit=20"
3193
+ }
3194
+ },
3195
+ "first": {
3196
+ "type": "object",
3197
+ "properties": {
3198
+ "href": {
3199
+ "type": "string",
3200
+ "description": "URL pointing to the first page of results in a paginated response"
3201
+ }
3202
+ },
3203
+ "description": "Object containing the URL link",
3204
+ "example": {
3205
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=0&limit=20"
3206
+ }
3207
+ },
3208
+ "last": {
3209
+ "type": "object",
3210
+ "properties": {
3211
+ "href": {
3212
+ "type": "string",
3213
+ "description": "URL pointing to the last page of results in a paginated response"
3214
+ }
3215
+ },
3216
+ "description": "Object containing the URL link",
3217
+ "example": {
3218
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=120&limit=20"
3219
+ }
3220
+ },
3221
+ "pages": {
3222
+ "type": "object",
3223
+ "description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
3224
+ "additionalProperties": {
3225
+ "type": "object",
3226
+ "properties": {
3227
+ "href": {
3228
+ "type": "string"
3229
+ }
3230
+ },
3231
+ "description": "Object containing the URL link",
3232
+ "examples": [
3233
+ {
3234
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=0&limit=20"
3235
+ }
3236
+ ]
3237
+ },
3238
+ "example": {
3239
+ "page1": {
3240
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=0&limit=20"
3241
+ },
3242
+ "page2": {
3243
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=20&limit=20"
3244
+ }
3245
+ }
3246
+ }
3247
+ },
3248
+ "description": "Object containing the links to the related endpoints"
3249
+ },
3250
+ "totalCount": {
3251
+ "type": "number",
3252
+ "description": "Number representing the total number of available items",
3253
+ "example": 150
3254
+ }
3255
+ }
3256
+ }
3257
+ }
3258
+ }
3259
+ }
3260
+ }
3261
+ },
3262
+ "401": {
3263
+ "description": "Default Response",
3264
+ "content": {
3265
+ "application/json": {
3266
+ "schema": {
3267
+ "type": "object",
3268
+ "required": [
3269
+ "code",
3270
+ "detail",
3271
+ "requestId",
3272
+ "name",
3273
+ "statusCode"
3274
+ ],
3275
+ "properties": {
3276
+ "code": {
3277
+ "type": "string",
3278
+ "description": "Code used to categorize the error"
3279
+ },
3280
+ "detail": {
3281
+ "type": "string",
3282
+ "description": "Description of the error"
3283
+ },
3284
+ "requestId": {
3285
+ "type": "string",
3286
+ "description": "Unique request id. This one will be used to troubleshoot the problems"
3287
+ },
3288
+ "name": {
3289
+ "type": "string",
3290
+ "description": "Name of the error type"
3291
+ },
3292
+ "validation": {
3293
+ "type": "array",
3294
+ "items": {
3295
+ "type": "object",
3296
+ "required": [
3297
+ "fieldName",
3298
+ "message"
3299
+ ],
3300
+ "properties": {
3301
+ "fieldName": {
3302
+ "type": "string"
3303
+ },
3304
+ "message": {
3305
+ "type": "string"
3306
+ }
3307
+ }
3308
+ },
3309
+ "description": "List of the validation errors"
3310
+ },
3311
+ "validationContext": {
3312
+ "type": "string"
3313
+ },
3314
+ "statusCode": {
3315
+ "type": "number"
3316
+ }
3317
+ }
3318
+ }
3319
+ }
3320
+ }
3321
+ },
3322
+ "403": {
3323
+ "description": "Default Response",
3324
+ "content": {
3325
+ "application/json": {
3326
+ "schema": {
3327
+ "type": "object",
3328
+ "required": [
3329
+ "code",
3330
+ "detail",
3331
+ "requestId",
3332
+ "name",
3333
+ "statusCode"
3334
+ ],
3335
+ "properties": {
3336
+ "code": {
3337
+ "type": "string",
3338
+ "description": "Code used to categorize the error"
3339
+ },
3340
+ "detail": {
3341
+ "type": "string",
3342
+ "description": "Description of the error"
3343
+ },
3344
+ "requestId": {
3345
+ "type": "string",
3346
+ "description": "Unique request id. This one will be used to troubleshoot the problems"
3347
+ },
3348
+ "name": {
3349
+ "type": "string",
3350
+ "description": "Name of the error type"
3351
+ },
3352
+ "validation": {
3353
+ "type": "array",
3354
+ "items": {
3355
+ "type": "object",
3356
+ "required": [
3357
+ "fieldName",
3358
+ "message"
3359
+ ],
3360
+ "properties": {
3361
+ "fieldName": {
3362
+ "type": "string"
3363
+ },
3364
+ "message": {
3365
+ "type": "string"
3366
+ }
3367
+ }
3368
+ },
3369
+ "description": "List of the validation errors"
3370
+ },
3371
+ "validationContext": {
3372
+ "type": "string"
3373
+ },
3374
+ "statusCode": {
3375
+ "type": "number"
3376
+ }
3377
+ }
3378
+ }
3379
+ }
3380
+ }
3381
+ },
3382
+ "500": {
3383
+ "description": "Default Response",
3384
+ "content": {
3385
+ "application/json": {
3386
+ "schema": {
3387
+ "type": "object",
3388
+ "required": [
3389
+ "code",
3390
+ "detail",
3391
+ "requestId",
3392
+ "name",
3393
+ "statusCode"
3394
+ ],
3395
+ "properties": {
3396
+ "code": {
3397
+ "type": "string",
3398
+ "description": "Code used to categorize the error"
3399
+ },
3400
+ "detail": {
3401
+ "type": "string",
3402
+ "description": "Description of the error"
3403
+ },
3404
+ "requestId": {
3405
+ "type": "string",
3406
+ "description": "Unique request id. This one will be used to troubleshoot the problems"
3407
+ },
3408
+ "name": {
3409
+ "type": "string",
3410
+ "description": "Name of the error type"
3411
+ },
3412
+ "validation": {
3413
+ "type": "array",
3414
+ "items": {
3415
+ "type": "object",
3416
+ "required": [
3417
+ "fieldName",
3418
+ "message"
3419
+ ],
3420
+ "properties": {
3421
+ "fieldName": {
3422
+ "type": "string"
3423
+ },
3424
+ "message": {
3425
+ "type": "string"
3426
+ }
3427
+ }
3428
+ },
3429
+ "description": "List of the validation errors"
3430
+ },
3431
+ "validationContext": {
3432
+ "type": "string"
3433
+ },
3434
+ "statusCode": {
3435
+ "type": "number"
3436
+ }
3437
+ }
3438
+ }
3439
+ }
3440
+ }
3441
+ }
3442
+ }
3443
+ }
3444
+ },
3445
+ "/api/v1/organisations/messages/": {
3446
+ "post": {
3447
+ "tags": [
3448
+ "Organisations Messages"
3449
+ ],
3450
+ "description": "Send a message with optional attachments (multipart/form-data)",
3451
+ "requestBody": {
3452
+ "required": true,
3453
+ "content": {
3454
+ "multipart/form-data": {
3455
+ "schema": {
3456
+ "type": "object",
3457
+ "required": [
3458
+ "subject",
3459
+ "plainTextBody",
3460
+ "securityLevel",
3461
+ "language",
3462
+ "scheduledAt",
3463
+ "recipient"
3464
+ ],
3465
+ "properties": {
3466
+ "subject": {
3467
+ "type": "string",
3468
+ "minLength": 1,
3469
+ "maxLength": 500,
3470
+ "description": "Message subject line (1-500 characters)",
3471
+ "example": "Welcome to MessagingIE"
3472
+ },
3473
+ "plainTextBody": {
3474
+ "type": "string",
3475
+ "minLength": 1,
3476
+ "description": "Plain text version of the message body",
3477
+ "example": "Dear John Doe, Welcome to MessagingIE."
3478
+ },
3479
+ "htmlBody": {
3480
+ "type": "string",
3481
+ "description": "HTML version of the message body (optional)",
3482
+ "example": "<p>Dear <strong>John Doe</strong>,</p><p>Welcome to MessagingIE.</p>"
3483
+ },
3484
+ "securityLevel": {
3485
+ "enum": [
3486
+ "public",
3487
+ "confidential"
3488
+ ],
3489
+ "description": "Security classification of the message: 'public' to show the original message in the sent email, 'confidential' to show the content only after login in MessagingIE",
3490
+ "example": "confidential"
3491
+ },
3492
+ "language": {
3493
+ "enum": [
3494
+ "en",
3495
+ "ga"
3496
+ ],
3497
+ "description": "Message language: 'en' for English, 'ga' for Irish (Gaeilge)",
3498
+ "example": "en"
3499
+ },
3500
+ "scheduledAt": {
3501
+ "type": "string",
3502
+ "format": "date-time",
3503
+ "description": "ISO 8601 timestamp (Europe/Dublin TZ assumed)",
3504
+ "example": "2025-11-25T14:30:00Z"
3505
+ },
3506
+ "recipient": {
3507
+ "anyOf": [
3508
+ {
3509
+ "type": "object",
3510
+ "required": [
3511
+ "type",
3512
+ "firstName",
3513
+ "lastName",
3514
+ "email"
3515
+ ],
3516
+ "properties": {
3517
+ "type": {
3518
+ "type": "string",
3519
+ "description": "Recipient type identifier for email-based recipients",
3520
+ "examples": [
3521
+ "email"
3522
+ ],
3523
+ "enum": [
3524
+ "email"
3525
+ ]
3526
+ },
3527
+ "firstName": {
3528
+ "type": "string",
3529
+ "minLength": 1,
3530
+ "description": "Recipient's first name",
3531
+ "examples": [
3532
+ "John"
3533
+ ]
3534
+ },
3535
+ "lastName": {
3536
+ "type": "string",
3537
+ "minLength": 1,
3538
+ "description": "Recipient's last name",
3539
+ "examples": [
3540
+ "Doe"
3541
+ ]
3542
+ },
3543
+ "email": {
3544
+ "type": "string",
3545
+ "format": "email",
3546
+ "description": "Recipient's email address",
3547
+ "examples": [
3548
+ "john.doe@example.ie"
3549
+ ]
3550
+ },
3551
+ "ppsn": {
3552
+ "type": "string",
3553
+ "description": "Personal Public Service Number (optional for email recipients)",
3554
+ "examples": [
3555
+ "1234567T"
3556
+ ]
3557
+ },
3558
+ "dateOfBirth": {
3559
+ "type": "string",
3560
+ "format": "date",
3561
+ "description": "Recipient's date of birth in YYYY-MM-DD format (optional for email recipients)",
3562
+ "examples": [
3563
+ "1985-03-15"
3564
+ ]
3565
+ }
3566
+ },
3567
+ "description": "Recipient identified by email address and optional personal details",
3568
+ "examples": [
3569
+ {
3570
+ "type": "email",
3571
+ "firstName": "John",
3572
+ "lastName": "Doe",
3573
+ "email": "john.doe@example.ie"
3574
+ }
3575
+ ]
3576
+ },
3577
+ {
3578
+ "type": "object",
3579
+ "required": [
3580
+ "type",
3581
+ "ppsn",
3582
+ "dateOfBirth"
3583
+ ],
3584
+ "properties": {
3585
+ "type": {
3586
+ "type": "string",
3587
+ "description": "Recipient type identifier for identity-based recipients",
3588
+ "examples": [
3589
+ "identity"
3590
+ ],
3591
+ "enum": [
3592
+ "identity"
3593
+ ]
3594
+ },
3595
+ "ppsn": {
3596
+ "type": "string",
3597
+ "minLength": 5,
3598
+ "description": "Personal Public Service Number (required for identity recipients)",
3599
+ "examples": [
3600
+ "1234567T"
3601
+ ]
3602
+ },
3603
+ "dateOfBirth": {
3604
+ "type": "string",
3605
+ "format": "date",
3606
+ "description": "Recipient's date of birth in YYYY-MM-DD format (required for identity recipients)",
3607
+ "examples": [
3608
+ "1985-03-15"
3609
+ ]
3610
+ }
3611
+ },
3612
+ "description": "Recipient identified by PPSN and date of birth for identity lookup",
3613
+ "examples": [
3614
+ {
3615
+ "type": "identity",
3616
+ "ppsn": "1234567T",
3617
+ "dateOfBirth": "1985-03-15"
3618
+ }
3619
+ ]
3620
+ },
3621
+ {
3622
+ "type": "object",
3623
+ "required": [
3624
+ "type",
3625
+ "profileId"
3626
+ ],
3627
+ "properties": {
3628
+ "type": {
3629
+ "type": "string",
3630
+ "description": "Recipient type identifier for profile-id recipients",
3631
+ "examples": [
3632
+ "profileId"
3633
+ ],
3634
+ "enum": [
3635
+ "profileId"
3636
+ ]
3637
+ },
3638
+ "profileId": {
3639
+ "type": "string",
3640
+ "minLength": 1,
3641
+ "maxLength": 15,
3642
+ "description": "Profile identifier supplied by the caller; the gateway forwards it without profile lookup",
3643
+ "examples": [
3644
+ "frehui776"
3645
+ ]
3646
+ }
3647
+ },
3648
+ "description": "Recipient identified by a known profile id; bypasses profile lookup",
3649
+ "examples": [
3650
+ {
3651
+ "type": "profileId",
3652
+ "profileId": "frehui776"
3653
+ }
3654
+ ]
3655
+ }
3656
+ ],
3657
+ "description": "Recipient of the message; one of email, identity (PPSN+DOB), or profile-id variants",
3658
+ "example": {
3659
+ "type": "profileId",
3660
+ "profileId": "frehui776"
3661
+ }
3662
+ },
3663
+ "metadata": {
3664
+ "type": "object",
3665
+ "properties": {
3666
+ "journey": {
3667
+ "type": "object",
3668
+ "required": [
3669
+ "submissionId"
3670
+ ],
3671
+ "properties": {
3672
+ "journeyId": {
3673
+ "type": "string",
3674
+ "minLength": 1,
3675
+ "description": "Identifier of the journey that triggered this message",
3676
+ "example": "11111111-1111-1111-1111-111111111111"
3677
+ },
3678
+ "submissionId": {
3679
+ "type": "string",
3680
+ "minLength": 1,
3681
+ "description": "Identifier of the journey submission linked to this message",
3682
+ "example": "22222222-2222-2222-2222-222222222222"
3683
+ }
3684
+ },
3685
+ "additionalProperties": false,
3686
+ "description": "Journey context associated with this message",
3687
+ "example": {
3688
+ "submissionId": "22222222-2222-2222-2222-222222222222"
3689
+ }
3690
+ }
3691
+ },
3692
+ "additionalProperties": false,
3693
+ "minProperties": 1,
3694
+ "description": "Gateway-level metadata associated with a message",
3695
+ "example": {
3696
+ "journey": {
3697
+ "submissionId": "22222222-2222-2222-2222-222222222222"
3698
+ }
3699
+ }
3700
+ },
3701
+ "attachments": {
3702
+ "description": "Multipart file attachments (handled at transport layer)"
3703
+ }
3704
+ },
3705
+ "description": "Request body for sending a new message"
3706
+ },
3707
+ "example": {
3708
+ "subject": "Welcome to MessagingIE",
3709
+ "plainTextBody": "Dear John Doe, Welcome to MessagingIE.",
3710
+ "securityLevel": "confidential",
3711
+ "language": "en",
3712
+ "scheduledAt": "2025-11-25T14:30:00Z",
3713
+ "recipient": {
3714
+ "type": "profileId",
3715
+ "profileId": "frehui776"
3716
+ }
3717
+ }
3718
+ }
3719
+ },
3720
+ "description": "Request body for sending a new message"
3721
+ },
3722
+ "responses": {
3723
+ "201": {
3724
+ "description": "Default Response",
3725
+ "content": {
3726
+ "application/json": {
3727
+ "schema": {
3728
+ "type": "object",
3729
+ "required": [
3730
+ "data"
3731
+ ],
3732
+ "properties": {
3733
+ "data": {
3734
+ "type": "object",
3735
+ "required": [
3736
+ "messageId",
3737
+ "recipientId",
3738
+ "attachmentIds"
3739
+ ],
3740
+ "properties": {
3741
+ "messageId": {
3742
+ "type": "string",
3743
+ "format": "uuid",
3744
+ "description": "Unique identifier for the created message",
3745
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
3746
+ },
3747
+ "recipientId": {
3748
+ "type": "string",
3749
+ "format": "uuid",
3750
+ "description": "Unique identifier for the message recipient profile",
3751
+ "example": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
3752
+ },
3753
+ "attachmentIds": {
3754
+ "type": "array",
3755
+ "items": {
3756
+ "type": "string",
3757
+ "format": "uuid",
3758
+ "description": "Unique identifier for an uploaded attachment",
3759
+ "example": "c3d4e5f6-a7b8-9012-cdef-123456789012"
3760
+ },
3761
+ "description": "List of attachment identifiers associated with the message",
3762
+ "example": [
3763
+ "c3d4e5f6-a7b8-9012-cdef-123456789012",
3764
+ "d4e5f6a7-b8c9-0123-def1-234567890123"
3765
+ ]
3766
+ },
3767
+ "warning": {
3768
+ "type": "object",
3769
+ "required": [
3770
+ "code",
3771
+ "detail"
3772
+ ],
3773
+ "properties": {
3774
+ "code": {
3775
+ "type": "string",
3776
+ "enum": [
3777
+ "MESSAGE_METADATA_NOT_STORED"
3778
+ ],
3779
+ "description": "Machine-readable code identifying the warning type",
3780
+ "example": "MESSAGE_METADATA_NOT_STORED"
3781
+ },
3782
+ "detail": {
3783
+ "type": "string",
3784
+ "description": "Human-readable description of the warning",
3785
+ "example": "Message metadata could not be stored"
3786
+ }
3787
+ },
3788
+ "description": "Warning details when message metadata could not be persisted",
3789
+ "example": {
3790
+ "code": "MESSAGE_METADATA_NOT_STORED",
3791
+ "detail": "Message metadata could not be stored"
3792
+ }
3793
+ }
3794
+ },
3795
+ "description": "Response body returned after successfully sending a message",
3796
+ "example": {
3797
+ "messageId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
3798
+ "recipientId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
3799
+ "attachmentIds": []
3800
+ }
3801
+ },
3802
+ "metadata": {
3803
+ "type": "object",
3804
+ "properties": {
3805
+ "links": {
3806
+ "type": "object",
3807
+ "required": [
3808
+ "self",
3809
+ "first",
3810
+ "last",
3811
+ "pages"
3812
+ ],
3813
+ "properties": {
3814
+ "self": {
3815
+ "type": "object",
3816
+ "properties": {
3817
+ "href": {
3818
+ "type": "string",
3819
+ "description": "URL pointing to the request itself"
3820
+ }
3821
+ },
3822
+ "description": "Object containing the URL link",
3823
+ "example": {
3824
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=20&limit=20"
3825
+ }
3826
+ },
3827
+ "next": {
3828
+ "type": "object",
3829
+ "properties": {
3830
+ "href": {
3831
+ "type": "string",
3832
+ "description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted"
3833
+ }
3834
+ },
3835
+ "description": "Object containing the URL link",
3836
+ "example": {
3837
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=40&limit=20"
3838
+ }
3839
+ },
3840
+ "prev": {
3841
+ "type": "object",
3842
+ "properties": {
3843
+ "href": {
3844
+ "type": "string",
3845
+ "description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted"
3846
+ }
3847
+ },
3848
+ "description": "Object containing the URL link",
3849
+ "example": {
3850
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=0&limit=20"
3851
+ }
3852
+ },
3853
+ "first": {
3854
+ "type": "object",
3855
+ "properties": {
3856
+ "href": {
3857
+ "type": "string",
3858
+ "description": "URL pointing to the first page of results in a paginated response"
3859
+ }
3860
+ },
3861
+ "description": "Object containing the URL link",
3862
+ "example": {
3863
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=0&limit=20"
3864
+ }
3865
+ },
3866
+ "last": {
3867
+ "type": "object",
3868
+ "properties": {
3869
+ "href": {
3870
+ "type": "string",
3871
+ "description": "URL pointing to the last page of results in a paginated response"
3872
+ }
3873
+ },
3874
+ "description": "Object containing the URL link",
3875
+ "example": {
3876
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=120&limit=20"
3877
+ }
3878
+ },
3879
+ "pages": {
3880
+ "type": "object",
3881
+ "description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
3882
+ "additionalProperties": {
3883
+ "type": "object",
3884
+ "properties": {
3885
+ "href": {
3886
+ "type": "string"
3887
+ }
3888
+ },
3889
+ "description": "Object containing the URL link",
3890
+ "examples": [
3891
+ {
3892
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=0&limit=20"
3893
+ }
3894
+ ]
3895
+ },
3896
+ "example": {
3897
+ "page1": {
3898
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=0&limit=20"
3899
+ },
3900
+ "page2": {
3901
+ "href": "https://api.example.ie/api/v1/the-endpoint?offset=20&limit=20"
3902
+ }
3903
+ }
3904
+ }
3905
+ },
3906
+ "description": "Object containing the links to the related endpoints"
3907
+ },
3908
+ "totalCount": {
3909
+ "type": "number",
3910
+ "description": "Number representing the total number of available items",
3911
+ "example": 150
3912
+ }
3913
+ }
3914
+ }
3915
+ }
3916
+ }
3917
+ }
3918
+ }
3919
+ },
3920
+ "400": {
3921
+ "description": "Default Response",
3922
+ "content": {
3923
+ "application/json": {
3924
+ "schema": {
3925
+ "type": "object",
3926
+ "required": [
3927
+ "code",
3928
+ "detail",
3929
+ "requestId",
3930
+ "name",
3931
+ "statusCode"
3932
+ ],
3933
+ "properties": {
3934
+ "code": {
3935
+ "type": "string",
3936
+ "description": "Code used to categorize the error"
3937
+ },
3938
+ "detail": {
3939
+ "type": "string",
3940
+ "description": "Description of the error"
3941
+ },
3942
+ "requestId": {
3943
+ "type": "string",
3944
+ "description": "Unique request id. This one will be used to troubleshoot the problems"
3945
+ },
3946
+ "name": {
3947
+ "type": "string",
3948
+ "description": "Name of the error type"
3949
+ },
3950
+ "validation": {
3951
+ "type": "array",
3952
+ "items": {
3953
+ "type": "object",
3954
+ "required": [
3955
+ "fieldName",
3956
+ "message"
3957
+ ],
3958
+ "properties": {
3959
+ "fieldName": {
3960
+ "type": "string"
3961
+ },
3962
+ "message": {
3963
+ "type": "string"
3964
+ }
3965
+ }
3966
+ },
3967
+ "description": "List of the validation errors"
3968
+ },
3969
+ "validationContext": {
3970
+ "type": "string"
3971
+ },
3972
+ "statusCode": {
3973
+ "type": "number"
3974
+ }
3975
+ }
3976
+ }
3977
+ }
3978
+ }
3979
+ },
3980
+ "401": {
3981
+ "description": "Default Response",
3982
+ "content": {
3983
+ "application/json": {
3984
+ "schema": {
3985
+ "type": "object",
3986
+ "required": [
3987
+ "code",
3988
+ "detail",
3989
+ "requestId",
3990
+ "name",
3991
+ "statusCode"
3992
+ ],
3993
+ "properties": {
3994
+ "code": {
3995
+ "type": "string",
3996
+ "description": "Code used to categorize the error"
3997
+ },
3998
+ "detail": {
3999
+ "type": "string",
4000
+ "description": "Description of the error"
4001
+ },
4002
+ "requestId": {
4003
+ "type": "string",
4004
+ "description": "Unique request id. This one will be used to troubleshoot the problems"
4005
+ },
4006
+ "name": {
4007
+ "type": "string",
4008
+ "description": "Name of the error type"
4009
+ },
4010
+ "validation": {
4011
+ "type": "array",
4012
+ "items": {
4013
+ "type": "object",
4014
+ "required": [
4015
+ "fieldName",
4016
+ "message"
4017
+ ],
4018
+ "properties": {
4019
+ "fieldName": {
4020
+ "type": "string"
4021
+ },
4022
+ "message": {
4023
+ "type": "string"
4024
+ }
4025
+ }
4026
+ },
4027
+ "description": "List of the validation errors"
4028
+ },
4029
+ "validationContext": {
4030
+ "type": "string"
4031
+ },
4032
+ "statusCode": {
4033
+ "type": "number"
4034
+ }
4035
+ }
4036
+ }
4037
+ }
4038
+ }
4039
+ },
4040
+ "403": {
4041
+ "description": "Default Response",
4042
+ "content": {
4043
+ "application/json": {
4044
+ "schema": {
4045
+ "type": "object",
4046
+ "required": [
4047
+ "code",
4048
+ "detail",
4049
+ "requestId",
4050
+ "name",
4051
+ "statusCode"
4052
+ ],
4053
+ "properties": {
4054
+ "code": {
4055
+ "type": "string",
4056
+ "description": "Code used to categorize the error"
4057
+ },
4058
+ "detail": {
4059
+ "type": "string",
4060
+ "description": "Description of the error"
4061
+ },
4062
+ "requestId": {
4063
+ "type": "string",
4064
+ "description": "Unique request id. This one will be used to troubleshoot the problems"
4065
+ },
4066
+ "name": {
4067
+ "type": "string",
4068
+ "description": "Name of the error type"
4069
+ },
4070
+ "validation": {
4071
+ "type": "array",
4072
+ "items": {
4073
+ "type": "object",
4074
+ "required": [
4075
+ "fieldName",
4076
+ "message"
4077
+ ],
4078
+ "properties": {
4079
+ "fieldName": {
4080
+ "type": "string"
4081
+ },
4082
+ "message": {
4083
+ "type": "string"
4084
+ }
4085
+ }
4086
+ },
4087
+ "description": "List of the validation errors"
4088
+ },
4089
+ "validationContext": {
4090
+ "type": "string"
4091
+ },
4092
+ "statusCode": {
4093
+ "type": "number"
4094
+ }
4095
+ }
4096
+ }
4097
+ }
4098
+ }
4099
+ },
4100
+ "404": {
4101
+ "description": "Default Response",
4102
+ "content": {
4103
+ "application/json": {
4104
+ "schema": {
4105
+ "type": "object",
4106
+ "required": [
4107
+ "code",
4108
+ "detail",
4109
+ "requestId",
4110
+ "name",
4111
+ "statusCode"
4112
+ ],
4113
+ "properties": {
4114
+ "code": {
4115
+ "type": "string",
4116
+ "description": "Code used to categorize the error"
4117
+ },
4118
+ "detail": {
4119
+ "type": "string",
4120
+ "description": "Description of the error"
4121
+ },
4122
+ "requestId": {
4123
+ "type": "string",
4124
+ "description": "Unique request id. This one will be used to troubleshoot the problems"
4125
+ },
4126
+ "name": {
4127
+ "type": "string",
4128
+ "description": "Name of the error type"
4129
+ },
4130
+ "validation": {
4131
+ "type": "array",
4132
+ "items": {
4133
+ "type": "object",
4134
+ "required": [
4135
+ "fieldName",
4136
+ "message"
4137
+ ],
4138
+ "properties": {
4139
+ "fieldName": {
4140
+ "type": "string"
4141
+ },
4142
+ "message": {
4143
+ "type": "string"
4144
+ }
4145
+ }
4146
+ },
4147
+ "description": "List of the validation errors"
4148
+ },
4149
+ "validationContext": {
4150
+ "type": "string"
4151
+ },
4152
+ "statusCode": {
4153
+ "type": "number"
4154
+ }
4155
+ }
4156
+ }
4157
+ }
4158
+ }
4159
+ },
4160
+ "409": {
4161
+ "description": "Default Response",
4162
+ "content": {
4163
+ "application/json": {
4164
+ "schema": {
4165
+ "type": "object",
4166
+ "required": [
4167
+ "code",
4168
+ "detail",
4169
+ "requestId",
4170
+ "name",
4171
+ "statusCode"
4172
+ ],
4173
+ "properties": {
4174
+ "code": {
4175
+ "type": "string",
4176
+ "description": "Code used to categorize the error"
4177
+ },
4178
+ "detail": {
4179
+ "type": "string",
4180
+ "description": "Description of the error"
4181
+ },
4182
+ "requestId": {
4183
+ "type": "string",
4184
+ "description": "Unique request id. This one will be used to troubleshoot the problems"
4185
+ },
4186
+ "name": {
4187
+ "type": "string",
4188
+ "description": "Name of the error type"
4189
+ },
4190
+ "validation": {
4191
+ "type": "array",
4192
+ "items": {
4193
+ "type": "object",
4194
+ "required": [
4195
+ "fieldName",
4196
+ "message"
4197
+ ],
4198
+ "properties": {
4199
+ "fieldName": {
4200
+ "type": "string"
4201
+ },
4202
+ "message": {
4203
+ "type": "string"
4204
+ }
4205
+ }
4206
+ },
4207
+ "description": "List of the validation errors"
4208
+ },
4209
+ "validationContext": {
4210
+ "type": "string"
4211
+ },
4212
+ "statusCode": {
4213
+ "type": "number"
4214
+ }
4215
+ }
4216
+ }
4217
+ }
4218
+ }
4219
+ },
4220
+ "413": {
4221
+ "description": "Default Response",
4222
+ "content": {
4223
+ "application/json": {
4224
+ "schema": {
4225
+ "type": "object",
4226
+ "required": [
4227
+ "code",
4228
+ "detail",
4229
+ "requestId",
4230
+ "name",
4231
+ "statusCode"
4232
+ ],
4233
+ "properties": {
4234
+ "code": {
4235
+ "type": "string",
4236
+ "description": "Code used to categorize the error"
4237
+ },
4238
+ "detail": {
4239
+ "type": "string",
4240
+ "description": "Description of the error"
4241
+ },
4242
+ "requestId": {
4243
+ "type": "string",
4244
+ "description": "Unique request id. This one will be used to troubleshoot the problems"
4245
+ },
4246
+ "name": {
4247
+ "type": "string",
4248
+ "description": "Name of the error type"
4249
+ },
4250
+ "validation": {
4251
+ "type": "array",
4252
+ "items": {
4253
+ "type": "object",
4254
+ "required": [
4255
+ "fieldName",
4256
+ "message"
4257
+ ],
4258
+ "properties": {
4259
+ "fieldName": {
4260
+ "type": "string"
4261
+ },
4262
+ "message": {
4263
+ "type": "string"
4264
+ }
4265
+ }
4266
+ },
4267
+ "description": "List of the validation errors"
4268
+ },
4269
+ "validationContext": {
4270
+ "type": "string"
4271
+ },
4272
+ "statusCode": {
4273
+ "type": "number"
4274
+ }
4275
+ }
4276
+ }
4277
+ }
4278
+ }
4279
+ },
4280
+ "500": {
4281
+ "description": "Default Response",
4282
+ "content": {
4283
+ "application/json": {
4284
+ "schema": {
4285
+ "type": "object",
4286
+ "required": [
4287
+ "code",
4288
+ "detail",
4289
+ "requestId",
4290
+ "name",
4291
+ "statusCode"
4292
+ ],
4293
+ "properties": {
4294
+ "code": {
4295
+ "type": "string",
4296
+ "description": "Code used to categorize the error"
4297
+ },
4298
+ "detail": {
4299
+ "type": "string",
4300
+ "description": "Description of the error"
4301
+ },
4302
+ "requestId": {
4303
+ "type": "string",
4304
+ "description": "Unique request id. This one will be used to troubleshoot the problems"
4305
+ },
4306
+ "name": {
4307
+ "type": "string",
4308
+ "description": "Name of the error type"
4309
+ },
4310
+ "validation": {
4311
+ "type": "array",
4312
+ "items": {
4313
+ "type": "object",
4314
+ "required": [
4315
+ "fieldName",
4316
+ "message"
4317
+ ],
4318
+ "properties": {
4319
+ "fieldName": {
4320
+ "type": "string"
4321
+ },
4322
+ "message": {
4323
+ "type": "string"
4324
+ }
4325
+ }
4326
+ },
4327
+ "description": "List of the validation errors"
4328
+ },
4329
+ "validationContext": {
4330
+ "type": "string"
4331
+ },
4332
+ "statusCode": {
4333
+ "type": "number"
4334
+ }
4335
+ }
4336
+ }
4337
+ }
4338
+ }
4339
+ },
4340
+ "502": {
4341
+ "description": "Default Response",
4342
+ "content": {
4343
+ "application/json": {
4344
+ "schema": {
4345
+ "type": "object",
4346
+ "required": [
4347
+ "code",
4348
+ "detail",
4349
+ "requestId",
4350
+ "name",
4351
+ "statusCode"
4352
+ ],
4353
+ "properties": {
4354
+ "code": {
4355
+ "type": "string",
4356
+ "description": "Code used to categorize the error"
4357
+ },
4358
+ "detail": {
4359
+ "type": "string",
4360
+ "description": "Description of the error"
4361
+ },
4362
+ "requestId": {
4363
+ "type": "string",
4364
+ "description": "Unique request id. This one will be used to troubleshoot the problems"
4365
+ },
4366
+ "name": {
4367
+ "type": "string",
4368
+ "description": "Name of the error type"
4369
+ },
4370
+ "validation": {
4371
+ "type": "array",
4372
+ "items": {
4373
+ "type": "object",
4374
+ "required": [
4375
+ "fieldName",
4376
+ "message"
4377
+ ],
4378
+ "properties": {
4379
+ "fieldName": {
4380
+ "type": "string"
4381
+ },
4382
+ "message": {
4383
+ "type": "string"
4384
+ }
4385
+ }
4386
+ },
4387
+ "description": "List of the validation errors"
4388
+ },
4389
+ "validationContext": {
4390
+ "type": "string"
4391
+ },
4392
+ "statusCode": {
4393
+ "type": "number"
4394
+ }
4395
+ }
4396
+ }
4397
+ }
4398
+ }
4399
+ },
4400
+ "503": {
4401
+ "description": "Default Response",
4402
+ "content": {
4403
+ "application/json": {
4404
+ "schema": {
4405
+ "type": "object",
4406
+ "required": [
4407
+ "code",
4408
+ "detail",
4409
+ "requestId",
4410
+ "name",
4411
+ "statusCode"
4412
+ ],
4413
+ "properties": {
4414
+ "code": {
4415
+ "type": "string",
4416
+ "description": "Code used to categorize the error"
4417
+ },
4418
+ "detail": {
4419
+ "type": "string",
4420
+ "description": "Description of the error"
4421
+ },
4422
+ "requestId": {
4423
+ "type": "string",
4424
+ "description": "Unique request id. This one will be used to troubleshoot the problems"
4425
+ },
4426
+ "name": {
4427
+ "type": "string",
4428
+ "description": "Name of the error type"
4429
+ },
4430
+ "validation": {
4431
+ "type": "array",
4432
+ "items": {
4433
+ "type": "object",
4434
+ "required": [
4435
+ "fieldName",
4436
+ "message"
4437
+ ],
4438
+ "properties": {
4439
+ "fieldName": {
4440
+ "type": "string"
4441
+ },
4442
+ "message": {
4443
+ "type": "string"
4444
+ }
4445
+ }
4446
+ },
4447
+ "description": "List of the validation errors"
4448
+ },
4449
+ "validationContext": {
4450
+ "type": "string"
4451
+ },
4452
+ "statusCode": {
4453
+ "type": "number"
4454
+ }
4455
+ }
4456
+ }
4457
+ }
4458
+ }
4459
+ },
4460
+ "504": {
4461
+ "description": "Default Response",
4462
+ "content": {
4463
+ "application/json": {
4464
+ "schema": {
4465
+ "type": "object",
4466
+ "required": [
4467
+ "code",
4468
+ "detail",
4469
+ "requestId",
4470
+ "name",
4471
+ "statusCode"
4472
+ ],
4473
+ "properties": {
4474
+ "code": {
4475
+ "type": "string",
4476
+ "description": "Code used to categorize the error"
4477
+ },
4478
+ "detail": {
4479
+ "type": "string",
4480
+ "description": "Description of the error"
4481
+ },
4482
+ "requestId": {
4483
+ "type": "string",
4484
+ "description": "Unique request id. This one will be used to troubleshoot the problems"
4485
+ },
4486
+ "name": {
4487
+ "type": "string",
4488
+ "description": "Name of the error type"
4489
+ },
4490
+ "validation": {
4491
+ "type": "array",
4492
+ "items": {
4493
+ "type": "object",
4494
+ "required": [
4495
+ "fieldName",
4496
+ "message"
4497
+ ],
4498
+ "properties": {
4499
+ "fieldName": {
4500
+ "type": "string"
4501
+ },
4502
+ "message": {
4503
+ "type": "string"
4504
+ }
4505
+ }
4506
+ },
4507
+ "description": "List of the validation errors"
4508
+ },
4509
+ "validationContext": {
4510
+ "type": "string"
4511
+ },
4512
+ "statusCode": {
4513
+ "type": "number"
4514
+ }
4515
+ }
4516
+ }
4517
+ }
4518
+ }
4519
+ }
4520
+ }
4521
+ }
4522
+ }
4523
+ },
4524
+ "security": [
4525
+ {
4526
+ "bearerAuth": []
4527
+ }
4528
+ ],
4529
+ "tags": [
4530
+ {
4531
+ "name": "Citizens Messages",
4532
+ "description": "Citizen message read operations"
4533
+ },
4534
+ {
4535
+ "name": "Organisations Messages",
4536
+ "description": "Organisation message dispatch, consent, and event operations"
4537
+ }
4538
+ ]
4539
+ }