Newer
Older
title: 'ETSI GS MEC 030 V2X Information Service API'
description: 'ETSI GS MEC 030 V2X Information Service API described using OpenAPI.'
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
/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:
required: true
description: 'Comma separated list of locations to identify a cell of a base station or a particular geographical area'
'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:
required: true
description: 'omma separated list of locations to identify a cell of a base station or a particular geographical area'
'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:
required: true
description: 'Comma separated list of locations to identify a cell of a base station or a particular geographical area'
'200':
description: 'A response body containing the PC5 provisioning information is returned.'
content:
application/json:
schema:
'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'
'200':
description: 'The response body shall contain the predicted QoS corresponding to potential routes of a vehicular UE'
content:
application/json:
schema:
'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:
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'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/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'
/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
summary: 'Retrieve information about this subscription.'
description: 'Retrieve information about this subscription.'
operationId: individualSubscriptionGET
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':
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'
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'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
delete:
tags:
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'
# /notifitication_end_point_provided_by_client
#post:
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:
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:
type: object
x-etsi-ref: 6.6.3
Ecgi:
properties:
cellId:
# description': The E-UTRAN Cell Identity.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': CellId
$ref: '#/components/schemas/CellId'
plmn:
# description': Public Land Mobile Network Identity.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': Plmn
$ref: '#/components/schemas/Plmn'
required:
type: object
x-etsi-ref: 6.5.5
FddInfo:
properties:
dlEarfcn:
# description': ''
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': Earfcn
$ref: '#/components/schemas/Earfcn'
dlTransmissionBandwidth:
# description': ''
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': TransmissionBandwidth
$ref: '#/components/schemas/TransmissionBandwidth'
ulEarfcn:
# description': ''
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': Earfcn
$ref: '#/components/schemas/Earfcn'
ulTransmissionBandwidth:
# description': ''
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': TransmissionBandwidth
$ref: '#/components/schemas/TransmissionBandwidth'
required:
- ulEarfcn
- dlEarfcn
- ulTransmissionBandwidth
- dlTransmissionBandwidth
Links:
description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.
properties:
self:
# description': Self-referring URI. The URI shall be unique within the VIS API as it acts as an ID for the subscription.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': LinkType
$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:
# description': E-UTRAN CelI Global Identifier of the serving cell.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': Ecgi
$ref: '#/components/schemas/Ecgi'
geoArea:
$ref: '#/components/schemas/GeoArea'
type: object
x-etsi-notes: "NOTE:\tEither ecgi or geoArea shall be present, but not both."
x-etsi-ref: 6.5.3
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)
Pc5NeighbourCellInfo:
properties:
ecgi:
# description': E-UTRAN CelI Global Identifier.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': Ecgi
$ref: '#/components/schemas/Ecgi'
plmn:
# description': Public Land Mobile Network Identity.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': Plmn
$ref: '#/components/schemas/Plmn'
siV2xConfig:
# description': V2X sidelink communication configuration, as defined in ETSI TS 136 331 [i.11].
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': SystemInformationBlockType21 (as defined in ETSI TS 136 331 [i.11])
$ref: '#/components/schemas/SystemInformationBlockType21'
$ref: '#/components/schemas/ProInfoPc5'
timeStamp:
# description': Time stamp.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': TimeStamp
$ref: '#/components/schemas/TimeStamp'
type: object
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
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:
# description': Location information to identify a cell of a base station or a particular geographical area.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': 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:
PredictedQos:
properties:
locationGranularity:
description: Granularity of visited location. Measured in meters.
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
$ref: '#/components/schemas/Routes'
timeGranularity:
# description': Time granularity of visiting a location.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': TimeStamp
$ref: '#/components/schemas/TimeStamp'
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
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
Routes:
description: Information relating to the potential routes of a vehicular UE.
items:
properties:
routeInfo:
$ref: '#/components/schemas/RouteInfo'
type: object
minItems: 1
required:
- routeInfo
type: array
x-etsi-mec-cardinality: 1..N
x-etsi-mec-origin-type: Structure (inlined)
RouteInfo:
description: 'Information relating to a specific route.
The 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:
# description': Vehicular UE location.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': LocationInfo
$ref: '#/components/schemas/LocationInfo'
rsrp:
description:
'Reference Signal Received Power as defined in ETSI TS 136 214 [i.13].
Shall 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].
Shall only be included in the response.'
format: uint8
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Uint8
time:
# description': Estimated time at the location.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': TimeStamp
$ref: '#/components/schemas/TimeStamp'
required:
- location
type: array
x-etsi-mec-cardinality: 2..N
x-etsi-mec-origin-type: Structure (inlined)
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
ProblemDetails:
properties:
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
type: object
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
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:
# description': Location information to identify a cell of a base station or a particular geographical area.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': 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:
# description': Time stamp.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': TimeStamp
$ref: '#/components/schemas/TimeStamp'
required:
type: object
x-etsi-ref: 6.4.4
ProvChgPc5Subscription:
properties:
_links:
$ref: '#/components/schemas/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:
# description': Time stamp.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': TimeStamp
$ref: '#/components/schemas/TimeStamp'
filterCriteria:
$ref: '#/components/schemas/ProvChgPc5SubscriptionFilterCriteria'
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:
# description': Provides details to negotiate and signal the use of a Websocket connection between VIS and the service consumer for notifications. See note.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': WebsockNotifConfig
$ref: '#/components/schemas/WebsockNotifConfig'
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.'
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
ProvChgPc5SubscriptionFilterCriteria:
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:
# description': Location information to identify a cell of a base station or a particular geographical area.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': 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)
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
ProvChgUuMbmsNotification:
properties:
locationInfo:
# description': Location information to identify a cell of a base station or a particular geographical area.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': 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:
# description': Time stamp.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': TimeStamp
$ref: '#/components/schemas/TimeStamp'
v2xServerUsd:
# description': User Service Description for V2X Application Server is used to configure the UE for receiving local V2X Application Server information when it is provided over MBMS.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': V2xServerUsd
$ref: '#/components/schemas/V2xServerUsd'
required:
type: object
x-etsi-ref: 6.4.3
ProvChgUuMbmsSubscription:
properties:
_links:
$ref: '#/components/schemas/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:
# description': Time stamp.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': TimeStamp
$ref: '#/components/schemas/TimeStamp'
filterCriteria:
$ref: '#/components/schemas/ProvChgUuMbmsSubscriptionFilterCriteria'
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:
# description': Provides details to negotiate and signal the use of a Websocket connection between VIS and the service consumer for notifications. See note.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': WebsockNotifConfig
$ref: '#/components/schemas/WebsockNotifConfig'
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."
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
ProvChgUuMbmsSubscriptionFilterCriteria:
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:
# description': Location information to identify a cell of a base station or a particular geographical area.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': 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:
# description': User Service Description for V2X Application Server is used to configure the UE for receiving local V2X Application Server information when it is provided over MBMS.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': V2xServerUsd
$ref: '#/components/schemas/V2xServerUsd'
required:
- locationInfo
- v2xServerUsd
type: object
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Structure (inlined)
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
ProvChgUuUniNotification:
properties:
locationInfo:
# description': Location information to identify a cell of a base station or a particular geographical area.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': 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:
# description': Time stamp.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': TimeStamp
$ref: '#/components/schemas/TimeStamp'
v2xApplicationServer:
# description': V2X Application Server address (consisting of IP address and UDP port) for unicast.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': V2xApplicationServer
$ref: '#/components/schemas/V2xApplicationServer'
required:
type: object
x-etsi-ref: 6.4.2
ProvChgUuUniSubscription:
properties:
_links:
$ref: '#/components/schemas/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:
# description': Time stamp.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': TimeStamp
$ref: '#/components/schemas/TimeStamp'
filterCriteria:
$ref: '#/components/schemas/ProvChgUuUniSubscriptionFilterCriteria'
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:
# description': Provides details to negotiate and signal the use of a Websocket connection between VIS and the service consumer for notifications. See note.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': WebsockNotifConfig
$ref: '#/components/schemas/WebsockNotifConfig'
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."
ProvChgUuUniSubscriptionFilterCriteria:
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:
# description': Location information to identify a cell of a base station or a particular geographical area.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': 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'