RnisAPI.json 190 KB
Newer Older
Yann Garcia's avatar
Yann Garcia committed
5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647
                "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": "SubscriptionLinkList_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",
              "required": [
                "SubscriptionLinkList"
              ],
              "properties": {
                "SubscriptionLinkList": {
                  "$ref": "#/definitions/SubscriptionLinkList"
                }
              }
            },
            "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",
              "required": [
                "ProblemDetails"
              ],
              "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": [
          {
            "$ref": "#/parameters/Body.CaReConfSubscriptionPost"
          }
        ],
        "responses": {
          "201": {
            "description": "Successful subscription to Carrier Aggregation Reconfiguration notifications",
            "schema": {
              "type": "object",
              "properties": {
                "CaReConfSubscription": {
                  "$ref": "#/definitions/CaReConfSubscription"
                }
              }
            },
            "examples": {
              "application/json": {
                "CaReConfSubscription": {
                  "callbackReference": "http://meAppClient.example.com/rni/v1/notifications/ca_reconf/77777",
                  "_links": {
                    "self": "http://meAppServer.example.com/rni/v1/subscriptions/ca_reconf/sub123"
                  },
                  "filterCriteriaAssoc": {
                    "appInsId": "app01",
                    "associateId": {
                      "type": "1",
                      "value": "192.0.2.0"
                    },
                    "plmn": {
                      "mnc": "01",
                      "mcc": "001"
                    },
                    "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",
              "required": [
                "ProblemDetails"
              ],
              "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/ca_reconf/{subscriptionId}": {
      "get": {
        "description": "Gets a subscription to Carrier Aggregation Reconfiguration notifications from Radio Network Information Service",
        "operationId": "CaReConfSubscription_subscriptionsGET",
        "produces": [
          "application/json",
          "application/problem+json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/Path.subscrId"
          }
        ],
        "responses": {
          "200": {
            "description": "Subscription information regarding Carrier Aggregation Reconfiguration notifications",
            "schema": {
              "type": "object",
              "required": [
                "CaReConfSubscription"
              ],
              "properties": {
                "CaReConfSubscription": {
                  "$ref": "#/definitions/CaReConfSubscription"
                }
              }
            },
            "examples": {
              "application/json": {
                "CaReConfSubscription": {
                  "callbackReference": "http://meAppClient.example.com/rni/v1/notifications/ca_reconf/77777",
                  "_links": {
                    "self": "http://meAppServer.example.com/rni/v1/subscriptions/ca_reconf/sub123"
                  },
                  "filterCriteriaAssoc": {
                    "appInsId": "app01",
                    "associateId": {
                      "type": "1",
                      "value": "192.0.2.0"
                    },
                    "plmn": {
                      "mnc": "01",
                      "mcc": "001"
                    },
                    "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",
              "required": [
                "ProblemDetails"
              ],
              "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 Carrier Aggregation Reconfiguration notifications from Radio Network Information Service",
        "operationId": "CaReConfSubscription_subscriptionsPUT",
        "produces": [
          "application/json",
          "application/problem+json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/Path.subscrId"
          },
          {
            "$ref": "#/parameters/Body.CaReConfSubscription"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful subscription to Carrier Aggregation Reconfiguration notifications",
            "schema": {
              "type": "object",
              "properties": {
                "CaReConfSubscription": {
                  "$ref": "#/definitions/CaReConfSubscription"
                }
              }
            },
            "examples": {
              "application/json": {
                "CaReConfSubscription": {
                  "callbackReference": "http://meAppClient.example.com/rni/v1/notifications/ca_reconf/77777",
                  "_links": {
                    "self": "http://meAppServer.example.com/rni/v1/subscriptions/ca_reconf/sub123"
                  },
                  "filterCriteriaAssoc": {
                    "appInsId": "app01",
                    "associateId": {
                      "type": "1",
                      "value": "192.0.2.0"
                    },
                    "plmn": {
                      "mnc": "01",
                      "mcc": "001"
                    },
                    "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",
              "required": [
                "ProblemDetails"
              ],
              "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": "CaReConf_subscriptionsSubscrIdDELETE",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/Path.subscrId"
          }
        ],
        "responses": {
          "204": {
            "description": "No Content"
          }
        },
        "x-swagger-router-controller": "Default"
      }
    }
  },
  "definitions": {
    "ProblemDetails": {
      "type": "object",
      "properties": {
        "type": {
          "$ref": "#/definitions/Problem.type"
        },
        "title": {
          "$ref": "#/definitions/Problem.title"
        },
        "status": {
          "$ref": "#/definitions/Problem.status"
        },
        "detail": {
          "$ref": "#/definitions/Problem.detail"
        },
        "instance": {
          "$ref": "#/definitions/Problem.instance"
        }
      }
    },
    "Problem.type": {
      "type": "string",
      "format": "uri",
      "description": "A URI reference according to IETF RFC 3986 that identifies the problem type"
    },
    "Problem.title": {
      "type": "string",
      "description": "A short, human-readable summary of the problem type"
    },
    "Problem.status": {
      "type": "integer",
      "format": "uint32",
      "description": "The HTTP status code for this occurrence of the problem"
    },
    "Problem.detail": {
      "type": "string",
      "description": "A human-readable explanation specific to this occurrence of the problem"
    },
    "Problem.instance": {
      "type": "string",
      "format": "uri",
      "description": "A URI reference that identifies the specific occurrence of the problem"
    },
    "PlmnInfo": {
      "type": "object",
      "required": [
        "appInsId",
Yann Garcia's avatar
Yann Garcia committed
      ],
      "properties": {
        "timeStamp": {
          "$ref": "#/definitions/TimeStamp"
        },
        "appInsId": {
          "$ref": "#/definitions/AppInsId"
        },
        "plmn": {
          "type": "array",
          "items": {
             "$ref": "#/definitions/Plmn"
          }
Yann Garcia's avatar
Yann Garcia committed
        }
      }
    },
    "RabInfo": {
      "type": "object",
      "required": [
        "appInsId",
        "requestId"
      ],
      "properties": {
        "timeStamp": {
          "$ref": "#/definitions/TimeStamp"
        },
        "appInsId": {
          "$ref": "#/definitions/AppInsId"
        },
        "requestId": {
          "$ref": "#/definitions/RequestId"
        },
        "cellUserInfo": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/CellUserInfo"
          }
        }
      }
    },
    "S1BearerInfo": {
      "type": "object",
      "required": [
        "s1UeInfo"
      ],
      "properties": {
        "timeStamp": {
          "$ref": "#/definitions/TimeStamp"
        },
        "s1UeInfo": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/S1UeInfo"
          }
        }
      }
    },
    "S1UeInfo": {
      "type": "object",
      "required": [
        "ecgi",
        "s1BearerInfoDetailed"
      ],
      "properties": {
        "tempUeId": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/TempUeId"
          }
        },
        "associateId": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/AssociateId"
          }
        },
        "ecgi": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/Ecgi"
          }
        },
        "s1BearerInfoDetailed": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/S1BearerInfoDetailed"
          }
        }
      },
      "description": "The information on users per cell."
    },
    "S1BearerInfoDetailed": {
      "type": "object",
      "required": [
        "erabId",
        "enbInfo",
        "sGwInfo"
Yann Garcia's avatar
Yann Garcia committed
      ],
      "properties": {
        "erabId": {
          "$ref": "#/definitions/ErabId"
        },
Yann Garcia's avatar
Yann Garcia committed
          "$ref": "#/definitions/S1EnbInfo"
        },
        "sGwInfo": {
          "$ref": "#/definitions/SGwInfo"
        }
      },
      "description": "Information on UEs in the specific cell."
    },
    "ErabId": {
      "type": "integer",
      "format": "int32",
      "description": "The element that uniquely identifies a S1 bearer for a specific UE, as defined in ETSI TS 136 413",
      "example": 10
    },
    "TempUeId": {
      "type": "object",
      "required": [
        "mmec",
        "mtmsi"
      ],
      "properties": {
        "mmec": {
          "$ref": "#/definitions/Mmec"
        },
        "mtmsi": {
          "$ref": "#/definitions/Mtmsi"
        }
      }
    },
    "Mmec": {
      "type": "string",
      "description": "MMEC as defined in ETSI TS 136 413",
      "example": "0"
    },
    "Mtmsi": {
      "type": "string",
      "description": "M-TMSI as defined in ETSI TS 136 413",
      "example": "1234"
    },
    "S1EnbInfo": {
      "type": "object",
      "required": [
        "ipAddress",
        "tunnelId"
      ],
      "properties": {
        "ipAddress": {
          "type": "string",
          "description": "eNB transport layer address of this S1 bearer.",
          "example": "192.0.2.0"
        },
        "tunnelId": {
          "type": "string",
          "description": "eNB GTP-U TEID of this S1 bearer.",
          "example": "1111"
        }
      }
    },
    "SGwInfo": {
      "type": "object",
      "required": [
        "ipAddress",
        "tunnelId"
      ],
      "properties": {
        "ipAddress": {
          "type": "string",
          "description": "SGW transport layer address of this S1 bearer.",
          "example": "192.0.2.1"
        },
        "tunnelId": {
          "type": "string",
          "description": "SGW GTP-U TEID of this S1 bearer.",
          "example": "2222"
        }
      }
    },
    "TimeStamp": {
      "type": "object",
      "required": [
        "nanoSeconds",
        "seconds"
      ],
      "properties": {
        "seconds": {
          "type": "integer",
          "format": "uint32",
          "description": "The seconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC",
          "example": 1577836800
        },
        "nanoSeconds": {
          "type": "integer",
          "format": "uint32",
          "description": "The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC",
          "example": 0
        }
      }
    },
    "AppInsId": {
      "type": "string",
      "format": "string",
      "description": "Unique identifier for the mobile edge application instance",
      "example": "01"
    },
    "RequestId": {
      "type": "string",
      "format": "string",
      "description": "Unique identifier allocated by the Mobile Edge application for the  Information request.",
      "example": "01"
    },
    "CellUserInfo": {
      "type": "object",
      "required": [
        "ecgi",
        "ueInfo"
      ],
      "properties": {
        "ecgi": {
          "$ref": "#/definitions/Ecgi"
        },
        "ueInfo": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/UeInfo"
          }
        }
      },
      "description": "The information on users per cell."
    },
    "Ecgi": {
      "type": "object",
      "required": [
        "cellId",
        "plmn"
      ],
      "properties": {
        "plmn": {
          "$ref": "#/definitions/Plmn"
        },
        "cellId": {
          "$ref": "#/definitions/CellId"
        }
      },
      "description": "E-UTRAN CelI Global Identifier as defined in 3GPP TS 36.413"
    },
    "Plmn": {
      "type": "object",
      "required": [
        "mcc",
        "mnc"
      ],
      "properties": {
        "mcc": {
          "type": "string",
          "format": "string",
          "description": "The Mobile Country Code part of PLMN Identity as defined in 3GPP TS 36.413",
          "example": "001"
        },
        "mnc": {
          "type": "string",
          "format": "string",
          "description": "The Mobile Network Code part of PLMN Identity as defined in 3GPP TS 36.413",
          "example": "01"
        }
      }
    },
    "CellId": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "binary"
      },
      "description": "The E-UTRAN Cell Identity as a bit string (size (28)), as defined in 3GPP TS 36.413",
      "example": "0x800000A"
    },
    "UeInfo": {
      "type": "object",
      "required": [
        "erabInfo"
      ],
      "properties": {
        "associateId": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/AssociateId"
          }
        },
        "erabInfo": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ErabQosParameters"
          }
        }
      },
      "description": "Information on UEs in the specific cell."
    },
    "AssociateId": {
      "type": "object",
      "required": [
        "type",
        "value"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "RESERVED",
            "UE_IPV4_ADDRESS",
            "UE_IPV6_ADDRESS",
            "NATED_IP_ADDRESS",
            "GTP_TEID"
          ],
          "description": "Numeric value (0-255) corresponding to specified type of identifier",
          "example": "UE_IPV4_ADDRESS"
        },
        "value": {
          "type": "String",
          "format": "String",
Yann Garcia's avatar
Yann Garcia committed
          "description": "Value for the identifier",
          "example": "192.0.0.2"
Yann Garcia's avatar
Yann Garcia committed
        }
      }
    },
    "ErabQosParameters": {
      "type": "object",
      "properties": {
        "qci": {
          "$ref": "#/definitions/Qci"
        },
        "qosInformation": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/QosInformation"
          }
Yann Garcia's avatar
Yann Garcia committed
        }
      }
    },
    "Qci": {
      "type": "integer",
      "format": "int32",
      "description": "QoS Class Identifier as defined in TS 23.401",
      "example": 7
    },
    "QosInformation": {
      "type": "object",
      "required": [
        "erabGbrDl",
        "erabGbrUl",
        "erabMbrDl",