openapi: 3.2.0
info:
  title: GMDviaMBMSbyxMB Service Operation API
  description: "API for Group Message Delivery via MBMS by xMB  \n© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).  \nAll rights reserved.\n"
  version: 1.4.0
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.
security:
- {}
- oAuth2ClientCredentials: []
tags:
- name: Service Operation
paths:
  /{scsAsId}/services:
    get:
      summary: Read all service resources for a given SCS/AS.
      operationId: FetchAllxMBServices
      tags:
      - Service Operation
      parameters:
      - name: scsAsId
        in: path
        description: Identifier of SCS/AS
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK (successful query of service creation resource)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ServiceCreation'
                minItems: 0
                description: The service resource for the SCS/AS in the request URI is returned.
        '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 service creation resource for a given SCS/AS.
      operationId: CreatexMBService
      tags:
      - Service Operation
      parameters:
      - name: scsAsId
        in: path
        description: Identifier of SCS/AS
        required: true
        schema:
          type: string
      requestBody:
        description: representation of the service to be created in the SCEF
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServiceCreation'
      responses:
        '201':
          description: successful creation of a service
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceCreation'
          headers:
            Location:
              description: Contains the URI of the newly created resource
              required: true
              schema:
                type: string
        '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
components:
  schemas:
    ServiceCreation:
      description: Represents an individual xMB Service resource.
      type: object
      properties:
        self:
          $ref: TS29122_CommonData.yaml#/components/schemas/Link
        supportedFeatures:
          $ref: TS29571_CommonData.yaml#/components/schemas/SupportedFeatures
        externalGroupId:
          $ref: TS29122_CommonData.yaml#/components/schemas/ExternalGroupId
        userServiceId:
          type: string
          description: Identifies the MBMS User Service supplied by the SCEF.
          readOnly: true
        serviceClass:
          type: string
          description: The service class that service belongs to supplied by the SCEF.
          readOnly: true
        serviceLanguages:
          type: array
          items:
            type: string
          minItems: 1
          description: List of language of the service content supplied by the SCEF.
          readOnly: true
        serviceNames:
          type: array
          items:
            type: string
          minItems: 1
          description: List of Service Names supplied by the SCEF.
          readOnly: true
        receiveOnlyMode:
          type: boolean
          description: 'When set to ''true'', the Content Provider indicates that the service is a Receive Only Mode service. This parameter is supplied by the SCEF.

            '
          readOnly: true
        serviceAnnouncementMode:
          $ref: '#/components/schemas/ServiceAnnouncementMode'
    ServiceAnnouncementMode:
      anyOf:
      - type: string
        enum:
        - SACH
        - CONTENT_PROVIDER
      - type: string
        description: 'This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API.

          '
      description: "Represents the service annoucement mode.  \nPossible values are:\n- SACH: BM-SC performs the service announcement for the current service using the\n  SACH channel.\n- CONTENT_PROVIDER: BM-SC provides the necessary service access information used by\n  the Content Provider to create the service announcement information.\n"
      readOnly: true
  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/