Newer
Older
{
"openapi": "3.1.0",
"info": {
"title": "ETSI GS MEC 030 V2X Information Service API",
"description": "ETSI GS MEC 030 V2X Information Service API described using OpenAPI.",
"contact": {
"name": "ETSI Forge",
"email": "cti_support@etsi.org",
"url": "https://forge.etsi.org/rep/mec/gs030-vis-api"
},
"license": {
"name": "BSD-3-Clause",
"url": "https://forge.etsi.org/legal-matters"
}
},
"externalDocs": {
"description": "ETSI GS MEC 030 V2X Information Service API, v2.2.1",
"url": "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/030/02.02.01_60/gs_mec030v020201p.pdf"
}
],
"tags": [
{
"name": "queries",
"description": "Queries"
},
{
"name": "subscription",
"description": "Subscription"
},
{
"name": "QoS"
},
{
"name": "V2X_msg"
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
}
],
"paths": {
"/queries/uu_unicast_provisioning_info": {
"get": {
"tags": ["queries"],
"summary": "Used to query provisioning information for V2X communication over Uu unicast.",
"description": "Used to query provisioning information for V2X communication over Uu unicast.",
"operationId": "prov_info_uu_unicastGET",
"parameters": [
{
"in": "query",
"name": "location_info",
"schema": {
"type": "string"
},
"required": true,
"description": "Comma separated list of locations to identify a cell of a base station or a particular geographical area"
}
],
"responses": {
"200": {
"description": "A response body containing the Uu unicast provisioning information. ",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UuUnicastProvisioningInfo"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"429": {
"$ref": "#/components/responses/429"
}
}
}
},
"/queries/uu_mbms_provisioning_info": {
"get": {
"tags": ["queries"],
"summary": "retrieve information required for V2X communication over Uu MBMS.",
"description": "retrieve information required for V2X communication over Uu MBMS.",
"operationId": "prov_info_uu_mbmsGET",
"parameters": [
{
"in": "query",
"name": "location_info",
"schema": {
"type": "string"
},
"required": true,
"description": "omma separated list of locations to identify a cell of a base station or a particular geographical area"
}
],
"responses": {
"200": {
"description": "A response body containing the Uu unicast provisioning information. ",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UuMbmsProvisioningInfo"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"429": {
"$ref": "#/components/responses/429"
}
}
}
},
"/queries/pc5_provisioning_info": {
"get": {
"tags": ["queries"],
"summary": "Query provisioning information for V2X communication over PC5.",
"description": "Query provisioning information for V2X communication over PC5.",
"operationId": "prov_infoGET",
"parameters": [
{
"in": "query",
"name": "location_info",
"schema": {
"type": "string"
},
"required": true,
"description": "Comma separated list of locations to identify a cell of a base station or a particular geographical area"
}
],
"responses": {
"200": {
"description": "A response body containing the PC5 provisioning information is returned.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Pc5ProvisioningInfo"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"429": {
"$ref": "#/components/responses/429"
}
}
}
},
"/provide_predicted_qos": {
"post": {
"tags": ["QoS"],
"summary": "Request the predicted QoS correspondent to potential routes of a vehicular UE.",
"description": "Request the predicted QoS correspondent to potential routes of a vehicular UE.",
"operationId": "predicted_qosPOST",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PredictedQos"
}
}
}
},
"responses": {
"200": {
"description": "The response body shall contain the predicted QoS corresponding to potential routes of a vehicular UE",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PredictedQos"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
}
}
},
"/publish_v2x_message": {
"post": {
"tags": ["V2X_msg"],
"summary": "Used to publish a V2X message.",
"description": "Used to publish a V2X message.",
"operationId": "v2x_messagePOST",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/V2xMsgPublication"
}
}
}
},
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"429": {
"$ref": "#/components/responses/429"
}
}
}
},
"/subscriptions": {
"get": {
"tags": ["subscription"],
"summary": "Request information about the subscriptions for this requestor.",
"description": "Request information about the subscriptions for this requestor.",
"operationId": "subGET",
"parameters": [
{
"in": "query",
"name": "subscription_type",
"description": "Query parameter to filter on a specific subscription type. Permitted values: prov_chg_uu_uni: provisioning information change for V2X communication over Uuunicast prov_chg_uu_mbms: provisioning information change for V2X communication over Uu MBMS prov_chg_uu_pc5: provisioning information change for V2X communication over PC5. v2x_msg: V2X interoperability message",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "A response body containing the list of links to requestor subscriptions is returned.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionLinkList"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"429": {
"$ref": "#/components/responses/429"
}
}
},
"post": {
"tags": ["subscription"],
"summary": " create a new subscription to VIS notifications.",
"description": " create a new subscription to VIS notifications.",
"operationId": "subPOST",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ProvChgUuUniSubscription"
},
{
"$ref": "#/components/schemas/ProvChgUuMbmsSubscription"
},
{
"$ref": "#/components/schemas/ProvChgPc5Subscription"
},
{
"$ref": "#/components/schemas/V2xMsgSubscription"
}
]
}
}
}
},
"responses": {
"201": {
"description": "In the returned NotificationSubscription structure, the created subscription is described using the appropriate data type.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ProvChgUuUniSubscription"
},
{
"$ref": "#/components/schemas/ProvChgUuMbmsSubscription"
},
{
"$ref": "#/components/schemas/ProvChgPc5Subscription"
},
{
"$ref": "#/components/schemas/V2xMsgSubscription"
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"415": {
"$ref": "#/components/responses/415"
},
"422": {
"$ref": "#/components/responses/422"
},
"429": {
"$ref": "#/components/responses/429"
}
},
"callbacks": {
"notification": {
"{$request.body#/callbackReference}": {
"post": {
"summary": "Callback POST used to send a notification",
"description": "A notification from VIS.",
"operationId": "notificationPOST",
"requestBody": {
"description": "Subscription notification",
"required": true,
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ProvChgUuUniNotification"
},
{
"$ref": "#/components/schemas/ProvChgUuMbmsNotification"
},
{
"$ref": "#/components/schemas/ProvChgPc5Notification"
},
{
"$ref": "#/components/schemas/V2xMsgNotification"
}
]
}
}
}
},
"responses": {
"204": {
"$ref": "#/components/responses/204"
}
}
}
}
}
}
}
},
"/subscriptions/{subscriptionId}": {
"parameters": [
{
"in": "path",
"name": "subscriptionId",
"description": "Refers to created subscription, where the VIS API allocates a unique resource name for this subscription",
"schema": {
"type": "string"
},
"required": true
}
],
"get": {
"tags": ["subscription"],
"summary": "Retrieve information about this subscription.",
"description": "Retrieve information about this subscription.",
"operationId": "individualSubscriptionGET",
"responses": {
"200": {
"description": "A response body containing the data type describing the specific RNI event subscription is returned",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ProvChgUuUniSubscription"
},
{
"$ref": "#/components/schemas/ProvChgUuMbmsSubscription"
},
{
"$ref": "#/components/schemas/ProvChgPc5Subscription"
},
{
"$ref": "#/components/schemas/V2xMsgSubscription"
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"429": {
"$ref": "#/components/responses/429"
}
}
},
"put": {
"tags": ["subscription"],
"summary": "Used to update the existing subscription.",
"description": "Used to update the existing subscription.",
"operationId": "individualSubscriptionPUT",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ProvChgUuUniSubscription"
},
{
"$ref": "#/components/schemas/ProvChgUuMbmsSubscription"
},
{
"$ref": "#/components/schemas/ProvChgPc5Subscription"
},
{
"$ref": "#/components/schemas/V2xMsgSubscription"
}
]
}
}
}
},
"responses": {
"200": {
"description": "A response body containing data type describing the updated subscription is returned",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ProvChgUuUniSubscription"
},
{
"$ref": "#/components/schemas/ProvChgUuMbmsSubscription"
},
{
"$ref": "#/components/schemas/ProvChgPc5Subscription"
},
{
"$ref": "#/components/schemas/V2xMsgSubscription"
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"412": {
"$ref": "#/components/responses/412"
},
"422": {
"$ref": "#/components/responses/422"
},
"429": {
"$ref": "#/components/responses/429"
}
}
},
"delete": {
"tags": ["subscription"],
"summary": "Used to cancel the existing subscription.",
"description": "Used to cancel the existing subscription.",
"operationId": "individualSubscriptionDELETE",
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"429": {
"$ref": "#/components/responses/429"
}
}
}
}
},
"components": {
"schemas": {
"CellId": {
"properties": {
"cellId": {
"description": "E-UTRAN Cell Identity as a bit string (size (28)).",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
}
},
"required": ["cellId"],
"type": "object",
"x-etsi-ref": "6.6.2"
},
"Earfcn": {
"properties": {
"earfcn": {
"description": "E-UTRA Absolute Radio Frequency Channel Number, range (0... 65535)",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Integer"
}
},
"required": ["earfcn"],
"type": "object",
"x-etsi-ref": "6.6.3"
},
"Ecgi": {
"properties": {
"cellId": {
"$ref": "#/components/schemas/CellId"
},
"plmn": {
"$ref": "#/components/schemas/Plmn"
}
},
"required": ["plmn", "cellId"],
"type": "object",
"x-etsi-ref": "6.5.5"
},
"FddInfo": {
"properties": {
"dlEarfcn": {
"$ref": "#/components/schemas/Earfcn"
},
"dlTransmissionBandwidth": {
"$ref": "#/components/schemas/TransmissionBandwidth"
},
"ulEarfcn": {
"$ref": "#/components/schemas/Earfcn"
},
"ulTransmissionBandwidth": {
"$ref": "#/components/schemas/TransmissionBandwidth"
}
},
"required": [
"ulEarfcn",
"dlEarfcn",
"ulTransmissionBandwidth",
"dlTransmissionBandwidth"
],
"type": "object",
"x-etsi-ref": "6.5.6"
},
"href": {
"description": "URI referring to a resource",
"format": "uri",
"type": "string",
},
"LocationInfo": {
"properties": {
"ecgi": {
"$ref": "#/components/schemas/Ecgi"
},
"geoArea": {
"description": "Information of a geographical area.",
"properties": {
"latitude": {
"description": "Latitude (DATUM = WGS84) -90 to 90 in decimal degree format DDD.ddd",
"format": "float",
"type": "number",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Float"
},
"longitude": {
"description": "Longitude (DATUM = WGS84) -180 to 180 in decimal degree format DDD.ddd",
"format": "float",
"type": "number",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Float"
}
},
"required": ["latitude", "longitude"],
"type": "object",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Structure (inlined)"
}
},
"type": "object",
"x-etsi-notes": "NOTE:\tEither ecgi or geoArea shall be present, but not both.",
"x-etsi-ref": "6.5.3"
},
"Pc5NeighbourCellInfo": {
"properties": {
"ecgi": {
"$ref": "#/components/schemas/Ecgi"
},
"plmn": {
"$ref": "#/components/schemas/Plmn"
},
"siV2xConfig": {
"$ref": "#/components/schemas/SystemInformationBlockType21"
}
},
"required": ["plmn", "ecgi", "siV2xConfig"],
"type": "object",
"x-etsi-ref": "6.5.12"
},
"Pc5ProvisioningInfo": {
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
"items": {
"properties": {
"proInfoPc5": {
"description": "The provisioning information per location as defined below.",
"items": {
"type": "object"
},
"minItems": 1,
"properties": {
"dstLayer2Id": {
"description": "For sidelink communication, the Destination Layer-2 ID is set to the ProSe Layer-2 Group ID or Prose UE ID, see ETSI TS 136 321 [i.12].\nPLMN operators coordinate to make sure Destination Layer2 ID(s) for different V2X services are configured in a consistent manner.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"locationInfo": {
"$ref": "#/components/schemas/LocationInfo"
},
"neighbourCellInfo": {
"description": "The information of the neighbour cells in a visiting PLMN that support V2X communication over PC5.",
"items": {
"$ref": "#/components/schemas/Pc5NeighbourCellInfo"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "Pc5NeighbourCellInfo"
}
},
"required": ["locationInfo", "dstLayer2Id"],
"type": "array",
"x-etsi-mec-cardinality": "1..N",
"x-etsi-mec-origin-type": "Structure (inlined)"
},
"timeStamp": {
"$ref": "#/components/schemas/TimeStamp"
},
"required": ["proInfoPc5"],
"type": "object",
"x-etsi-ref": "6.2.4"
},
"Plmn": {
"properties": {
"mcc": {
"description": "The Mobile Country Code part of PLMN Identity.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"mnc": {
"description": "The Mobile Network Code part of PLMN Identity.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
}
},
"required": ["mcc", "mnc"],
"type": "object",
"x-etsi-ref": "6.5.4"
},
"locationGranularity": {
"description": "Granularity of visited location. Measured in meters.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
"routes": {
"description": "Information relating to the potential routes of a vehicular UE.",
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
"properties": {
"routeInfo": {
"description": "Information relating to a specific route.\nThe first structure shall relate to the route origin and the last to the route destination. Intermediate waypoint locations may also be provided.",
"items": {
"type": "object"
},
"minItems": 2,
"properties": {
"location": {
"$ref": "#/components/schemas/LocationInfo"
},
"rsrp": {
"description": "Reference Signal Received Power as defined in ETSI TS 136 214 [i.13].\nShall only be included in the response.",
"format": "uint8",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint8"
},
"rsrq": {
"description": "Reference Signal Received Quality as defined in ETSI TS 136 214 [i.13].\nShall only be included in the response.",
"format": "uint8",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint8"
},
"time": {
"$ref": "#/components/schemas/TimeStamp"
}
},
"required": ["location"],
"type": "array",
"x-etsi-mec-cardinality": "2..N",
"x-etsi-mec-origin-type": "Structure (inlined)"
}
},
"type": "object"
},
"minItems": 1,
"required": ["routeInfo"],
"type": "array",
"x-etsi-mec-cardinality": "1..N",
"x-etsi-mec-origin-type": "Structure (inlined)"
},
"timeGranularity": {
"$ref": "#/components/schemas/TimeStamp"
"required": ["locationGranularity", "routes"],
"type": "object",
"x-etsi-notes": "NOTE:\tThe data type of locationGranularity is a string which indicates the granularity of a visited location by means of latitudinal and longitudinal margins.",
"x-etsi-ref": "6.2.5"
"detail": {
"description": "A human-readable explanation specific to this occurrence of the problem",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
"instance": {
"description": "A URI reference that identifies the specific occurrence of the problem",
"format": "uri",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "URI"
"status": {
"description": "The HTTP status code for this occurrence of the problem",
"format": "uint32",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint32"
},
"title": {
"description": "A short, human-readable summary of the problem type",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"type": {
"description": "A URI reference according to IETF RFC 3986 that identifies the problem type",
"format": "uri",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "URI"
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
},
"ProvChgPc5Notification": {
"properties": {
"dstLayer2Id": {
"description": "For sidelink communication, the Destination Layer-2 ID is set to the ProSe Layer-2 Group ID or Prose UE ID, see ETSI TS 136 321 [i.12].",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"locationInfo": {
"$ref": "#/components/schemas/LocationInfo"
},
"neighbourCellInfo": {
"description": "The information of the neighbour cells in a visiting PLMN that support V2X communication over PC5.",
"items": {
"$ref": "#/components/schemas/Pc5NeighbourCellInfo"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "Pc5NeighbourCellInfo"
},
"notificationType": {
"description": "Shall be set to \"ProvChgPc5Notification\".",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"timeStamp": {
"$ref": "#/components/schemas/TimeStamp"
}
},
"required": ["notificationType", "locationInfo"],
"type": "object",
"x-etsi-ref": "6.4.4"
},
"ProvChgPc5Subscription": {
"properties": {
"_links": {
"description": "Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.",
"properties": {
"self": {
"$ref": "#/components/schemas/LinkType"
}
},
"required": ["self"],
"type": "object",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Structure (inlined)"
"description": "URI exposed by the client on which to receive notifications via HTTP. See note.",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uri"
},
"expiryDeadline": {
"$ref": "#/components/schemas/TimeStamp"
},
"filterCriteria": {
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
"description": "List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.",
"properties": {
"dstLayer2Id": {
"description": "For sidelink communication, the Destination Layer-2 ID is set to the ProSe Layer-2 Group ID or Prose UE ID, see ETSI TS 136 321 [i.12].",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"locationInfo": {
"$ref": "#/components/schemas/LocationInfo"
},
"neighbourCellInfo": {
"description": "The information of the neighbour cells in a visiting PLMN that support V2X communication over PC5.",
"items": {
"$ref": "#/components/schemas/Pc5NeighbourCellInfo"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "Pc5NeighbourCellInfo"
}
},
"required": ["locationInfo", "dstLayer2Id"],
"type": "object",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Structure (inlined)"
},
"requestTestNotification": {
"description": "Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as described in ETSI GS MEC 009 [i.1], clause 6.12a.\nDefault: FALSE.",
"type": "boolean",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Boolean"
},
"subscriptionType": {
"description": "Shall be set to \"ProvChgPc5Subscription\".",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"websockNotifConfig": {
"$ref": "#/components/schemas/WebsockNotifConfig"
"required": ["subscriptionType", "filterCriteria"],
"x-etsi-notes": "NOTE: At least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to VIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009 [i.1], clause 6.12a.",
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
"x-etsi-ref": "6.3.4"
},
"ProvChgUuMbmsNotification": {
"properties": {
"locationInfo": {
"$ref": "#/components/schemas/LocationInfo"
},
"neighbourCellInfo": {
"description": "The information of the neighbour cells in a visiting PLMN that support V2X communication over Uu MBMS.",
"items": {
"$ref": "#/components/schemas/UuMbmsNeighbourCellInfo"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "UuMbmsNeighbourCellInfo"
},
"notificationType": {
"description": "Shall be set to \"ProvChgUuMbmsNotification\".",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"timeStamp": {
"$ref": "#/components/schemas/TimeStamp"
},
"v2xServerUsd": {
"$ref": "#/components/schemas/V2xServerUsd"
}
},
"required": ["notificationType", "locationInfo"],
"type": "object",
"x-etsi-ref": "6.4.3"
},
"ProvChgUuMbmsSubscription": {
"properties": {
"_links": {
"description": "Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.",
"properties": {
"self": {
"$ref": "#/components/schemas/LinkType"
}
},
"required": ["self"],
"type": "object",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Structure (inlined)"
"description": "URI exposed by the client on which to receive notifications via HTTP. See note.",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uri"
},
"expiryDeadline": {
"$ref": "#/components/schemas/TimeStamp"
},
"filterCriteria": {
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
"description": "List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.",
"properties": {
"locationInfo": {
"$ref": "#/components/schemas/LocationInfo"
},
"neighbourCellInfo": {
"description": "The information of the neighbour cells in a visiting PLMN that support V2X communication over Uu MBMS.",
"items": {
"$ref": "#/components/schemas/UuMbmsNeighbourCellInfo"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "UuMbmsNeighbourCellInfo"
},
"v2xServerUsd": {
"$ref": "#/components/schemas/V2xServerUsd"
}
},
"required": ["locationInfo", "v2xServerUsd"],
"type": "object",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Structure (inlined)"
},
"requestTestNotification": {
"description": "Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as described in ETSI GS MEC 009 [i.1], clause 6.12a.\nDefault: FALSE.",
"type": "boolean",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Boolean"
},
"subscriptionType": {
"description": "Shall be set to \"ProvChgUuMbmsSubscription\".",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"websockNotifConfig": {
"$ref": "#/components/schemas/WebsockNotifConfig"
"required": ["subscriptionType", "filterCriteria"],
"x-etsi-notes": "NOTE:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to VIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009 [i.1], clause 6.12a.",
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
"x-etsi-ref": "6.3.3"
},
"ProvChgUuUniNotification": {
"properties": {
"locationInfo": {
"$ref": "#/components/schemas/LocationInfo"
},
"neighbourCellInfo": {
"description": "The information of the neighbour cells in a visiting PLMN that support V2X communication over Uu unicast.",
"items": {
"$ref": "#/components/schemas/UuUniNeighbourCellInfo"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "UuUniNeighbourCellInfo"
},
"notificationType": {
"description": "Shall be set to \"ProvChgUuUniNotification\".",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"timeStamp": {
"$ref": "#/components/schemas/TimeStamp"
},
"v2xApplicationServer": {
"$ref": "#/components/schemas/V2xApplicationServer"
}
},
"required": ["notificationType", "locationInfo"],
"type": "object",
"x-etsi-ref": "6.4.2"
},
"ProvChgUuUniSubscription": {
"properties": {
"_links": {
"description": "Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.",
"properties": {
"self": {
"$ref": "#/components/schemas/LinkType"
}
},
"required": ["self"],
"type": "object",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Structure (inlined)"
"description": "URI exposed by the client on which to receive notifications via HTTP. See note.",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uri"
},
"expiryDeadline": {
"$ref": "#/components/schemas/TimeStamp"
},
"filterCriteria": {
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
"description": "List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.",
"properties": {
"locationInfo": {
"$ref": "#/components/schemas/LocationInfo"
},
"neighbourCellInfo": {
"description": "The information of the neighbour cells in a visiting PLMN that support V2X communication over Uu unicast.",
"items": {
"$ref": "#/components/schemas/UuUniNeighbourCellInfo"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "UuUniNeighbourCellInfo"
},
"v2xApplicationServer": {
"$ref": "#/components/schemas/V2xApplicationServer"
}
},
"required": ["locationInfo", "v2xApplicationServer"],
"type": "object",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Structure (inlined)"
},
"requestTestNotification": {
"description": "Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as described in ETSI GS MEC 009 [i.1], clause 6.12a.\nDefault: FALSE.",
"type": "boolean",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Boolean"
},
"subscriptionType": {
"description": "Shall be set to \"ProvChgUuUniSubscription\".",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"websockNotifConfig": {
"$ref": "#/components/schemas/WebsockNotifConfig"
"required": ["subscriptionType", "filterCriteria"],
"x-etsi-notes": "NOTE:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to VIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009 [i.1], clause 6.12a.",
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
"_links": {
"description": "List of hyperlinks related to the resource.",
"items": {
"properties": {
"self": {
"$ref": "#/components/schemas/LinkType"
},
"subscriptions": {
"description": "The service consumer's subscriptions.",
"items": {
"type": "object"
},
"minItems": 0,
"properties": {
"href": {
"description": "The URI referring to the subscription.",
"format": "uri",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "URI"
},
"subscriptionType": {
"description": "Type of the subscription. The values are as defined in the \"subscriptionType\" attribute for each different V2X information event subscription data type.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
}
},
"required": ["href", "subscriptionType"],
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "Structure (inlined)"
}
},
"type": "object"
},
"required": ["self"],
"type": "object",
"x-etsi-mec-origin-type": "Structure (inlined)"
}
},
"required": ["_links"],
"type": "object",
"x-etsi-ref": "6.3.6"
},
"SystemInformationBlockType21": {
"type": "object"
},
"TddInfo": {
"properties": {
"earfcn": {
"$ref": "#/components/schemas/Earfcn"
},
"subframeAssignment": {
"description": "Uplink-downlink subframe configuration information.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"transmissionBandwidth": {
"$ref": "#/components/schemas/TransmissionBandwidth"
}
},
"required": ["earfcn", "transmissionBandwidth", "subframeAssignment"],
"type": "object",
"x-etsi-ref": "6.5.7"
},
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
"TestNotification": {
"properties": {
"_links": {
"description": "Hyperlink related to the resource. ",
"properties": {
"subscription": {
"$ref": "#/components/schemas/LinkType"
}
},
"required": ["subscription"],
"type": "object",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Structure (inlined)"
},
"notificationType": {
"description": "Shall be set to \"TestNotification\".",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
}
},
"required": ["notificationType", "_links"],
"type": "object",
"x-etsi-ref": "6.4.6"
},
"TimeStamp": {
"properties": {
"nanoSeconds": {
"description": "The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint32"
},
"seconds": {
"description": "The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint32"
}
},
"required": ["seconds", "nanoSeconds"],
"type": "object",
"x-etsi-ref": "6.5.2"
},
"TransmissionBandwidth": {
"properties": {
"transmissionBandwidth": {
"description": "'Numeric value corresponding to the transmission bandwidth expressed in units of resource blocks as follows:\n\n1 = bw6 (6 resource blocks)\n\n2 = bw15 (15 resource blocks)\n\n3 = bw25 (25 resource blocks)\n\n4 = bw50 (50 resource blocks)\n\n5 = bw75 (75 resource blocks)\n\n6 = bw100 (100 resource blocks)'\n",
"enum": ["1", "2", "3", "4", "5", "6"],
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Enum"
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
}
},
"required": ["transmissionBandwidth"],
"type": "object",
"x-etsi-ref": "6.6.4"
},
"UuMbmsNeighbourCellInfo": {
"properties": {
"ecgi": {
"$ref": "#/components/schemas/Ecgi"
},
"fddInfo": {
"$ref": "#/components/schemas/FddInfo"
},
"mbmsServiceAreaIdentity": {
"description": "Supported MBMS Service Area Identities in the cell.",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"x-etsi-mec-cardinality": "1..N",
"x-etsi-mec-origin-type": "String"
},
"pci": {
"description": "Physical Cell Identifier.",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Integer"
},
"plmn": {
"$ref": "#/components/schemas/Plmn"
},
"tddInfo": {
"$ref": "#/components/schemas/TddInfo"
}
},
"required": [
"plmn",
"ecgi",
"pci",
"fddInfo",
"tddInfo",
"mbmsServiceAreaIdentity"
],
"type": "object",
"x-etsi-ref": "6.5.11"
},
"UuMbmsProvisioningInfo": {
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
"items": {
"properties": {
"proInfoUuMbms": {
"description": "The provisioning information per location as defined below.",
"items": {
"type": "object"
},
"minItems": 1,
"properties": {
"locationInfo": {
"$ref": "#/components/schemas/LocationInfo"
},
"neighbourCellInfo": {
"description": "The information of the neighbour cells in a visiting PLMN that support V2X communication over Uu MBMS.",
"items": {
"$ref": "#/components/schemas/UuMbmsNeighbourCellInfo"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "UuMbmsNeighbourCellInfo"
},
"v2xServerUsd": {
"$ref": "#/components/schemas/V2xServerUsd"
}
},
"required": ["locationInfo", "v2xServerUsd"],
"type": "array",
"x-etsi-mec-cardinality": "1..N",
"x-etsi-mec-origin-type": "Structure (inlined)"
},
"timeStamp": {
"$ref": "#/components/schemas/TimeStamp"
}
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
},
"required": ["proInfoUuMbms"],
"type": "object",
"x-etsi-ref": "6.2.3"
},
"UuUniNeighbourCellInfo": {
"properties": {
"ecgi": {
"$ref": "#/components/schemas/Ecgi"
},
"fddInfo": {
"$ref": "#/components/schemas/FddInfo"
},
"pci": {
"description": "Physical Cell Identifier.",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Integer"
},
"plmn": {
"$ref": "#/components/schemas/Plmn"
},
"tddInfo": {
"$ref": "#/components/schemas/TddInfo"
}
},
"required": ["plmn", "ecgi", "pci", "fddInfo", "tddInfo"],
"type": "object",
"x-etsi-ref": "6.5.9"
},
"UuUnicastProvisioningInfo": {
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
"items": {
"properties": {
"proInfoUuUnicast": {
"description": "The provisioning information per location as defined below.",
"items": {
"type": "object"
},
"minItems": 1,
"properties": {
"locationInfo": {
"$ref": "#/components/schemas/LocationInfo"
},
"neighbourCellInfo": {
"description": "The information of the neighbour cells in a visiting PLMN that support V2X communication over Uu unicast.",
"items": {
"$ref": "#/components/schemas/UuUniNeighbourCellInfo"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "UuUniNeighbourCellInfo"
},
"v2xApplicationServer": {
"$ref": "#/components/schemas/V2xApplicationServer"
}
},
"required": ["locationInfo", "v2xApplicationServer"],
"type": "array",
"x-etsi-mec-cardinality": "1..N",
"x-etsi-mec-origin-type": "Structure (inlined)"
},
"timeStamp": {
"$ref": "#/components/schemas/TimeStamp"
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
},
"required": ["proInfoUuUnicast"],
"type": "object",
"x-etsi-ref": "6.2.2"
},
"V2xApplicationServer": {
"properties": {
"ipAddress": {
"description": "",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"udpPort": {
"description": "",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
}
},
"required": ["ipAddress", "udpPort"],
"type": "object",
"x-etsi-ref": "6.5.8"
},
"_links": {
"description": "Links to resources related to this notification.",
"properties": {
"subscription": {
"$ref": "#/components/schemas/LinkType"
}
},
"required": ["subscription"],
"type": "object",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Structure (inlined)"
},
"description": "Published V2X message content. The format of the string is defined by the standardization organization indicated by the attribute stdOrganization.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"msgEncodeFormat": {
"description": "The encode format of the V2X message, for example base64.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"msgType": {
"description": "Published V2X message type. Its value is defined by the standardization organization indicated by the attribute stdOrganization. See note 2.\n− denm(1): Decentralized Environmental Notification Message (DENM) as specified in ETSI EN 302 637-3,\n− cam(2): Cooperative Awareness Message (CAM) as specified in ETSI EN 302 637-2,\n− poi(3): Point of Interest message as specified in ETSI TS 101 556-1,\n− spatem(4): Signal Phase And Timing (SPAT) message as specified in SAE J2735 and in ETSI TS 103 301,\n− mapem(5): MAP message as specified in SAE J2735 and in ETSI TS 103 301,\n− ivim(6): In Vehicle Information (IVI) message as defined in ISO TS 19321,\n− ev-rsr(7): Electric vehicle recharging spot reservation message, as defined in ETSI TS 101 556-3,\n− tistpgtransaction(8): messages for Tyre Information System (TIS) and Tyre Pressure Gauge (TPG) interoperability, as specified in ETSI TS 101 556-2,\n− srem(9): Traffic light Signal Request Message as specified in ETSI TS 103 301,\n− ssem(10): Traffic Light Signal Request Status Message as specified in ETSI TS 103 301.\n− evcsn(11): Electrical Vehicle Charging Spot Notification message as specified in ETSI TS 101 556-1,\n− saem(12): Services Announcement Extended Message as specified in ETSI TS 102 890-1,\n− rtcmem(13): Radio Technical Commission for Maritime Services (RTCM) Message as specified in ETSI TS 103 301,\n",
"enum": [
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"10",
"11",
"12",
"13"
],
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Enum"
},
"notificationType": {
"description": "Shall be set to \"V2xMsgNotification\".",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"stdOrganization": {
"description": "Standardization organization which defines the published V2X message type: \nETSI: European Telecommunications Standards Institute.\nSee note 1.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Enum"
"timeStamp": {
"$ref": "#/components/schemas/TimeStamp"
}
},
"required": [
"notificationType",
"timeStamp",
"stdOrganization",
"msgType",
"msgEncodeFormat",
"msgContent",
"_links"
],
"type": "object",
"x-etsi-notes": "NOTE 1:\tOther standardization organizations could be added as needed.\nNOTE 2:\tThe V2X message types of ETSI shall be used as specified in ETSI TS 102 894-2 [6], clause A.114.",
"x-etsi-ref": "6.4.5"
"msgContent": {
"description": "Published V2X message content. Its format is defined by the standardization organization indicated by the attribute stdOrganization.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"msgEncodeFormat": {
"description": "The encode format of the V2X message, for example base64.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
},
"msgType": {
"description": "Published V2X message type. Its value is defined by the standardization organization indicated by the attribute stdOrganization. See note 2.\n− denm(1): Decentralized Environmental Notification Message (DENM) as specified in ETSI EN 302 637-3,\n− cam(2): Cooperative Awareness Message (CAM) as specified in ETSI EN 302 637-2,\n− poi(3): Point of Interest message as specified in ETSI TS 101 556-1,\n− spatem(4): Signal Phase And Timing (SPAT) message as specified in SAE J2735 and in ETSI TS 103 301,\n− mapem(5): MAP message as specified in SAE J2735 and in ETSI TS 103 301,\n− ivim(6): In Vehicle Information (IVI) message as defined in ISO TS 19321,\n− ev-rsr(7): Electric vehicle recharging spot reservation message, as defined in ETSI TS 101 556-3,\n− tistpgtransaction(8): messages for Tyre Information System (TIS) and Tyre Pressure Gauge (TPG) interoperability, as specified in ETSI TS 101 556-2,\n− srem(9): Traffic light Signal Request Message as specified in ETSI TS 103 301,\n− ssem(10): Traffic Light Signal Request Status Message as specified in ETSI TS 103 301.\n− evcsn(11): Electrical Vehicle Charging Spot Notification message as specified in ETSI TS 101 556-1,\n− saem(12): Services Announcement Extended Message as specified in ETSI TS 102 890-1,\n− rtcmem(13): Radio Technical Commission for Maritime Services (RTCM) Message as specified in ETSI TS 103 301,\n",
"enum": [
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"10",
"11",
"12",
"13"
],
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Enum"
},
"stdOrganization": {
"description": "Standardization organization which defines the published V2X message type:\nETSI: European Telecommunications Standards Institute. \nSee note 1.",
"enum": ["ETSI"],
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Enum"
"required": [
"stdOrganization",
"msgType",
"msgEncodeFormat",
"msgContent"
],
"x-etsi-notes": "NOTE 1:\tOther standardization organizations could be added as needed.\nNOTE 2:\tThe V2X message types of ETSI shall be used as specified in ETSI TS 102 894-2 [6], clause A.114.",
"x-etsi-ref": "6.2.6"
"_links": {
"description": "Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.",
"properties": {
"self": {
"$ref": "#/components/schemas/LinkType"
}
},
"required": ["self"],
"type": "object",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Structure (inlined)"
"callbackReference": {
"description": "URI exposed by the client on which to receive notifications via HTTP. See note 1.",
"format": "uri",
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uri"
},
"expiryDeadline": {
"$ref": "#/components/schemas/TimeStamp"
},
"filterCriteria": {
"description": "List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.",
"properties": {
"msgType": {
"description": "Subscribed V2X message type. Its value is defined by the standardization organization indicated by the attribute stdOrganization. See note 3.",
"items": {
"type": "string"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "Enum"
},
"stdOrganization": {
"description": "Standardization organization which defines the subscribed V2X message type: \nETSI: European Telecommunications Standards Institute. \nSee note 2.",
"enum": ["ETSI"],
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Enum"
}
},
"required": ["stdOrganization"],
"type": "object",
"x-etsi-mec-origin-type": "Structure (inlined)"
"requestTestNotification": {
"description": "Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as described in ETSI GS MEC 009 [i.1], clause 6.12a.\nDefault: FALSE.",
"type": "boolean",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Boolean"
},
"subscriptionType": {
"description": "Shall be set to \"V2xMsgSubscription\".",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"websockNotifConfig": {
"$ref": "#/components/schemas/WebsockNotifConfig"
"required": ["subscriptionType", "filterCriteria"],
"x-etsi-notes": "NOTE 1:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to VIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009 [i.1], clause 6.12a.\nNOTE 2:\tOther standardization organizations could be added as needed.\nNOTE 3:\tThe V2X message types of ETSI shall be used as specified in ETSI TS 102 894-2 [6], clause A.114.",
"x-etsi-ref": "6.3.5"
},
"V2xServerUsd": {
"properties": {
"sdpInfo": {
"description": "SDP with IP multicast address and port number used for V2X communication via MBMS.",
"properties": {
"ipMulticastAddress": {
"description": "",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"portNumber": {
"description": "",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
}
},
"required": ["ipMulticastAddress", "portNumber"],
"type": "object",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Structure (inlined)"
},
"serviceAreaIdentifier": {
"description": "A list of service area identifier for the applicable MBMS broadcast area.",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"x-etsi-mec-cardinality": "1..N",
"x-etsi-mec-origin-type": "String"
},
"tmgi": {
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
"description": "Temporary Mobile Group Identity (TMGI), which is used within MBMS to uniquely identify Multicast and Broadcast bearer services.",
"properties": {
"mbmsServiceId": {
"description": "MBMS Service ID consisting of three octets.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"mcc": {
"description": "The Mobile Country Code part of PLMN Identity.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"mnc": {
"description": "The Mobile Network Code part of PLMN Identity.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
}
},
"required": ["mbmsServiceId", "mcc", "mnc"],
"type": "object",
"x-etsi-mec-cardinality": "",
"x-etsi-mec-origin-type": "Structure (inlined)"
}
},
"required": ["tmgi", "serviceAreaIdentifier", "sdpInfo"],
"type": "object",
"x-etsi-ref": "6.5.10"
},
"requestWebsocketUri": {
"description": "Set to TRUE by the service consumer to indicate that Websocket delivery is requested.",
"type": "boolean",
"websocketUri": {
"description": "Set by VIS to indicate to the service consumer the Websocket URI to be used for delivering notifications.",
"format": "uri",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"type": "object",
"x-etsi-ref": "6.5.14"
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
}
},
"responses": {
"204": {
"description": "No Content"
},
"206": {
"description": "Partial content"
},
"400": {
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized : used when the client did not submit credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"406": {
"description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"412": {
"description": "Precondition failed : used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"415": {
"description": "Unsupported Media Type : used to indicate that the server or the client does not support the content type of the entity body.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests : used when a rate limiter has triggered.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
}