Newer
Older
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
},
"AccessPointInfo": {
"description": "A type containing access point information.",
"type": "object",
"required": [
"accessPointId",
"connectionType",
"operationStatus",
"numberOfUsers",
"resourceURL"
],
"properties": {
"accessPointId": {
"$ref": "#/definitions/AccessPointId"
},
"locationInfo": {
"$ref": "#/definitions/LocationInfo"
},
"connectionType": {
"$ref": "#/definitions/ConnectionType"
},
"operationStatus": {
"$ref": "#/definitions/OperationStatus"
},
"numberOfUsers": {
"$ref": "#/definitions/NumberOfUsers"
},
"timezone": {
"$ref": "#/definitions/Timezone"
},
"interestRealm": {
"$ref": "#/definitions/InterestRealm"
},
"resourceURL": {
"$ref": "#/definitions/ResourceURL"
}
}
},
"AccessPointList": {
"description": "A type containing list of access points.",
"type": "object",
"required": [
"zoneId",
"resourceURL"
],
"properties": {
"zoneId": {
"$ref": "#/definitions/ZoneId"
},
"accessPoint": {
"description": "Collection of the access point information list.",
"type": "array",
"items": {
"$ref": "#/definitions/AccessPointInfo"
}
},
"resourceURL": {
"$ref": "#/definitions/ResourceURL"
}
}
},
"Address": {
"description": "Address of user (e.g. \"sip\" URI, \"tel\" URI, \"acr\" URI).",
"type": "string",
"format": "uri",
"example": "acr:192.0.2.1"
},
"AncillaryInfo": {
"description": "Reserved for future use.",
"type": "string"
},
"CallbackData": {
"description": "CallBackData if passed by the application during the associated ZonalTrafficSubscription and UserTrackingSubscription operation. See [REST_NetAPI_Common].",
"type": "string",
"example": "1234"
},
"CallbackReference": {
"description": "Notification callback definition.",
"type": "object",
"required": [
"notifyURL"
],
"properties": {
"notifyURL": {
"$ref": "#/definitions/NotifyURL"
}
}
},
"ClientCorrelator": {
"description": "Uniquely identifies this create subscription request. If there is a communication failure during the request, using the same clientCorrelator when retrying the request allows the operator to avoid creating a duplicate subscription.",
"type": "string",
"example": "0123"
},
"ConnectionType": {
"description": "The connection type for the access point",
"type": "string",
"enum": [
"Femto",
"LTE-femto",
"Smallcell",
"LTE-smallcell",
"Wifi",
"Pico",
"Micro",
"Macro",
"Wimax",
"Unknown"
],
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
"example": "Macro"
},
"ContextLocationInfo": {
"description": "Contextual information of a user location (e.g., aisle, floor, room number, etc.)",
"type": "string",
"example": "GroundFloor"
},
"CurrentAccessPointId": {
"description": "Zone ID",
"type": "string",
"example": "zone01"
},
"Duration": {
"description": "Period (in seconds) of time notifications are provided for. If set to \"0\" (zero), a default duration time, which is specified by the service policy, will be used. If the parameter is omitted, the notifications will continue until the maximum duration time, which is specified by the service policy, unless the notifications are stopped by deletion of subscription for notifications. This element MAY be given by the client during resource creation in order to signal the desired lifetime of the subscription. The server MUST return in this element the period of time for which the subscription will still be valid.",
"type": "string",
"example": "0"
},
"InterestRealm": {
"description": "Interest realm of access point (e.g. geographical area, a type of industry etc.).",
"type": "string",
"example": "LA"
},
"Link": {
"description": "Link to other resources",
"type": "object",
"required": [
"rel",
"href"
],
"properties": {
"rel": {
"description": "Describes the relationship between the URI and the resource.",
"type": "object",
"format": "string"
},
"href": {
"description": "URI",
"type": "object",
"format": "anyURI"
}
}
},
"LocationInfo": {
"description": "A type containing location information with latitude, longitude and altitude, in addition the accuracy of the information are provided.",
"type": "object",
"required": [
"latitude",
"longitude",
"accuracy"
],
"properties": {
"latitude": {
"type": "number",
"format": "float",
"example": "80.123"
},
"longitude": {
"type": "number",
"format": "float",
"example": "70.123"
},
"altitude": {
"type": "number",
"format": "float",
"example": "10.0"
},
"accuracy": {
"type": "integer",
"format": "int32",
"example": "10"
}
}
},
"NotifyURL": {
"description": "The URL of your own listener application.",
"type": "string",
"format": "url",
"example": "http://clientApp.example.com/location_notifications/123456"
},
"NumberOfAccessPoints": {
"description": "The number of access points within the zone",
"type": "integer",
"format": "uint32",
"example": "10"
},
"NumberOfUnserviceableAccessPoints": {
"description": "Number of inoperable access points within the zone.",
"type": "integer",
"format": "uint32",
"example": "9"
},
"NumberOfUsers": {
"description": "The number of users currently on the access point.",
"type": "integer",
"format": "uint32",
"example": "7"
},
"NumberOfUsersAPThreshold": {
"description": "Threshold number of users in an access point which if crossed shall cause a notification.",
"type": "integer",
"format": "uint32",
"example": "20"
},
"NumberOfUsersInAP": {
"description": "This element shall be present when ZoneStatusSubscription includes numberOfUsersAPThreshold element and the number of users in an access point exceeds the threshold defined in the subscription.",
"type": "integer",
"format": "uint32",
"example": "12"
},
"NumberOfUsersInZone": {
"description": "This element shall be present when ZoneStatusSubscription includes numberOfUsersZoneThreshold element and the number of users in a zone exceeds the threshold defined in this subscription.",
"type": "integer",
"format": "uint32",
"example": "20"
},
"NumberOfUsersZoneThreshold": {
"description": "Threshold number of users in a zone which if crossed shall cause a notification.",
"type": "integer",
"format": "uint32",
"example": "40"
},
"OperationStatus": {
"description": "The operation status of the access point",
"type": "string",
"enum": [
"Serviceable",
"Unserviceable",
"Unknown"
],
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
"example": "Serviceable"
},
"PreviousAccessPointId": {
"description": "Zone ID",
"type": "string",
"example": "zone02"
},
"ResourceURL": {
"description": "Self referring URL.",
"type": "string",
"format": "uri",
"example": "http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123"
},
"Timestamp": {
"description": "Indicates the time of day for zonal presence notification.",
"type": "string",
"format": "date-time",
"example": "2017-01-01T02:51:43Z"
},
"Timezone": {
"description": "Time zone of access point",
"type": "string",
"format": "date-time",
"example": "2017-01-01T02:51:43Z"
},
"UserEventCriteria": {
"description": "List of user event values to generate notifications for (these apply to address specified). If this element is missing, a notification is requested to be generated for any change in user event.",
"type": "array",
"items": {
"$ref": "#/definitions/UserEventType"
}
},
"UserEventType": {
"description": "User event",
"type": "string",
"enum": [
"Entering",
"Leaving",
"Transferring"
],
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
"example": "Entering"
},
"UserInfo": {
"description": "A type containing user information.",
"type": "object",
"required": [
"address",
"accessPointId",
"zoneId",
"resourceURL"
],
"properties": {
"address": {
"$ref": "#/definitions/Address"
},
"accessPointId": {
"$ref": "#/definitions/AccessPointId"
},
"zoneId": {
"$ref": "#/definitions/ZoneId"
},
"resourceURL": {
"$ref": "#/definitions/ResourceURL"
},
"locationInfo": {
"$ref": "#/definitions/LocationInfo"
},
"contextLocationInfo": {
"$ref": "#/definitions/ContextLocationInfo"
},
"ancillaryInfo": {
"$ref": "#/definitions/AncillaryInfo"
}
}
},
"UserList": {
"description": "A type containing list of users.",
"type": "object",
"required": [
"resourceURL"
],
"properties": {
"user": {
"description": "Collection of the zone information list.",
"type": "array",
"items": {
"$ref": "#/definitions/UserInfo"
}
},
"resourceURL": {
"$ref": "#/definitions/ResourceURL"
}
}
},
"UserTrackingSubscription": {
"description": "A type containing user tracking subscription.",
"type": "object",
"required": [
"callbackReference",
"address"
],
"properties": {
"clientCorrelator": {
"$ref": "#/definitions/ClientCorrelator"
},
"callbackReference": {
"$ref": "#/definitions/CallbackReference"
},
"address": {
"$ref": "#/definitions/Address"
},
"userEventCriteria": {
"$ref": "#/definitions/UserEventCriteria"
},
"resourceURL": {
"$ref": "#/definitions/ResourceURL"
}
}
},
"ZonalPresenceNotification": {
"description": "A type containing zonal presence notification",
"type": "object",
"required": [
"zoneId",
"address",
"userEventType",
"currentAccessPointId",
"timestamp"
],
"properties": {
"callbackData": {
"$ref": "#/definitions/CallbackData"
},
"zoneId": {
"$ref": "#/definitions/ZoneId"
},
"address": {
"$ref": "#/definitions/Address"
},
"interestRealm": {
"$ref": "#/definitions/InterestRealm"
},
"userEventType": {
"$ref": "#/definitions/UserEventType"
},
"currentAccessPointId": {
"$ref": "#/definitions/CurrentAccessPointId"
},
"previousAccessPointId": {
"$ref": "#/definitions/PreviousAccessPointId"
},
"timestamp": {
"$ref": "#/definitions/Timestamp"
},
"link": {
"description": "Link to other resources that are in relationship with this notification. The server SHOULD include a link to the related subscription. No other links are required or suggested by this specification.",
"type": "array",
"items": {
"$ref": "#/definitions/Link"
},
"example": "rel=\"ZonalTrafficSubscription\" href=\"http://example.com/exampleAPI/location/v1/subscriptions/zonalTraffic/sub123\"/"
}
}
},
"ZonalTrafficSubscription": {
"description": "A type containing zonal traffic subscription",
"type": "object",
"required": [
"callbackReference",
"zoneId"
],
"properties": {
"clientCorrelator": {
"$ref": "#/definitions/ClientCorrelator"
},
"callbackReference": {
"$ref": "#/definitions/CallbackReference"
},
"zoneId": {
"$ref": "#/definitions/ZoneId"
},
"interestRealm": {
"description": "Interest realms of access points within a zone (e.g. geographical area, a type of industry etc.).",
"type": "array",
"items": {
"$ref": "#/definitions/InterestRealm"
}
},
"userEventCriteria": {
"description": "List of user event values to generate notifications for (these apply to zone identifier or all interest realms within zone identifier specified). If this element is missing, a notification is requested to be generated for any change in user event.",
"type": "array",
"items": {
"$ref": "#/definitions/UserEventType"
}
},
"duration": {
"$ref": "#/definitions/Duration"
},
"resourceURL": {
"$ref": "#/definitions/ResourceURL"
}
}
},
"ZoneId": {
"description": "Identifier of zone",
"type": "string",
"example": "zone01"
},
"ZoneInfo": {
"description": "A type containing zone information.",
"type": "object",
"required": [
"zoneId",
"numberOfAccessPoints",
"numberOfUnservicableAccessPoints",
"numberOfUsers",
"resourceURL"
],
"properties": {
"zoneId": {
"$ref": "#/definitions/ZoneId"
},
"numberOfAccessPoints": {
"$ref": "#/definitions/NumberOfAccessPoints"
},
"numberOfUnservicableAccessPoints": {
"$ref": "#/definitions/NumberOfUnserviceableAccessPoints"
},
"numberOfUsers": {
"$ref": "#/definitions/NumberOfUsers"
},
"resourceURL": {
"$ref": "#/definitions/ResourceURL"
}
}
},
"ZoneList": {
"description": "Collection of the zone information list.",
"type": "object",
"required": [
"resourceURL"
],
"properties": {
"zone": {
"description": "Collection of the zone information list.",
"type": "array",
"items": {
"$ref": "#/definitions/ZoneInfo"
}
},
"resourceURL": {
"$ref": "#/definitions/ResourceURL"
}
}
},
"ZoneStatusNotification": {
"description": "A type containing zone status notification.",
"type": "object",
"required": [
"zoneId",
"timestamp"
],
"properties": {
"callbackData": {
"$ref": "#/definitions/CallbackData"
},
"zoneId": {
"$ref": "#/definitions/ZoneId"
},
"accessPointId": {
"$ref": "#/definitions/AccessPointId"
},
"numberOfUsersInZone": {
"$ref": "#/definitions/NumberOfUsersInZone"
},
"numberOfUsersInAP": {
"$ref": "#/definitions/NumberOfUsersInAP"
},
"operationStatus": {
"$ref": "#/definitions/OperationStatus"
},
"timestamp": {
"$ref": "#/definitions/Timestamp"
},
"link": {
"description": "Link to other resources that are in relationship with this notification. The server SHOULD include a link to the related subscription. No other links are required or suggested by this specification.",
"type": "array",
"items": {
"$ref": "#/definitions/Link"
},
"example": "rel=\"ZonalStatusSubscription\" href=\"http://example.com/exampleAPI/location/v1/subscriptions/zonalStatus/sub123\""
}
}
},
"ZoneStatusSubscription": {
"description": "A type containing zone status subscription.",
"type": "object",
"required": [
"callbackReference",
"zoneId"
],
"properties": {
"clientCorrelator": {
"$ref": "#/definitions/ClientCorrelator"
},
"resourceURL": {
"$ref": "#/definitions/ResourceURL"
},
"callbackReference": {
"$ref": "#/definitions/CallbackReference"
},
"zoneId": {
"$ref": "#/definitions/ZoneId"
},
"numberOfUsersZoneThreshold": {
"$ref": "#/definitions/NumberOfUsersZoneThreshold"
},
"numberOfUsersAPThreshold": {
"$ref": "#/definitions/NumberOfUsersAPThreshold"
},
"operationStatus": {
"description": "List of operation status values to generate notifications for (these apply to all access points within a zone).",
"type": "array",
"items": {
"$ref": "#/definitions/OperationStatus"
}
}
}
}
}
}