-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yaml
1228 lines (1228 loc) · 28.4 KB
/
openapi.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
openapi: 3.0.1
info:
title: VIA BFF
version: '1.0'
description: >
BFF to the VIA web front end
servers:
- url: 'https://internal-retail-dev.momentum.co.za/via-bff/v1'
description: Internal development server
- url: 'https://retail-dev.momentum.co.za/via-bff/v1'
description: External development server
- url: 'https://internal-retail-pre.momentum.co.za/via-bff/v1'
description: Internal pre-live server
- url: 'https://retail-pre.momentum.co.za/via-bff/v1'
description: External pre-live server
- url: 'https://internal-retail.momentum.co.za/via-bff/v1'
description: Internal production server
- url: 'https://retail.momentum.co.za/via-bff/v1'
description: External production server
security:
- CIFToken: []
tags:
- name: Client
description: All operations related to client resource
- name: Look-up
description: Operations for look-ups
paths:
'/lookup':
get:
summary: Returns the supported values for the lookups
description: Returns the supported values for the lookups
operationId: lookup
tags:
- Look-up
parameters:
- $ref: '#/components/parameters/Channel'
- $ref: '#/components/parameters/LookupTypeEnum'
- $ref: '#/components/parameters/Token'
responses:
'200':
description: Successful response and results from the service.
content:
application/json:
schema:
$ref: '#/components/schemas/ClientCount'
'400':
$ref: '#/components/responses/InvalidRequest'
'500':
$ref: '#/components/responses/GeneralError'
'504':
$ref: '#/components/responses/TimeOut'
security:
- CIFToken: []
'/total-clients':
get:
summary: Returns the total count of the clients from the respective backend
description: Calls either MC or MFP backend to get a total count of the client
operationId: totalClients
tags:
- Client
parameters:
- $ref: '#/components/parameters/Channel'
- $ref: '#/components/parameters/BrokerHouseCode'
- $ref: '#/components/parameters/BrokerCode'
- $ref: '#/components/parameters/Token'
responses:
'200':
description: Successful response and results from the service.
content:
application/json:
schema:
$ref: '#/components/schemas/ClientCount'
'400':
$ref: '#/components/responses/InvalidRequest'
'500':
$ref: '#/components/responses/GeneralError'
'504':
$ref: '#/components/responses/TimeOut'
security:
- CIFToken: []
'/clients':
get:
summary: Returns the client list from the respective backend
description: Calls either MC or MFP backend to get a client list and reformats the payload optimized for the VIA web frontend.
operationId: clientList
tags:
- Client
parameters:
- $ref: '#/components/parameters/Channel'
- $ref: '#/components/parameters/BrokerHouseCode'
- $ref: '#/components/parameters/BrokerCode'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/Limit'
responses:
'200':
description: Successful response and results from the service. <br><b><font size="2" color="red">Note:- 200 response with empty list as response body may indicate either adviser doesn't have any client or the supplied adviser codes are not valid</font></b></br>
content:
application/json:
schema:
$ref: '#/components/schemas/ClientListResponse'
'400':
$ref: '#/components/responses/InvalidRequest'
'500':
$ref: '#/components/responses/GeneralError'
'504':
$ref: '#/components/responses/TimeOut'
security:
- CIFToken: []
post:
summary: Create a client
description: Add client to MC/MFP Party store
operationId: addClient
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ClientWriteRepresentation'
tags:
- Client
parameters:
- $ref: '#/components/parameters/Token'
responses:
'201':
description: client record created successfully
headers:
Location:
schema:
type: string
format: uri
description: Location of newly created client.
content:
application/json:
schema:
$ref: '#/components/schemas/ClientReadRepresentation'
'400':
$ref: '#/components/responses/InvalidRequest'
'500':
$ref: '#/components/responses/GeneralError'
'504':
$ref: '#/components/responses/TimeOut'
security:
- CIFToken: []
'/clients/{client-id}':
get:
summary: Returns the client detail
description: Calls either MC or MFP backend to get the client detail.
operationId: getClient
tags:
- Client
parameters:
- $ref: '#/components/parameters/Channel'
- $ref: '#/components/parameters/ClientType'
- $ref: '#/components/parameters/ClientId'
- $ref: '#/components/parameters/Token'
responses:
'200':
description: Successful response and result from the respective service.
content:
application/json:
schema:
$ref: '#/components/schemas/ClientReadRepresentation'
'400':
$ref: '#/components/responses/InvalidRequest'
'500':
$ref: '#/components/responses/GeneralError'
'504':
$ref: '#/components/responses/TimeOut'
security:
- CIFToken: []
put:
summary: Update the client data
description: Calls either MC or MFP backend to update the client data
operationId: updateClient
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ClientWriteRepresentation'
tags:
- Client
parameters:
- $ref: '#/components/parameters/ClientId'
- $ref: '#/components/parameters/Token'
responses:
'200':
description: Successful response and results from the service.
content:
application/json:
schema:
$ref: '#/components/schemas/ClientCountResponse'
'400':
$ref: '#/components/responses/InvalidRequest'
'500':
$ref: '#/components/responses/GeneralError'
'504':
$ref: '#/components/responses/TimeOut'
security:
- CIFToken: []
components:
securitySchemes:
CIFToken:
type: apiKey
in: header
name: x-access-token
description: >-
Token-based authentication and authorization. This token is of the JWT
type. One can be obtained from the login resource.
parameters:
LookupTypeEnum:
name: type
in: query
required: true
description: An enumeration of lookup types
schema:
type: string
enum: [ADDRESS, CONSUMER_ROLE, CONTACT, DIGITAL, GENDER, IDENTIFICATION_NUMBER_IDENTIFIER, LANGUAGE, MARITAL_STATUS, ORGANISATION, ORGANISATION_NAME, PARTY_NAME, PARTY_ROLE, PERSON_NAME, PHONE, PHYSICAL_ADDRESS, POSTAL_ADDRESS, PREFIX, RACE, REGISTERED_IDENTIFIER, REGISTERING_AUTHORITY, SUPPLIER_ROLE, UNSTRUCTURED_ADDRESS, COUNTRY, DATE]
ClientType:
name: client-type
in: query
description: The type of client
required: true
schema:
type: string
enum: [NATURAL, JURISTIC]
ClientId:
name: client-id
in: path
description: The unique identifier of the client
required: true
schema:
type: string
Token:
name: x-access-token
in: header
description: The security token (This will override the other one generated through 'Authorize' option on top)
required: false
schema:
type: string
Channel:
name: channel
in: query
description: The channel
required: true
schema:
type: string
enum: [MC, MDS, MFP]
BrokerHouseCode:
name: brokerHouseCode
in: query
description: The brokerhouse code
required: true
schema:
type: string
BrokerCode:
name: brokerCode
in: query
description: The broker Code
required: true
schema:
type: string
Offset:
name: offset
in: query
description: The number of results to skip. This will be ignored for MDS/MFP channel.
required: false
schema:
type: integer
minimum: 0
default: 0
Limit:
name: limit
in: query
description: The number of clients to retrieve. This will be ignored for MDS/MFP channel.
required: false
schema:
type: integer
minimum: 0
default: 30
responses:
InvalidRequest:
description: Validation failed.
content:
application/json:
schema:
type: object
required:
- message
properties:
message:
type: string
referenceNumber:
type: string
errors:
type: array
items:
type: object
required:
- key
- message
properties:
key:
type: string
field:
type: string
message:
type: string
TimeOut:
description: >-
Service request timed out. This status will be returned if a source
system does not respond timely.
content:
application/json:
schema:
type: object
required:
- message
properties:
message:
type: string
referenceNumber:
type: string
errors:
type: array
items:
type: object
required:
- key
- message
properties:
key:
type: string
field:
type: string
message:
type: string
GeneralError:
description: An error occurred while processing the request
content:
application/json:
schema:
type: object
required:
- message
properties:
message:
type: string
referenceNumber:
type: string
errors:
type: array
items:
type: object
required:
- key
- message
properties:
key:
type: string
field:
type: string
message:
type: string
schemas:
ClientCountResponse:
type: object
required:
- count
properties:
count:
type: integer
ClientListResponse:
type: array
items:
anyOf:
- $ref: '#/components/schemas/NaturalClient'
- $ref: '#/components/schemas/JuristicClient'
discriminator:
propertyName: clientType
Client:
type: object
required:
- clientType
- clientKey
- relationshipType
properties:
clientType:
description: Type of client
type: string
enum: [NATURAL, JURISTIC]
relationshipType:
$ref: '#/components/schemas/RelationshipTypeEnum'
clientKey:
description: Unique key that identifies this client in the backend system
type: string
discriminator:
propertyName: clientType
NaturalClient:
allOf:
- $ref: "#/components/schemas/Client"
- type: object
properties:
firstName:
description: Firstname of the client
type: string
lastName:
description: Last name of the client
type: string
contactNumber:
description: Contact number of the client
type: string
contactEmail:
description: Email of the client
type: string
format: email
MaritalStatusEnum:
description: An enumeration of marital statuses applicable to a natural person
enum:
- SINGLE
- CIVIL_UNION_ANC_WITH_ACCRUAL
- CIVIL_UNION_ANC_NO_ACCRUAL
- CIVIL_UNION_IN_COP
- DIVORCED
- MARRIED_ANC_WITH_ACCRUAL
- MARRIED_ANC_NO_ACCRUAL
- MARRIED_IN_COP
- WIDOWED
- UNKNOWN
type: string
NationalityEnum:
description: An enumeration of nationalities applicable to a natural person
enum:
- AD
- AE
- AF
- AG
- AI
- AL
- AM
- AO
- AQ
- AR
- AS
- AT
- AU
- AW
- AX
- AZ
- BA
- BB
- BD
- BE
- BF
- BG
- BH
- BI
- BJ
- BL
- BM
- BN
- BO
- BQ
- BR
- BS
- BT
- BV
- BW
- BY
- BZ
- CA
- CC
- CD
- CF
- CG
- CH
- CI
- CK
- CL
- CM
- CN
- CO
- CR
- CU
- CV
- CW
- CX
- CY
- CZ
- DE
- DJ
- DK
- DM
- DO
- DZ
- EC
- EE
- EG
- EH
- ER
- ES
- ET
- FI
- FJ
- FK
- FM
- FO
- FR
- GA
- GB
- GD
- GE
- GF
- GG
- GH
- GI
- GL
- GM
- GN
- GP
- GQ
- GR
- GS
- GT
- GU
- GW
- GY
- HK
- HM
- HN
- HR
- HT
- HU
- ID
- IE
- IL
- IM
- IN
- IO
- IQ
- IR
- IS
- IT
- JE
- JM
- JO
- JP
- KE
- KG
- KH
- KI
- KM
- KN
- KP
- KR
- KW
- KY
- KZ
- LA
- LB
- LC
- LI
- LK
- LR
- LS
- LT
- LU
- LV
- LY
- MA
- MC
- MD
- ME
- MF
- MG
- MH
- MK
- ML
- MM
- MN
- MO
- MP
- MQ
- MR
- MS
- MT
- MU
- MV
- MW
- MX
- MY
- MZ
- NA
- NC
- NE
- NF
- NG
- NI
- NL
- 'NO'
- NP
- NR
- NU
- NZ
- OM
- PA
- PE
- PF
- PG
- PH
- PK
- PL
- PM
- PN
- PR
- PS
- PT
- PW
- PY
- QA
- RE
- RO
- RS
- RU
- RW
- SA
- SB
- SC
- SD
- SE
- SG
- SH
- SI
- SJ
- SK
- SL
- SM
- SN
- SO
- SR
- SS
- ST
- SV
- SX
- SY
- SZ
- TC
- TD
- TF
- TG
- TH
- TJ
- TK
- TL
- TM
- TN
- TO
- TR
- TT
- TV
- TW
- TZ
- UA
- UG
- UM
- US
- UY
- UZ
- VA
- VC
- VE
- VG
- VI
- VN
- VU
- WF
- WS
- YE
- YT
- ZA
- ZM
- ZW
type: string
GenderEnum:
description: An enumeration of genders applicable to a natural person
enum:
- FEMALE
- MALE
- UNKNOWN
type: string
ClientTypeEnum:
description: An enumeration of client type
enum:
- NATURAL
- JURISTIC
type: string
ChannelEnum:
description: An enumeration of supported channel
enum:
- MC
- MDS
- MFP
type: string
RelationshipTypeEnum:
description: An enumeration of relationship types
enum:
- CLIENT
- PROSPECTS
type: string
ContextTypeEnum:
description: An enumeration of supported context type
enum:
- CDB
type: string
RaceEnum:
description: An enumeration of races applicable to a natural person
enum:
- BLACK
- WHITE
- COLOURED
- INDIAN
- ASIAN
- OTHER
- UNKNOWN
type: string
PrefixEnum:
description: An enumeration of prefixes applicable to a natural person
enum:
- ADVOCATE
- DOCTOR
- MISS
- MS
- MR
- MRS
- PROFESSOR
- UNKNOWN
type: string
RegisteringAuthorityEnum:
description: An enumeration of valid registering authorities
enum:
- HOME_AFFAIRS
- MOMENTUM_CONSULT
type: string
JuristicPersonRegisteredIdentifierEnum:
description: An enumeration of valid registered identifiers applicable to a juristic person
enum:
- ID
- REGISTRATION_NUMBER
- UNIQUE
type: string
CountryEnum:
description: An enumeration of two letter country codes
enum:
- AD
- AE
- AF
- AG
- AI
- AL
- AM
- AO
- AQ
- AR
- AS
- AT
- AU
- AW
- AX
- AZ
- BA
- BB
- BD
- BE
- BF
- BG
- BH
- BI
- BJ
- BL
- BM
- BN
- BO
- BQ
- BR
- BS
- BT
- BV
- BW
- BY
- BZ
- CA
- CC
- CD
- CF
- CG
- CH
- CI
- CK
- CL
- CM
- CN
- CO
- CR
- CU
- CV
- CW
- CX
- CY
- CZ
- DE
- DJ
- DK
- DM
- DO
- DZ
- EC
- EE
- EG
- EH
- ER
- ES
- ET
- FI
- FJ
- FK
- FM
- FO
- FR
- GA
- GB
- GD
- GE
- GF
- GG
- GH
- GI
- GL
- GM
- GN
- GP
- GQ
- GR
- GS
- GT
- GU
- GW
- GY
- HK
- HM
- HN
- HR
- HT
- HU
- ID
- IE
- IL
- IM
- IN
- IO
- IQ
- IR
- IS
- IT
- JE
- JM
- JO
- JP
- KE
- KG
- KH
- KI
- KM
- KN
- KP
- KR
- KW
- KY
- KZ
- LA
- LB
- LC
- LI
- LK
- LR
- LS
- LT
- LU
- LV
- LY
- MA
- MC
- MD
- ME
- MF
- MG
- MH
- MK
- ML
- MM
- MN
- MO
- MP
- MQ
- MR
- MS
- MT
- MU
- MV
- MW
- MX
- MY
- MZ
- NA
- NC
- NE
- NF
- NG
- NI
- NL
- 'NO'
- NP
- NR
- NU
- NZ
- OM
- PA
- PE
- PF
- PG
- PH
- PK
- PL
- PM
- PN
- PR
- PS
- PT
- PW
- PY
- QA
- RE
- RO
- RS
- RU
- RW
- SA
- SB
- SC
- SD
- SE
- SG
- SH
- SI
- SJ
- SK
- SL
- SM
- SN
- SO
- SR
- SS
- ST
- SV
- SX
- SY
- SZ
- TC
- TD
- TF
- TG
- TH
- TJ
- TK
- TL
- TM
- TN
- TO
- TR
- TT
- TV
- TW
- TZ
- UA
- UG
- UM
- US
- UY
- UZ
- VA
- VC
- VE
- VG
- VI
- VN
- VU
- WF
- WS
- YE
- YT
- ZA