MEC030_V2XInformationService.yaml

        transmissionBandwidth:
          # description': ''
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': TransmissionBandwidth
          $ref: '#/components/schemas/TransmissionBandwidth'
      required:
      - earfcn
      - transmissionBandwidth
      - subframeAssignment
      type: object
      x-etsi-ref: 6.5.7
    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
          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
          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.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    
    
    TransmissionBandwidth:
      properties:
        transmissionBandwidth:
          $ref: '#/components/schemas/TransmissionBandwidth.transmissionBandwidth'
      required:
      - transmissionBandwidth
      type: object
      x-etsi-ref: 6.6.4
    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.proInfoUuMbms:
            description: The provisioning information per location as defined below.
            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.
                type: array
                items:
                  $ref: '#/components/schemas/UuMbmsNeighbourCellInfo'
                minItems: 0
                
                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
            
    UuMbmsProvisioningInfo:
        properties:
          proInfoUuMbms:
            $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'
        required:
        - proInfoUuMbms
        type: object
        x-etsi-ref: 6.2.3
        
    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.proInfoUuUnicast:
            description: The provisioning information per location as defined below.
            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
    UuUnicastProvisioningInfo:
        properties:
          proInfoUuUnicast:
           type: array
           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'
        required:
        - proInfoUuUnicast
        type: object
        x-etsi-ref: 6.2.2
    V2xApplicationServer:
      properties:
        ipAddress:
          description: ''
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        udpPort:
          description: ''
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
      required:
      - ipAddress
      - udpPort
      type: object
      x-etsi-ref: 6.5.8
      

    msgType:
          description: '− denm(1): Decentralized Environmental Notification Message (DENM) as specified in ETSI EN 302 637-3 [i.3], − cam(2): Cooperative Awareness Message (CAM) as specified in ETSI EN 302 637-2 [i.2], − poi(3): Point of Interest message as specified in ETSI TS 101 556-1 [i.11], − spat(4): Signal Phase And Timing (SPAT) message as specified in SAE J2735 [i.12], − map(5): MAP message as specified in SAE J2735 [i.12], − ivi(6): In Vehicle Information (IVI) message as defined in ISO TS 19321 [i.13], − ev-rsr(7): Electric vehicle recharging spot reservation message, as defined in ETSI TS 101 556-3 [i.14], '
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
          - 7
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Enum  
    
    V2xMsgPublication:
      properties:
        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
        msgType:
          $ref: '#/components/schemas/msgType'
          #x-etsi-mec-origin-type: Enum
        stdOrganization:
          description: "Standardization organization which defines the published V2X message type: \nETSI: European Telecommunications Standards Institute. \nSee note 1."
          enum:
          - ETSI
          type: string
          x-etsi-mec-cardinality: '1'
          #-etsi-mec-origin-type: Enum
      required:
      - stdOrganization
      - msgType
      - msgEncodeFormat
      - msgContent
      type: object
      x-etsi-notes: "NOTE 1: Other standardization organizations could be added as needed.NOTE 2:The 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
      
    V2xMsgSubscription.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
          
    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.
          properties:
            msgType:
              description: Subscribed V2X message type. Its value is defined by the standardization organization indicated by the attribute stdOrganization. See note 2.
              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 1."
              enum:
              - ETSI
              type: string
              x-etsi-mec-cardinality: '1'
              x-etsi-mec-origin-type: Enum
          required:
          - stdOrganization
          type: object
          x-etsi-mec-cardinality: '1'
          
    V2xMsgSubscription:
      properties:
        _links:
          $ref: '#/components/schemas/V2xMsgSubscription.links'
        callbackReference:
          description: URI selected by the service consumer to receive notifications on the subscribed V2X message. This shall be included both in the request and in response.
          format: uri
          type: string
          x-etsi-mec-cardinality: '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'
        subscriptionType:
          description: Shall be set to "V2xMsgSubscription".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
      required:
      - subscriptionType
      - callbackReference
      - filterCriteria
      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.3.5


    V2xMsgNotification.links:
          description: 'Links to resources related to this notification.'
          properties:
            subscription:
              # 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:
          - subscription
          type: object
          x-etsi-mec-cardinality: 0..1

    V2xMsgNotification:
      properties:
        notificationType:
          description: Shall be set to "V2xMsgNotification".
          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'
        stdOrganization:
          description: 'Standardization organization which defines the published V2X message type ETSI: European Telecommunications Standards Institute. See note 1.'
          enum:
          - "ETSI"
          type: string
        msgType:
          $ref: '#/components/schemas/msgType'
        msgEncodeFormat:
          description: 'The encode format of the V2X message, for example base64 '
          type: string  
        msgContent:
          description: 'Published V2X message content. The format of the string is defined by the standardization organization indicated by the attribute stdOrganization.'
          type: string
        _links:
          $ref: '#/components/schemas/V2xMsgNotification.links'
      required:
      - notificationType
      - timeStamp
      - stdOrganization
      - msgType
      - msgEncodeFormat
      - msgContent
      - _links
      type: object
      x-etsi-notes: "NOTE 1: Other standardization organizations could be added as needed. NOTE 2: The V2X message types of ETSI shall be used as specified in ETSI TS 102 894-2 [6], clause A.114"
      
    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'
    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: ''
          
    V2xServerUsd:
      properties:
        sdpInfo:
          $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'
      required:
      - tmgi
      - serviceAreaIdentifier
      - sdpInfo
      type: object
      x-etsi-ref: 6.5.10

    LinkType:
      description: >-
        'This data type represents a type of link'
      type: object
      required:
        - href
      properties:
        href:
          $ref: '#/components/schemas/Href' 
    Href:
      description: >-
        The URI referring to the subscription.
      type: string
      format: uri        
    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            
  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'