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.1.9'
url: ''
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
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/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:
# 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'
properties:
proInfoPc5:
![Hammad Zafar Hammad Zafar's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Hammad Zafar
committed
type: array
minItems: 1
items:
$ref: '#/components/schemas/Pc5ProvisioningInfo.proInfoPc5'
timeStamp:
# description': Time stamp.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': TimeStamp
$ref: '#/components/schemas/TimeStamp'
description: The provisioning information per location as defined below.
![Hammad Zafar Hammad Zafar's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Hammad Zafar
committed
type: object
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
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
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:
# 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
PredictedQos.routes:
properties:
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:
$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)
type: object
minItems: 1
PredictedQos.routes.routeInfo:
type: object
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
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'
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
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
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
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:
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/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:
# 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.'
ProvChgPc5Subscription.filterCriteria:
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
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)
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
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:
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/ProvChgUuMbmsSubscription.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 "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."
ProvChgUuMbmsSubscription.filterCriteria:
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
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)
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
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:
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/ProvChgUuUniSubscription.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 "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."
ProvChgUuUniSubscription.filterCriteria:
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
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'
minItems: 0
type: array
x-etsi-mec-cardinality: 0..N
x-etsi-mec-origin-type: UuUniNeighbourCellInfo
v2xApplicationServer:
# description': V2X Application Server address (consisting of IP address and UDP port) for unicast.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': V2xApplicationServer
$ref: '#/components/schemas/V2xApplicationServer'
required:
- locationInfo
- v2xApplicationServer
type: object
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Structure (inlined)
$ref: '#/components/schemas/SubscriptionLinkList.links'
SystemInformationBlockType21:
type: object
TddInfo:
properties:
earfcn:
# description': ''
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': 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:
# description': ''
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': TransmissionBandwidth
$ref: '#/components/schemas/TransmissionBandwidth'
required:
- earfcn
- transmissionBandwidth
- subframeAssignment
description: List of hyperlinks related to the resource.
properties:
self:
# description': URI of this resource.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': LinkType
$ref: '#/components/schemas/LinkType'
subscriptions:
![Hammad Zafar Hammad Zafar's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Hammad Zafar
committed
type: array
items:
$ref: '#/components/schemas/SubscriptionLinkList.links.subscriptions'
required:
- self
type: object
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Structure (inlined)
SubscriptionLinkList.links.subscriptions:
description: The service consumer's subscriptions.
![Hammad Zafar Hammad Zafar's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Hammad Zafar
committed
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
x-etsi-mec-cardinality: 0..N
x-etsi-mec-origin-type: Structure (inlined)
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
TestNotification:
properties:
_links:
description: 'Hyperlink related to the resource. '
properties:
subscription:
# description': URI identifying the subscription for the test notification.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': LinkType
$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:
type: object
x-etsi-ref: 6.5.2
TransmissionBandwidth:
properties:
transmissionBandwidth:
$ref: '#/components/schemas/TransmissionBandwidth.transmissionBandwidth'
required:
- transmissionBandwidth
type: object
x-etsi-ref: 6.6.4
TransmissionBandwidth.transmissionBandwidth:
description: |
'Numeric value corresponding to the transmission bandwidth expressed in units of resource blocks as follows:
1 = bw6 (6 resource blocks)
2 = bw15 (15 resource blocks)
3 = bw25 (25 resource blocks)
4 = bw50 (50 resource blocks)
5 = bw75 (75 resource blocks)
6 = bw100 (100 resource blocks)'
enum:
- 1
- 2
- 3
- 4
- 5
- 6
type: integer
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Enum
1163
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
1193
1194
1195
1196
1197
1198
UuMbmsNeighbourCellInfo:
properties:
ecgi:
# description': E-UTRAN CelI Global Identifier.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': Ecgi
$ref: '#/components/schemas/Ecgi'
fddInfo:
# description': Information for FDD operation.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': 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:
# description': Public Land Mobile Network Identity.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': Plmn
$ref: '#/components/schemas/Plmn'
tddInfo:
# description': Information for TDD operation.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': TddInfo
$ref: '#/components/schemas/TddInfo'
required:
- plmn
- ecgi
- pci
- fddInfo
- tddInfo
- mbmsServiceAreaIdentity
type: object
x-etsi-ref: 6.5.11
UuMbmsProvisioningInfo:
properties:
proInfoUuMbms:
![Hammad Zafar Hammad Zafar's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Hammad Zafar
committed
type: array
minItems: 1
items:
$ref: '#/components/schemas/UuMbmsProvisioningInfo.proInfoUuMbms'
timeStamp:
# description': Time stamp.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': TimeStamp
$ref: '#/components/schemas/TimeStamp'
UuMbmsProvisioningInfo.proInfoUuMbms:
description: The provisioning information per location as defined below.
![Hammad Zafar Hammad Zafar's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Hammad Zafar
committed
type: object
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
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
x-etsi-mec-cardinality: 1..N
x-etsi-mec-origin-type: Structure (inlined)
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
UuUniNeighbourCellInfo:
properties:
ecgi:
# description': E-UTRAN CelI Global Identifier.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': Ecgi
$ref: '#/components/schemas/Ecgi'
fddInfo:
# description': Information for FDD operation.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': FddInfo
$ref: '#/components/schemas/FddInfo'
pci:
description: Physical Cell Identifier.
type: integer
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Integer
plmn:
# description': Public Land Mobile Network Identity.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': Plmn
$ref: '#/components/schemas/Plmn'
tddInfo:
# description': Information for TDD operation.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': TddInfo
$ref: '#/components/schemas/TddInfo'
required:
- plmn
- ecgi
- pci
- fddInfo
- tddInfo
type: object
x-etsi-ref: 6.5.9
UuUnicastProvisioningInfo:
properties:
proInfoUuUnicast:
![Hammad Zafar Hammad Zafar's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Hammad Zafar
committed
type: array
minItems: 1
items:
$ref: '#/components/schemas/UuUnicastProvisioningInfo.proInfoUuUnicast'
timeStamp:
# description': Time stamp.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': TimeStamp
$ref: '#/components/schemas/TimeStamp'
UuUnicastProvisioningInfo.proInfoUuUnicast:
description: The provisioning information per location as defined below.
![Hammad Zafar Hammad Zafar's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Hammad Zafar
committed
type: object
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
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
v2xApplicationServer:
# description': V2X Application Server address (consisting of IP address and UDP port) for unicast.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': V2xApplicationServer
$ref: '#/components/schemas/V2xApplicationServer'
required:
- locationInfo
- v2xApplicationServer
x-etsi-mec-cardinality: 1..N
x-etsi-mec-origin-type: Structure (inlined)
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:
$ref: '#/components/schemas/V2xMsgNotification.links'
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:
notificationType:
description: Shall be set to "V2xMsgNotification".
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
description: "Standardization organization which defines the published V2X message type: \nETSI: European Telecommunications Standards Institute.\nSee note 1."
x-etsi-mec-origin-type: Enum
timeStamp:
# description': Date and time of the notification generation.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': TimeStamp
$ref: '#/components/schemas/TimeStamp'
- 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.4.5
V2xMsgNotification.links:
description: links to resources related to this notification.
properties:
subscription:
# description': A link to the related subscription.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': LinkType
$ref: '#/components/schemas/LinkType'
required:
- subscription
type: object
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Structure (inlined)
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
description: "Standardization organization which defines the published V2X message type:\nETSI: European Telecommunications Standards Institute. \nSee note 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
description: |
Published V2X message type. Its value is defined by the standardization organization indicated by the attribute stdOrganization. See note 2.
− denm(1): Decentralized Environmental Notification Message (DENM) as specified in ETSI EN 302 637-3,
− cam(2): Cooperative Awareness Message (CAM) as specified in ETSI EN 302 637-2,
− poi(3): Point of Interest message as specified in ETSI TS 101 556-1,
− spatem(4): Signal Phase And Timing (SPAT) message as specified in SAE J2735 and in ETSI TS 103 301,
− mapem(5): MAP message as specified in SAE J2735 and in ETSI TS 103 301,
− ivim(6): In Vehicle Information (IVI) message as defined in ISO TS 19321,
− ev-rsr(7): Electric vehicle recharging spot reservation message, as defined in ETSI TS 101 556-3,
− tistpgtransaction(8): messages for Tyre Information System (TIS) and Tyre Pressure Gauge (TPG) interoperability, as specified in ETSI TS 101 556-2,
− srem(9): Traffic light Signal Request Message as specified in ETSI TS 103 301,
− ssem(10): Traffic Light Signal Request Status Message as specified in ETSI TS 103 301.
− evcsn(11): Electrical Vehicle Charging Spot Notification message as specified in ETSI TS 101 556-1,
− saem(12): Services Announcement Extended Message as specified in ETSI TS 102 890-1,
− rtcmem(13): Radio Technical Commission for Maritime Services (RTCM) Message as specified in ETSI TS 103 301,
enum:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
type: integer
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Enum
description: URI exposed by the client on which to receive notifications via HTTP. See note 1.
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/V2xMsgSubscription.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 "V2xMsgSubscription".
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 1.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': WebsockNotifConfig
$ref: '#/components/schemas/WebsockNotifConfig'
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."
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
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-cardinality: '1'
x-etsi-mec-origin-type: Structure (inlined)
$ref: '#/components/schemas/V2xServerUsd.sdpInfo'
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:
$ref: '#/components/schemas/V2xServerUsd.tmgi'
- tmgi
- serviceAreaIdentifier
- 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)
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
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)
requestWebsocketUri:
description: Set to TRUE by the service consumer to indicate that Websocket delivery is requested.
type: boolean
x-etsi-mec-origin-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
'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'
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'
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'
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: