-
Notifications
You must be signed in to change notification settings - Fork 0
/
CustomerBill_Management.regular.swagger.json
executable file
·1659 lines (1388 loc) · 53.5 KB
/
CustomerBill_Management.regular.swagger.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
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": {
"description": "## TMF API Reference: TMF 678 - Customer bill Management\n\n### Release: 17.5 - January 2018\n\nThe Customer Bill Management API allows to find and retrieve one or several customer bills (also called invoices) produced for a customer. A customer bill is an electronic or paper document produced at the end of the billing process. The customer bill gathers and displays different items (applied customer billing rates generated during the rating and billing processes) to be charged to a customer. It represents a total amount due for all the products during the billing period and all significant information like dates, bill reference...\nThis API provides also operations to find and retrieve the details of applied customer billing rates presented on a customer bill. \nFinally, this API allows to request in real-time a customer bill creation and to manage this request.\n\n### Resources \n- customerBill\n- appliedCustomerBillingRate\n- customerBillOnDemand\n\n### Operations\nCustomer Bill Management API performs the following operations :\n- Retrieve a customer bill or a collection of customer bills depending on filter criteria.\n- Partial update of a customer bill (for administration purposes).\n- Retrieve an applied customer billing rate or a collection of applied customer billing rates depending on filter criteria.\n- Create a customer bill on demand request, retrieve one or a collection of customer bill on demand request(s) depending on filter criteria.\n\n- Manage notification of events on customer bill and customer bill on demand.\n\nCopyright © TM Forum 2018. All Rights Reserved.",
"version": "2.1",
"title": "API CustomerBill"
},
"host": "serverRoot",
"basePath": "/tmf-api/customerBillManagement/v2/",
"schemes": [
"https"
],
"consumes": [
"application/json;charset=utf-8"
],
"produces": [
"application/json;charset=utf-8"
],
"tags": [
{
"name": "customerBill",
"description": ""
},
{
"name": "appliedCustomerBillingRate",
"description": ""
},
{
"name": "CustomerBillOnDemand",
"description": ""
},
{
"name": "Hub",
"description": ""
}
],
"paths": {
"/customerBill": {
"get": {
"tags": [
"customerBill"
],
"operationId": "customerBillFind",
"summary": "List customer bills",
"description": "This operation list customer bill entities.\nAttribute selection is enabled for all first level attributes.\nFiltering may be available depending on the compliance level supported by an implementation.\n\nSpecific business errors for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n",
"deprecated": false,
"parameters": [
{
"name": "fields",
"required": false,
"in": "query",
"description": "Attribute selection",
"type": "string"
},
{
"name": "billingAccount.id",
"required": false,
"in": "query",
"description": "Example of filter criteria that can be used to find customer bills",
"type": "string"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "Requested index for start of resources to be provided in response requested by client",
"type": "integer",
"format": "int32"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Requested number of resources to be provided in response requested by client",
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/CustomerBill"
}
},
"headers": {
"X-Total-Count": {
"description": "Total number of items matching criteria",
"type": "integer",
"format": "int32"
},
"X-Result-Count": {
"description": "Actual number of items returned in the response body",
"type": "integer",
"format": "int32"
}
}
},
"400": {
"description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"404": {
"description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"405": {
"description": "Method Not Allowed\n\nList of supported error codes:\n- 61: Method not allowed",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"422": {
"description": "Unprocessable entity\n\nFunctional error",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"500": {
"description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
}
}
}
},
"/customerBill/{id}": {
"get": {
"tags": [
"customerBill"
],
"operationId": "customerBillGet",
"summary": "Retrieve a customer bill",
"description": "This operation retrieves a customer bill entity.\nAttribute selection is enabled for all first level attributes.\nFiltering on sub-resources may be available depending on the compliance level supported by an implementation.\n\nSpecific business errors for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n",
"deprecated": false,
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "fields",
"required": false,
"in": "query",
"description": "Attribute selection",
"type": "string"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/CustomerBill"
}
},
"400": {
"description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"404": {
"description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"405": {
"description": "Method Not Allowed\n\nList of supported error codes:\n- 61: Method not allowed",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"422": {
"description": "Unprocessable entity\n\nFunctional error",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"500": {
"description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
}
}
},
"patch": {
"tags": [
"customerBill"
],
"operationId": "customerBillPatch",
"summary": "Partially update a customer bill",
"description": "Note: this operation is available only to ADMIN API users. The PATCH Bill operation is optional. An implementation is not required to support PATCH to be compliant with the standard.\nThis operation allows partial updates of a customer bill entity.\nOnly state attribute is patchable.\nThis operation allows partial updates of a customer bill entity. Support of json/merge (https://tools.ietf.org/html/rfc7386) is mandatory, support of json/patch (http://tools.ietf.org/html/rfc5789) is optional.\n\nSpecific business errors for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n",
"deprecated": false,
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "customerBill",
"required": true,
"in": "body",
"description": "",
"schema": {
"$ref": "#/definitions/CustomerBillUpdate"
}
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/CustomerBill"
}
},
"400": {
"description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"404": {
"description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"405": {
"description": "Method Not Allowed\n\nList of supported error codes:\n- 61: Method not allowed",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"422": {
"description": "Unprocessable entity\n\nFunctional error",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"500": {
"description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
}
}
}
},
"/appliedCustomerBillingRate": {
"get": {
"tags": [
"appliedCustomerBillingRate"
],
"operationId": "appliedCustomerBillingRateFind",
"summary": "List applied customer billing rates",
"description": "This operation list applied customer billing rate entities.\nAttribute selection is enabled for all first level attributes.\nFiltering may be available depending on the compliance level supported by an implementation.\n\nSpecific business errors for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n",
"deprecated": false,
"parameters": [
{
"name": "fields",
"required": false,
"in": "query",
"description": "Attribute selection",
"type": "string"
},
{
"name": "bill.id",
"required": false,
"in": "query",
"description": "Example of a filter criteria that can be used to find applied customer billing rates",
"type": "string"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "Requested index for start of resources to be provided in response requested by client",
"type": "integer",
"format": "int32"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Requested number of resources to be provided in response requested by client",
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/AppliedCustomerBillingRate"
}
},
"headers": {
"X-Total-Count": {
"description": "Total number of items matching criteria",
"type": "integer",
"format": "int32"
},
"X-Result-Count": {
"description": "Actual number of items returned in the response body",
"type": "integer",
"format": "int32"
}
}
},
"400": {
"description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"404": {
"description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"405": {
"description": "Method Not Allowed\n\nList of supported error codes:\n- 61: Method not allowed",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"422": {
"description": "Unprocessable entity\n\nFunctional error",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"500": {
"description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
}
}
}
},
"/appliedCustomerBillingRate/{id}": {
"get": {
"tags": [
"appliedCustomerBillingRate"
],
"operationId": "appliedCustomerBillingRateGet",
"summary": "Retrieve an applied customer billing rate",
"description": "This operation retrieves an applied customer billing rate entity.\nAttribute selection is enabled for all first level attributes.\nFiltering on sub-resources may be available depending on the compliance level supported by an implementation.\n\nSpecific business errors for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n",
"deprecated": false,
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "fields",
"required": false,
"in": "query",
"description": "Attribute selection",
"type": "string"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/AppliedCustomerBillingRate"
}
},
"400": {
"description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"404": {
"description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"405": {
"description": "Method Not Allowed\n\nList of supported error codes:\n- 61: Method not allowed",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"422": {
"description": "Unprocessable entity\n\nFunctional error",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"500": {
"description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
}
}
}
},
"/customerBillOnDemand": {
"post": {
"tags": [
"CustomerBillOnDemand"
],
"operationId": "customerBillOnDemandCreate",
"summary": "Create a customer bill on demand",
"description": "This operation creates a customer bill on demand entity.\n\nSpecific business errors for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n",
"deprecated": false,
"parameters": [
{
"name": "CustomerBillOnDemand",
"required": true,
"in": "body",
"description": "",
"schema": {
"$ref": "#/definitions/CustomerBillOnDemandRequest"
}
}
],
"responses": {
"201": {
"description": "Success",
"schema": {
"$ref": "#/definitions/CustomerBillOnDemand"
}
},
"400": {
"description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"404": {
"description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"405": {
"description": "Method Not Allowed\n\nList of supported error codes:\n- 61: Method not allowed",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"422": {
"description": "Unprocessable entity\n\nFunctional error",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"500": {
"description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
}
}
},
"get": {
"tags": [
"CustomerBillOnDemand"
],
"operationId": "customerBillOnDemandFind",
"summary": "Retrieve customer bill on demand with filter criteria",
"description": "This operation list customer bill on demand entities.\nAttribute selection is enabled for all first level attributes.\nFiltering may be available depending on the compliance level supported by an implementation.\n\nSpecific business errors for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n",
"deprecated": false,
"parameters": [
{
"name": "fields",
"required": false,
"in": "query",
"description": "Attribute selection",
"type": "string"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "Requested index for start of resources to be provided in response requested by client",
"type": "integer",
"format": "int32"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Requested number of resources to be provided in response requested by client",
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/CustomerBillOnDemand"
}
},
"headers": {
"X-Total-Count": {
"description": "Total number of items matching criteria",
"type": "integer",
"format": "int32"
},
"X-Result-Count": {
"description": "Actual number of items returned in the response body",
"type": "integer",
"format": "int32"
}
}
},
"400": {
"description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"404": {
"description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"405": {
"description": "Method Not Allowed\n\nList of supported error codes:\n- 61: Method not allowed",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"422": {
"description": "Unprocessable entity\n\nFunctional error",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"500": {
"description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
}
}
}
},
"/customerBillOnDemand/{id}": {
"get": {
"tags": [
"CustomerBillOnDemand"
],
"operationId": "customerBillOnDemandGet",
"summary": "Retrieve a customer bill on demand with its id",
"description": "This operation retrieves a customer bill on demand entity.\nAttribute selection is enabled for all first level attributes.\nFiltering on sub-resources may be available depending on the compliance level supported by an implementation.\n\nSpecific business errors for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n",
"deprecated": false,
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "fields",
"required": false,
"in": "query",
"description": "Attribute selection",
"type": "string"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/CustomerBillOnDemand"
}
},
"400": {
"description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"404": {
"description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"405": {
"description": "Method Not Allowed\n\nList of supported error codes:\n- 61: Method not allowed",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"422": {
"description": "Unprocessable entity\n\nFunctional error",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"500": {
"description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
}
}
}
},
"/hub": {
"post": {
"tags": [
"Hub"
],
"operationId": "hubCreate",
"summary": "Register a listener",
"description": "Sets the communication endpoint address the service instance must use to deliver information about its health state, execution state, failures and metrics\n\nSpecific business errors for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n",
"deprecated": false,
"parameters": [
{
"name": "Hub",
"required": true,
"in": "body",
"description": "",
"schema": {
"$ref": "#/definitions/HubInput"
}
}
],
"responses": {
"201": {
"description": "Success",
"schema": {
"$ref": "#/definitions/Hub"
}
},
"400": {
"description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"404": {
"description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"405": {
"description": "Method Not Allowed\n\nList of supported error codes:\n- 61: Method not allowed",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"422": {
"description": "Unprocessable entity\n\nFunctional error",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"500": {
"description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
}
}
}
},
"/hub/{hubId}": {
"delete": {
"tags": [
"Hub"
],
"operationId": "hubDelete",
"summary": "Unregister a listener",
"description": "Clears the communication endpoint address that was set by creating the Hub\n\nSpecific business errors for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n",
"deprecated": false,
"parameters": [
{
"name": "hubId",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"404": {
"description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"405": {
"description": "Method Not Allowed\n\nList of supported error codes:\n- 61: Method not allowed",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"422": {
"description": "Unprocessable entity\n\nFunctional error",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"500": {
"description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
}
}
}
}
},
"definitions": {
"stateValue": {
"description": "",
"type": "string",
"enum": [
"new",
"onHold",
"validated",
"sent",
"partiallyPaid",
"settled"
]
},
"StateValues": {
"description": "",
"type": "string",
"enum": [
"inProgress",
"rejected",
"done",
"terminatedWithError"]
},
"ErrorRepresentation": {
"description": "Standard tmf error representation",
"required": [
"code",
"message"
],
"type": "object",
"properties": {
"code": {
"description": "Application related code (as defined in the API or from a common list)",
"type": "integer",
"format": "int32"
},
"reason": {
"description": "Text that explains the reason for error. This can be shown to a client user.",
"type": "string"
},
"message": {
"description": "Text that provides more details and corrective actions related to the error. This can be shown to a client user.",
"type": "string"
},
"status": {
"description": "http error code extension like 400-2",
"type": "string"
},
"referenceError": {
"description": "url pointing to documentation describing the error",
"type": "string"
},
"@type": {
"description": "Indicates the type of resource",
"type": "string"
},
"@schemaLocation": {
"description": "Link to schema describing this REST resource",
"type": "string"
}
}
},
"CustomerBill": {
"description": "The billing account receives all charges (recurring, one time and usage) of the offers and products assigned to it during order process. Periodically according to billing cycle specifications attached to the billing account or as a result of an event, a customer bill (aka invoice) is produced. This customer bill concerns different related parties which play a role on it : for example, a customer bill is produced by an operator, is sent to a bill receiver and has to be paid by a payer.\nA payment method could be assigned to the customer bill to build the call of payment. Lettering process enables to assign automatically or manually incoming amount from payments to customer bills (payment items).\nA tax item is created for each tax rate used in the customer bill.\nThe financial account represents a financial entity which records all customer’s accounting events : payment amount are recorded as credit and invoices amount are recorded as debit. It gives the customer overall balance (account balance).\nThe customer bill is linked to one or more documents that can be downloaded via a provided url.",
"type": "object",
"properties": {
"id": {
"description": "Unique identifier of he bill",
"type": "string"
},
"href": {
"description": "Bill unique reference",
"type": "string"
},
"billNo": {
"description": "Bill reference known by the customer or the party and displayed on the bill. Could be different from the id",
"type": "string"
},
"runType": {
"description": "onCycle (a bill can be created as a result of a cycle run) or offCycle (a bill can be created as a result of other events such as customer request or account close)",
"type": "string"
},
"category": {
"description": "Category of the bill produced : normal, duplicate, interim, last, trial customer or credit note for example",
"type": "string"
},
"state": {
"$ref": "#/definitions/stateValue"