Skip to content
RniAPI.json 187 KiB
Newer Older
          "200": {
            "description": "Response body contains the list of links to requestors cell_change subscriptions.",
            "schema": {
              "type": "object",
              "properties": {
                "SubscriptionLinkList": {
                  "$ref": "#/definitions/SusbcriptionLinkList"
                }
              }
            },
            "examples": {
              "application/json": {
                "SubscriptionLinkList": {
                  "_links": {
                    "self": "http://meAppServer.example.com/rni/v1/subscriptions/cell_change",
                    "susbcription": [
                      {
                        "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": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "406": {
            "description": "Not Acceptable",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "429": {
            "description": "Too Many Requests",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/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": [
          {
            "$ref": "#/parameters/Body.CellChangeSubscriptionPost"
          }
        ],
        "responses": {
          "201": {
            "description": "Successful subscription to response to UE cell change notifications",
            "schema": {
              "type": "object",
              "properties": {
                "CellChangeSubscription": {
                  "$ref": "#/definitions/CellChangeSubscription"
                }
              }
            },
            "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": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "406": {
            "description": "Not Acceptable",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "415": {
            "description": "Unsupported Media Type",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable Entity",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            },
            "examples": {
              "application/problem+json": {
                "ProblemDetails": {
                  "type": "https://meAppServer.example.com/rni/v1/probs/too-many-targets",
                  "title": "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": {
                  "$ref": "#/definitions/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": [
          {
            "$ref": "#/parameters/Path.subscrId"
          }
        ],
        "responses": {
          "200": {
            "description": "Subscription information regarding cell change notifications",
            "schema": {
              "type": "object",
              "properties": {
                "CellChangeSubscription": {
                  "$ref": "#/definitions/CellChangeSubscription"
                }
              }
            },
            "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": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "406": {
            "description": "Not Acceptable",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "429": {
            "description": "Too Many Requests",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/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": [
          {
            "$ref": "#/parameters/Body.CellChangeSubscription"
          },
          {
            "$ref": "#/parameters/Path.subscrId"
          }
        ],
        "responses": {
          "201": {
            "description": "Successful subscription to response to cell change notifications",
            "schema": {
              "type": "object",
              "properties": {
                "CellChangeSubscription": {
                  "$ref": "#/definitions/CellChangeSubscription"
                }
              }
            },
            "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": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "406": {
            "description": "Not Acceptable",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "412": {
            "description": "Precondition failed",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable Entity",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            },
            "examples": {
              "application/problem+json": {
                "ProblemDetails": {
                  "type": "https://meAppServer.example.com/rni/v1/probs/too-many-targets",
                  "title": "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": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          }
        }
      },
      "delete": {
        "description": "Method to delete a subscription",
        "operationId": "CellChange_subscriptionsSubscrIdDELETE",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/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",
        "operationId": "SusbcriptionLinkList_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",
              "properties": {
                "SusbcriptionLinkList": {
                  "$ref": "#/definitions/SusbcriptionLinkList"
                }
              }
            },
            "examples": {
              "application/json": {
                "SubscriptionLinkList": {
                  "_links": {
                    "self": "http://meAppServer.example.com/rni/v1/subscriptions/s1_bearer",
                    "susbcription": [
                      {
                        "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": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "406": {
            "description": "Not Acceptable",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "429": {
            "description": "Too Many Requests",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/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": [
          {
            "$ref": "#/parameters/Body.S1BearerSubscriptionPost"
          }
        ],
        "responses": {
          "201": {
            "description": "Successful subscription to response to S1 Bearer notifications",
            "schema": {
              "type": "object",
              "properties": {
                "S1BearerSubscription": {
                  "$ref": "#/definitions/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"
                  },
                  "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": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "406": {
            "description": "Not Acceptable",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "415": {
            "description": "Unsupported Media Type",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable Entity",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            },
            "examples": {
              "application/problem+json": {
                "ProblemDetails": {
                  "type": "https://meAppServer.example.com/rni/v1/probs/too-many-targets",
                  "title": "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": {
                  "$ref": "#/definitions/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": [
          {
            "$ref": "#/parameters/Path.subscrId"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful subscription to response to S1 Bearer notifications",
            "schema": {
              "type": "object",
              "properties": {
                "S1BearerSubscription": {
                  "$ref": "#/definitions/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"
                  },
                  "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": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "406": {
            "description": "Not Acceptable",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "429": {
            "description": "Too Many Requests",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          }
        }
      },
      "put": {
        "description": "Update a subscription to S1 bearer notifications from Radio Network Information Service",
        "operationId": "S1BearerSubscription_subscriptionsPUT",
        "produces": [
          "application/json",
          "application/problem+json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/Path.subscrId"
          },
          {
            "$ref": "#/parameters/Body.S1BearerSubscription"
          }
        ],
        "responses": {
          "201": {
            "description": "Successful subscription update to response to S1 Bearer notifications",
            "schema": {
              "type": "object",
              "properties": {
                "S1BearerSubscription": {
                  "$ref": "#/definitions/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"
                  },
                  "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": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {