开发者平台

TP-LINK官网首页
开发者平台 / 视频管理系统(VMS)/ API功能接口定义 / 直播管理

4.10.3 查询客流统计进出人数列表

接口说明:

名称 内容
URL https://xxx/tums/passengerFlow/v1/queryFlow
功能说明 获取客流数据
使用限制

请求参数:

参数名称 参数描述
start
long
要获取的起始条目
限制:必选参数
limit
int
要获取的条目总数
限制:必选参数,[1, 1000]
filterAnd
Map
获取的数据要同时匹配filterAnd中的数据
可以与filterOr一起使用,表示满足filterAnd中的所有条件同时满足one of其中之一条件
限制:
1.必选参数;
2.包含一组key/value,key必须是如下的参数之一,必须包括必选参数:
名称 内容
queryCategory
String
查询分类
限制:必选参数,{“region”, “device”, “all”}
regionAccumulate
int
是否区域累计
限制:仅queryCategory为region的时候有效。0不累计,1累计
raccuracy
String
查询精度
限制:必选参数,{“hour”,”day”,”week”,”month”,”year”}
timeList
List<String,String>
起始时间和结束时间二维数组,支持多个查询。
忽略精度等级以下的时间等级。例如,查询时间“2016年8月25日12时25分48秒”,以hour精度时,忽略“25分48秒”;以day精度时,忽略“12时25分48秒”;以month精度时,忽略“25日12时25分48秒
projectId
String
项目ID
限制:必选参数,数值型字符串,[0, +∞)
needExport
int
是否需要导出查询(当前仅导出报表的需要)
限制:必选参数
0 :不导出 1:导出
queryCateGory为device,region允许导出,all时不允许
仅当”queryCategory”为”regjion”时有效
regionIdList
List<int>
区域ID列表
限制:必选参数
仅当” queryCategory”为”device”时有效
deviceIdList
List<String>
设备ID列表
限制:必选参数, [1, +∞)
仅当”deviceCatagory”为”all”时有效
regionIdList
List<int>
区域ID列表
限制:必选参数
deviceIdList
List<String>
设备ID列表
限制:必选参数, [1, +∞)
sort
List
表示返回数据的排序方式,数组第一个元素是第一优先级,依次降低
限制:
1.可选参数;
2.包含一组key/value,key必须是如下的参数之一:
名称 内容
inFlow 进入的人数
outFlow 出去的人数
仅当”filterAnd”->”queryCategory”为”region”时有效
regionId 区域ID
仅当”filterAnd”->”queryCategory”为”device”时有效
deviceId 设备ID
3.value为asc/desc,分别表升序和降序

返回参数:

参数名称 参数描述
error_code 返回码,0 – 成功,其他- 失败,具体请参考返回码章节
result total
int
满足查询条件的个数
lastUpdateTime
long
上次更新时间
key
String
唯一生成的查询ID,仅导出文件用
list
List<vo>
设备信息列表,具体字段有:
名称 内容
通用信息,不区分”filterAnd”->”quertCategory”
projectId
String
项目ID
accuracy
String
时间精度
startTime
String
查询起始时间
endTime
String
查询结束时间
inFlow 进入的人数
outflow 出去的人数
仅当”filterAnd”->”queryCateGory”为”region”时返回
regionId
int
区域ID
regionName
String
区域名称
仅当”filterAnd”->”queryCateGory”为”device”时返回
deviceId
String
设备ID
deviceName
String
设备名称
relatedRegionId
int
所属区域ID
relatedRegionName
String
所属区域名称
当”filterAnd”->” queryCateGory”为”all”时返回以上两种列表
当” regionAccumulate”->为1时,没有name也没有ID

代码示例

        https://xxx/tums/passengerFlow/v1/queryFlow
        request:
        {
        "start": 1,
        "limit": 20,
        "filterAnd": {
        "queryCatagory": "region",
        "needExport": "1",
        "projectId": "5",
        "accuracy": "hour",
        "timeList": [
        {"startTime": "1470412800",”endTime”:” 1470416400”},
        {"startTime": "1470416400",”endTime”:” 1470420000”}
        
            ]
        
        ”regionIdList“:[1,3]
        },
        "sort": [
        {"inFlow": "asc"}
            ]
        }
        response:
        {
        "result": {
        "total": 4,
        "key": ”XmjfsdaljjLjfjgJ“,
        "lastUpdateTime": ” 1470412800 “,
        "list": [
        {
        "regionId": "1",
        "regjionName": "默认区域",
        " projectId ": 5, 
        " accuracy ": "hour",
        "deviceModel": "TL-IPC42EW-4",
        " startTime ": "1470412800",
        " endTIme ": "1470416400",
        " inFlow ": 100,
        "outFlow": 20,
        "errorCode": 0
        
        },
        {
        "regionId": "1",
        "regjionName": "默认区域",
        " projectId ": 5, 
        " accuracy ": "hour",
        "deviceModel": "TL-IPC42EW-4",
        " startTime ": "1470416400",
        " endTIme ": "1470420000",
        " inFlow ": 90,
        "outFlow": 20,
        "errorCode": 0
        
        },
        {
        "regionId": "3",
        "regjionName": "默认区域2",
        " projectId ": 5, 
        " accuracy ": "hour",
        "deviceModel": "TL-IPC42EW-4",
        " startTime ": "1470416400",
        " endTIme ": "1470420000",
        " inFlow ": 80,
        "outFlow": 20,
        "errorCode": 0
        
        },
        {
        "regionId": "1",
        "regjionName": "默认区域",
        " projectId ": 5, 
        " accuracy ": "hour",
        "deviceModel": "TL-IPC42EW-4",
        " startTime ": "1470412800",
        " endTIme ": "1470416400",
        " inFlow ": 50,
        "outFlow": 20,
        "errorCode": 0
        
        }
        },
        ]
        },
        "error_code": 0
        }