-
Notifications
You must be signed in to change notification settings - Fork 24
/
api_backend.yaml
1572 lines (1571 loc) · 59.3 KB
/
api_backend.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
swagger: "2.0"
info:
version: 1.0.0
title: Proxy API
description: Mobile and web proxy API gateway.
host: localhost
basePath: /api/v1
schemes:
- https
security:
- Bearer: []
paths:
"/services/{service_id}":
x-swagger-router-controller: ServicesController
parameters:
- in: path
name: service_id
required: true
description: The ID of an existing Service.
type: string
get:
operationId: getService
summary: Get Service
description: A previously created service with the provided service ID is returned.
responses:
'200':
description: Service found.
schema:
"$ref": "#/definitions/ServicePublic"
examples:
application/json:
department_name: "IO"
organization_fiscal_code: "00000000000"
organization_name: "IO"
service_id: "5a563817fcc896087002ea46c49a"
service_name: "App IO"
version: 1
"400":
description: Bad request
schema:
$ref: "#/definitions/ProblemJson"
"401":
description: Bearer token null or expired.
"404":
description: No service found for the provided ID.
schema:
$ref: "#/definitions/ProblemJson"
"429":
description: Too many requests
schema:
$ref: "#/definitions/ProblemJson"
"500":
description: There was an error in retrieving the service.
schema:
$ref: "#/definitions/ProblemJson"
parameters: []
"/services/{service_id}/preferences":
post:
operationId: upsertServicePreferences
summary: UpsertServicePreferences
parameters:
- in: path
name: service_id
required: true
description: The ID of an existing Service.
type: string
- in: body
name: body
schema:
$ref: "#/definitions/UpsertServicePreference"
responses:
"200":
description: Service Preference found.
schema:
"$ref": "#/definitions/ServicePreference"
examples:
application/json:
can_access_message_read_status: true
is_inbox_enabled: true
is_email_enabled: false
is_webhook_enabled: true
settings_version: 1
"400":
description: Bad request
schema:
$ref: "#/definitions/ProblemJson"
"401":
description: Unauthorized
"404":
description: No service found for the provided ID.
"409":
description: |-
Conflict. Either the provided preference setting version is not consistent with the current version stored in the Profile
or the Profile is not in the correct preference mode.
"429":
description: Too many requests
"500":
description: Internal Server Error
get:
operationId: getServicePreferences
summary: GetServicePreferences
parameters:
- name: service_id
in: path
type: string
required: true
description: The ID of an existing Service.
responses:
"200":
description: Service Preference found.
schema:
"$ref": "#/definitions/ServicePreference"
examples:
application/json:
can_access_message_read_status: true
is_inbox_enabled: true
is_email_enabled: false
is_webhook_enabled: true
settings_version: 1
"400":
description: Bad request
schema:
$ref: "#/definitions/ProblemJson"
"401":
description: Unauthorized
"404":
description: No service found for the provided ID.
"409":
description: Conflict. The Profile is not in the correct preference mode.
"429":
description: Too many requests
"500":
description: Internal Server Error
"/services":
x-swagger-router-controller: ServicesController
get:
operationId: getVisibleServices
summary: Get all visible services
description: |-
Returns the description of all visible services.
responses:
"200":
description: Found.
schema:
$ref: "#/definitions/PaginatedServiceTupleCollection"
examples:
application/json:
items:
- service_id: "AzureDeployc49a"
version: 1
- service_id: "5a25abf4fcc89605c082f042c49a"
version: 0
page_size: 1
"401":
description: Bearer token null or expired.
"429":
description: Too many requests
schema:
$ref: "#/definitions/ProblemJson"
"500":
description: There was an error in retrieving the services.
schema:
$ref: "#/definitions/ProblemJson"
parameters:
- $ref: "#/parameters/PaginationRequest"
"/messages":
x-swagger-router-controller: MessagesController
parameters:
- $ref: "#/parameters/PageSize"
- $ref: "#/parameters/EnrichResultData"
- $ref: "#/parameters/GetArchivedMessages"
- $ref: "#/parameters/MaximumId"
- $ref: "#/parameters/MinimumId"
get:
operationId: getUserMessages
summary: Get user's messages
description: |-
Returns the messages for the user identified by the provided fiscal code.
Messages will be returned in inverse acceptance order (from last to first).
The "next" field, when present, contains an URL pointing to the next page of results.
responses:
"200":
description: Found.
schema:
$ref: "#/definitions/PaginatedPublicMessagesCollection"
examples:
application/json:
items:
- created_at: "2018-05-21T07:36:41.209Z"
fiscal_code: "LSSLCU79B24L219P"
id: "01CE0T1Z18T3NT9ECK5NJ09YR3"
sender_service_id: "5a563817fcc896087002ea46c49a"
time_to_live: 3600
- created_at: "2018-05-21T07:41:01.361Z"
fiscal_code: "LSSLCU79B24L219P"
id: "01CE0T9X1HT595GEF8FH9NRSW7"
sender_service_id: "5a563817fcc896087002ea46c49a"
time_to_live: 3600
next: 01CE0T9X1HT595GEF8FH9NRSW7
"400":
description: Bad request
schema:
$ref: "#/definitions/ProblemJson"
"401":
description: Bearer token null or expired.
"404":
description: No message found.
schema:
$ref: "#/definitions/ProblemJson"
"429":
description: Too many requests
schema:
$ref: "#/definitions/ProblemJson"
"500":
description: There was an error in retrieving the messages.
schema:
$ref: "#/definitions/ProblemJson"
"/messages/{id}":
x-swagger-router-controller: MessagesController
parameters:
- $ref: "#/parameters/MessageId"
- $ref: "#/parameters/PublicMessage"
get:
operationId: getUserMessage
summary: Get message
description: |-
Returns the message with the provided message ID.
responses:
"200":
description: Found.
schema:
$ref: "#/definitions/CreatedMessageWithContentAndAttachments"
examples:
application/json: |
content: {
markdown: "hey hey !! <a style=\"color: red\" href=\"http://example.com\"> some content here ..... this is a link with a style applied, some other content</a>",
subject: "my subject ............",
attachments: [{name:"attachment", content:"aBase64Encoding", mime_type: "image/png"}]
},
created_at: "2018-06-06T12:22:24.523Z",
fiscal_code: "LSSLCU79B24L219P",
id: "01CFAGRMGB9XCA8B2CQ4QA7K76",
sender_service_id: "5a25abf4fcc89605c082f042c49a",
time_to_live: 3600
"400":
description: Bad request
schema:
$ref: "#/definitions/ProblemJson"
"401":
description: Bearer token null or expired.
"404":
description: No message found for the provided ID.
schema:
$ref: "#/definitions/ProblemJson"
"429":
description: Too many requests
schema:
$ref: "#/definitions/ProblemJson"
"500":
description: There was an error in retrieving the message.
schema:
$ref: "#/definitions/ProblemJson"
"/messages/{id}/message-status":
x-swagger-router-controller: MessagesController
put:
operationId: upsertMessageStatusAttributes
summary: UpsertMessageStatusAttributes
description: Updates the status of a message with attributes
parameters:
- $ref: "#/parameters/MessageId"
- name: body
in: body
schema:
$ref: "#/definitions/MessageStatusChange"
required: true
x-examples:
application/json: |
change_type: "bulk",
is_archived: true,
is_read: true
responses:
"200":
description: Success.
schema:
$ref: "#/definitions/MessageStatusAttributes"
examples:
application/json:
is_read: true,
is_archived: false
"400":
description: Bad request
schema:
$ref: "#/definitions/ProblemJson"
"401":
description: Bearer token null or expired.
"403":
description: Operation forbidden.
"404":
description: No message found for the provided ID.
schema:
$ref: "#/definitions/ProblemJson"
"429":
description: Too many requests
schema:
$ref: "#/definitions/ProblemJson"
"500":
description: There was an error in upserting message's status attributes.
schema:
$ref: "#/definitions/ProblemJson"
"/third-party-messages/{id}":
x-swagger-router-controller: MessagesController
get:
operationId: getThirdPartyMessage
summary: Retrieve Third Party message
description: |-
Returns the Third Party message with the provided message ID.
parameters:
- $ref: "#/parameters/MessageId"
responses:
"200":
description: Found.
schema:
$ref: "#/definitions/ThirdPartyMessageWithContent"
examples:
text/json: |
content: {
markdown: "hey hey !! <a style=\"color: red\" href=\"http://example.com\"> some content here ..... this is a link with a style applied, some other content</a>",
subject: "my subject ............",
third_party_data: [{id: "aThirdPartyMessageId"}]
},
third_party_message: {
attachments: [],
custom_property: "a custom property"
},
created_at: "2018-06-06T12:22:24.523Z",
fiscal_code: "LSSLCU79B24L219P",
id: "01CFAGRMGB9XCA8B2CQ4QA7K76",
sender_service_id: "5a25abf4fcc89605c082f042c49a",
time_to_live: 3600
"400":
description: Bad request
schema:
$ref: "#/definitions/ProblemJson"
"401":
description: Bearer token null or expired.
"403":
description: Forbidden
"404":
description: No message found for the provided ID.
schema:
$ref: "#/definitions/ProblemJson"
"410":
description: Third Party Service no longer available
"429":
description: Too many requests
schema:
$ref: "#/definitions/ProblemJson"
"500":
description: There was an error in retrieving the message.
schema:
$ref: "#/definitions/ProblemJson"
'501':
description: Not Implemented
'502':
description: Bad Gateway
schema:
$ref: "#/definitions/ProblemJson"
'504':
description: Gateway Timeout
"/third-party-messages/{id}/attachments/{attachment_url}":
x-swagger-router-controller: MessagesController
get:
operationId: getThirdPartyMessageAttachment
summary: Retrieve an attachment of a Thrid Party message
produces:
- application/octet-stream
parameters:
- $ref: "#/parameters/MessageId"
- in: path
name: attachment_url
type: string
minLength: 1
required: true
responses:
"200":
description: Success
schema:
format: binary
type: string
"400":
description: Bad Request
"401":
description: Unauthorized
"403":
description: Forbidden
"404":
description: No message found for the provided ID.
schema:
$ref: "#/definitions/ProblemJson"
"410":
description: Third Party Service no longer available
"415":
description: Unsupported Media TYPE - File Format Validation Error
"429":
description: Too Many Requests
"500":
description: Internal Server Error
'501':
description: Not Implemented
'504':
description: Gateway Timeout
"/third-party-messages/{id}/precondition":
x-swagger-router-controller: MessagesController
get:
operationId: getThirdPartyMessagePrecondition
summary: Retrieve Third Party message precondition to receive the third party content
description: |-
Returns the Third Party message precondition associated to the provided message ID to receive the third party content.
parameters:
- $ref: "#/parameters/MessageId"
responses:
"200":
description: Found.
schema:
$ref: "#/definitions/ThirdPartyMessagePrecondition"
examples:
text/json: |
"title": "Questo messaggio contiene una comunicazione a valore legale",
"markdown": "Se continui, la notifica risulterà legalmente recapitata a te. Aprire il messaggio su IO equivale infatti a firmare la ricevuta di ritorno di una raccomandata tradizionale.\n**Mittente**: Comune di Xxxxxxx \n**Oggetto**: Infrazione al codice della strada \n**Data e ora**: 12 Luglio 2022 - 12.36 \n**Codice IUN**: YYYYMM-1-ABCD-EFGH-X"
"204":
description: Pre conditions not needed
"400":
description: Bad request
schema:
$ref: "#/definitions/ProblemJson"
"401":
description: Bearer token null or expired.
"403":
description: Forbidden
"404":
description: No message found for the provided ID.
schema:
$ref: "#/definitions/ProblemJson"
"410":
description: Third Party Service no longer available
"429":
description: Too many requests
schema:
$ref: "#/definitions/ProblemJson"
"500":
description: There was an error in retrieving the message.
schema:
$ref: "#/definitions/ProblemJson"
'501':
description: Not Implemented
'504':
description: Gateway Timeout
"/profile":
x-swagger-router-controller: ProfileController
get:
operationId: getUserProfile
summary: Get user's profile
description: Returns the profile for the user identified by the provided fiscal code.
responses:
"200":
description: Found.
schema:
$ref: "#/definitions/InitializedProfile"
examples:
application/json:
email: "email@example.com"
family_name: "Rossi"
fiscal_code: "TMMEXQ60A10Y526X"
has_profile: true
is_email_set: true
is_inbox_enabled: true
is_webhook_enabled: true
is_email_validated: true
is_email_already_taken: false
name: "Mario"
spid_email: "preferred@example.com"
service_preferences_settings:
- mode: LEGACY
version: 1
"400":
description: Bad request
schema:
$ref: "#/definitions/ProblemJson"
"401":
description: Bearer token null or expired.
"429":
description: Too many requests
schema:
$ref: "#/definitions/ProblemJson"
"500":
description: There was an error in retrieving the user profile.
schema:
$ref: "#/definitions/ProblemJson"
post:
operationId: updateProfile
summary: Update the User's profile
description: Update the profile for the user identified by the provided fiscal code.
parameters:
- in: body
name: body
schema:
$ref: "#/definitions/Profile"
required: true
x-examples:
application/json:
email: foobar@example.com
preferred_languages: [ it_IT ]
is_inbox_enabled: true
is_webhook_enabled: false
version: 1
responses:
'200':
description: Profile updated.
schema:
$ref: "#/definitions/InitializedProfile"
examples:
application/json:
email: "email@example.com"
family_name: "Rossi"
fiscal_code: "TMMEXQ60A10Y526X"
has_profile: true
is_email_set: true
is_inbox_enabled: true
is_webhook_enabled: true
is_email_validated: true
is_email_already_taken: false
name: "Mario"
spid_email: "preferred@example.com"
version: 0
"400":
description: Invalid payload.
schema:
$ref: "#/definitions/ProblemJson"
"401":
description: Bearer token null or expired.
"404":
description: User not found
schema:
$ref: "#/definitions/ProblemJson"
"409":
description: Conflict.
schema:
$ref: "#/definitions/ProblemJson"
"412":
description: Precondition Failed
schema:
$ref: "#/definitions/ProblemJson"
"429":
description: Too many requests
schema:
$ref: "#/definitions/ProblemJson"
"500":
description: Profile cannot be updated.
schema:
$ref: "#/definitions/ProblemJson"
"/api-profile":
x-swagger-router-controller: ProfileController
get:
operationId: getApiUserProfile
summary: Get user's profile stored into the API
description: Returns the profile for the user identified by the provided fiscal code.
responses:
"200":
description: Found.
schema:
$ref: "#/definitions/ExtendedProfile"
examples:
application/json:
email: "email@example.com"
preferred_languages: ["it_IT"]
is_inbox_enabled: true
accepted_tos_version: 1
is_webhook_enabled: true
is_email_enabled: true
is_email_validated: true
is_email_already_taken: false
version: 1
sender_allowed: true
"400":
description: Bad request
schema:
$ref: "#/definitions/ProblemJson"
"401":
description: Bearer token null or expired.
"404":
description: Profile not found
schema:
$ref: "#/definitions/ProblemJson"
"429":
description: Too many requests
schema:
$ref: "#/definitions/ProblemJson"
"500":
description: There was an error in retrieving the user profile.
schema:
$ref: "#/definitions/ProblemJson"
"/email-validation-process":
x-swagger-router-controller: ProfileController
post:
operationId: startEmailValidationProcess
summary: Start the Email Validation Process
description: |-
Start the email validation process that create the validation token
and send the validation email
responses:
"202":
description: Accepted
"400":
description: Bad request
schema:
$ref: "#/definitions/ProblemJson"
"401":
description: Bearer token null or expired.
"404":
description: Profile not found
schema:
$ref: "#/definitions/ProblemJson"
"429":
description: Too many requests
schema:
$ref: "#/definitions/ProblemJson"
"500":
description: There was an error starting email validation process
schema:
$ref: "#/definitions/ProblemJson"
"/user-metadata":
x-swagger-router-controller: userMetadataController
get:
operationId: getUserMetadata
summary: Get user's metadata
description: Returns metadata for the current authenticated user.
responses:
"200":
description: Found.
schema:
$ref: "#/definitions/UserMetadata"
"204":
description: No Content.
"401":
description: Bearer token null or expired.
"500":
description: There was an error in retrieving the user metadata.
schema:
$ref: "#/definitions/ProblemJson"
post:
operationId: upsertUserMetadata
summary: Set User's metadata
description: Create or update metadata for the current authenticated user.
parameters:
- in: body
name: body
schema:
$ref: "#/definitions/UserMetadata"
required: true
responses:
'200':
description: User Metadata updated.
schema:
$ref: "#/definitions/UserMetadata"
"400":
description: Invalid payload.
schema:
$ref: "#/definitions/ProblemJson"
"401":
description: Bearer token null or expired.
"409":
description: Conflict.
schema:
$ref: "#/definitions/ProblemJson"
"500":
description: Profile cannot be updated.
schema:
$ref: "#/definitions/ProblemJson"
"/installations/{installationID}":
x-swagger-router-controller: NotificationController
parameters:
- name: installationID
in: path
required: true
description: The ID of the message.
type: string
put:
operationId: createOrUpdateInstallation
summary: Create or update an Installation
description: Create or update an Installation to the Azure Notification hub.
parameters:
- name: body
in: body
schema:
$ref: "#/definitions/Installation"
required: true
x-examples:
application/json:
platform: "gcm"
pushChannel: "push-notification-service-handle"
responses:
"200":
description: Success.
schema:
$ref: "#/definitions/SuccessResponse"
examples:
application/json:
"message": "ok"
"401":
description: Bearer token null or expired.
"500":
description: There was an error in registering the device to the Notification Hub.
schema:
$ref: "#/definitions/ProblemJson"
"/session":
x-swagger-router-controller: AuthenticationController
get:
operationId: getSessionState
summary: Get the user current session
description: Return the session state for the current authenticated user.
responses:
"200":
description: Found.
schema:
$ref: "#/definitions/PublicSession"
examples:
application/json:
spidLevel: "https://www.spid.gov.it/SpidL2"
walletToken: "c77de47586c841adbd1a1caeb90dce25dcecebed620488a4f932a6280b10ee99a77b6c494a8a6e6884ccbeb6d3fe736b"
"400":
description: Bad request
schema:
$ref: "#/definitions/ProblemJson"
"401":
description: Bearer token null or expired.
"500":
description: Internal server error
schema:
$ref: "#/definitions/ProblemJson"
"/sessions":
x-swagger-router-controller: AuthenticationController
get:
operationId: listUserSessions
summary: List sessions of a User
description: Return all the active sessions for an authenticated User.
responses:
"200":
description: Found.
schema:
$ref: "#/definitions/SessionsList"
"400":
description: Bad request
schema:
$ref: "#/definitions/ProblemJson"
"401":
description: Bearer token null or expired.
"500":
description: Unavailable service
schema:
$ref: "#/definitions/ProblemJson"
"/token/support":
x-swagger-router-controller: SupportController
get:
operationId: getSupportToken
summary: Get a JWT Support Token
description: Return a JWT Support Token for the authenticated user.
responses:
"200":
description: Created.
schema:
$ref: "#/definitions/SupportToken"
"400":
description: Bad request
schema:
$ref: "#/definitions/ProblemJson"
"401":
description: Bearer token null or expired.
"500":
description: Unavailable service
schema:
$ref: "#/definitions/ProblemJson"
"/payment-requests/{rptId}":
x-swagger-router-controller: PagoPAProxyController
parameters:
- name: rptId
in: path
required: true
description: Unique identifier for payments.
type: string
- name: test
in: query
description: Use test environment of PagoPAClient
type: boolean
required: false
get:
operationId: getPaymentInfo
summary: Get Payment Info
description: Retrieve information about a payment
responses:
"200":
description: Payment information retrieved
schema:
"$ref": "#/definitions/PaymentRequestsGetResponse"
examples:
application/json:
importoSingoloVersamento: 200,
codiceContestoPagamento: "ABC123"
"400":
description: Bad request
schema:
$ref: "#/definitions/ProblemJson"
"401":
description: Bearer token null or expired.
"500":
description: PagoPA services are not available or request is rejected
schema:
$ref: "#/definitions/PaymentProblemJson"
"504":
description: gateway timeout.
schema:
$ref: "#/definitions/PaymentProblemJson"
"/payment-activations":
x-swagger-router-controller: PagoPAProxyController
parameters:
- name: test
in: query
description: Use test environment of PagoPAClient
type: boolean
required: false
post:
operationId: activatePayment
summary: Activate Payment
description: Require a lock (activation) for a payment
parameters:
- in: body
name: body
schema:
$ref: "#/definitions/PaymentActivationsPostRequest"
required: true
x-examples:
application/json:
rptId: "12345678901012123456789012345"
importoSingoloVersamento: 200
codiceContestoPagamento: "ABC123"
responses:
"200":
description: Payment activation process started
schema:
"$ref": "#/definitions/PaymentActivationsPostResponse"
examples:
application/json:
importoSingoloVersamento: 200
"400":
description: Bad request
schema:
$ref: "#/definitions/ProblemJson"
"401":
description: Bearer token null or expired.
"500":
description: PagoPA services are not available or request is rejected
schema:
$ref: "#/definitions/PaymentProblemJson"
"504":
description: gateway timeout.
schema:
$ref: "#/definitions/PaymentProblemJson"
"/payment-activations/{codiceContestoPagamento}":
x-swagger-router-controller: PagoPAProxyController
parameters:
- name: codiceContestoPagamento
in: path
required: true
description: Transaction Id used to identify the communication flow.
type: string
- name: test
in: query
description: Use test environment of PagoPAClient
type: boolean
required: false
get:
operationId: getActivationStatus
summary: Get Activation status
description: Check the activation status to retrieve the paymentId
responses:
'200':
description: Payment information
schema:
$ref: "#/definitions/PaymentActivationsGetResponse"
examples:
application/json:
idPagamento: "123455"
"400":
description: Invalid input
schema:
$ref: "#/definitions/ProblemJson"
"401":
description: Bearer token null or expired.
"404":
description: Activation status not found
schema:
$ref: "#/definitions/ProblemJson"
"500":
description: Unavailable service
schema:
$ref: "#/definitions/ProblemJson"
"/user-data-processing":
x-swagger-router-controller: UserDataProcessingController
post:
operationId: upsertUserDataProcessing
summary: Set User's data processing choices
description: Let the authenticated user express his will to retrieve or delete his stored data.
parameters:
- in: body
name: body
schema:
$ref: "#/definitions/UserDataProcessingChoiceRequest"
required: true
responses:
'200':
description: User Data processing created / updated.
schema:
$ref: "#/definitions/UserDataProcessing"
"400":
description: Invalid payload.
schema:
$ref: "#/definitions/ProblemJson"
"401":
description: Bearer token null or expired.
"409":
description: Conflict.
schema:
$ref: "#/definitions/ProblemJson"
"429":
description: Too may requests
"500":
description: User Data processing choice cannot be taken in charge.
schema:
$ref: "#/definitions/ProblemJson"
"/user-data-processing/{choice}":
x-swagger-router-controller: UserDataProcessingController
get:
operationId: getUserDataProcessing
summary: Get User's data processing
description: Get the user's request to delete or download his stored data by providing a kind of choice.
parameters:
- $ref: "#/parameters/UserDataProcessingChoiceParam"
responses:
"200":
description: User data processing retrieved
schema:
$ref: "#/definitions/UserDataProcessing"
"401":
description: Bearer token null or expired.
"404":
description: Not found.
schema:
$ref: "#/definitions/ProblemJson"
"429":
description: Too many requests
delete:
operationId: abortUserDataProcessing
summary: Abort User's revious data processing request
description: |-
Ask for a request to abort, if present
tags:
- restricted
parameters:
- $ref: "#/parameters/UserDataProcessingChoiceParam"
responses:
"202":
description: The abort request has been recorded
"400":
description: Invalid request.
schema:
$ref: "#/definitions/ProblemJson"
"401":
description: Unauthorized
"404":
description: Not Found
"409":
description: Conflict
schema:
$ref: "#/definitions/ProblemJson"
"429":
description: Too many requests
"500":
description: Server Error
schema:
$ref: "#/definitions/ProblemJson"
definitions:
# Definitions from the digital citizenship APIs
AcceptedTosVersion:
$ref: "https://raw.githubusercontent.com/pagopa/io-functions-commons/v29.1.1/openapi/definitions.yaml#/AcceptedTosVersion"
AppVersion:
$ref: "https://raw.githubusercontent.com/pagopa/io-functions-commons/v29.1.1/openapi/definitions.yaml#/AppVersion"
BlockedInboxOrChannels:
$ref: "https://raw.githubusercontent.com/pagopa/io-functions-commons/v29.1.1/openapi/definitions.yaml#/BlockedInboxOrChannels"
DepartmentName:
$ref: "https://raw.githubusercontent.com/pagopa/io-functions-commons/v29.1.1/openapi/definitions.yaml#/DepartmentName"