万店掌 开放平台 获取门店热点设备列表
{ "idx": null }

open.passengerflow.getAllHotspotShops （获取门店热点设备列表）

获取门店热点设备列表

接口描述 #

环境 接口方法 提交方式 是否需要签名 HTTP请求路由
正式环境 open.passengerflow.getAllHotspotShops POST true http://cloudapi.ovopark.com/cloud.api

公共请求参数 #

参数 类型 是否必填 最大长度 描述 示例值
_aid String 是 20 开放平台系统编号，固定为S107 S107
_akey String 是 20 万店掌开放平台分配给第三方的开发者key 认证平台开发者后获取
_mt String 是 100 接口名称 open.passengerflow.getAllHotspotShops
_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
depId		 int × 11 门店id 9494
pageNumber		 int × 11 当前第几页(不传默认第一页) 1
pageSize		 int × 11 每页多少条(不传默认返回20条） 20
shopId		 string × 100 三方店铺id 001
ovoparkEnterpriseId		 int × 11 业务平台企业id 1

公共响应参数 #

参数 类型 最大长度 描述 示例值
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格式数据，具体数据格式会在业务返回参数中定义) 查看

业务返回参数 #

参数名称 类型 是否一定返回 返回最大长度 描述 示例值
total		 int × 11 当前页总数 5
all		 int × 11 所有数据总数 20
pageNumber		 int × 11 当前第几页 1
pageSize		 int × 11 每页多少条 20
list		 JSON × 结果集 查看
    
depId		 int × 11 【list】门店id 7192
    
depName		 string × 100 【list】门店名称 苏州总部
    
nums		 int × 11 【list】该门店下设备总数 5
    
devices		 JSON × 【list】设备列表集合 查看
        
online		 int × 1 【devices】在线状态(0:不在线,1:在线) 1
        
deviceName		 string × 100 【devices】设备名称 热点1
        
deviceUrl		 string × 100 【devices】设备场景图片URL http://121.43.231.99/b827eb48294d.jpg
        
mac		 string × 100 【devices】设备MAc b827eb48294d

公共返回码 #

返回码名称 返回码 返回码描述 解决方案
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 开放平台系统异常 重新发起请求

业务返回码 #

返回码名称 返回码 返回码描述
BUSINESS_PLATFORM_UNBOUND		 101001 业务平台未做绑定,请联系客服
DATA_NOT_NULL		 101002 必填字段不能为空
DEPID_DOES_NOT_EXIST		 101003 当前企业下此门店号不存在
IDENTITY_INFORMATION_WRONG		 101005 身份信息有误,_akey与企业id不匹配
API_SYSTEM_ERROR		 101999 api服务未知异常