万店掌 开放平台 获取设备列表
联系我们

open.shopweb.device.getDeviceList (获取设备列表)

获取设备列表

接口描述#

环境接口方法提交方式是否需要签名HTTP请求路由
正式环境open.shopweb.device.getDeviceListPOSTtruehttp://cloudapi.ovopark.com/m.api

公共请求参数#

参数类型是否必填最大长度描述示例值
_aidString20开放平台系统编号,固定为S107S107
_akeyString20万店掌开放平台分配给第三方的开发者key认证平台开发者后获取
_mtString100接口名称open.shopweb.device.getDeviceList
_smString100签名算法 md5,sha1md5
_requestModeString100请求方式post,getPOST
_versionString100版本号v1
_timestampString100时间戳yyyyMMddHHmmss格式
_sigString32签名token根据签名算法生成,详情见签名算法规则
_formatString10format类型目前默认仅支持json

业务请求参数#

参数类型是否必填最大长度描述示例值
id
int门店id

公共响应参数#

参数类型最大长度描述示例值
statJSON-网关状态(具体参数描述如下:)查看
stat.cidString100http请求的标识符
stat.codeString100网关返回码
stat.codenameString100网关返回码名称
stat.systimeStringLong接口调用的当前时间
resultString100接口返回提示信息
dataJSON-接口调用返回的业务信息(一般是json格式数据,具体数据格式会在业务返回参数中定义)查看

业务返回参数#

参数名称类型是否一定返回返回最大长度描述示例值
records
JSON×结果集查看
    
id
int×【records】设备id
    
mac
string×【records】设备mac
    
deviceType
string×【records】设备类别
    
deviceName
string×【records】设备名称
    
version
string×【records】版本号
    
platformId
int×【records】平台id
    
platformAddress
string×【records】平台地址
    
createTime
long×【records】创建时间
    
deviceIp
string×【records】设备ip
    
groupId
int×【records】企业id
    
capability
long×【records】大小
    
online
int×【records】设备在线状态(1:在线)
    
deviceStatusLst
JSON×【records】nvr下的子设备列表查看
        
onlineOnPlatform
boolean×【deviceStatusLst】设备网管在线状态(false:离线)
        
deviceId
int×【deviceStatusLst】视频设备id
        
accessType
int×【deviceStatusLst】设备注册方式(0:直接注册;1:设备直接挂载到nvr下(VSIP);2:ONVIF; 3:RTSP上报)
        
obtainVideoPath
int×【deviceStatusLst】录像视频流获取类型(0:通过websocket获得;1:通过流媒体平台获得)
        
mac
string×【deviceStatusLst】视频设备mac61ac7b42c75a
        
deviceIp
string×【deviceStatusLst】视频设备ip172.16.3.18
        
online
int×【deviceStatusLst】视频设备设备在线状态(0:离线,1:在线)1

公共返回码#

返回码名称返回码返回码描述解决方案
SUCCESS0调用成功
KEY_NOTNULL1_akey和不能为空接口调用时传入_akey参数
KEY_UNLAWFUL2_akey不合法key是非法的,传入正确的key
KEY_HAS_EXPIRED3_akey已过期请续订服务或联系平台管理人员
SIGN_METHOD_NOTNULL4_sm参数不能为空接口调用时传入_sm参数
SIGN_TYPE_NOTEXIST5_sm类型不存在目前仅支持md5,sha1
SIGN_NOTNULL6_sig参数不能为空接口调用时传入_sig参数
SIGN_WRONG7无效的签名,请检查参数和签名格式_sig值根据签名算法生成
METHOD_NOTNULL8_mt参数不能为空接口调用时传入_mt参数
METHOD_NOTEXIST_CODE9_mt对应的方法名不存在或未注册进服务检查_mt方法名和_version版本号对应的方法是否传入错误
REQUESTMODE_NOTNULL10_requestMode参数不能为空接口调用时传入_requestMode参数
APPLICATIONID_NOTNULL11_aid参数不能为空接口调用时传入_aid参数
APPLICATIONID_NOTSAME12_aid与当前key不匹配_aid与_akey必须一一对应
VERSION_NOTNULL13_version版本号不能为空接口调用时传入_version参数
TIMESTAMP_NOTNULL14_timestamp时间戳不能为空接口调用时传入_timestamp参数
TIMESTAMP_FORMAT_ERROR15_timestamp时间戳格式化错误按照yyyyMMddHHmmss格式
TIMESTAMP_OVERTIME16_timestamp已失效_timestamp每次接口调用时重新生成
FORMAT_TYPE_NOTEXIST17_format类型不存在目前仅支持json(默认),xml
API_CALL_REPEAT-100接口重复调用接口平台调用异常
API_SYSTEM_CALL_ERROR-500api调用失败,系统发生异常接口平台调用异常
UNKNOWN_ERROR-999开放平台系统异常重新发起请求

业务返回码#

返回码名称返回码返回码描述