openapi: 3.2.0
info:
  title: 3gpp Delivery via MBMS Operation API
  version: 1.4.0
  description: 'Operations tagged Delivery via MBMS Operation across 2 of this provider''s published API definitions: 3gpp-ts29122-gmdviambmsbymb2.yml, 3gpp-ts29122-gmdviambmsbyxmb.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: '{apiRoot}/3gpp-group-message-delivery-mb2/v1'
  variables:
    apiRoot:
      default: https://example.com
      description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122.
- url: '{apiRoot}/3gpp-group-message-delivery-xmb/v1'
  variables:
    apiRoot:
      default: https://example.com
      description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122.
security:
- {}
- oAuth2ClientCredentials: []
tags:
- name: Delivery via MBMS Operation
paths:
  /{scsAsId}/tmgi-allocation/{tmgi}/delivery-via-mbms:
    get:
      summary: Read all group message delivery via MBMS resource for a given SCS/AS and a TMGI.
      operationId: FecthAllGMDViaMBMSByMB2
      tags:
      - Delivery via MBMS Operation
      parameters:
      - name: scsAsId
        in: path
        description: Identifier of SCS/AS
        required: true
        schema:
          type: string
      - name: tmgi
        in: path
        description: TMGI
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK (successful query of Delivery via MBMS resource)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GMDViaMBMSByMb2'
        '307':
          $ref: TS29122_CommonData.yaml#/components/responses/307
        '308':
          $ref: TS29122_CommonData.yaml#/components/responses/308
        '400':
          $ref: TS29122_CommonData.yaml#/components/responses/400
        '401':
          $ref: TS29122_CommonData.yaml#/components/responses/401
        '403':
          $ref: TS29122_CommonData.yaml#/components/responses/403
        '404':
          $ref: TS29122_CommonData.yaml#/components/responses/404
        '406':
          $ref: TS29122_CommonData.yaml#/components/responses/406
        '429':
          $ref: TS29122_CommonData.yaml#/components/responses/429
        '500':
          $ref: TS29122_CommonData.yaml#/components/responses/500
        '503':
          $ref: TS29122_CommonData.yaml#/components/responses/503
        default:
          $ref: TS29122_CommonData.yaml#/components/responses/default
    post:
      summary: Creates a new delivery via MBMS for a given SCS/AS and a TMGI.
      operationId: CreateGMDViaMBMSByMB2
      tags:
      - Delivery via MBMS Operation
      parameters:
      - name: scsAsId
        in: path
        description: Identifier of SCS/AS
        required: true
        schema:
          type: string
      - name: tmgi
        in: path
        description: TMGI
        required: true
        schema:
          type: string
      requestBody:
        description: representation of the GMD via MBMS by MB2 resource to be Created in the SCEF
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GMDViaMBMSByMb2'
      callbacks:
        gMDByMb2Notification:
          '{$request.body#/notificationDestination}':
            post:
              requestBody:
                required: true
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/GMDByMb2Notification'
              responses:
                '200':
                  description: OK (The successful acknowledgement of the notification with a body)
                  content:
                    application/json:
                      schema:
                        $ref: TS29122_CommonData.yaml#/components/schemas/Acknowledgement
                '204':
                  description: successful notification
                '307':
                  $ref: TS29122_CommonData.yaml#/components/responses/307
                '308':
                  $ref: TS29122_CommonData.yaml#/components/responses/308
                '400':
                  $ref: TS29122_CommonData.yaml#/components/responses/400
                '401':
                  $ref: TS29122_CommonData.yaml#/components/responses/401
                '403':
                  $ref: TS29122_CommonData.yaml#/components/responses/403
                '404':
                  $ref: TS29122_CommonData.yaml#/components/responses/404
                '411':
                  $ref: TS29122_CommonData.yaml#/components/responses/411
                '413':
                  $ref: TS29122_CommonData.yaml#/components/responses/413
                '415':
                  $ref: TS29122_CommonData.yaml#/components/responses/415
                '429':
                  $ref: TS29122_CommonData.yaml#/components/responses/429
                '500':
                  $ref: TS29122_CommonData.yaml#/components/responses/500
                '503':
                  $ref: TS29122_CommonData.yaml#/components/responses/503
                default:
                  $ref: TS29122_CommonData.yaml#/components/responses/default
      responses:
        '201':
          description: successful creation of an GMD via MBMS by MB2 resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GMDViaMBMSByMb2'
          headers:
            Location:
              description: Contains the URI of the newly created resource
              required: true
              schema:
                type: string
        '307':
          $ref: TS29122_CommonData.yaml#/components/responses/307
        '308':
          $ref: TS29122_CommonData.yaml#/components/responses/308
        '400':
          $ref: TS29122_CommonData.yaml#/components/responses/400
        '401':
          $ref: TS29122_CommonData.yaml#/components/responses/401
        '403':
          $ref: TS29122_CommonData.yaml#/components/responses/403
        '404':
          $ref: TS29122_CommonData.yaml#/components/responses/404
        '411':
          $ref: TS29122_CommonData.yaml#/components/responses/411
        '413':
          $ref: TS29122_CommonData.yaml#/components/responses/413
        '415':
          $ref: TS29122_CommonData.yaml#/components/responses/415
        '429':
          $ref: TS29122_CommonData.yaml#/components/responses/429
        '500':
          $ref: TS29122_CommonData.yaml#/components/responses/500
        '503':
          $ref: TS29122_CommonData.yaml#/components/responses/503
        default:
          $ref: TS29122_CommonData.yaml#/components/responses/default
    servers:
    - url: '{apiRoot}/3gpp-group-message-delivery-mb2/v1'
      variables:
        apiRoot:
          default: https://example.com
          description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122.
  /{scsAsId}/services/{serviceId}/delivery-via-mbms:
    get:
      summary: Read all group message delivery via MBMS resource for a given SCS/AS and a service id.
      operationId: FetchAllGMDViaMBMS
      tags:
      - Delivery via MBMS Operation
      parameters:
      - name: scsAsId
        in: path
        description: Identifier of SCS/AS
        required: true
        schema:
          type: string
      - name: serviceId
        in: path
        description: Service Id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK (successful query of Delivery via MBMS resource)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GMDViaMBMSByxMB'
                minItems: 0
        '307':
          $ref: TS29122_CommonData.yaml#/components/responses/307
        '308':
          $ref: TS29122_CommonData.yaml#/components/responses/308
        '400':
          $ref: TS29122_CommonData.yaml#/components/responses/400
        '401':
          $ref: TS29122_CommonData.yaml#/components/responses/401
        '403':
          $ref: TS29122_CommonData.yaml#/components/responses/403
        '404':
          $ref: TS29122_CommonData.yaml#/components/responses/404
        '406':
          $ref: TS29122_CommonData.yaml#/components/responses/406
        '429':
          $ref: TS29122_CommonData.yaml#/components/responses/429
        '500':
          $ref: TS29122_CommonData.yaml#/components/responses/500
        '503':
          $ref: TS29122_CommonData.yaml#/components/responses/503
        default:
          $ref: TS29122_CommonData.yaml#/components/responses/default
    post:
      summary: Creates a new delivery via MBMS for a given SCS/AS and a service Id.
      operationId: CreateGMDViaMBMS
      tags:
      - Delivery via MBMS Operation
      parameters:
      - name: scsAsId
        in: path
        description: Identifier of SCS/AS
        required: true
        schema:
          type: string
      - name: serviceId
        in: path
        description: Service Id
        required: true
        schema:
          type: string
      requestBody:
        description: representation of the GMD via MBMS by xMB resource to be Created in the SCEF
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GMDViaMBMSByxMB'
      callbacks:
        gMDByxMBNotification:
          '{$request.body#/notificationDestination}':
            post:
              requestBody:
                required: true
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/GMDByxMBNotification'
              responses:
                '200':
                  description: OK (The successful acknowledgement of the notification with a body)
                  content:
                    application/json:
                      schema:
                        $ref: TS29122_CommonData.yaml#/components/schemas/Acknowledgement
                '204':
                  description: successful notification
                '307':
                  $ref: TS29122_CommonData.yaml#/components/responses/307
                '308':
                  $ref: TS29122_CommonData.yaml#/components/responses/308
                '400':
                  $ref: TS29122_CommonData.yaml#/components/responses/400
                '401':
                  $ref: TS29122_CommonData.yaml#/components/responses/401
                '403':
                  $ref: TS29122_CommonData.yaml#/components/responses/403
                '404':
                  $ref: TS29122_CommonData.yaml#/components/responses/404
                '411':
                  $ref: TS29122_CommonData.yaml#/components/responses/411
                '413':
                  $ref: TS29122_CommonData.yaml#/components/responses/413
                '415':
                  $ref: TS29122_CommonData.yaml#/components/responses/415
                '429':
                  $ref: TS29122_CommonData.yaml#/components/responses/429
                '500':
                  $ref: TS29122_CommonData.yaml#/components/responses/500
                '503':
                  $ref: TS29122_CommonData.yaml#/components/responses/503
                default:
                  $ref: TS29122_CommonData.yaml#/components/responses/default
      responses:
        '201':
          description: successful creation of an GMD via MBMS by xMB resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GMDViaMBMSByxMB'
          headers:
            Location:
              description: Contains the URI of the newly created resource
              required: true
              schema:
                type: string
        '307':
          $ref: TS29122_CommonData.yaml#/components/responses/307
        '308':
          $ref: TS29122_CommonData.yaml#/components/responses/308
        '400':
          $ref: TS29122_CommonData.yaml#/components/responses/400
        '401':
          $ref: TS29122_CommonData.yaml#/components/responses/401
        '403':
          $ref: TS29122_CommonData.yaml#/components/responses/403
        '404':
          $ref: TS29122_CommonData.yaml#/components/responses/404
        '411':
          $ref: TS29122_CommonData.yaml#/components/responses/411
        '413':
          $ref: TS29122_CommonData.yaml#/components/responses/413
        '415':
          $ref: TS29122_CommonData.yaml#/components/responses/415
        '429':
          $ref: TS29122_CommonData.yaml#/components/responses/429
        '500':
          $ref: TS29122_CommonData.yaml#/components/responses/500
        '503':
          $ref: TS29122_CommonData.yaml#/components/responses/503
        default:
          $ref: TS29122_CommonData.yaml#/components/responses/default
    servers:
    - url: '{apiRoot}/3gpp-group-message-delivery-xmb/v1'
      variables:
        apiRoot:
          default: https://example.com
          description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122.
components:
  schemas:
    GMDByMb2Notification:
      description: Represents a group message delivery notification.
      type: object
      properties:
        transaction:
          $ref: TS29122_CommonData.yaml#/components/schemas/Link
        deliveryTriggerStatus:
          type: boolean
          description: 'Indicates whether delivery of group message payload corresponding to the TMGI was successful (TRUE) or not (FALSE)

            '
      required:
      - transaction
      - deliveryTriggerStatus
    MbmsLocArea:
      description: 'Represents a user location area whithin which is sent a group message delivery via MBMS request.

        '
      type: object
      properties:
        cellId:
          type: array
          items:
            type: string
          minItems: 1
          description: 'Indicates a Cell Global Identification of the user which identifies the cell the UE is registered.

            '
        enodeBId:
          type: array
          items:
            type: string
          minItems: 1
          description: Indicates an eNodeB in which the UE is currently located.
        geographicArea:
          type: array
          items:
            $ref: TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea
          minItems: 1
          description: Identifies a geographic area of the user where the UE is located.
        mbmsServiceAreaId:
          type: array
          items:
            type: string
          minItems: 1
          description: Identifies an MBMS Service Area Identity of the user where the UE is located.
        civicAddress:
          type: array
          items:
            $ref: TS29572_Nlmf_Location.yaml#/components/schemas/CivicAddress
          minItems: 1
          description: Identifies a civic address of the user where the UE is located.
    GMDViaMBMSByMb2:
      description: Represents a group message delivery via MBMS by MB2.
      type: object
      properties:
        self:
          $ref: TS29122_CommonData.yaml#/components/schemas/Link
        notificationDestination:
          $ref: TS29122_CommonData.yaml#/components/schemas/Link
        requestTestNotification:
          type: boolean
          description: 'Set to true by the SCS/AS to request the SCEF to send a test notification as defined in clause 5.2.5.3. Set to false or omitted otherwise.

            '
        websockNotifConfig:
          $ref: TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig
        externalGroupId:
          $ref: TS29122_CommonData.yaml#/components/schemas/ExternalGroupId
        mbmsLocArea:
          $ref: '#/components/schemas/MbmsLocArea'
        messageDeliveryStartTime:
          $ref: TS29122_CommonData.yaml#/components/schemas/DateTime
        groupMessagePayload:
          $ref: TS29122_CommonData.yaml#/components/schemas/Bytes
        scefMessageDeliveryIPv4:
          $ref: TS29122_CommonData.yaml#/components/schemas/Ipv4AddrRo
        scefMessageDeliveryIPv6:
          $ref: TS29122_CommonData.yaml#/components/schemas/Ipv6AddrRo
        scefMessageDeliveryPort:
          $ref: TS29122_CommonData.yaml#/components/schemas/PortRo
      required:
      - notificationDestination
    GMDViaMBMSByxMB:
      description: Represents a group message delivery via MBMS by xMB.
      type: object
      properties:
        self:
          $ref: TS29122_CommonData.yaml#/components/schemas/Link
        notificationDestination:
          $ref: TS29122_CommonData.yaml#/components/schemas/Link
        requestTestNotification:
          type: boolean
          description: 'Set to true by the SCS/AS to request the SCEF to send a test notification as defined in clause 5.2.5.3. Set to false or omitted otherwise.

            '
        websockNotifConfig:
          $ref: TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig
        mbmsLocArea:
          $ref: '#/components/schemas/MbmsLocArea'
        messageDeliveryStartTime:
          $ref: TS29122_CommonData.yaml#/components/schemas/DateTime
        messageDeliveryStopTime:
          $ref: TS29122_CommonData.yaml#/components/schemas/DateTime
        groupMessagePayload:
          $ref: TS29122_CommonData.yaml#/components/schemas/Bytes
        scefMessageDeliveryIPv4:
          $ref: TS29122_CommonData.yaml#/components/schemas/Ipv4AddrRo
        scefMessageDeliveryIPv6:
          $ref: TS29122_CommonData.yaml#/components/schemas/Ipv6AddrRo
        scefMessageDeliveryPort:
          $ref: TS29122_CommonData.yaml#/components/schemas/PortRo
      required:
      - notificationDestination
    GMDByxMBNotification:
      description: Represents a group message delivery notification.
      type: object
      properties:
        transaction:
          $ref: TS29122_CommonData.yaml#/components/schemas/Link
        deliveryTriggerStatus:
          type: boolean
          description: 'Indicates whether delivery of group message payload was successful(TRUE) or not (FALSE).

            '
      required:
      - transaction
      - deliveryTriggerStatus
  securitySchemes:
    oAuth2ClientCredentials:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: '{tokenUrl}'
          scopes: {}
externalDocs:
  description: 3GPP TS 29.122 V19.5.0 T8 reference point for Northbound APIs
  url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.122/
x-refined-from:
- 3gpp-ts29122-gmdviambmsbymb2.yml
- 3gpp-ts29122-gmdviambmsbyxmb.yml