open.ai.public.aicheck.getRecordList (巡店执行记录列表接口)
门店摄像头抓拍的图片传给巡店平台,平台将图片传给算法进行检测给出检测结果,包含检测物体的坐标信息以及是否合格等,平台生成一条执行记录。用户通过该接口可以查看某个门店下产生的所有执行记录信息,可以根据一定的条件筛选满足条件的记录。
接口描述#
环境 | 接口方法 | 提交方式 | 是否需要签名 | HTTP请求路由 |
---|---|---|---|---|
正式环境 | open.ai.public.aicheck.getRecordList | POST | true | http://cloudapi.ovopark.com/cloud.api |
公共请求参数#
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
_aid | String | 是 | 20 | 开放平台系统编号,固定为S107 | S107 |
_akey | String | 是 | 20 | 万店掌开放平台分配给第三方的开发者key | 认证平台开发者后获取 |
_mt | String | 是 | 100 | 接口名称 | open.ai.public.aicheck.getRecordList |
_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 |
业务请求参数#
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
json | JSON | √ | 100 | 请求示例值 | 查看 |
int | √ | 100 | 1084 | 企业ID | |
int | × | 100 | [29303,29304] | 门店ID集合 | |
int | × | 100 | [1,2] | 检测类型集合(2.店面管理检测 3.着装检测 4.车间检测 5.老鼠检测 7.动作检测 9.实时动作检测 11.货架检测 12.实时着装检测 13.实时店面管理检测) | |
int | × | 100 | [] | 检测结果集合(1.正常 2.异常 3.误检 4.无目标 | |
string | √ | 100 | 2022-12-06 00:00:00 | 搜索时间范围-开始时间(搜索时间范围不传默认查询7天内) | |
string | √ | 100 | 2022-12-07 23:59:59 | 搜索时间范围-结束时间(搜索时间范围不传默认查询7天内) | |
int | × | 100 | 1 | 分页的当前页数,默认1 | |
int | × | 100 | 10 | 分页的每页大小数,默认10 | |
int | × | 100 | 测试 | 场景值名称 | |
int | × | 0 | 测试 | 检出检测项名称 |
公共响应参数#
参数 | 类型 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|
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格式数据,具体数据格式会在业务返回参数中定义) | 查看 |
业务返回参数#
参数名称 | 类型 | 是否一定返回 | 返回最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
data | JSON | × | 100 | 返回 | 查看 |
int | × | 100 | list | 测试 | |
int | × | 100 | 执行记录ID | 88 | |
string | × | 100 | 门店名称 | 88 | |
int | × | 100 | 巡店应用名称 | 测试 | |
int | × | 100 | 检测类型 (2.店面管理检测 3.着装检测 4.车间检测 5.老鼠检测 7.动作检测 9.实时动作检测 11.货架检测 12.实时着装检测 13.实时店面管理检测) | 1 | |
int | × | 100 | 检测结果(1.正常 2.异常 3.误检 4.无目标) | 1 | |
int | × | 100 | 产生时间 | 测试时间 | |
int | × | 100 | 场景ID | 11 | |
int | × | 100 | 场景名称 | 测试 | |
int | × | 100 | 设备ID | 12312 | |
int | × | 100 | 预置位ID | 125 | |
int | × | 100 | 抓拍图片url | 测试地址 | |
int | × | 100 | 算法识别结果集 | 结果 | |
int | × | 100 | 检测结果图片 | 测试图片 | |
int | × | 100 | 出现时长,单位:分钟 | 10 | |
int | × | 100 | 出现时间 | 10 | |
int | × | 100 | 页面 | 1 | |
int | × | 100 | 页面大小 | 10 | |
int | × | 100 | 总计 | 55 | |
int | × | 100 | 所有 | 11 | |
JSON | × | 0 | array [object {9}] | 查看 | |
int | × | 0 | 记录ID | ||
string | × | 0 | 门店名称 | ||
string | × | 0 | 算法code | ||
string | × | 0 | 算法名称 | ||
string | × | 0 | 检测项名称 | ||
string | × | 0 | 数据来源(1.云端抓拍 2.智能设备) | ||
string | × | 0 | 云端任务名称 | ||
int | × | 0 | 检测结果(1.正常 2.异常 3.误检 4.无目标 5.图片质量不佳 6.场景不适用) | ||
string | × | 0 | 记录产生时间 |
公共返回码#
返回码名称 | 返回码 | 返回码描述 | 解决方案 |
---|---|---|---|
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 | 开放平台系统异常 | 重新发起请求 |
业务返回码#
返回码名称 | 返回码 | 返回码描述 |
---|---|---|
SUCCESS | 0 | 成功 |