Newer
Older
{
"openapi": "3.1.0",
"info": {
"title": "ETSI GS MEC 030 V2X Information Service API",
"version": "2.1.9",
"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.1.9",
"url": ""
}
],
"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"
},
"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)"
},
"href": {
"description": "URI referring to a resource",
"format": "uri",
"type": "string",
},
"LocationInfo": {
"properties": {
"ecgi": {
"$ref": "#/components/schemas/Ecgi"
},
"geoArea": {
"$ref": "#/components/schemas/LocationInfo.geoArea"
}
},
"type": "object",
"x-etsi-notes": "NOTE:\tEither ecgi or geoArea shall be present, but not both.",
"x-etsi-ref": "6.5.3"
},
"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)"
},
"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": {
"properties": {
"proInfoPc5": {
"$ref": "#/components/schemas/Pc5ProvisioningInfo.proInfoPc5"
"timeStamp": {
"$ref": "#/components/schemas/TimeStamp"
}
},
"required": ["proInfoPc5"],
"type": "object",
"x-etsi-ref": "6.2.4"
},
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
"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)"
},
"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"
"description": "Information relating to the potential routes of a vehicular UE.",
"items": {
"$ref": "#/components/schemas/PredictedQos.routes"
},
"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"
"PredictedQos.routes": {
"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": {
"$ref": "#/components/schemas/PredictedQos.routes.routeInfo"
},
"required": ["location"],
"minItems": 2,
"type": "array",
"x-etsi-mec-cardinality": "2..N",
"x-etsi-mec-origin-type": "Structure (inlined)"
}
"PredictedQos.routes.routeInfo": {
"type": "object",
"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"
}
"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"
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
},
"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": "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": {
"$ref": "#/components/schemas/ProvChgPc5Subscription.filterCriteria"
},
"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.",
"ProvChgPc5Subscription.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": {
"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"