-
Notifications
You must be signed in to change notification settings - Fork 0
/
demo.json
1192 lines (1192 loc) · 43.7 KB
/
demo.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
{
"openapi": "3.0.3",
"info": {
"title": "Check-Control-Messages API",
"description": "<h2>Check Control Message</h2>\nA check control message (CCM) is a notification to the driver from the Check Control system in the event of a fault,\ne.g. a system failure, being detected by the monitoring control unit.\nCheck controls vary in severity from mere warnings to highly critical failures.\nExamples: An unclosed door (warning) or a brake failure (critical).\nThey are displayed as long as they are relevant. Therefore, these are declared \"active\" CCMs.\n<h2>Historized Check Control Messages</h2>\nCheck controls, which are not active any more, can still be useful to support a root cause analysis and are therefore provided as inactive/historized CCMs.\n<h2>Sources</h2>\nThere are two sources for CCM data, namely over-the-air data from the vehicle or key reads, either as remote key or physical reads.\nThe grouping of active CCMs and the amount of historized CCMs varies depending on the source.\n",
"version": "3.0.3-bd104c900c"
},
"servers": [
{
"url": "https://ckf-int.bmwgroup.net",
"description": "EMEA-INT (Intranet)"
},
{
"url": "https://ckf-int.bmwgroup.com",
"description": "EMEA-INT (Internet)"
},
{
"url": "https://mtls.ckf-int.bmwgroup.com",
"description": "EMEA-INT (Internet, mTLS)"
},
{
"url": "https://ckf-qa.bmwgroup.net",
"description": "EMEA-QA (Intranet)"
},
{
"url": "https://ckf-qa.bmwgroup.com",
"description": "EMEA-QA (Internet)"
},
{
"url": "https://mtls.ckf-qa.bmwgroup.com",
"description": "EMEA-QA (Internet, mTLS)"
},
{
"url": "https://ckf-us-qa.bmwgroup.net",
"description": "US-QA (Intranet)"
},
{
"url": "https://ckf-us-qa.bmwgroup.com",
"description": "US-QA (Internet)"
},
{
"url": "https://ckf-cn-qa.bmwgroup.net",
"description": "CN-QA (Intranet)"
},
{
"url": "https://ckf-qa.bmwgroup.com.cn",
"description": "CN-QA (Internet)"
},
{
"url": "https://ckf.bmwgroup.net",
"description": "EMEA-PROD (Intranet)"
},
{
"url": "https://ckf.bmwgroup.com",
"description": "EMEA-PROD (Internet)"
},
{
"url": "https://mtls.ckf.bmwgroup.com",
"description": "EMEA-PROD (Internet, mTLS)"
},
{
"url": "https://ckf-us.bmwgroup.net",
"description": "US-PROD (Intranet)"
},
{
"url": "https://ckf-us.bmwgroup.com",
"description": "US-PROD (Internet)"
},
{
"url": "https://ckf-cn.bmwgroup.net",
"description": "CN-PROD (Intranet)"
},
{
"url": "https://ckf.bmwgroup.com.cn",
"description": "CN-PROD (Internet)"
}
],
"tags": [
{
"name": "B2D authentication",
"description": "The endpoint supports B2D authentication.",
"externalDocs": {
"description": "Authentication Documentation",
"url": "https://atc.bmwgroup.net/confluence/x/KRnXgQ"
}
},
{
"name": "M2M-B2D authentication",
"description": "The endpoint supports M2M-B2D authentication.",
"externalDocs": {
"description": "Authentication Documentation",
"url": "https://atc.bmwgroup.net/confluence/x/KRnXgQ"
}
},
{
"name": "B2E authentication",
"description": "The endpoint supports B2E authentication.",
"externalDocs": {
"description": "Authentication Documentation",
"url": "https://atc.bmwgroup.net/confluence/x/KRnXgQ"
}
},
{
"name": "B2I authentication",
"description": "The endpoint supports B2I authentication.",
"externalDocs": {
"description": "Authentication Documentation",
"url": "https://atc.bmwgroup.net/confluence/x/KRnXgQ"
}
},
{
"name": "M2M-B2I authentication",
"description": "The endpoint supports M2M-B2I authentication.",
"externalDocs": {
"description": "Authentication Documentation",
"url": "https://atc.bmwgroup.net/confluence/x/KRnXgQ"
}
},
{
"name": "Basic authentication",
"description": "The endpoint supports Basic authentication. This form of authentication is deprecated and should not be used anymore.",
"externalDocs": {
"description": "Authentication Documentation",
"url": "https://atc.bmwgroup.net/confluence/x/KRnXgQ"
}
},
{
"name": "CSSL authentication",
"description": "The endpoint supports CSSL-JWT authentication.",
"externalDocs": {
"description": "Authentication Documentation",
"url": "https://atc.bmwgroup.net/confluence/x/KRnXgQ"
}
},
{
"name": "ILEAN authentication",
"description": "The endpoint supports ILEAN authentication.",
"externalDocs": {
"description": "Authentication Documentation",
"url": "https://atc.bmwgroup.net/confluence/x/KRnXgQ"
}
},
{
"name": "M2M_TOKEN authentication",
"description": "The endpoint supports M2M token authentication.",
"externalDocs": {
"description": "Authentication Documentation",
"url": "https://atc.bmwgroup.net/confluence/x/KRnXgQ"
}
},
{
"name": "BASIC_AUTH_WEN_FOR_CA authentication",
"description": "The endpoint supports WEN for CA basic authentication.",
"externalDocs": {
"description": "Authentication Documentation",
"url": "https://atc.bmwgroup.net/confluence/x/KRnXgQ"
}
}
],
"paths": {
"/api/check-control-messages/service-demands/{vin}": {
"get": {
"tags": [
"B2D authentication"
],
"summary": "fetches the service demand for check control messages",
"operationId": "getCheckControlMessages",
"parameters": [
{
"name": "vin",
"in": "path",
"description": "A 17 letter vehicle identification number; the pattern is [0-9a-zA-Z]{17}",
"required": true,
"schema": {
"type": "string"
},
"example": "WBAGT2107LLE41319"
},
{
"name": "language",
"in": "query",
"description": "a language tag consisting of a two-letter language code and a two-letter country code; the pattern is [a-z]{2}-[A-Z]{2}",
"required": true,
"schema": {
"default": "en-GB",
"type": "string"
},
"style": "form",
"example": "de-DE"
},
{
"name": "cavors-request-id",
"in": "header",
"description": "The CaVORS request identifier marks a request, especially for logging purposes. This identifier may be provided by the client application to relate the request to preceding requests. This header is specific to CaVORS applications, since all CaVORS applications share the same logging system.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "cavors-session-id",
"in": "header",
"description": "The CaVORS session identifier marks all requests of a user session, especially for logging and analytics purposes. This identifier may be provided by the client application to relate the request to further requests of the user session. This header is specific to CaVORS applications, since all CaVORS applications share the same logging and analytics systems.",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "The request was successful",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceDemandsResponse"
}
}
}
},
"400": {
"description": "The request was invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Authentication was missing or authentication failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "The user has no permission to access this resource",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "The requested resource was not found. Check that all required parameters of the resource are provided and that all parameters conform to their schema. Consider that the requested resource might be missing or gone.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorsResponse"
}
}
}
},
"422": {
"description": "The response of the Key Pool is not processable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "An internal error occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"auth_scheme": [],
"auth_type": [],
"auth_dist_partner": [],
"auth_outlet": [],
"wen_token": []
},
{
"auth_scheme": [],
"auth_type": [],
"auth_buno": [],
"wen_token": []
},
{
"auth_scheme": [],
"auth_type": [],
"auth_dist_partner": [],
"auth_outlet": [],
"wen_cookie": []
},
{
"auth_scheme": [],
"auth_type": [],
"auth_buno": [],
"wen_cookie": []
}
]
}
},
"/api/check-control-messages/vehicles/{vin}": {
"get": {
"tags": [
"B2D authentication",
"M2M-B2D authentication",
"B2I authentication"
],
"summary": "Fetches check control messages for a vehicle",
"operationId": "getCheckControlSets",
"parameters": [
{
"name": "vin",
"in": "path",
"description": "A 17 letter vehicle identification number; the pattern is [0-9a-zA-Z]{17}",
"required": true,
"schema": {
"type": "string"
},
"example": "WBAGT2107LLE41319"
},
{
"name": "language",
"in": "query",
"description": "A language tag consisting of a two-letter language code and a two-letter country code; the pattern is [a-z]{2}-[A-Z]{2}",
"required": false,
"schema": {
"default": "en-GB",
"type": "string"
},
"style": "form",
"example": "de-DE"
},
{
"name": "source",
"in": "query",
"description": "Optional filter for source",
"required": false,
"schema": {
"type": "string"
},
"example": "VEHICLE_OTA"
},
{
"name": "cavors-request-id",
"in": "header",
"description": "The CaVORS request identifier marks a request, especially for logging purposes. This identifier may be provided by the client application to relate the request to preceding requests. This header is specific to CaVORS applications, since all CaVORS applications share the same logging system.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "cavors-session-id",
"in": "header",
"description": "The CaVORS session identifier marks all requests of a user session, especially for logging and analytics purposes. This identifier may be provided by the client application to relate the request to further requests of the user session. This header is specific to CaVORS applications, since all CaVORS applications share the same logging and analytics systems.",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "The list of check control sets from all available sources. If a source filter parameter is provided, only data from requested data source will be returned. The returned active check control messages are sorted first by priority and then by mileage.",
"content": {
"application/json": {
"schema": {
"description": "A response containing check controls from all requested sources. Check control messages are displayed in historized context and as active items",
"type": "object",
"properties": {
"checkControlSets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CheckControlSet"
}
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"example": {
"checkControlSets": [
{
"activeCheckControlGroups": [
{
"checkControls": [
{
"identifier": "00400",
"message": "long CCM for 9500400",
"mileage": 40863,
"occurredAt": "2023-07-03T09:28:32.000Z",
"occurrences": 2,
"title": "short CCM for 9500400"
}
],
"colorStatus": "YELLOW",
"eventIdentifier": "CcmEngineNonUrgent",
"groupName": "group name for event identifier CcmEngineNonUrgent",
"publishedRecommendedCustomerAction": "recommended customer action for SCHEDULE_APPOINTMENT",
"recommendedCustomerAction": "SCHEDULE_APPOINTMENT",
"urgency": 80
}
],
"createdAt": "2023-07-03T09:28:34.109Z",
"historizedCheckControls": [
{
"identifier": "00400",
"message": "long CCM for 9500400",
"mileage": 40863,
"occurredAt": "2023-07-03T09:28:32.000Z",
"occurrences": 2,
"title": "short CCM for 9500400"
},
{
"identifier": "02421",
"message": "long CCM for 9502421",
"mileage": 40856,
"occurredAt": "2023-07-03T09:28:33.288Z",
"occurrences": 1,
"title": "short CCM for 9502421"
}
],
"mileage": 40913,
"source": "VEHICLE_OTA"
}
],
"errors": []
}
}
}
}
},
"400": {
"description": "The request was invalid. Check that all required information is provided in the request body and the request headers and verify that all provided information conforms to the specified requirements. Further information is provided in the response body.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorsResponse"
}
}
}
},
"401": {
"description": "No authentication was provided or the provided authentication is invalid. Check that proper authentication, such as credentials or tokens or cookies, is provided and verify that the request contains all necessary authentication headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorsResponse"
}
}
}
},
"403": {
"description": "The authenticated principal has no permission to access this resource. Check that authentication suitable for the resource is provided.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorsResponse"
}
}
}
},
"404": {
"description": "The requested resource was not found. Check that all required parameters of the resource are provided and that all parameters conform to their schema. Consider that the requested resource might be missing or gone.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorsResponse"
}
}
}
},
"500": {
"description": "An internal error occurred. The service failed to handle the request appropriately and triggered an alarm. If the problem remains, raise a ticket with the information provided in the response body.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorsResponse"
}
}
}
}
},
"security": [
{
"auth_scheme": [],
"auth_type": [],
"auth_dist_partner": [],
"auth_outlet": [],
"wen_token": []
},
{
"auth_scheme": [],
"auth_type": [],
"auth_buno": [],
"wen_token": []
},
{
"auth_scheme": [],
"auth_type": [],
"auth_dist_partner": [],
"auth_outlet": [],
"wen_cookie": []
},
{
"auth_scheme": [],
"auth_type": [],
"auth_buno": [],
"wen_cookie": []
},
{
"machine_token": [],
"auth_scheme": [],
"auth_type": [],
"auth_buno": []
},
{
"auth_scheme": [],
"auth_type": [],
"auth_app_id": [],
"auth_session": [],
"wen_cookie": []
},
{
"auth_scheme": [],
"auth_type": [],
"auth_app_id": [],
"auth_session": [],
"wen_token": []
}
]
}
}
},
"components": {
"schemas": {
"CheckControl": {
"description": "A check control event describing the associated check control message and its historical context",
"required": [
"identifier",
"occurrences"
],
"type": "object",
"properties": {
"identifier": {
"description": "The code of the check control",
"type": "string"
},
"mileage": {
"format": "int32",
"description": "The mileage at which the check control occurred last. Distance unit = km",
"type": "integer",
"nullable": true
},
"occurredAt": {
"format": "date-time",
"description": "The ISO-8601 timestamp at which the check control occurred for over-the-air check controls",
"type": "string",
"example": "2022-03-10T16:15:50.000Z",
"nullable": true
},
"occurrences": {
"format": "int32",
"description": "The number of times the check control has occurred so far. For source VEHICLE_OTA, the interval for which the occurrences are aggregated is the last six months. For source KEY_READ, only the last 40 CCMs minus the number of active CCMs are aggregated.",
"type": "integer",
"example": 3
},
"title": {
"description": "Short description of the check control",
"type": "string",
"nullable": true
},
"message": {
"description": "Full message of the check control",
"type": "string",
"nullable": true
}
}
},
"CheckControlGroup": {
"description": "A group of related check control messages",
"type": "object",
"properties": {
"eventIdentifier": {
"description": "For source VEHICLE_OTA, eventIdentifier maps to the SEAM event identifier. This field is not included for source KEY_READ",
"type": "string"
},
"urgency": {
"format": "int32",
"description": "Describes how urgent the resolving of a check control event is. The lower, the more urgent it is",
"type": "integer"
},
"recommendedCustomerAction": {
"description": "The action the customer is recommended to take as provided by SEAM",
"type": "string",
"example": "CALL_RSA"
},
"groupName": {
"description": "The name of the control group, which specifies the domain or physical context of the messages. May be null if no translation is available",
"type": "string",
"example": "Brakes check up",
"nullable": true
},
"publishedRecommendedCustomerAction": {
"description": "The localized action the user is recommended to take. May be null if no translation is available",
"type": "string",
"example": "Call road-side assistance",
"nullable": true
},
"colorStatus": {
"$ref": "#/components/schemas/ColorStatus"
},
"checkControls": {
"description": "A list of check controls ordered by urgency, then mileage",
"type": "array",
"items": {
"$ref": "#/components/schemas/CheckControl"
}
}
}
},
"CheckControlSet": {
"description": "The complete set of check control information at a specific time",
"type": "object",
"properties": {
"mileage": {
"format": "int32",
"description": "The mileage of the vehicle at the time of the KEY_READ or the latest demand from VEHICLE_OTA. Distance unit = km",
"type": "integer",
"example": 18000
},
"createdAt": {
"format": "date-time",
"description": "The ISO-8601 timestamp at which the set of check control information was evaluated in the backend",
"type": "string",
"example": "2022-03-10T16:15:50.000Z"
},
"readInDate": {
"format": "date-time",
"description": "In case of a KEY_READ, the ISO-8601 timestamp at which the key read was performed",
"type": "string",
"example": "2022-03-10T16:15:50.000Z"
},
"source": {
"$ref": "#/components/schemas/Source"
},
"activeCheckControlGroups": {
"description": "List of active check controls grouped by event categories (except for source KEY_READ, for which the categories are not known)",
"type": "array",
"items": {
"$ref": "#/components/schemas/CheckControlGroup"
}
},
"historizedCheckControls": {
"description": "List of historized check controls",
"type": "array",
"items": {
"$ref": "#/components/schemas/CheckControl"
}
}
}
},
"CheckControlSetListResponse": {
"description": "A response containing check controls from all requested sources. Check control messages are displayed in historized context and as active items",
"type": "object",
"properties": {
"checkControlSets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CheckControlSet"
}
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"example": {
"checkControlSets": [
{
"activeCheckControlGroups": [
{
"checkControls": [
{
"identifier": "00400",
"message": "long CCM for 9500400",
"mileage": 40863,
"occurredAt": "2023-07-03T09:28:32.000Z",
"occurrences": 2,
"title": "short CCM for 9500400"
}
],
"colorStatus": "YELLOW",
"eventIdentifier": "CcmEngineNonUrgent",
"groupName": "group name for event identifier CcmEngineNonUrgent",
"publishedRecommendedCustomerAction": "recommended customer action for SCHEDULE_APPOINTMENT",
"recommendedCustomerAction": "SCHEDULE_APPOINTMENT",
"urgency": 80
}
],
"createdAt": "2023-07-03T09:28:34.109Z",
"historizedCheckControls": [
{
"identifier": "00400",
"message": "long CCM for 9500400",
"mileage": 40863,
"occurredAt": "2023-07-03T09:28:32.000Z",
"occurrences": 2,
"title": "short CCM for 9500400"
},
{
"identifier": "02421",
"message": "long CCM for 9502421",
"mileage": 40856,
"occurredAt": "2023-07-03T09:28:33.288Z",
"occurrences": 1,
"title": "short CCM for 9502421"
}
],
"mileage": 40913,
"source": "VEHICLE_OTA"
}
],
"errors": []
}
},
"ColorStatus": {
"description": "The urgency as color. Always RED for active check controls if no urgency is provided",
"enum": [
"RED_ALERT",
"RED",
"YELLOW",
"GREY",
"UNKNOWN"
],
"type": "string",
"example": "RED"
},
"ErrorResponse": {
"description": "The error response provides details for an error that occurred in processing a request.",
"type": "object",
"properties": {
"eventId": {
"description": "The event identifier encodes the service and the location of the error.",
"type": "string",
"nullable": true
},
"type": {
"description": "The type is a short name for the error and is more expressive than the event identifier.",
"type": "string",
"nullable": true
},
"message": {
"description": "The error message describes the cause of the error.",
"type": "string",
"nullable": true
},
"errorCode": {
"format": "int32",
"description": "The error code of a backend request gives information about the cause of this error.",
"type": "integer",
"nullable": true
},
"cavorsRequestId": {
"description": "The CaVORS request identifier is unique for a request to CaVORS services.",
"type": "string",
"nullable": true
},
"cavorsSessionId": {
"description": "The CaVORS session identifier is shared by all requests of a user session.",
"type": "string",
"nullable": true
},
"parameters": {
"description": "The parameters provide additional information about the error.",
"type": "object",
"additionalProperties": {},
"nullable": true
}
}
},
"ErrorsResponse": {
"description": "Error information returned if the HTTP response status code >= 400",
"type": "object",
"properties": {
"statusCode": {
"format": "int32",
"description": "The status code is the HTTP code of the response.",
"type": "integer",
"nullable": true
},
"reasonPhrase": {
"description": "The reason phrase is the short description of the HTTP code.",
"type": "string",
"nullable": true
},
"errors": {
"description": "The errors list contains all errors that occurred in processing the request.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorResponse"
},
"nullable": true
},
"traceId": {
"description": "The trace identifier can be used to analyze the error.",
"type": "string",
"nullable": true,
"deprecated": true
},
"message": {
"description": "The message explains the reason for the error.",
"type": "string",
"nullable": true,
"deprecated": true
},
"errorCode": {
"format": "int32",
"description": "The error code of a backend request gives information about the cause of this error.",
"type": "integer",
"nullable": true,
"deprecated": true
}
}
},
"ServiceDemand": {
"description": "Service demand for check control messages",
"type": "object",
"properties": {
"type": {
"description": "The type of the service demand.",
"type": "string",
"allOf": [
{
"$ref": "#/components/schemas/ServiceDemandType"
}
]
},
"statusColor": {
"description": "The overall color status for the service demand.",
"enum": [
"GREY",
"YELLOW",
"RED"
],
"type": "string",
"example": "RED"
},
"status": {
"description": "The overall status of the service demand.",
"enum": [
"OVERDUE",
"PENDING",
"OK"
],
"type": "string",
"example": "OVERDUE"
},
"title": {
"description": "The service demands title.",
"type": "string",
"example": "Check Control message"
},
"items": {
"description": "The service demand items.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceDemandItem"
}
}
}
},
"ServiceDemandColorStatus": {
"description": "The color status.",
"enum": [
"RED",
"YELLOW",
"GREY"
],
"type": "string",
"example": "RED"
},
"ServiceDemandItem": {
"description": "A service demand item",
"type": "object",
"properties": {
"type": {
"description": "The overall status color of the service demand.",
"type": "string",
"allOf": [
{
"$ref": "#/components/schemas/ServiceDemandType"
}
]
},
"id": {
"description": "The id of the service demand item",
"type": "string",
"example": "00987"
},
"statusColor": {
"description": "The color status of the service demand item",
"type": "string",
"allOf": [
{
"$ref": "#/components/schemas/ServiceDemandColorStatus"
}
]
},
"status": {
"description": "The status of the service demand item",
"type": "string",
"allOf": [
{
"$ref": "#/components/schemas/ServiceDemandStatus"
}
]
},
"title": {
"description": "The status of the service demand item",
"type": "string",
"example": "00987"
},
"description": {
"description": "The status of the service demand item",
"type": "string",
"example": "Diagnostic mode active Press Start/Stop button to exit diagnostic mode."
}
}
},
"ServiceDemandStatus": {
"description": "Service demand status",
"enum": [
"OK",
"PENDING",
"OVERDUE"
],
"type": "string",
"example": "OK"
},
"ServiceDemandType": {
"description": "Service demand type",
"enum": [
"CCM"
],
"type": "string",
"example": "CCM"
},
"ServiceDemandsResponse": {
"description": "List of service demands for check control messages",
"type": "object",
"properties": {
"serviceDemands": {
"description": "Service demands",
"type": "array",
"items": {
"description": "Service demand for check control messages",
"type": "object",
"properties": {
"type": {
"description": "The type of the service demand.",
"type": "string",
"allOf": [
{
"$ref": "#/components/schemas/ServiceDemandType"
}
]
},
"statusColor": {
"description": "The overall color status for the service demand.",
"enum": [
"GREY",
"YELLOW",
"RED"