ECRControl

API for enhanced converage restriction control.

OpenAPI

OpenAPI Version: 3.0.0

info

Title: 3gpp-ecr-control

Version: "1.0.0"

externalDocs

Description: 3GPP TS 29.122 V15.2.0 T8 reference point for Northbound APIs

URL: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.122/'

security

- {}

- oAuth2ClientCredentials: []

servers

URL: '{apiRoot}/3gpp-ecr-control/v1'

Variables:

API Root:

Default: https://example.com

Description: apiRoot as defined in subclause 5.2.4 of 3GPP TS 29.122.

paths

/query

Method: Post

Summary: Query the status of enhanced converage restriction for a UE.

Request Body:

Required/Optional: true

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/ECRControl'

Responses:

'200' The requested information was returned successfully.

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/ECRData'

'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'

'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'

'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'

'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'

'411': Reference 'TS29122_CommonData.yaml#/components/responses/411'

'413': Reference 'TS29122_CommonData.yaml#/components/responses/413'

'415': Reference 'TS29122_CommonData.yaml#/components/responses/415'

'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'

default: Reference 'TS29122_CommonData.yaml#/components/responses/default'

/configure

Method: Post

Summary: Configure the enhanced converage restriction for a UE.

Request Body:

Required/Optional: true

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/ECRControl'

Responses:

'200' The Enhanced Coverage Restriction setting was configured successfully..

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/ECRData'

'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'

'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'

'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'

'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'

'411': Reference 'TS29122_CommonData.yaml#/components/responses/411'

'413': Reference 'TS29122_CommonData.yaml#/components/responses/413'

'415': Reference 'TS29122_CommonData.yaml#/components/responses/415'

'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'

default: Reference 'TS29122_CommonData.yaml#/components/responses/default'

components

securitySchemes

oAuth2ClientCredentials

Type: oauth2

Flows:

clientCredentials:

tokenUrl: '{tokenUrl}'

scopes: {}

schemas

ECRControl

Type: object

Properties:

supportedFeatures:

Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'

externalId:

Reference: 'TS29122_CommonData.yaml#/components/schemas/ExternalId'

msisdn:

Reference: 'TS29122_CommonData.yaml#/components/schemas/Msisdn'

restrictedPlmnIds:

Type: array

Items:

Reference: '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:

Reference: '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]

ECRData

Type: object

Properties:

supportedFeatures:

Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'

visitedPlmnId:

Reference: 'TS29122_CommonData.yaml#/components/schemas/PlmnId'

restrictedPlmnIds:

Type: array

Items:

Reference: '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:

Reference: '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]