open.passengerflow.getDeviceHotspotZone （获取设备热点区域）
获取设备热点区域
接口描述#
| 环境 | 接口方法 | 提交方式 | 是否需要签名 | HTTP请求路由 |
|---|---|---|---|---|
| 正式环境 | open.passengerflow.getDeviceHotspotZone | POST | true | http://cloudapi.ovopark.com/cloud.api |
公共请求参数#
| 参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|---|
| _aid | String | 是 | 20 | 开放平台系统编号，固定为S107 | S107 |
| _akey | String | 是 | 20 | 万店掌开放平台分配给第三方的开发者key | 认证平台开发者后获取 |
| _mt | String | 是 | 100 | 接口名称 | open.passengerflow.getDeviceHotspotZone |
| _sm | String | 是 | 100 | 签名算法 md5,sha1 | md5 |
| _requestMode | String | 是 | 100 | 请求方式post,get | POST |
| _version | String | 是 | 100 | 版本号 | v1 |
| _timestamp | String | 是 | 100 | 时间戳 | yyyyMMddHHmmss格式 |
| _sig | String | 是 | 32 | 签名token | 根据签名算法生成，详情见签名算法规则 |
| _format | String | 否 | 10 | format类型 | 目前默认仅支持json |
业务请求参数#
| 参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|---|
| orgid | int | √ | 11 | 企业id | 1 |
| mintime | int | √ | 11 | 时间阈值，超过多少秒属于驻足(取值范围 5， 15， 30， 60) | 15 |
| compareType | int | √ | 11 | 同环比，0：不获取，1：上周数据 2：上月数据 | 0 |
| deviceMac | string | √ | 100 | 设备mac | b827eb5cb67a |
| starttime | string | √ | 100 | 开始时间(格式：yyyy-MM-dd HH:mm:ss) | 2018-05-01 13:00:00 |
| endtime | string | √ | 100 | 结束时间(格式：yyyy-MM-dd HH:mm:ss) | 2018-05-24 14:00:00 |
公共响应参数#
| 参数 | 类型 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|
| stat | JSON | - | 网关状态(具体参数描述如下：) | 查看 |
| stat.cid | String | 100 | http请求的标识符 | |
| stat.code | String | 100 | 网关返回码 | |
| stat.codename | String | 100 | 网关返回码名称 | |
| stat.systime | String | Long | 接口调用的当前时间 | |
| result | String | 100 | 接口返回提示信息 | |
| data | JSON | - | 接口调用返回的业务信息(一般是json格式数据，具体数据格式会在业务返回参数中定义) | 查看 |
业务返回参数#
| 参数名称 | 类型 | 是否一定返回 | 返回最大长度 | 描述 | 示例值 |
|---|---|---|---|---|---|
| upto5Count | int | × | 11 | 超过5秒的人数 | 504 |
| upto5Time | int | × | 11 | 超过5秒的时间 | 8531 |
| upto15Count | int | × | 11 | 超过15秒的人数 | |
| upto15Time | int | × | 11 | 超过15秒的时间 | |
| upto30Count | int | × | 11 | 超过30秒的人数 | |
| upto30Time | int | × | 11 | 超过30秒的时间 | |
| upto60Count | int | × | 11 | 超过60秒的人数 | |
| upto60Time | int | × | 11 | 超过60秒的时间 | |
| totalCount | int | × | 11 | 合计人数 | |
| totalTime | int | × | 11 | 合计时间 | |
| remain | int | × | 11 | 客流人次 | 4266 |
| deviceProductAreaId | int | × | 11 | 商品区域id | 655 |
| productName | string | × | 100 | 商品区域名称 | A区 |
| points | string | × | 100 | 区域范围坐标（所有区域都是四边形矩形，总区域大小320*240） | [[15,24],[16,119],[189,115],[189,16]] |
| remainAvg | float | × | 20 | 平均停留时长（超过阈值的所有人的平均停留时长，单位秒） | 25.19 |
| validRemain | int | × | 11 | 驻足人次 | 81 |
| compareRemain | int | × | 11 | 对比停留人数 | 0 |
| compareValidRemain | int | × | 11 | 对比有效停留人数 | 0 |
| compareRemainAvg | float | × | 20 | 对比平均停留时间 | 0 |
| areaId | int | × | 11 | 区域id | 1295 |
公共返回码#
| 返回码名称 | 返回码 | 返回码描述 | 解决方案 |
|---|---|---|---|
| SUCCESS | 0 | 调用成功 | |
| KEY_NOTNULL | 1 | _akey和不能为空 | 接口调用时传入_akey参数 |
| KEY_UNLAWFUL | 2 | _akey不合法 | key是非法的,传入正确的key |
| KEY_HAS_EXPIRED | 3 | _akey已过期 | 请续订服务或联系平台管理人员 |
| SIGN_METHOD_NOTNULL | 4 | _sm参数不能为空 | 接口调用时传入_sm参数 |
| SIGN_TYPE_NOTEXIST | 5 | _sm类型不存在 | 目前仅支持md5,sha1 |
| SIGN_NOTNULL | 6 | _sig参数不能为空 | 接口调用时传入_sig参数 |
| SIGN_WRONG | 7 | 无效的签名，请检查参数和签名格式 | _sig值根据签名算法生成 |
| METHOD_NOTNULL | 8 | _mt参数不能为空 | 接口调用时传入_mt参数 |
| METHOD_NOTEXIST_CODE | 9 | _mt对应的方法名不存在或未注册进服务 | 检查_mt方法名和_version版本号对应的方法是否传入错误 |
| REQUESTMODE_NOTNULL | 10 | _requestMode参数不能为空 | 接口调用时传入_requestMode参数 |
| APPLICATIONID_NOTNULL | 11 | _aid参数不能为空 | 接口调用时传入_aid参数 |
| APPLICATIONID_NOTSAME | 12 | _aid与当前key不匹配 | _aid与_akey必须一一对应 |
| VERSION_NOTNULL | 13 | _version版本号不能为空 | 接口调用时传入_version参数 |
| TIMESTAMP_NOTNULL | 14 | _timestamp时间戳不能为空 | 接口调用时传入_timestamp参数 |
| TIMESTAMP_FORMAT_ERROR | 15 | _timestamp时间戳格式化错误 | 按照yyyyMMddHHmmss格式 |
| TIMESTAMP_OVERTIME | 16 | _timestamp已失效 | _timestamp每次接口调用时重新生成 |
| FORMAT_TYPE_NOTEXIST | 17 | _format类型不存在 | 目前仅支持json(默认),xml |
| API_CALL_REPEAT | -100 | 接口重复调用 | 接口平台调用异常 |
| API_SYSTEM_CALL_ERROR | -500 | api调用失败，系统发生异常 | 接口平台调用异常 |
| UNKNOWN_ERROR | -999 | 开放平台系统异常 | 重新发起请求 |
业务返回码#
| 返回码名称 | 返回码 | 返回码描述 |
|---|---|---|
| DATA_NOT_NULL | 101002 | 必填字段不能为空 |
| API_SYSTEM_ERROR | 101999 | api服务未知异常 |