この製品のマニュアルセットは、偏向のない言語を使用するように配慮されています。このマニュアルセットでの偏向のない言語とは、年齢、障害、性別、人種的アイデンティティ、民族的アイデンティティ、性的指向、社会経済的地位、およびインターセクショナリティに基づく差別を意味しない言語として定義されています。製品ソフトウェアのユーザーインターフェイスにハードコードされている言語、RFP のドキュメントに基づいて使用されている言語、または参照されているサードパーティ製品で使用されている言語によりドキュメントに例外が存在する場合があります。シスコのインクルーシブランゲージに対する取り組みの詳細は、こちらをご覧ください。
このドキュメントは、米国シスコ発行ドキュメントの参考和訳です。リンク情報につきましては、日本語版掲載時点で、英語版にアップデートがあり、リンク先のページが移動/変更されている場合がありますことをご了承ください。あくまでも参考和訳となりますので、正式な内容については米国サイトのドキュメントを参照ください。
この API は、アクティブなタグの数を返します。
GET
/api/location/v1/tags/count
N
なし。
application/json
{"deviceType":"Tag","deviceQueryString":null,"count":8}
この API は、すべてのタグを返します。
GET
/api/location/v1/tags
N
なし。
application/json
[{"macAddress":"00:18:8e:28:24:26","mapInfo":{"mapHierarchyString": "Singapore>SINGAPORE UE BIZHUB EAST (SNG11)>SNG11-5Fl>SingZone","floorRefId": "739764660256899136","floorDimension":{"length":118.11024,"width":184.05511, "height":9.84252,"offsetX":0.0,"offsetY":0.0,"unit":"FEET"},"image":{"imageName": "domain_0_1380690706964.png","zoomLevel":4,"width":1440.0,"height":900.0,"size":1440.0, "maxResolution":8.0,"colorDepth":8}},"mapCoordinate":{"x":108.84515,"y":68.62626,"z" :0.0,"unit":"FEET"},"currentlyTracked":true,"confidenceFactor":72.0,"statistics": {"currentServerTime":"2016-06-16T02:17:38.682+0800","firstLocatedTime" :"1970-01-01T07:30:00.000+0730","lastLocatedTime":"2016-06-16T02:17:33.039+0800", "maxDetectedRssi":{"apMacAddress":"64:f6:9d:2a:05:00","band":"IEEE_802_11_B","slot" :0,"rssi":-58,"antennaIndex":0,"lastHeardInSeconds":1}},"historyLogReason":null, "geoCoordinate":{"latitude":1.3347778969996247,"longitude":103.96366325767761,"unit": "DEGREES"},"networkStatus":"ACTIVE","changedOn":1466014653039,"telemetryList":null, "batteryInfo":{"tolerance":70,"percentRemaining":100,"daysRemaining":0,"batteryAge":0, "lastReceivedTime":"2016-06-09T06:38:29.748+0800","lastReceivedSeqNum":2221},"vendorData" :{"vendorId":6286,"elementId":0,"data":"AAMAAQEABAABAQ==","lastReceivedTime": "2016-06-09T06:38:29.748+0800","lastReceivedSeqNum":2221},"sortedEmergencyList":null, "sortedChokepointList":null,"lastBeaconTime":null,"lastBeaconSequenceNumber":2221, "manufacturer":"Ekahau"},
{"x":72.013855,"y":141.74767,"z":0.0,"unit":"FEET"},"currentlyTracked": true,"confidenceFactor":312.0,"statistics":{"currentServerTime": "2016-06-16T02:17:38.683+0800","firstLocatedTime":"2016-06-16T01:03:27.408+0800", "lastLocatedTime":"2016-06-16T02:11:46.648+0800","maxDetectedRssi":{"apMacAddress": "04:62:73:61:b3:10","band":"IEEE_802_11_B","slot":0,"rssi":-91,"antennaIndex":0, "lastHeardInSeconds":2}},"historyLogReason":null,"geoCoordinate":null,"networkStatus" :"ACTIVE","changedOn":1466014306648,"telemetryList":null,"batteryInfo":{"tolerance":20, "percentRemaining":80,"daysRemaining":2948,"batteryAge":29,"lastReceivedTime": "2016-06-16T02:11:45.137+0800","lastReceivedSeqNum":169},"vendorData":{"vendorId": 3276,"elementId":0,"data":"AAAOAA==","lastReceivedTime":"2016-06-16T02:11:45.137+0800", "lastReceivedSeqNum":169},"sortedEmergencyList":null,"sortedChokepointList":null, "lastBeaconTime":null,"lastBeaconSequenceNumber":169,"manufacturer":"Aeroscout"}]
この API は、タグの MAC アドレスを基準に、タグを返します。
GET
/api/location/v1/tags/:macaddress
N
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
---|---|---|---|---|---|
macaddress |
Y |
— |
文字列 |
pathReplace |
タグ MAC アドレス。 |
application/json
http://10.68.40.131/api/location/v1/tags/00:18:8e:28:24:26
{"macAddress":"00:18:8e:28:24:26","mapInfo":{"mapHierarchyString": "Singapore>SINGAPORE UE BIZHUB EAST (SNG11)>SNG11-5Fl>SingZone","floorRefId": "739764660256899136","floorDimension":{"length":118.11024,"width":184.05511, "height":9.84252,"offsetX":0.0,"offsetY":0.0,"unit":"FEET"},"image":{"imageName": "domain_0_1380690706964.png","zoomLevel":4,"width":1440.0,"height":900.0,"size":1440.0, "maxResolution":8.0,"colorDepth":8}},"mapCoordinate":{"x":108.84515,"y":68.62626,"z":0.0, "unit":"FEET"},"currentlyTracked":true,"confidenceFactor":72.0,"statistics": {"currentServerTime":"2016-06-16T02:20:42.974+0800","firstLocatedTime": "1970-01-01T07:30:00.000+0730","lastLocatedTime":"2016-06-16T02:20:39.336+0800", "maxDetectedRssi":{"apMacAddress":"64:f6:9d:2a:05:00","band":"IEEE_802_11_B","slot":0, "rssi":-58,"antennaIndex":0,"lastHeardInSeconds":1}},"historyLogReason":null, "geoCoordinate":{"latitude":1.3347778969996247,"longitude":103.96366325767761, "unit":"DEGREES"},"networkStatus":"ACTIVE","changedOn":1466014839336,"telemetryList":null, "batteryInfo":{"tolerance":70,"percentRemaining":100,"daysRemaining":0,"batteryAge":0, "lastReceivedTime":"2016-06-09T06:38:29.748+0800","lastReceivedSeqNum":2221}, "vendorData":{"vendorId":6286,"elementId":0,"data":"AAMAAQEABAABAQ==", "lastReceivedTime":"2016-06-09T06:38:29.748+0800","lastReceivedSeqNum":2221}, "sortedEmergencyList":null,"sortedChokepointList":null,"lastBeaconTime":null, "lastBeaconSequenceNumber":2221,"manufacturer":"Ekahau"}
この API は、通知ルールでサポートされているすべての通知タイプと該当する属性を返します。
GET
/api/location/v1/attributes
N
なし。
application/json
{"association":{"association":{"name":"association","dataType":"BOOLEAN", "nameSpace":"association","needValueCheck":true,"evaluateByProvider":false,"validValueSet" :[]},"deviceType":{"name":"deviceType","dataType":"ENUM","nameSpace":"association", "needValueCheck":false,"evaluateByProvider":false,"validValueSet":["client"]}}, "beaconmovement":{"distance":{"name":"distance","dataType":"FLOAT","nameSpace": "beaconmovement","needValueCheck":true,"evaluateByProvider":false,"validValueSet":[]}}, "absence":{"triggerAbsence":{"name":"triggerAbsence","dataType":"BOOLEAN","nameSpace": "absence","needValueCheck":false,"evaluateByProvider":false,"validValueSet":[]}, "deviceType":{"name":"deviceType","dataType":"ENUM","nameSpace":"absence","needValueCheck": false,"evaluateByProvider":false,"validValueSet":["client"]}},"locationupdate": {"deviceType":{"name":"deviceType","dataType":"ENUM","nameSpace":"locationupdate", "needValueCheck":true,"evaluateByProvider":false,"validValueSet":["client","tag", "interferer"]},"triggerLocationEvent":{"name":"triggerLocationEvent","dataType": "BOOLEAN","nameSpace":"locationupdate","needValueCheck":false,"evaluateByProvider":false, "validValueSet":[]},"hierarchy":{"name":"hierarchy","dataType":"STRING","nameSpace": "locationupdate","needValueCheck":true,"evaluateByProvider":true,"validValueSet":[]}}, "inout":{"in/out":{"name":"in/out","dataType":"ENUM","nameSpace":"inout","needValueCheck": false,"evaluateByProvider":false,"validValueSet":["no change","in","out"]},"absence":{"name": "absence","dataType":"BOOLEAN","nameSpace":"inout","needValueCheck":false,"evaluateByProvider": false,"validValueSet":[]},"deviceType":{"name":"deviceType","dataType":"ENUM","nameSpace": "inout","needValueCheck":true,"evaluateByProvider":false,"validValueSet":["client","tag", "interferer"]},"hierarchy":{"name":"hierarchy","dataType":"STRING","nameSpace":"inout", "needValueCheck":true,"evaluateByProvider":true,"validValueSet":[]}},"beaconabsence": {"absence":{"name":"absence","dataType":"BOOLEAN","nameSpace":"beaconabsence","needValueCheck": true,"evaluateByProvider":false,"validValueSet":[]}},"movement":{"distance":{"name": "distance","dataType":"FLOAT","nameSpace":"movement","needValueCheck":true, "evaluateByProvider":false,"validValueSet":[]},"deviceType":{"name":"deviceType","dataType": "ENUM","nameSpace":"movement","needValueCheck":true,"evaluateByProvider":false,"validValueSet" :["client","tag","interferer"]},"hierarchy":{"name":"hierarchy","dataType":"STRING", "nameSpace":"movement","needValueCheck":true,"evaluateByProvider":false,"validValueSet":[]}}, "any":{"macAddressList":{"name":"macAddressList","dataType":"LIST","nameSpace":"any", "needValueCheck":true,"evaluateByProvider":false,"validValueSet":[]},"macAddress": {"name":"macAddress","dataType":"STRING","nameSpace":"any","needValueCheck":true, "evaluateByProvider":false,"validValueSet":[]}},"areachange":{"buildingChange":{"name": "buildingChange","dataType":"BOOLEAN","nameSpace":"areachange","needValueCheck":true, "evaluateByProvider":false,"validValueSet":[]},"campusChange":{"name":"campusChange", "dataType":"BOOLEAN","nameSpace":"areachange","needValueCheck":true,"evaluateByProvider": false,"validValueSet":[]},"deviceType":{"name":"deviceType","dataType":"ENUM","nameSpace": "areachange","needValueCheck":true,"evaluateByProvider":false,"validValueSet":["client", "tag","interferer"]},"floorChange":{"name":"floorChange","dataType":"BOOLEAN","nameSpace": "areachange","needValueCheck":true,"evaluateByProvider":false,"validValueSet":[]}}}
この API は、ビーコンの合計数を返します。
GET
/api/location/v1/beacon/count
N
なし。
application/json
http://10.68.40.131/api/location/v1/beacon/count
28
この API はマップ上で、ビーコンを検出された場所に配置します。
PUT
/api/location/v1/beacon/replace/:macaddress
N
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
---|---|---|---|---|---|
macaddress |
Y |
— |
文字列 |
pathReplace |
ビーコンの MAC アドレス。 |
application/json
この API は、指定されたビーコンの名前を更新します。
PUT
/api/location/v1/beacon/name/:macaddress/:name
N
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
---|---|---|---|---|---|
macaddress |
Y |
— |
文字列 |
pathReplace |
ビーコンの MAC アドレス。 |
name |
Y |
— |
文字列 |
pathReplace |
名前として使用する新しい値。 |
application/json
この API は、指定されたフロアにある、フィルタ基準と一致するビーコンのリストを返します。filterString の形式は、mac={mac} name={name} uuid={uuid} major={major} minor={minor} です。例:api/location/v1/veacon/search/{floorrefid}/mac=11:22:33:44:55:66 name=abc
GET
/api/location/v1/beacon/search/:floorrefid/:filterString
N
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
---|---|---|---|---|---|
floorrefid |
Y |
— |
Number |
pathReplace |
フロアの参照 ID。 |
filterString |
Y |
— |
文字列 |
pathReplace |
filterString の値。 |
application/json
この API は、最小限のフィールドでビーコンをストアに追加します。クエリ文字列の例:/info/mac={mac}、name={name}、uuid={uuid}、major={major}、minor={minor}
POST
/api/location/v1/beacon/info/:queryString
N
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
---|---|---|---|---|---|
クエリ文字列 |
Y |
— |
文字列 |
pathReplace |
queryString の値。 |
application/json
この API は、特定のフロア ID に関連するビーコンと最小限の情報を返します。
GET
/api/location/v1/beacon/info/:floorrefid
N
名前 |
必須 |
デフォルト |
タイプ |
Location |
説明 |
---|---|---|---|---|---|
floorrefid |
Y |
— |
Number |
pathReplace |
フロアの参照 ID。 |
application/json
http://10.68.40.131/api/location/v1/beacon/info/739764660256899136
["MAC- c8:69:cd:54:2c:3a UUID-null MAJOR-null MINOR-null TYPE-Rogue STATUS-Active RSSI-null","MAC- e7:8e:65:42:7b:5e UUID-b9:40:7f:30:f5:f8:46:6e:af:f9:25:55:6b:57:fe:6d MAJOR-31582 MINOR-25922 TYPE-Rogue STATUS-Active RSSI--74","MAC- f8:25:1d:38:5f:df UUID-b9:40:7f:30:f5:f8:46:6e:af:f9:25:55:6b:57:fe:6d MAJOR-24543 MINOR-7480 TYPE-Rogue STATUS-Active RSSI--74","MAC- c8:69:cd:50:29:de UUID-null MAJOR-null MINOR-null TYPE-Rogue STATUS-Active RSSI-null"]
この API は、ビーコンのリストを返します。
GET
/api/location/v1/beacon
N
なし。
application/json
http://10.68.40.131/api/location/v1/beacon
[{"macAddress":"c8:69:cd:54:2c:3a","name":null,"type":"Rogue", "detectedOn":1465384031100,"status":"Active","lastUpdatedOn":1466015949748, "currentServerTime":1466016244167,"expectedHierarchyString":null,"actualHierarchyString": null,"uuid":null,"major":null,"minor":null,"manufacturerId":null,"rssi":null,"mapInfo": {"mapHierarchyString":"Singapore>SINGAPORE UE BIZHUB EAST (SNG11)>SNG11-5Fl>IOT Demo, SingZone","floorRefId":"739764660256899136"},"mapCoordinate":{"x":79.47438,"y":60.84791, "z":0.0,"unit":"FEET"},"detectedLocation":null,"configuredLocation":null,"lastUpdatedTime": 1466015949748},{"macAddress":"e7:8e:65:42:7b:5e","name":null,"type":"Rogue","detectedOn": 1466007673699,"status":"Active","lastUpdatedOn":0,"currentServerTime":1466016244167, "expectedHierarchyString":null,"actualHierarchyString":null,"uuid": "b9:40:7f:30:f5:f8:46:6e:af:f9:25:55:6b:57:fe:6d","major":"31582","minor":"25922", "manufacturerId":"4c00","rssi":"-74","mapInfo":{"mapHierarchyString":"Singapore> SINGAPORE UE BIZHUB EAST (SNG11)>SNG11-5Fl>SingZone","floorRefId":"739764660256899136"}, "mapCoordinate":{"x":110.90741,"y":62.45491,"z":0.0,"unit":"FEET"},"detectedLocation": null,"configuredLocation":null,"lastUpdatedTime":0},
………
{"mapHierarchyString":"Bangalore_Cessna>Building 11>Customer Experience Center", "floorRefId":"739764720386534870"},"mapCoordinate":{"x":91.889755,"y":161.0643,"z":0.0, "unit":"FEET"},"detectedLocation":null,"configuredLocation":null,"lastUpdatedTime":0}, {"macAddress":"34:c0:59:36:71:1d","name":null,"type":"Rogue","detectedOn":1466015514702, "status":"Active","lastUpdatedOn":0,"currentServerTime":1466016244167, "expectedHierarchyString":null,"actualHierarchyString":null,"uuid":null,"major":null, "minor":null,"manufacturerId":null,"rssi":null,"mapInfo":{"mapHierarchyString": "Bangalore_Cessna>Building 11>Customer Experience Center","floorRefId": "739764720386534870"},"mapCoordinate":{"x":91.889755,"y":161.0643,"z":0.0,"unit":"FEET"}, "detectedLocation":null,"configuredLocation":null,"lastUpdatedTime":0}]
この API は、MAC アドレスを基準にビーコンを返します。
GET
/api/location/v1/beacon/:macaddress
N
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
---|---|---|---|---|---|
macaddress |
Y |
— |
文字列 |
pathReplace |
ビーコンの MAC アドレス。 |
application/json
http://10.68.40.131/api/location/v1/beacon/c8:69:cd:54:2c:3a
{"macAddress":"c8:69:cd:54:2c:3a","name":null,"type":"Rogue", "detectedOn":1465384031100,"status":"Active","lastUpdatedOn":1466015949748, "currentServerTime":1466016328698,"expectedHierarchyString":null,"actualHierarchyString": null,"uuid":null,"major":null,"minor":null,"manufacturerId":null,"rssi":null,"mapInfo": {"mapHierarchyString":"Singapore>SINGAPORE UE BIZHUB EAST (SNG11)>SNG11-5Fl>SingZone", "floorRefId":"739764660256899136"},"mapCoordinate":{"x":76.43114,"y":58.149662,"z":0.0, "unit":"FEET"},"detectedLocation":null,"configuredLocation":null,"lastUpdatedTime": 1466015949748}
この API は、MAC アドレスを基準にビーコンを削除します。
DELETE
/api/location/v1/beacon/:macaddress
N
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
---|---|---|---|---|---|
macaddress |
Y |
— |
文字列 |
pathReplace |
削除するビーコンの MAC アドレス。 |
application/json
この API は、指定されたビーコンを更新します。
PUT
/api/location/v1/beacon
N
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
---|---|---|---|---|---|
macAddress |
Y |
— |
string |
body |
MAC アドレス。 |
name |
Y |
— |
string |
body |
名前 |
type |
N |
— |
列挙型 |
body |
|
detectedOn |
N |
— |
number |
body |
detectedOn |
status |
N |
— |
列挙型 |
body |
|
lastUpdatedOn |
N |
— |
number |
body |
最終更新日。 |
expectedHierarchyString |
N |
— |
string |
body |
予想される階層文字列。 |
actualHierarchyString |
N |
— |
string |
body |
実際の階層文字列。 |
uuid |
Y |
— |
string |
body |
UUID |
major |
Y |
— |
string |
body |
メジャー。 |
minor |
Y |
— |
string |
body |
マイナー。 |
manufacturerId |
N |
— |
string |
body |
製造者 ID。 |
rssi |
N |
— |
string |
body |
RSSI 値。 |
mapInfo |
N |
— |
text |
body |
マップの情報。 |
mapCoordinate |
N |
— |
text |
body |
マップの座標。 |
detectedLocation |
N |
— |
text |
body |
検出された場所。 |
configuredLocation |
N |
— |
text |
body |
設定された場所。 |
application/json
この API は、指定されたフロアにあるビーコンのリストを返します。
GET
/api/location/v1/beacon/floor/:floorrefid
N
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
---|---|---|---|---|---|
floorrefid |
Y |
— |
Number |
pathReplace |
フロアの参照 ID。 |
application/json
[{"macAddress":"c8:69:cd:54:2c:3a","name":null,"type":"Rogue","detectedOn": 1465384031100,"status":"Active","lastUpdatedOn":1466015949748,"currentServerTime": 1466016486617,"expectedHierarchyString":null,"actualHierarchyString":null,"uuid":null, "major":null,"minor":null,"manufacturerId":null,"rssi":null,"mapInfo": {"mapHierarchyString":"Singapore>SINGAPORE UE BIZHUB EAST (SNG11)>SNG11-5Fl>SingZone", "floorRefId":"739764660256899136"},"mapCoordinate":{"x":76.43114,"y":58.149662,"z":0.0, "unit":"FEET"},"detectedLocation":null,"configuredLocation":null,"lastUpdatedTime": 1466015949748},{"macAddress":"e7:8e:65:42:7b:5e","name":null,"type":"Rogue","detectedOn": 1466007673699,"status":"Active","lastUpdatedOn":0,"currentServerTime":1466016486617, "expectedHierarchyString":null,"actualHierarchyString":null,"uuid": "b9:40:7f:30:f5:f8:46:6e:af:f9:25:55:6b:57:fe:6d","major":"31582","minor":"25922", "manufacturerId":"4c00","rssi":"-74","mapInfo":{"mapHierarchyString": "Singapore>SINGAPORE UE BIZHUB EAST (SNG11)>SNG11-5Fl>SingZone","floorRefId": "739764660256899136"},"mapCoordinate":{"x":110.90741,"y":62.45491,"z":0.0,"unit":"FEET"}, "detectedLocation":null,"configuredLocation":null,"lastUpdatedTime":0}, {"macAddress":"f8:25:1d:38:5f:df","name":null,"type":"Rogue","detectedOn":1465803834008, "status":"Active","lastUpdatedOn":1466012481898,"currentServerTime":1466016486617, "expectedHierarchyString":null,"actualHierarchyString":null,"uuid": "b9:40:7f:30:f5:f8:46:6e:af:f9:25:55:6b:57:fe:6d","major":"24543","minor":"7480", "manufacturerId":"4c00","rssi":"-74","mapInfo":{"mapHierarchyString": "Singapore>SINGAPORE UE BIZHUB EAST (SNG11)>SNG11-5Fl>SingZone","floorRefId": "739764660256899136"},"mapCoordinate":{"x":106.88582,"y":70.93849,"z":0.0,"unit":"FEET"}, "detectedLocation":null,"configuredLocation":null,"lastUpdatedTime":1466012481898}, {"macAddress":"c8:69:cd:50:29:de","name":null,"type":"Rogue","detectedOn":1465860354185, "status":"Active","lastUpdatedOn":1466010229973,"currentServerTime":1466016486617, "expectedHierarchyString":null,"actualHierarchyString":null,"uuid":null,"major":null, "minor":null,"manufacturerId":null,"rssi":null,"mapInfo":{"mapHierarchyString": "Singapore>SINGAPORE UE BIZHUB EAST (SNG11)>SNG11-5Fl>MainDemo Theater,SingZone", "floorRefId":"739764660256899136"},"mapCoordinate":{"x":83.58248,"y":96.976616,"z":0.0, "unit":"FEET"},"detectedLocation":null,"configuredLocation":null, "lastUpdatedTime":1466010229973}]
この API は、ビーコンをストアに追加します。
POST
/api/location/v1/beacon
N
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
---|---|---|---|---|---|
macAddress |
Y |
— |
文字列 |
body |
MAC アドレス。 |
name |
Y |
— |
文字列 |
body |
|
type |
N |
— |
列挙型 |
body |
|
detectedOn |
N |
— |
number |
body |
検出日。 |
status |
N |
— |
列挙型 |
body |
|
lastUpdatedOn |
N |
— |
number |
body |
最終更新日。 |
expectedHierarchyString |
N |
— |
string |
body |
予想される階層文字列。 |
actualHierarchyString |
N |
— |
string |
body |
実際の階層文字列。 |
uuid |
Y |
— |
string |
body |
UUID |
major |
Y |
— |
string |
body |
Major |
minor |
Y |
— |
string |
body |
Minor |
manufacturerId |
N |
— |
string |
body |
Manufacturer ID |
rssi |
N |
— |
string |
body |
RSSI 値。 |
mapInfo |
N |
— |
text |
body |
マップの情報。 |
mapCoordinate |
N |
— |
text |
body |
マップの座標。 |
detectedLocation |
N |
— |
text |
body |
検出された場所。 |
configuredLocation |
N |
— |
text |
body |
設定された場所。 |
application/json
この API は、アクティブなクライアントの数を返します。
GET
/api/location/v2/clients/count
N
なし。
{"deviceType":"Wireless_Client","deviceQueryString":null,"count":118}
この API は、IPv4/IPv6、MAC アドレス、およびユーザ名を基準とした検索をサポートします。IPv4/IPv6 で検索する例:api/location/v2/clients?ipAddress=x.x.x.xMAC アドレスで検索する例:api/location/v2/clients?macAddress=x:x:x:xユーザ名で検索する例:api/location/v2/clients?username=someUsernameこの API は、ページとページ サイズに基づくページネーションもサポートしています。ページネーション:api/location/v2/clients?include=metadata and page=x and pageSize=xデータが存在する限り、page と pageSize の値を順に増やしてページネーションを続けることができます。並べ替え:/api/location/v2/clients?sortBy=macAddress:ASC /api/location/v2/clients?sortBy=macAddress:DESCsortBy パラメータでサポートされている値は、「lastLocatedTime」、「userName」、「macAddress」、「ssId」、「dot11Status」です。
GET
/api/location/v2/clients
N
なし。
application/json
http://10.68.40.131/api/location/v2/clients
[{"macAddress":"fc:e9:98:2a:8e:2a","mapInfo":{"mapHierarchyString":"Beijing>BEIJING - YINTAI TOWER (BJN6)>BJN6-7Fl>Jing Shan","floorRefId":"739764660256899130","floorDimension":{"length":145.0,"width":145.0,"height":10.0,"offsetX":0.0,"offsetY":0.0,"unit":"FEET"},"image":{"imageName":"domain_0_1381803717769.jpg","zoomLevel":4,"width":553.0,"height":553.0,"size":553.0,"maxResolution":4.0,"colorDepth":8}},"mapCoordinate":{"x":15.227272,"y":51.00305,"z":0.0,"unit":"FEET"},"currentlyTracked":true,"confidenceFactor":40.0,"statistics":{"currentServerTime":"2016-06-16T02:50:12.085+0800","firstLocatedTime":"2016-06-08T19:07:41.983+0800","lastLocatedTime":"2016-06-16T02:49:25.334+0800","maxDetectedRssi":{"apMacAddress":"64:f6:9d:d3:9b:50","band":"IEEE_802_11_B","slot":0,"rssi":-54,"antennaIndex":0,"lastHeardInSeconds":5}},"historyLogReason":null,"geoCoordinate":null,"networkStatus":"ACTIVE","changedOn":1466016565334,"ipAddress":["10.75.208.106"],"userName":"","ssId":"EXP-CTR","sourceTimestamp":null,"band":"IEEE_802_11_B","apMacAddress":"64:f6:9d:d3:9b:50","dot11Status":"ASSOCIATED","manufacturer":"Apple","areaGlobalIdList":[802,3,2,1,803,804,777,789],"detectingControllers":"10.75.51.125","bytesSent":207547136,"bytesReceived":206672473,"guestUser":false},
l,"networkStatus":"ACTIVE","changedOn":1466016587192,"ipAddress":null,"userName":"","ssId":"","sourceTimestamp":null,"band":"UNKNOWN","apMacAddress":"","dot11Status":"UNKNOWN","manufacturer":"Logitec","areaGlobalIdList":[752,3,2,1,753,754,742,745],"detectingControllers":"10.71.162.9","bytesSent":0,"bytesReceived":0,"guestUser":false}]
この API は、アクティブなクライアントの MAC アドレス コレクションを返します。
GET
/api/location/v2/clients/active
N
なし。
application/json
["c0:8a:de:bd:e5:3a","5c:59:48:59:29:21","40:88:05:b2:6c:ec", "c0:8a:de:3d:e5:30","98:d6:bb:03:58:d5","e8:4e:84:8b:9f:90","48:45:20:0c:73:58", "f0:25:b7:36:db:83","c8:69:cd:50:29:dd","78:da:6e:f6:3f:ff","80:ed:2c:44:e5:ca", "08:3d:88:a7:67:6f","d0:4f:7e:34:b1:f2","3c:15:c2:c7:05:c6","ec:35:86:ce:15:94", "d8:50:e6:2e:ed:39","fc:e9:98:19:87:6f","40:a6:d9:77:2a:77","60:fe:c5:dc:57:5d", "cc:44:63:b7:c9:06","bc:14:85:ac:ba:30","a8:86:dd:ac:1b:f7","a4:34:d9:f8:0f:cf", "30:10:e4:c2:9f:04","64:00:f1:79:55:c5","64
.....
"00:23:33:41:5f:80","90:a4:de:29:0d:1d","b4:ce:f6:09:2b:e3"]
この API は、日付とユーザ名を基準に、クライアントの簡略履歴を返します。
GET
/api/location/v1/historylite/byusername/:username
N
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
---|---|---|---|---|---|
date |
Y |
— |
文字列 |
query |
日付(yyyy/mm/dd 形式)。 |
username |
Y |
— |
文字列 |
pathReplace |
ユーザ名。 |
application/json
http://10.68.40.131/api/location/v1/historylite/byusername/rykikuch
{"Data":[{"x":0.0,"y":90.67049,"flr":"739764660256899128", "chgOn":"1466016775067","s":"1","ssid":"TKY-ECN","ap":"10:05:ca:15:61:70","un": "rykikuch","ip":"10.71.160.35, fe80:0000:0000:0000:7a4b:87ff:fe5b:ebe9","lat":-999.0, "long":-999.0},{"x":0.0,"y":60.44699,"flr":"739764660256899128","chgOn":"1466016753280", "s":"1","ssid":"TKY-ECN","ap":"10:05:ca:15:61:70","un":"rykikuch","ip":"10.71.160.35, fe80:0000:0000:0000:7a4b:87ff:fe5b:ebe9","lat":-999.0,"long":-999.0},{"x":3.3062298,"y": 100.85927,"flr":"739764660256899128","chgOn":"1466016729336","s":"1","ssid":"TKY-ECN", "ap":"10:05:ca:15:61:70","un":"rykikuch","ip":"10.71.160.35, fe80:0000:0000:0000:7a4b:87ff:fe5b:ebe9","lat":-999.0,"long":-999.0}, {"x":2.4152029,"y":94.40629,"flr":"739764660256899128","chgOn":"1466016727243","s": "1","ssid":"TKY-ECN","ap":"10:05:ca:15:61:70","un":"rykikuch","ip":"10.71.160.35, fe80:0000:0000:0000:7a4b:87ff:fe5b:ebe9","lat":-999.0,"long":-999.0}, {"x":0.0,"y":83.11462,"flr":"739764660256899128","chgOn":"1466016705764","s":"1", "ssid":"TKY-ECN","ap":"10:05:ca:15:61:70","un":"rykikuch","ip":"10.71.160.35, fe80:0000:0000:0000:7a4b:87ff:fe5b:ebe9","lat":-999.0,"long":-999.0},
-…..
ECN","ap":"10:05:ca:15:61:70","un":"rykikuch","ip":"10.71.160.35, fe80:0000:0000:0000:7a4b:87ff:fe5b:ebe9","lat":-999.0,"long":-999.0},{"x":0.0,"y":68.00287,"flr":"739764660256899128","chgOn":"1466006412975","s":"1","ssid":"TKY-ECN","ap":"10:05:ca:15:61:70","un":"rykikuch","ip":"10.71.160.35, fe80:0000:0000:0000:7a4b:87ff:fe5b:ebe9","lat":-999.0,"long":-999.0}],"Count":210,"Date":"2016/06/16","Username":"rykikuch","Macaddress":"78:4b:87:5b:eb:e9"}
この API は、特定のフロアまたはゾーンで指定された日に観測された、ユニーク MAC アドレスを返します。必要なパラメータは日付と階層です。階層はフロア レベルまたはゾーン レベルまで指定できます。たとえば、フロア レベルを指定する場合は、キャンパス名、ビル名、フロア名を含めます。ゾーン レベルを指定する場合は、キャンパス名、ビル名、フロア名、ゾーン名を含めます。フロア ID またはゾーン ID が既知であれば、hierarchy パラメータを省略して、date および floorid パラメータ、または date および zoneid パラメータを指定できます。
date パラメータが指定されていないと、API がデフォルトとして現在の日付を使用します。hierarchy パラメータまたは floorid/zoneid パラメータのいずれかを指定することは必須です。この API は、時間および距離によるフィルタ条件もサポートしています。時間を基準にフィルタリングする場合は、fromHour パラメータと toHour パラメータを使用します(どちらも 24 時間形式です)。フィルタ条件に距離を使用するクエリでは、時間もフィルタ条件として指定する必要があります。関連データをフィルタで除外する場合、サポートされる toHour/fromHour の差は 1 時間です。
以下に例を示します。
階層を指定する場合:/api/location/v1/history/uniqueclientsbyhierarchy?hierarchy=System%20Campus/Floor-19/1st%20Floorフロア ID を指定する場合:/api/location/v1/history/uniqueclientsbyhierarchy?floorid=730297895206534073
ゾーン ID と日付を指定する場合:/api/location/v1/history/uniqueclientsbyhierarchy?zoneid=23 and date=2016/02/29階層を指定して時間を基準にフィルタリングする場合:/api/location/v1/history/uniqueclientsbyhierarchy?hierarchy=System%20Campus/BGLD-19/1st%20Floor and fromHour=13 and toHour=14
階層を指定して時間と距離を基準にフィルタリングする場合:/api/location/v1/history/uniqueclientsbyhierarchy?hierarchy=System%20Campus/BGLD-19/1st%20Floor and fromHour=13 and toHour=14 and x=30 and y=50 and distance=10
GET
/api/location/v1/history/uniqueclientsbyhierarchy
N
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
---|---|---|---|---|---|
階層 |
Y |
— |
文字列 |
query |
階層(キャンパス名/ビル名/フロア名の形式)。 |
date |
N |
— |
文字列 |
query |
日付(yyyy/mm/dd 形式)。 |
floorid |
N |
— |
文字列 |
query |
フロア ID。 |
zoneid |
N |
— |
文字列 |
query |
ゾーン ID。 |
fromHour |
N |
— |
文字列 |
query |
開始時刻(24 時間形式の HH)。 |
toHour |
N |
— |
文字列 |
query |
終了時刻(24 時間形式の HH)。 |
x |
N |
— |
文字列 |
query |
○ |
y |
N |
— |
文字列 |
query |
y |
distance |
N |
— |
文字列 |
query |
距離(フィート) |
application/json
この API は、日付と IPv4 アドレスを基準に、クライアントの簡略履歴を返します。
GET
/api/location/v1/historylite/byipaddress/:ipv4address
N
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
---|---|---|---|---|---|
date |
Y |
— |
文字列 |
query |
日付(yyyy/mm/dd 形式)。 |
ipv4address |
Y |
— |
文字列 |
pathReplace |
IPv4 アドレス。 |
application/json
http://10.68.40.131/api/location/v1/historylite/byipaddress/10.68.41.186
{"Data":[{"x":77.017044,"y":63.450798,"flr":"739764660256899136","chgOn": "1466017126384","s":"1","ssid":"EXP-CTR","ap":"64:f6:9d:36:6b:e0","un":"","ip": "10.68.41.186","lat":1.3348362417605646,"long":103.963600110401},{"x":73.746574,"y": 59.760944,"flr":"739764660256899136","chgOn":"1466017117786","s":"1","ssid":"EXP-CTR", "ap":"64:f6:9d:36:6b:e0","un":"","ip":"10.68.41.186","lat":1.3348490318868647,"long": 103.96359856354766},{"x":68.30552,"y":59.5387,"flr":"739764660256899136","chgOn": "1466017113711","s":"1","ssid":"EXP-CTR","ap":"64:f6:9d:36:6b:e0","un":"","ip": "10.68.41.186","lat":1.3348575805268508,"long":103.96358673173596},{"x":65.13171, "y":51.720306,"flr":"739764660256899136","chgOn":"1466017109515","s":"1","ssid": "EXP-CTR","ap":"64:f6:9d:36:6b:e0","un":"","ip":"10.68.41.186","lat":1.334879110375031, "long":103.96359186167277},{"x":73.50822,"y":60.077927,"flr":"739764660256899136","chgOn": "1466017105458","s":"1","ssid":"EXP-CTR","ap":"64:f6:9d:36:6b:e0","un":"","ip": "10.68.41.186","lat":1.3348487034026406,"long":103.96359753397321},
….
CTR","ap":"64:f6:9d:36:6b:e0","un":"","ip":"10.68.41.186", "lat":1.3348446311431865,"long":103.96357759122772},{"x":68.51861,"y":59.40737, "flr":"739764660256899136","chgOn":"1466006400371","s":"1","ssid":"EXP-CTR","ap": "64:f6:9d:36:6b:e0","un":"","ip":"10.68.41.186","lat":1.3348575470327593,"long": 103.96358741423289}],"Count":748,"Ipv4address":"10.68.41.186","Date":"2016/06/16", "Macaddress":"00:19:70:03:22:e3"}
この API は、すべてのクライアントの履歴を返します。ページネーションはサポートされていませんが、locatedAfterTime パラメータと locatedBeforeTime パラメータの値(ミリ秒)を指定することで、データを小さいかたまりで抽出できます。
この API で、たとえば現在の日付の午前 0 時から現在時刻までの日付範囲を指定する場合は、/api/location/v1/history/clients を使用します。渡した日付 + fromHour から渡した日付 + toHour までの日付範囲を指定する場合は、/api/location/v1/history/clients?date=2016/03/02 and fromHour=14 and toHour=15 を使用します。YYYY/MM/DD HH:MM:SS 2016/03/01 21:00:00 に相当する locatedAfterTime パラメータ(1456894800000 ミリ秒)から YYYY/MM/DD HH:MM:SS 2016/03/01 21:30:00 に相当する locatedBeforeTime パラメータ(1456896600000 ミリ秒)までの日付範囲を使用する場合は、/api/location/v1/history/clients?locatedAfterTime=1456894800000 and locatedBeforeTime=1456896600000 と指定します。
CSCuz69078 では、API で指定された locatedAfterTime と locatedBeforeTime の範囲が 1 日を超えている場合、および 1 時間未満の場合、API は以下のエラーを返します。
ERROR - Cassandra timeout during read query at consistency ONE (1 responses were required but only 0 replica responded)
たとえば、https://<ip-address</api/location/v1/history/clients?locatedAfterTime=1459468800000&locatedBeforeTime=1459636800000 とすると、エラーが返されます。
GET
/api/location/v1/history/clients
N
なし。
application/json
この API は、クライアントの MAC アドレスを基準に、クライアントの履歴を返します。
GET
/api/location/v1/history/clients/:macaddress
N
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
---|---|---|---|---|---|
macaddress |
Y |
— |
文字列 |
pathReplace |
クライアント MAC アドレス。 |
date |
Y |
— |
文字列 |
query |
日付(yyyy/mm/dd 形式)。 |
application/json