openapi: 3.2.0
info:
  title: 3gpp-ecr-control Configure API
  version: 1.2.0
  description: "API for enhanced converage restriction control.  \n© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).  \nAll rights reserved.\n"
servers:
- url: '{apiRoot}/3gpp-ecr-control/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: Configure
paths:
  /configure:
    post:
      summary: Configure the enhanced converage restriction for a UE.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ECRControl'
      responses:
        '200':
          description: The Enhanced Coverage Restriction setting was configured successfully..
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ECRData'
        '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
      tags:
      - Configure
components:
  schemas:
    ECRData:
      description: Represents the current visited PLMN (if any) and the current settings of enhanced coverage restriction.
      type: object
      properties:
        supportedFeatures:
          $ref: TS29571_CommonData.yaml#/components/schemas/SupportedFeatures
        visitedPlmnId:
          $ref: TS29122_CommonData.yaml#/components/schemas/PlmnId
        ecrDataWbs:
          type: array
          items:
            $ref: '#/components/schemas/PlmnEcRestrictionDataWb'
          minItems: 0
        restrictedPlmnIds:
          type: array
          items:
            $ref: TS29122_CommonData.yaml#/components/schemas/PlmnId
          minItems: 0
          description: Indicates a complete list (and possibly empty) of serving PLMNs where Enhanced Coverage shall be restricted.
        allowedPlmnIds:
          type: array
          items:
            $ref: TS29122_CommonData.yaml#/components/schemas/PlmnId
          minItems: 0
          description: Indicates a complete list (and possibly empty) of serving PLMNs where Enhanced Coverage shall be allowed.
      required:
      - supportedFeatures
      not:
        required:
        - restrictedPlmnIds
        - allowedPlmnIds
    PlmnEcRestrictionDataWb:
      description: Indicates whether enhanced coverage mode is restricted or not for a PLMN ID.
      type: object
      properties:
        plmnId:
          $ref: TS29122_CommonData.yaml#/components/schemas/PlmnId
        plmnEcrDataWb:
          $ref: TS29503_Nudm_SDM.yaml#/components/schemas/EcRestrictionDataWb
      required:
      - plmnId
    ECRControl:
      description: Represents the parameters to request Enhanced Coverage Restriction control.
      type: object
      properties:
        supportedFeatures:
          $ref: TS29571_CommonData.yaml#/components/schemas/SupportedFeatures
        mtcProviderId:
          type: string
          description: Identifies the MTC Service Provider and/or MTC Application.
        scsAsId:
          type: string
          description: Identifier of the SCS/AS.
        externalId:
          $ref: TS29122_CommonData.yaml#/components/schemas/ExternalId
        msisdn:
          $ref: TS29122_CommonData.yaml#/components/schemas/Msisdn
        ecrDataWbs:
          type: array
          items:
            $ref: '#/components/schemas/PlmnEcRestrictionDataWb'
          minItems: 0
        restrictedPlmnIds:
          type: array
          items:
            $ref: TS29122_CommonData.yaml#/components/schemas/PlmnId
          minItems: 0
          description: Indicates a complete list (and possibly empty) of serving PLMNs where Enhanced Coverage shall be restricted. This attribute shall not be present for the query custom operation.
        allowedPlmnIds:
          type: array
          items:
            $ref: TS29122_CommonData.yaml#/components/schemas/PlmnId
          minItems: 0
          description: Indicates a complete list (and possibly empty) of serving PLMNs where Enhanced Coverage shall be allowed. This attribute shall not be present for the query custom operation.
      required:
      - supportedFeatures
      oneOf:
      - required:
        - externalId
      - required:
        - msisdn
      not:
        required:
        - restrictedPlmnIds
        - allowedPlmnIds
  securitySchemes:
    oAuth2ClientCredentials:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: '{tokenUrl}'
          scopes: {}
externalDocs:
  description: 3GPP TS 29.122 V17.6.0 T8 reference point for Northbound APIs
  url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.122/