MEC030_V2XInformationService.json 67.8 KB
Newer Older
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
          },
          "locationInfo": {
            "$ref": "#/components/schemas/LocationInfo"
          },
          "neighbourCellInfo": {
            "description": "The information of the neighbour cells in a visiting PLMN that support V2X communication over PC5.",
            "items": {
              "$ref": "#/components/schemas/Pc5NeighbourCellInfo"
            },
            "minItems": 0,
            "type": "array",
            "x-etsi-mec-cardinality": "0..N",
            "x-etsi-mec-origin-type": "Pc5NeighbourCellInfo"
          }
        },
        "required": ["locationInfo", "dstLayer2Id"],
        "type": "object",
        "x-etsi-mec-cardinality": "1",
        "x-etsi-mec-origin-type": "Structure (inlined)"
      },
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
      "ProvChgUuMbmsNotification": {
        "properties": {
          "locationInfo": {
            "$ref": "#/components/schemas/LocationInfo"
          },
          "neighbourCellInfo": {
            "description": "The information of the neighbour cells in a visiting PLMN that support V2X communication over Uu MBMS.",
            "items": {
              "$ref": "#/components/schemas/UuMbmsNeighbourCellInfo"
            },
            "minItems": 0,
            "type": "array",
            "x-etsi-mec-cardinality": "0..N",
            "x-etsi-mec-origin-type": "UuMbmsNeighbourCellInfo"
          },
          "notificationType": {
            "description": "Shall be set to \"ProvChgUuMbmsNotification\".",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
          },
          "timeStamp": {
            "$ref": "#/components/schemas/TimeStamp"
          },
          "v2xServerUsd": {
            "$ref": "#/components/schemas/V2xServerUsd"
          }
        },
        "required": ["notificationType", "locationInfo"],
        "type": "object",
        "x-etsi-ref": "6.4.3"
      },
      "ProvChgUuMbmsSubscription": {
        "properties": {
          "_links": {
            "$ref": "#/components/schemas/links"
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
          },
          "callbackReference": {
            "description": "URI exposed by the client on which to receive notifications via HTTP. See note.",
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
            "format": "uri",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Uri"
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
          },
          "expiryDeadline": {
            "$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"
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
          },
          "subscriptionType": {
            "description": "Shall be set to \"ProvChgUuMbmsSubscription\".",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
          },
          "websockNotifConfig": {
            "$ref": "#/components/schemas/WebsockNotifConfig"
        "required": ["subscriptionType", "filterCriteria"],
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
        "type": "object",
        "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.",
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
        "x-etsi-ref": "6.3.3"
      },
      "ProvChgUuMbmsSubscription.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": {
          "locationInfo": {
            "$ref": "#/components/schemas/LocationInfo"
          },
          "neighbourCellInfo": {
            "description": "The information of the neighbour cells in a visiting PLMN that support V2X communication over Uu MBMS.",
            "items": {
              "$ref": "#/components/schemas/UuMbmsNeighbourCellInfo"
            },
            "minItems": 0,
            "type": "array",
            "x-etsi-mec-cardinality": "0..N",
            "x-etsi-mec-origin-type": "UuMbmsNeighbourCellInfo"
          },
          "v2xServerUsd": {
            "$ref": "#/components/schemas/V2xServerUsd"
          }
        },
        "required": ["locationInfo", "v2xServerUsd"],
        "type": "object",
        "x-etsi-mec-cardinality": "1",
        "x-etsi-mec-origin-type": "Structure (inlined)"
      },
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
      "ProvChgUuUniNotification": {
        "properties": {
          "locationInfo": {
            "$ref": "#/components/schemas/LocationInfo"
          },
          "neighbourCellInfo": {
            "description": "The information of the neighbour cells in a visiting PLMN that support V2X communication over Uu unicast.",
            "items": {
              "$ref": "#/components/schemas/UuUniNeighbourCellInfo"
            },
            "minItems": 0,
            "type": "array",
            "x-etsi-mec-cardinality": "0..N",
            "x-etsi-mec-origin-type": "UuUniNeighbourCellInfo"
          },
          "notificationType": {
            "description": "Shall be set to \"ProvChgUuUniNotification\".",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
          },
          "timeStamp": {
            "$ref": "#/components/schemas/TimeStamp"
          },
          "v2xApplicationServer": {
            "$ref": "#/components/schemas/V2xApplicationServer"
          }
        },
        "required": ["notificationType", "locationInfo"],
        "type": "object",
        "x-etsi-ref": "6.4.2"
      },
      "ProvChgUuUniSubscription": {
        "properties": {
          "_links": {
            "$ref": "#/components/schemas/links"
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
          },
          "callbackReference": {
            "description": "URI exposed by the client on which to receive notifications via HTTP. See note.",
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
            "format": "uri",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Uri"
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
          },
          "expiryDeadline": {
            "$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"
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
          },
          "subscriptionType": {
            "description": "Shall be set to \"ProvChgUuUniSubscription\".",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
          },
          "websockNotifConfig": {
            "$ref": "#/components/schemas/WebsockNotifConfig"
        "required": ["subscriptionType", "filterCriteria"],
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
        "type": "object",
        "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.",
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
        "x-etsi-ref": "6.3.2"
      },
      "ProvChgUuUniSubscription.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.",
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
        "properties": {
          "locationInfo": {
            "$ref": "#/components/schemas/LocationInfo"
          },
          "neighbourCellInfo": {
            "description": "The information of the neighbour cells in a visiting PLMN that support V2X communication over Uu unicast.",
            "items": {
              "$ref": "#/components/schemas/UuUniNeighbourCellInfo"
            "minItems": 0,
            "type": "array",
            "x-etsi-mec-cardinality": "0..N",
            "x-etsi-mec-origin-type": "UuUniNeighbourCellInfo"
          },
          "v2xApplicationServer": {
            "$ref": "#/components/schemas/V2xApplicationServer"
          }
        },
        "required": ["locationInfo", "v2xApplicationServer"],
        "type": "object",
        "x-etsi-mec-cardinality": "1",
        "x-etsi-mec-origin-type": "Structure (inlined)"
      },
      "SubscriptionLinkList": {
        "properties": {
          "_links": {
            "$ref": "#/components/schemas/SubscriptionLinkList.links"
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
          }
        },
        "required": ["_links"],
        "type": "object",
        "x-etsi-ref": "6.3.6"
      },
      "SystemInformationBlockType21": {
        "type": "object"
      },
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
      "TddInfo": {
        "properties": {
          "earfcn": {
            "$ref": "#/components/schemas/Earfcn"
          },
          "subframeAssignment": {
            "description": "Uplink-downlink subframe configuration information.",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
          },
          "transmissionBandwidth": {
            "$ref": "#/components/schemas/TransmissionBandwidth"
          }
        },
        "required": ["earfcn", "transmissionBandwidth", "subframeAssignment"],
        "type": "object",
        "x-etsi-ref": "6.5.7"
      },
      "SubscriptionLinkList.links": {
        "description": "List of hyperlinks related to the resource.",
        "items": {
          "properties": {
            "self": {
              "$ref": "#/components/schemas/LinkType"
            },
            "subscriptions": {
              "$ref": "#/components/schemas/SubscriptionLinkList.links.subscriptions"
            }
          },
          "type": "object"
        },
        "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.",
        "items": {
          "type": "object"
        },
        "minItems": 0,
        "properties": {
          "href": {
            "description": "The URI referring to the subscription.",
            "format": "uri",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "URI"
          },
          "subscriptionType": {
            "description": "Type of the subscription. The values are as defined in the \"subscriptionType\" attribute for each different V2X information event subscription data type.",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
          }
        },
        "required": ["href", "subscriptionType"],
        "type": "array",
        "x-etsi-mec-cardinality": "0..N",
        "x-etsi-mec-origin-type": "Structure (inlined)"
      },
      "TestNotification": {
        "properties": {
          "_links": {
            "description": "Hyperlink related to the resource. ",
            "properties": {
              "subscription": {
                "$ref": "#/components/schemas/LinkType"
              }
            },
            "required": ["subscription"],
            "type": "object",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Structure (inlined)"
          },
          "notificationType": {
            "description": "Shall be set to \"TestNotification\".",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
          }
        },
        "required": ["notificationType", "_links"],
        "type": "object",
        "x-etsi-ref": "6.4.6"
      },
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
      "TimeStamp": {
        "properties": {
          "nanoSeconds": {
            "description": "The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.",
            "format": "uint32",
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
            "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.",
            "format": "uint32",
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
            "type": "integer",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Uint32"
          }
        },
        "required": ["seconds", "nanoSeconds"],
        "type": "object",
        "x-etsi-ref": "6.5.2"
      },
      "TransmissionBandwidth": {
        "properties": {
          "transmissionBandwidth": {
            "$ref": "#/components/schemas/TransmissionBandwidth.transmissionBandwidth"
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
          }
        },
        "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:\n\n1 = bw6 (6 resource blocks)\n\n2 = bw15 (15 resource blocks)\n\n3 = bw25 (25 resource blocks)\n\n4 = bw50 (50 resource blocks)\n\n5 = bw75 (75 resource blocks)\n\n6 = bw100 (100 resource blocks)'\n",
        "enum": ["1", "2", "3", "4", "5", "6"],
        "x-etsi-mec-cardinality": "1",
        "x-etsi-mec-origin-type": "Enum"
      },
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
      "UuMbmsNeighbourCellInfo": {
        "properties": {
          "ecgi": {
            "$ref": "#/components/schemas/Ecgi"
          },
          "fddInfo": {
            "$ref": "#/components/schemas/FddInfo"
          },
          "mbmsServiceAreaIdentity": {
            "description": "Supported MBMS Service Area Identities in the cell.",
            "items": {
              "type": "string"
            },
            "minItems": 1,
            "type": "array",
            "x-etsi-mec-cardinality": "1..N",
            "x-etsi-mec-origin-type": "String"
          },
          "pci": {
            "description": "Physical Cell Identifier.",
            "type": "integer",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Integer"
          },
          "plmn": {
            "$ref": "#/components/schemas/Plmn"
          },
          "tddInfo": {
            "$ref": "#/components/schemas/TddInfo"
          }
        },
        "required": [
          "plmn",
          "ecgi",
          "pci",
          "fddInfo",
          "tddInfo",
          "mbmsServiceAreaIdentity"
        ],
        "type": "object",
        "x-etsi-ref": "6.5.11"
      },
      "UuMbmsProvisioningInfo": {
        "items": {
          "properties": {
            "proInfoUuMbms": {
              "$ref": "#/components/schemas/UuMbmsProvisioningInfo.proInfoUuMbms"
            },
            "timeStamp": {
              "$ref": "#/components/schemas/TimeStamp"
            }
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
          },
          "type": "object"
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
        },
        "required": ["proInfoUuMbms"],
        "type": "object",
        "x-etsi-ref": "6.2.3"
      },
      "UuMbmsProvisioningInfo.proInfoUuMbms": {
        "description": "The provisioning information per location as defined below.",
        "items": {
          "type": "object"
        },
        "minItems": 1,
        "properties": {
          "locationInfo": {
            "$ref": "#/components/schemas/LocationInfo"
          },
          "neighbourCellInfo": {
            "description": "The information of the neighbour cells in a visiting PLMN that support V2X communication over Uu MBMS.",
            "items": {
              "$ref": "#/components/schemas/UuMbmsNeighbourCellInfo"
            },
            "minItems": 0,
            "type": "array",
            "x-etsi-mec-cardinality": "0..N",
            "x-etsi-mec-origin-type": "UuMbmsNeighbourCellInfo"
          },
          "v2xServerUsd": {
            "$ref": "#/components/schemas/V2xServerUsd"
          }
        },
        "required": ["locationInfo", "v2xServerUsd"],
        "type": "array",
        "x-etsi-mec-cardinality": "1..N",
        "x-etsi-mec-origin-type": "Structure (inlined)"
      },
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
      "UuUniNeighbourCellInfo": {
        "properties": {
          "ecgi": {
            "$ref": "#/components/schemas/Ecgi"
          },
          "fddInfo": {
            "$ref": "#/components/schemas/FddInfo"
          },
          "pci": {
            "description": "Physical Cell Identifier.",
            "type": "integer",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Integer"
          },
          "plmn": {
            "$ref": "#/components/schemas/Plmn"
          },
          "tddInfo": {
            "$ref": "#/components/schemas/TddInfo"
          }
        },
        "required": ["plmn", "ecgi", "pci", "fddInfo", "tddInfo"],
        "type": "object",
        "x-etsi-ref": "6.5.9"
      },
      "UuUnicastProvisioningInfo": {
        "items": {
          "properties": {
            "proInfoUuUnicast": {
              "$ref": "#/components/schemas/UuUnicastProvisioningInfo.proInfoUuUnicast"
            },
            "timeStamp": {
              "$ref": "#/components/schemas/TimeStamp"
          "type": "object"
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
        },
        "required": ["proInfoUuUnicast"],
        "type": "object",
        "x-etsi-ref": "6.2.2"
      },
      "UuUnicastProvisioningInfo.proInfoUuUnicast": {
        "description": "The provisioning information per location as defined below.",
        "items": {
          "type": "object"
        },
        "minItems": 1,
        "properties": {
          "locationInfo": {
            "$ref": "#/components/schemas/LocationInfo"
          },
          "neighbourCellInfo": {
            "description": "The information of the neighbour cells in a visiting PLMN that support V2X communication over Uu unicast.",
            "items": {
              "$ref": "#/components/schemas/UuUniNeighbourCellInfo"
            },
            "minItems": 0,
            "type": "array",
            "x-etsi-mec-cardinality": "0..N",
            "x-etsi-mec-origin-type": "UuUniNeighbourCellInfo"
          },
          "v2xApplicationServer": {
            "$ref": "#/components/schemas/V2xApplicationServer"
          }
        },
        "required": ["locationInfo", "v2xApplicationServer"],
        "type": "array",
        "x-etsi-mec-cardinality": "1..N",
        "x-etsi-mec-origin-type": "Structure (inlined)"
      },
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
      "V2xApplicationServer": {
        "properties": {
          "ipAddress": {
            "description": "",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
          },
          "udpPort": {
            "description": "",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
          }
        },
        "required": ["ipAddress", "udpPort"],
        "type": "object",
        "x-etsi-ref": "6.5.8"
      },
      "V2xMsgNotification": {
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
        "properties": {
          "_links": {
            "$ref": "#/components/schemas/V2xMsgNotification.links"
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
          "msgContent": {
            "description": "Published V2X message content. The format of the string is defined by the standardization organization indicated by the attribute stdOrganization.",
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
            "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": {
            "$ref": "#/components/schemas/msgType"
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
          },
          "notificationType": {
            "description": "Shall be set to \"V2xMsgNotification\".",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
          },
          "stdOrganization": {
            "description": "Standardization organization which defines the published V2X message type: \nETSI: European Telecommunications Standards Institute.\nSee note 1.",
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
            "enum": ["ETSI"],
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Enum"
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
          },
          "timeStamp": {
            "$ref": "#/components/schemas/TimeStamp"
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
          }
        },
        "required": [
          "notificationType",
          "timeStamp",
          "stdOrganization",
          "msgType",
          "msgEncodeFormat",
          "msgContent",
          "_links"
        ],
        "type": "object",
        "x-etsi-notes": "NOTE 1:\tOther standardization organizations could be added as needed.\nNOTE 2:\tThe V2X message types of ETSI shall be used as specified in ETSI TS 102 894-2 [6], clause A.114.",
        "x-etsi-ref": "6.4.5"
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
      },
      "V2xMsgNotification.links": {
        "description": "links to resources related to this notification.",
        "properties": {
          "subscription": {
            "$ref": "#/components/schemas/LinkType"
          }
        },
        "required": ["subscription"],
        "type": "object",
        "x-etsi-mec-cardinality": "1",
        "x-etsi-mec-origin-type": "Structure (inlined)"
      },
      "V2xMsgPublication": {
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
        "properties": {
          "msgContent": {
            "description": "Published V2X message content. Its format is defined by the standardization organization indicated by the attribute stdOrganization.",
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
            "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.",
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
          },
          "msgType": {
            "$ref": "#/components/schemas/msgType"
          },
          "stdOrganization": {
            "description": "Standardization organization which defines the published V2X message type:\nETSI: European Telecommunications Standards Institute. \nSee note 1.",
            "enum": ["ETSI"],
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Enum"
        "required": [
          "stdOrganization",
          "msgType",
          "msgEncodeFormat",
          "msgContent"
        ],
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
        "type": "object",
        "x-etsi-notes": "NOTE 1:\tOther standardization organizations could be added as needed.\nNOTE 2:\tThe V2X message types of ETSI shall be used as specified in ETSI TS 102 894-2 [6], clause A.114.",
        "x-etsi-ref": "6.2.6"
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
      },
      "msgType": {
        "description": "Published V2X message type. Its value is defined by the standardization organization indicated by the attribute stdOrganization. See note 2.\n− denm(1): Decentralized Environmental Notification Message (DENM) as specified in ETSI EN 302 637-3,\n− cam(2): Cooperative Awareness Message (CAM) as specified in ETSI EN 302 637-2,\n− poi(3): Point of Interest message as specified in ETSI TS 101 556-1,\n− spatem(4): Signal Phase And Timing (SPAT) message as specified in SAE J2735 and in ETSI TS 103 301,\n− mapem(5): MAP message as specified in SAE J2735 and in ETSI TS 103 301,\n− ivim(6): In Vehicle Information (IVI) message as defined in ISO TS 19321,\n− ev-rsr(7): Electric vehicle recharging spot reservation message, as defined in ETSI TS 101 556-3,\n− tistpgtransaction(8): messages for Tyre Information System (TIS) and Tyre Pressure Gauge (TPG) interoperability, as specified in ETSI TS 101 556-2,\n− srem(9): Traffic light Signal Request Message as specified in ETSI TS 103 301,\n− ssem(10): Traffic Light Signal Request Status Message as specified in ETSI TS 103 301.\n− evcsn(11): Electrical Vehicle Charging Spot Notification message as specified in ETSI TS 101 556-1,\n− saem(12): Services Announcement Extended Message as specified in ETSI TS 102 890-1,\n− rtcmem(13): Radio Technical Commission for Maritime Services (RTCM) Message as specified in ETSI TS 103 301,\n",
        "enum": [
          "1",
          "2",
          "3",
          "4",
          "5",
          "6",
          "7",
          "8",
          "9",
          "10",
          "11",
          "12",
          "13"
        ],
        "x-etsi-mec-cardinality": "1",
        "x-etsi-mec-origin-type": "Enum"
      },
      "V2xMsgSubscription": {
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
        "properties": {
          "_links": {
            "$ref": "#/components/schemas/links"
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
          },
          "callbackReference": {
            "description": "URI exposed by the client on which to receive notifications via HTTP. See note 1.",
            "format": "uri",
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Uri"
          },
          "expiryDeadline": {
            "$ref": "#/components/schemas/TimeStamp"
          },
          "filterCriteria": {
            "$ref": "#/components/schemas/V2xMsgSubscription.filterCriteria"
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
          },
          "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\".",
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
          },
          "websockNotifConfig": {
            "$ref": "#/components/schemas/WebsockNotifConfig"
        "required": ["subscriptionType", "filterCriteria"],
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
        "type": "object",
        "x-etsi-notes": "NOTE 1:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to VIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009 [i.1], clause 6.12a.\nNOTE 2:\tOther standardization organizations could be added as needed.\nNOTE 3:\tThe V2X message types of ETSI shall be used as specified in ETSI TS 102 894-2 [6], clause A.114.",
        "x-etsi-ref": "6.3.5"
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
      },
      "V2xMsgSubscription.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.",
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
        "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)"
      },
      "V2xServerUsd": {
        "properties": {
          "sdpInfo": {
            "$ref": "#/components/schemas/V2xServerUsd.sdpInfo"
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
          },
          "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"
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
          }
        },
        "required": ["tmgi", "serviceAreaIdentifier", "sdpInfo"],
        "type": "object",
        "x-etsi-ref": "6.5.10"
      },
      "V2xServerUsd.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)"
      },
      "V2xServerUsd.tmgi": {
        "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)"
      },
      "WebsockNotifConfig": {
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
        "properties": {
          "requestWebsocketUri": {
            "description": "Set to TRUE by the service consumer to indicate that Websocket delivery is requested.",
            "type": "boolean",
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Boolean"
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
          },
          "websocketUri": {
            "description": "Set by VIS to indicate to the service consumer the Websocket URI to be used for delivering notifications.",
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
            "format": "uri",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Uri"
        "type": "object",
        "x-etsi-ref": "6.5.14"
M. Rehan Abbasi's avatar
M. Rehan Abbasi committed
      }
    },
    "responses": {
      "204": {
        "description": "No Content"
      },
      "206": {
        "description": "Partial content"
      },
      "400": {
        "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        }
      },
      "401": {
        "description": "Unauthorized :  used when the client did not submit credentials.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        }
      },
      "403": {
        "description": "Forbidden :  operation is not allowed given the current status of the resource.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        }
      },
      "404": {
        "description": "Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        }
      },
      "406": {
        "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        }
      },
      "409": {
        "description": "Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        }
      },
      "412": {
        "description": "Precondition failed :  used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        }
      },
      "415": {
        "description": "Unsupported Media Type :  used to indicate that the server or the client does not support the content type of the entity body.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        }
      },
      "422": {
        "description": "Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        }
      },
      "429": {
        "description": "Too Many Requests : used when a rate limiter has triggered.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        }
      }
    }
  }
}