RniAPI.json 187 KB
Newer Older
              "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/rab_mod/{subscriptionId}": {
      "get": {
        "description": "Creates a subscription to RAB Modification notifications from Radio Network Information Service",
        "operationId": "RabModSubscription_subscriptionsGET",
        "produces": [
          "application/json",
          "application/problem+json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/Path.subscrId"
          }
        ],
        "responses": {
          "201": {
            "description": "Subscription information regarding RAB Modification notifications",
            "schema": {
              "type": "object",
              "properties": {
                "RabModSubscription": {
                  "$ref": "#/definitions/RabModSubscription"
                }
              }
            },
            "examples": {
              "application/json": {
                "RabModSubscription": {
                  "callbackReference": "http://meAppClient.example.com/rni/v1/notifications/rab_mod/77777",
                  "_links": {
                    "self": "http://meAppServer.example.com/rni/v1/subscriptions/rab_mod/sub123"
                  },
                  "filterCriteriaAssocQci": {
                    "appInsId": "app01",
                    "associateId": {
                      "type": "1",
                      "value": "192.0.2.0"
                    },
                    "plmn": {
                      "mnc": "01",
                      "mcc": "001"
                    },
                    "cellId": "0x800000B",
                    "qci": 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": "Updates a subscription to RAB Modification notifications from Radio Network Information Service",
        "operationId": "RabModSubscription_subscriptionsPUT",
        "produces": [
          "application/json",
          "application/problem+json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/Path.subscrId"
          },
          {
            "$ref": "#/parameters/Body.RabModSubscription"
          }
        ],
        "responses": {
          "201": {
            "description": "Successful subscription update to RAB Modification notifications",
            "schema": {
              "type": "object",
              "properties": {
                "RabModSubscription": {
                  "$ref": "#/definitions/RabModSubscription"
                }
              }
            },
            "examples": {
              "application/json": {
                "RabModSubscription": {
                  "callbackReference": "http://meAppClient.example.com/rni/v1/notifications/rab_mod/77777",
                  "_links": {
                    "self": "http://meAppServer.example.com/rni/v1/subscriptions/rab_mod/sub123"
                  },
                  "filterCriteriaAssocQci": {
                    "appInsId": "app01",
                    "associateId": {
                      "type": "1",
                      "value": "192.0.2.0"
                    },
                    "plmn": {
                      "mnc": "01",
                      "mcc": "001"
                    },
                    "cellId": "0x800000B",
                    "qci": 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"
                }
              }
            }
          },
          "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": "RabMod_subscriptionsSubscrIdDELETE",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/Path.subscrId"
          }
        ],
        "responses": {
          "204": {
            "description": "No Content. Successful deletion of Rab Modification subscription"
          }
        },
        "x-swagger-router-controller": "Default"
      }
    },
    "/subscriptions/rab_rel": {
      "get": {
        "description": "The GET method can be used to request information about the rab_rel subscriptions for this requestor",
        "operationId": "SusbcriptionLinkList_subscriptions_rr_GET",
        "produces": [
          "application/json",
          "application/problem+json"
        ],
        "responses": {
          "200": {
            "description": "Response body contains the list of links to requestors rab_rel subscriptions.",
            "schema": {
              "type": "object",
              "properties": {
                "SusbcriptionLinkList": {
                  "$ref": "#/definitions/SusbcriptionLinkList"
                }
              }
            },
            "examples": {
              "application/json": {
                "SubscriptionLinkList": {
                  "_links": {
                    "self": "http://meAppServer.example.com/rni/v1/subscriptions/rab_rel",
                    "susbcription": [
                      {
                        "href": "http://meAppClient.example.com/rni/v1/notifications/rab_rel/77777",
                        "subscriptionType": "RAB_RELEASE"
                      },
                      {
                        "href": "http://meAppClient.example.com/rni/v1/notifications/rab_rel/77778",
                        "subscriptionType": "RAB_RELEASE"
                      }
                    ]
                  }
                }
              }
            }
          },
          "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 RAB Release notifications from Radio Network Information Service",
        "operationId": "RabRelSubscription_subscriptionsPOST",
        "produces": [
          "application/json",
          "application/problem+json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/Body.RabRelSubscriptionPost"
          }
        ],
        "responses": {
          "201": {
            "description": "Successful subscription to RAB Release notifications",
            "schema": {
              "type": "object",
              "properties": {
                "RabRelSubscription": {
                  "$ref": "#/definitions/RabRelSubscription"
                }
              }
            },
            "examples": {
              "application/json": {
                "RabRelSubscription": {
                  "callbackReference": "http://meAppClient.example.com/rni/v1/notifications/rab_rel/77777",
                  "_links": {
                    "self": "http://meAppServer.example.com/rni/v1/subscriptions/rab_rel/sub123"
                  },
                  "filterCriteriaAssocQci": {
                    "appInsId": "app01",
                    "associateId": {
                      "type": "1",
                      "value": "192.0.2.0"
                    },
                    "plmn": {
                      "mnc": "01",
                      "mcc": "001"
                    },
                    "cellId": "0x800000B",
                    "qci": 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/rab_rel/{subscriptionId}": {
      "get": {
        "description": "Creates a subscription to RAB Release notifications from Radio Network Information Service",
        "operationId": "RabRelSubscription_subscriptionsGET",
        "produces": [
          "application/json",
          "application/problem+json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/Path.subscrId"
          }
        ],
        "responses": {
          "201": {
            "description": "Subscription information regarding RAB Release notifications",
            "schema": {
              "type": "object",
              "properties": {
                "RabRelSubscription": {
                  "$ref": "#/definitions/RabRelSubscription"
                }
              }
            },
            "examples": {
              "application/json": {
                "RabRelSubscription": {
                  "callbackReference": "http://meAppClient.example.com/rni/v1/notifications/rab_rel/77777",
                  "_links": {
                    "self": "http://meAppServer.example.com/rni/v1/subscriptions/rab_rel/sub123"
                  },
                  "filterCriteriaAssocQci": {
                    "appInsId": "app01",
                    "associateId": {
                      "type": "1",
                      "value": "192.0.2.0"
                    },
                    "plmn": {
                      "mnc": "01",
                      "mcc": "001"
                    },
                    "cellId": "0x800000B",
                    "qci": 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": "Updates a subscription to RAB Release notifications from Radio Network Information Service",
        "operationId": "RabRelSubscription_subscriptionsPUT",
        "produces": [
          "application/json",
          "application/problem+json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/Path.subscrId"
          },
          {
            "$ref": "#/parameters/Body.RabRelSubscription"
          }
        ],
        "responses": {
          "201": {
            "description": "Successful subscription update to RAB Release notifications",
            "schema": {
              "type": "object",
              "properties": {
                "RabRelSubscription": {
                  "$ref": "#/definitions/RabRelSubscription"
                }
              }
            },
            "examples": {
              "application/json": {
                "RabRelSubscription": {
                  "callbackReference": "http://meAppClient.example.com/rni/v1/notifications/rab_rel/77777",
                  "_links": {
                    "self": "http://meAppServer.example.com/rni/v1/subscriptions/rab_rel/sub123"
                  },
                  "filterCriteriaAssocQci": {
                    "appInsId": "app01",
                    "associateId": {
                      "type": "1",
                      "value": "192.0.2.0"
                    },
                    "plmn": {
                      "mnc": "01",
                      "mcc": "001"
                    },
                    "cellId": "0x800000B",
                    "qci": 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"
                }
              }
            }
          },
          "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": "RabRel_subscriptionsSubscrIdDELETE",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/Path.subscrId"
          }
        ],
        "responses": {
          "204": {
            "description": "No Content. Successful deletion of Rab Release subscription"
          }
        },
        "x-swagger-router-controller": "Default"
      }
    },
    "/subscriptions/ca_reconf": {
      "get": {
        "description": "The GET method can be used to request information about the ca_reconf subscriptions for this requestor",
        "operationId": "SusbcriptionLinkList_subscriptions_cr_GET",
        "produces": [
          "application/json",
          "application/problem+json"
        ],
        "responses": {
          "200": {
            "description": "Response body contains the list of links to requestors ca_reconf subscriptions.",
            "schema": {
              "type": "object",
              "properties": {
                "SusbcriptionLinkList": {
                  "$ref": "#/definitions/SusbcriptionLinkList"
                }
              }
            },
            "examples": {
              "application/json": {
                "SubscriptionLinkList": {
                  "_links": {
                    "self": "http://meAppServer.example.com/rni/v1/subscriptions/ca_reconf",
                    "susbcription": [
                      {
                        "href": "http://meAppClient.example.com/rni/v1/notifications/ca_reconf/77777",
                        "subscriptionType": "CA_RECONF"
                      },
                      {
                        "href": "http://meAppClient.example.com/rni/v1/notifications/ca_reconf/77778",
                        "subscriptionType": "CA_RECONF"
                      }
                    ]
                  }
                }
              }
            }
          },
          "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 Carrier Aggregation Reconfiguration notifications from Radio Network Information Service",
        "operationId": "CaReConfSubscription_subscriptionsPOST",
        "produces": [
          "application/json",
          "application/problem+json"
        ],
        "parameters": [
          {