Newer
Older
openapi: 3.0.2
servers:
- url: 'http://127.0.0.1:8081/rni/v2'
- url: 'https://127.0.0.1:8081/rni/v2'
title: MEC Radion Network Information API
version: 2.1.1
description: The ETSI MEC ISG MEC012 Radio Network Information API
name: BSD-3-Clause
url: 'https://forge.etsi.org/legal-matters'
description: ETSI GS MEC012 Radio Network Information API, V2.1.1
url: 'https://www.etsi.org/deliver/etsi_gs/MEC/001_099/012/02.01.01_60/gs_mec012v020101p.pdf'
/queries/rab_info:
get:
description: >-
Gets information on existing E-RABs that are associated with a specific
mobile edge application instance
operationId: rab_infoGET
parameters:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
- $ref: '#/components/parameters/Query.AppInsId'
- $ref: '#/components/parameters/Query.CellId'
- $ref: '#/components/parameters/Query.UeIpv4Address'
- $ref: '#/components/parameters/Query.UeIpv6Address'
- $ref: '#/components/parameters/Query.NatedIpAddress'
- $ref: '#/components/parameters/Query.GtpTeId'
- $ref: '#/components/parameters/Query.ErabId'
- $ref: '#/components/parameters/Query.Qci'
- $ref: '#/components/parameters/Query.ErabMbrDl'
- $ref: '#/components/parameters/Query.ErabMbrUl'
- $ref: '#/components/parameters/Query.ErabGbrDl'
- $ref: '#/components/parameters/Query.ErabGbrUl'
responses:
'200':
description: Successful response to rab_info request
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
content:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
schema:
type: object
required:
- RabInfo
properties:
RabInfo:
$ref: '#/components/schemas/RabInfo'
example:
RabInfo:
timeStamp:
seconds: 1577836800
nanoSeconds: 0
appInId: '01'
requestId: '01'
cellUserInfo:
ecgi:
plmn:
mcc: '001'
mnc: '01'
cellId: '0x800000A'
ueInfo:
associateId: null
type: '1'
value: 192.0.2.0
erabInfo:
erabId: 10
erabQosParameters:
qci: 7
qosInformation:
erabMbrDl: 10
erabMbrUl: 10
erabGbrDl: 10
erabGbrUl: 10
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
'406':
description: Not Acceptable
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
'429':
description: Too Many Requests
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
/queries/plmn_info:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
Gets the information on Mobile Network(s).
operationId: plmn_infoGET
parameters:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
- $ref: '#/components/parameters/Query.AppInsIdArr'
responses:
'200':
description: Successful response to rab_info request
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
content:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
schema:
type: object
properties:
PlmnInfo:
$ref: '#/components/schemas/PlmnInfo'
example:
PlmnInfo:
timeStamp:
seconds: 1577836800
nanoSeconds: 0
appInId: '01'
ecgi:
plmn:
mcc: '001'
mnc: '01'
cellId: '0x800000A'
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
'406':
description: Not Acceptable
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
'429':
description: Too Many Requests
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
/queries/s1_bearer_info:
get:
description: >-
Gets information on existing E-RABs that are associated with a specific
mobile edge application instance
operationId: s1_bearer_infoGET
parameters:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
- $ref: '#/components/parameters/Query.TempUeId'
- $ref: '#/components/parameters/Query.UeIpv4Address'
- $ref: '#/components/parameters/Query.UeIpv6Address'
- $ref: '#/components/parameters/Query.NatedIpAddress'
- $ref: '#/components/parameters/Query.GtpTeId'
- $ref: '#/components/parameters/Query.CellId'
- $ref: '#/components/parameters/Query.ErabIdArr'
responses:
'200':
description: Successful response to s1_bearer_info request
schema:
type: object
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
required:
- S1BearerInfo
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/S1BearerInfo'
examples:
application/json:
S1BearerInfo:
timeStamp:
seconds: 1577836800
nanoSeconds: 0
s1UeInfo:
- tempUeId:
mmec: '0'
mtmsi: '1234'
associateId:
- type: '1'
value: 192.0.2.0
- type: '3'
value: 198.51.100.0
ecgi:
plmn:
mcc: '001'
mnc: '01'
s1BearerInfoDetailed:
- erabId: 1
s1EnbInfo:
ipAddress: 192.0.2.0
tunnelId: '1111'
sGwInfo:
ipAddress: 192.0.2.1
tunnelId: '2222'
- tempUeId:
mmec: '0'
mtmsi: '1234'
associateId:
type: '1'
value: 192.0.2.0
ecgi:
plmn:
mcc: '001'
mnc: '01'
s1BearerInfoDetailed:
- erabId: 2
s1EnbInfo:
ipAddress: 192.0.2.0
tunnelId: '3333'
sGwInfo:
ipAddress: 192.0.2.1
tunnelId: '4444'
'400':
description: Bad Request
schema:
type: object
properties:
ProblemDetails:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
'401':
description: Unauthorized
schema:
type: object
properties:
ProblemDetails:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
'403':
description: Forbidden
schema:
type: object
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
required:
- ProblemDetails
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
schema:
type: object
properties:
ProblemDetails:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
'406':
description: Not Acceptable
schema:
type: object
properties:
ProblemDetails:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
'429':
description: Too Many Requests
schema:
type: object
properties:
ProblemDetails:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
x-swagger-router-controller: Default
/subscriptions/:
get:
description: >-
The GET method can be used to request information about the
subscriptions for this requestor
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
operationId: SubscriptionLinkList_subscriptionsGET
produces:
- application/json
- application/problem+json
responses:
'200':
description: >-
Response body contains the list of links to requestors
subscriptions.
schema:
type: object
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
required:
- SubscriptionLinkList
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
SubscriptionLinkList:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/SubscriptionLinkList'
examples:
application/json:
SubscriptionLinkList:
_links:
self: 'http://meAppServer.example.com/rni/v1/subscriptions'
- href: >-
http://meAppClient.example.com/rni/v1/notifications/cell_change/77777
subscriptionType: CELL_CHANGE
- href: >-
http://meAppClient.example.com/rni/v1/notifications/MeasTa/77777
subscriptionType: MEAS_TIMING_ADVANCE
'400':
description: Bad Request
schema:
type: object
properties:
ProblemDetails:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
'401':
description: Unauthorized
schema:
type: object
properties:
ProblemDetails:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
'403':
description: Forbidden
schema:
type: object
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
required:
- ProblemDetails
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
schema:
type: object
properties:
ProblemDetails:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
'406':
description: Not Acceptable
schema:
type: object
properties:
ProblemDetails:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
'429':
description: Too Many Requests
schema:
type: object
properties:
ProblemDetails:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
x-swagger-router-controller: Default
/subscriptions/cell_change:
get:
description: >-
The GET method can be used to request information about the
cell_change subscriptions for this requestor
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
operationId: SubscriptionLinkList_subscriptions_cc_GET
produces:
- application/json
- application/problem+json
responses:
'200':
description: >-
Response body contains the list of links to requestors
cell_change subscriptions.
schema:
type: object
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
required:
- SubscriptionLinkList
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/SubscriptionLinkList'
examples:
application/json:
SubscriptionLinkList:
_links:
self: 'http://meAppServer.example.com/rni/v1/subscriptions/cell_change'
- href: >-
http://meAppClient.example.com/rni/v1/notifications/cell_change/77777
subscriptionType: CELL_CHANGE
- href: >-
http://meAppClient.example.com/rni/v1/notifications/cell_change/77778
subscriptionType: CELL_CHANGE
'400':
description: Bad Request
schema:
type: object
properties:
ProblemDetails:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
'401':
description: Unauthorized
schema:
type: object
properties:
ProblemDetails:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
'403':
description: Forbidden
schema:
type: object
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
required:
- ProblemDetails
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
schema:
type: object
properties:
ProblemDetails:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
'406':
description: Not Acceptable
schema:
type: object
properties:
ProblemDetails:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
'429':
description: Too Many Requests
schema:
type: object
properties:
ProblemDetails:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
x-swagger-router-controller: Default
post:
description: >-
Creates a subscription to cell change notifications from Radio Network
Information Service
operationId: CellChange_subscriptionsPOST
produces:
- application/json
- application/problem+json
parameters:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
- $ref: '#/components/parameters/Body.CellChangeSubscriptionPost'
responses:
'201':
description: Successful subscription to response to UE cell change notifications
schema:
type: object
properties:
CellChangeSubscription:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/CellChangeSubscription'
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
examples:
application/json:
CellChangeSubscription:
callbackReference: >-
http://meAppClient.example.com/rni/v1/notifications/cell_change/77777
_links:
self: >-
http://meAppServer.example.com/rni/v1/subscriptions/cell_change/sub123
filterCriteria:
associateId:
type: '1'
value: 192.0.2.0
plmn:
mnc: '01'
mcc: '001'
appInsId: '01'
trigger: 6
cellId: '0x800000B'
expiryDeadline:
seconds: 1577836800
nanoSeconds: 0
'400':
description: Bad Request
schema:
type: object
properties:
ProblemDetails:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
'401':
description: Unauthorized
schema:
type: object
properties:
ProblemDetails:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
'403':
description: Forbidden
schema:
type: object
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
required:
- ProblemDetails
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
schema:
type: object
properties:
ProblemDetails:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
'406':
description: Not Acceptable
schema:
type: object
properties:
ProblemDetails:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
'415':
description: Unsupported Media Type
schema:
type: object
properties:
ProblemDetails:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
'422':
description: Unprocessable Entity
schema:
type: object
properties:
ProblemDetails:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
'application/problem+json':
ProblemDetails:
type: 'https://meAppServer.example.com/rni/v1/probs/too-many-targets'
status: '422'
detail: The target area for the request is considered too large
instance: '/meAppClient.example.com/77777/msgs/abc'
'429':
description: Too Many Requests
schema:
type: object
properties:
ProblemDetails:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
x-swagger-router-controller: Default
'/subscriptions/cell_change/{subscriptionId}':
get:
description: Get cell change subscription information
operationId: CellChange_subscriptionsGET
produces:
- application/json
- application/problem+json
parameters:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
- $ref: '#/components/parameters/Path.subscrId'
responses:
'200':
description: Subscription information regarding cell change notifications
schema:
type: object
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
required:
- CellChangeSubscription
properties:
CellChangeSubscription:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/CellChangeSubscription'
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
examples:
application/json:
CellChangeSubscription:
callbackReference: >-
http://meAppClient.example.com/rni/v1/notifications/cell_change/77777
_links:
self: >-
http://meAppServer.example.com/rni/v1/subscriptions/cell_change/sub123
filterCriteria:
appInsId: '01'
associateId:
type: '1'
value: 192.0.2.0
plmn:
mnc: '01'
mcc: '001'
cellId: '0x800000B'
hoStatus: 3
expiryDeadline:
seconds: 1577836800
nanoSeconds: 0
'400':
description: Bad Request
schema:
type: object
properties:
ProblemDetails:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
'401':
description: Unauthorized
schema:
type: object
properties:
ProblemDetails:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
'403':
description: Forbidden
schema:
type: object
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
required:
- ProblemDetails
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
schema:
type: object
properties:
ProblemDetails:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
'406':
description: Not Acceptable
schema:
type: object
properties:
ProblemDetails:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
'429':
description: Too Many Requests
schema:
type: object
properties:
ProblemDetails:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
put:
description: >-
Updates a subscription to cell change notifications from Radio Network
Information Service
operationId: CellChange_subscriptionsPUT
produces:
- application/json
- application/problem+json
parameters:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
- $ref: '#/components/parameters/Body.CellChangeSubscription'
- $ref: '#/components/parameters/Path.subscrId'
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
'200':
description: Successful subscription to response to cell change notifications
schema:
type: object
properties:
CellChangeSubscription:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/CellChangeSubscription'
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
examples:
application/json:
CellChangeSubscription:
callbackReference: >-
http://meAppClient.example.com/rni/v1/notifications/cell_change/77777
_links:
self: >-
http://meAppServer.example.com/rni/v1/subscriptions/cell_change/sub123
filterCriteria:
appInsId: '01'
associateId:
type: '1'
value: 192.0.2.0
plmn:
mnc: '01'
mcc: '001'
cellId: '0x800000B'
hoStatus: 3
expiryDeadline:
seconds: 1577836800
nanoSeconds: 0
'400':
description: Bad Request
schema:
type: object
properties:
ProblemDetails:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
'401':
description: Unauthorized
schema:
type: object
properties:
ProblemDetails:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
'403':
description: Forbidden
schema:
type: object
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
required:
- ProblemDetails
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
schema:
type: object
properties:
ProblemDetails:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
'406':
description: Not Acceptable
schema:
type: object
properties:
ProblemDetails:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
'412':
description: Precondition failed
schema:
type: object
properties:
ProblemDetails:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
'422':
description: Unprocessable Entity
schema:
type: object
properties:
ProblemDetails:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
'application/problem+json':
ProblemDetails:
type: 'https://meAppServer.example.com/rni/v1/probs/too-many-targets'
status: '422'
detail: The target area for the request is considered too large
instance: '/meAppClient.example.com/77777/msgs/abc'
'429':
description: Too Many Requests
schema:
type: object
properties:
ProblemDetails:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
delete:
description: Method to delete a subscription
operationId: CellChange_subscriptionsSubscrIdDELETE
produces:
- application/json
parameters:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
- $ref: '#/components/parameters/Path.subscrId'
responses:
'204':
description: No Content
x-swagger-router-controller: Default
/subscriptions/s1_bearer:
get:
description: >-
The GET method can be used to request information about the
s1_bearer subscriptions for this requestor
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
operationId: SubscriptionLinkList_subscriptions_s1_GET
produces:
- application/json
- application/problem+json
responses:
'200':
description: >-
Response body contains the list of links to requestors
s1_bearer subscriptions.
schema:
type: object
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
required:
- SubscriptionLinkList
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
SubscriptionLinkList:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/SubscriptionLinkList'
examples:
application/json:
SubscriptionLinkList:
_links:
self: 'http://meAppServer.example.com/rni/v1/subscriptions/s1_bearer'
- href: >-
http://meAppClient.example.com/rni/v1/notifications/s1_bearer/77777
subscriptionType: S1_BEARER
- href: >-
http://meAppClient.example.com/rni/v1/notifications/s1_bearer/77778
subscriptionType: S1_BEARER
'400':
description: Bad Request
schema:
type: object
properties:
ProblemDetails:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
'401':
description: Unauthorized
schema:
type: object
properties:
ProblemDetails:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
'403':
description: Forbidden
schema:
type: object
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
required:
- ProblemDetails
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
schema:
type: object
properties:
ProblemDetails:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
'406':
description: Not Acceptable
schema:
type: object
properties:
ProblemDetails:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
'429':
description: Too Many Requests
schema:
type: object
properties:
ProblemDetails:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
x-swagger-router-controller: Default
post:
description: >-
Creates a subscription to S1 bearer notifications from Radio Network
Information Service
operationId: S1BearerSubscription_subscriptionsPOST
produces:
- application/json
- application/problem+json
parameters:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
- $ref: '#/components/parameters/Body.S1BearerSubscriptionPost'
responses:
'201':
description: Successful subscription to response to S1 Bearer notifications
schema:
type: object
properties:
S1BearerSubscription:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/S1BearerSubscription'
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
examples:
application/json:
S1BearerSubscription:
callbackReference: >-
http://meAppClient.example.com/rni/v1/notifications/s1_bearer/77777
_links:
self: >-
http://meAppServer.example.com/rni/v1/subscriptions/s1_bearer/sub123
eventType: 1
s1BearerSubscriptionCriteria:
associateId:
type: '1'
value: 192.0.2.0
plmn:
mnc: '01'
mcc: '001'
cellId: '0x800000B'
erabId: 1
expiryDeadline:
seconds: 1577836800
nanoSeconds: 0
'400':
description: Bad Request
schema:
type: object
properties:
ProblemDetails:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
'401':
description: Unauthorized
schema:
type: object
properties:
ProblemDetails:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
'403':
description: Forbidden
schema:
type: object
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
required:
- ProblemDetails
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
schema:
type: object
properties:
ProblemDetails:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
'406':
description: Not Acceptable
schema:
type: object
properties:
ProblemDetails:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
'415':
description: Unsupported Media Type
schema:
type: object
properties:
ProblemDetails:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
'422':
description: Unprocessable Entity
schema:
type: object
properties:
ProblemDetails:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
'application/problem+json':
ProblemDetails:
type: 'https://meAppServer.example.com/rni/v1/probs/too-many-targets'
status: '422'
detail: The target area for the request is considered too large
instance: '/meAppClient.example.com/77777/msgs/abc'
'429':
description: Too Many Requests
schema:
type: object
properties:
ProblemDetails:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/ProblemDetails'
x-swagger-router-controller: Default
'/subscriptions/s1_bearer/{subscriptionId}':
get:
description: >-
Gets a subscription to S1 bearer notifications from Radio Network
Information Service
operationId: S1BearerSubscription_subscriptionsGET
produces:
- application/json
- application/problem+json
parameters:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
- $ref: '#/components/parameters/Path.subscrId'
responses:
'200':
description: Successful subscription to response to S1 Bearer notifications
schema:
type: object
properties:
S1BearerSubscription:
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
$ref: '#/components/schemas/S1BearerSubscription'
examples:
application/json:
S1BearerSubscription:
callbackReference: >-
http://meAppClient.example.com/rni/v1/notifications/s1_bearer/77777
_links:
self: >-
http://meAppServer.example.com/rni/v1/subscriptions/s1_bearer/sub123