RniAPI.json 187 KB
Newer Older
6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423
      "required": [
        "callbackReference",
        "_links",
        "filterCriteria"
      ],
      "properties": {
        "callbackReference": {
          "$ref": "#/definitions/CallbackReference"
        },
        "_links": {
          "$ref": "#/definitions/Link"
        },
        "filterCriteria": {
          "$ref": "#/definitions/FilterCriteriaAssocQci"
        },
        "expiryDeadline": {
          "$ref": "#/definitions/TimeStamp"
        }
      }
    },
    "RabModSubscriptionPost": {
      "type": "object",
      "required": [
        "callbackReference",
        "filterCriteria"
      ],
      "properties": {
        "callbackReference": {
          "$ref": "#/definitions/CallbackReference"
        },
        "filterCriteria": {
          "$ref": "#/definitions/FilterCriteriaAssocQci"
        },
        "expiryDeadline": {
          "$ref": "#/definitions/TimeStamp"
        }
      }
    },
    "RabRelSubscription": {
      "type": "object",
      "required": [
        "callbackReference",
        "_links",
        "filterCriteria"
      ],
      "properties": {
        "callbackReference": {
          "$ref": "#/definitions/CallbackReference"
        },
        "_links": {
          "$ref": "#/definitions/Link"
        },
        "filterCriteria": {
          "$ref": "#/definitions/FilterCriteriaAssocQci"
        },
        "expiryDeadline": {
          "$ref": "#/definitions/TimeStamp"
        }
      }
    },
    "RabRelSubscriptionPost": {
      "type": "object",
      "required": [
        "callbackReference",
        "filterCriteria"
      ],
      "properties": {
        "callbackReference": {
          "$ref": "#/definitions/CallbackReference"
        },
        "filterCriteria": {
          "$ref": "#/definitions/FilterCriteriaAssocQci"
        },
        "expiryDeadline": {
          "$ref": "#/definitions/TimeStamp"
        }
      }
    },
    "CaReConfSubscription": {
      "type": "object",
      "required": [
        "callbackReference",
        "_links",
        "filterCriteria"
      ],
      "properties": {
        "callbackReference": {
          "$ref": "#/definitions/CallbackReference"
        },
        "_links": {
          "$ref": "#/definitions/Link"
        },
        "filterCriteria": {
          "$ref": "#/definitions/FilterCriteriaAssoc"
        },
        "expiryDeadline": {
          "$ref": "#/definitions/TimeStamp"
        }
      }
    },
    "CaReConfSubscriptionPost": {
      "type": "object",
      "required": [
        "callbackReference",
        "filterCriteria"
      ],
      "properties": {
        "callbackReference": {
          "$ref": "#/definitions/CallbackReference"
        },
        "filterCriteria": {
          "$ref": "#/definitions/FilterCriteriaAssoc"
        },
        "expiryDeadline": {
          "$ref": "#/definitions/TimeStamp"
        }
      }
    },
    "CellChangeSubscriptionPost": {
      "type": "object",
      "required": [
        "callbackReference",
        "filterCriteria"
      ],
      "properties": {
        "callbackReference": {
          "$ref": "#/definitions/CallbackReference"
        },
        "filterCriteria": {
          "$ref": "#/definitions/FilterCriteriaAssocHo"
        },
        "expiryDeadline": {
          "$ref": "#/definitions/TimeStamp"
        }
      }
    },
    "CellChangeSubscription": {
      "type": "object",
      "required": [
        "callbackReference",
        "_links",
        "filterCriteria"
      ],
      "properties": {
        "callbackReference": {
          "$ref": "#/definitions/CallbackReference"
        },
        "_links": {
          "$ref": "#/definitions/Link"
        },
        "filterCriteria": {
          "$ref": "#/definitions/FilterCriteriaAssocHo"
        },
        "expiryDeadline": {
          "$ref": "#/definitions/TimeStamp"
        }
      }
    },
    "MeasTaSubscriptionPost": {
      "type": "object",
      "required": [
        "callbackReference",
        "filterCriteria"
      ],
      "properties": {
        "callbackReference": {
          "$ref": "#/definitions/CallbackReference"
        },
        "filterCriteria": {
          "$ref": "#/definitions/FilterCriteriaAssoc"
        },
        "expiryDeadline": {
          "$ref": "#/definitions/TimeStamp"
        }
      }
    },
    "MeasTaSubscription": {
      "type": "object",
      "required": [
        "callbackReference",
        "_links",
        "filterCriteria"
      ],
      "properties": {
        "callbackReference": {
          "$ref": "#/definitions/CallbackReference"
        },
        "_links": {
          "$ref": "#/definitions/Link"
        },
        "filterCriteria": {
          "$ref": "#/definitions/FilterCriteriaAssoc"
        },
        "expiryDeadline": {
          "$ref": "#/definitions/TimeStamp"
        }
      }
    },
    "CallbackReference": {
      "type": "string",
      "format": "uri",
      "description": "URL selected by the Mobile Edge application to receive notifications on the subscribed RNIS information.",
      "example": "http://meAppClient.example.com/rni/v1/"
    },
    "Link": {
      "type": "object",
      "properties": {
        "self": {
          "$ref": "#/definitions/LinkType"
        }
      },
      "description": "List of hyperlinks related to the resource"
    },
    "LinkList": {
      "type": "object",
      "required": [
        "self"
      ],
      "properties": {
        "self": {
          "$ref": "#/definitions/LinkType"
        },
        "subscription": {
          "$ref": "#/definitions/Subscription"
        }
      },
      "description": "List of hyperlinks related to the resource"
    },
    "LinkType": {
      "description": "URI referring to a resource",
      "type": "string",
      "format": "uri",
      "example": "http://meAppClient.example.com/rni/v1/"
    },
    "Subscription": {
      "type": "object",
      "required": [
        "href",
        "subscriptionType"
      ],
      "properties": {
        "href": {
          "$ref": "#/definitions/LinkType"
        },
        "subscriptionType": {
          "$ref": "#/definitions/SubscriptionType"
        }
      },
      "description": "A link to a subscription."
    },
    "SubscriptionType": {
      "type": "string",
      "description": "Numeric value corresponding to specified type of subscription.",
      "enum": [
        "RESERVED",
        "CELL_CHANGE",
        "RAB_ESTABLISHMENT",
        "RAB_MODIFICATION",
        "RAB_RELEASE",
        "MEAS_ REPORT_UE",
        "MEAS_TIMING_ADVANCE",
        "CA_RECONF",
        "S1_BEARE"
      ],
      "example": "CELL_CHANGE"
    },
    "FilterCriteriaAssoc": {
      "type": "object",
      "properties": {
        "appInsId": {
          "$ref": "#/definitions/AppInsId"
        },
        "associateId": {
          "$ref": "#/definitions/AssociateId"
        },
        "plmn": {
          "$ref": "#/definitions/Plmn"
        },
        "cellId": {
          "$ref": "#/definitions/CellId"
        }
      },
      "description": "List of filtering criteria for the subscription."
    },
    "FilterCriteriaAssocQci": {
      "type": "object",
      "properties": {
        "appInsId": {
          "$ref": "#/definitions/AppInsId"
        },
        "associateId": {
          "$ref": "#/definitions/AssociateId"
        },
        "plmn": {
          "$ref": "#/definitions/Plmn"
        },
        "cellId": {
          "$ref": "#/definitions/CellId"
        },
        "qci": {
          "$ref": "#/definitions/Qci"
        }
      },
      "description": "List of filtering criteria for the subscription."
    },
    "FilterCriteriaAssocHo": {
      "type": "object",
      "properties": {
        "appInsId": {
          "$ref": "#/definitions/AppInsId"
        },
        "associateId": {
          "$ref": "#/definitions/AssociateId"
        },
        "plmn": {
          "$ref": "#/definitions/Plmn"
        },
        "cellId": {
          "$ref": "#/definitions/CellId"
        },
        "hoStatus": {
          "$ref": "#/definitions/HoStatus"
        }
      },
      "description": "List of filtering criteria for the subscription."
    },
    "FilterCriteriaAssocTri": {
      "type": "object",
      "properties": {
        "appInsId": {
          "$ref": "#/definitions/AppInsId"
        },
        "associateId": {
          "$ref": "#/definitions/AssociateId"
        },
        "plmn": {
          "$ref": "#/definitions/Plmn"
        },
        "cellId": {
          "$ref": "#/definitions/CellId"
        },
        "trigger": {
          "$ref": "#/definitions/Trigger"
        }
      },
      "description": "List of filtering criteria for the subscription."
    },
    "S1BearerSubscriptionCriteria": {
      "type": "object",
      "properties": {
        "associateId": {
          "$ref": "#/definitions/AssociateId"
        },
        "plmn": {
          "$ref": "#/definitions/Plmn"
        },
        "cellId": {
          "$ref": "#/definitions/CellId"
        },
        "erabId": {
          "$ref": "#/definitions/ErabId"
        }
      },
      "description": "List of filtering criteria for the subscription."
    },
    "HoStatus": {
      "type": "string",
      "description": "Description of the subscribed to event",
      "enum": [
        "RESERVED",
        "IN_PREPARATION",
        "IN_EXECUTION",
        "COMPLETED",
        "REJECTED",
        "CANCELLED"
      ],
      "example": "COMPLETED"
    },
    "EventType": {
      "type": "string",
      "description": "Description of the subscribed event.",
      "enum": [
        "RESERVED",
        "S1_BEARER_ESTABLISH",
        "S1_BEARER_MODIFY",
        "S1_BEARER_RELEASE"
      ],
      "example": "S1_BEARER_ESTABLISH"
    },
    "Trigger": {
      "type": "string",
      "description": "Unique identifier for the mobile edge application instance",
      "enum": [
        "NOT_AVAILABLE",
        "PERIODICAL_REPORT_STRONGEST_CELLS",
        "PERIODICAL_REPORT_STRONGEST_CELLS_FOR_SON",
        "PERIODICAL_REPORT_CGI",
        "EVENT_A1",
        "EVENT_A2",
        "EVENT_A3",
        "EVENT_A4",
        "EVENT_A5",
        "EVENT_A6",
        "EVENT_B1",
        "EVENT_B2",
        "EVENT_C1",
        "EVENT_C2",
        "EVENT_W1",
        "EVENT_W2",
        "EVENT_W3"
      ],
      "example": "EVENT_A3"
    },
    "ErabQosParameters_qci": {
      "type": "object",
      "properties": {
        "qosInformation": {
          "$ref": "#/definitions/QosInformation"
        }
      },
      "description": "QoS Class Identifier as defined in TS 23.401"
    }
  }