open.xundian.public.getLiveCheckLog (巡店任务列表 )
巡店任务列表
接口描述 #
环境 | 接口方法 | 提交方式 | 是否需要签名 | HTTP请求路由 |
---|---|---|---|---|
正式环境 | open.xundian.public.getLiveCheckLog | POST | true | http://cloudapi.ovopark.com/cloud.api |
公共请求参数 #
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
_aid | String | 是 | 20 | 开放平台系统编号,固定为S107 | S107 |
_akey | String | 是 | 20 | 万店掌开放平台分配给第三方的开发者key | 认证平台开发者后获取 |
_mt | String | 是 | 100 | 接口名称 | open.xundian.public.getLiveCheckLog |
_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 |
业务请求参数 #
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
int | × | 0 | 页码 | 1 | |
int | × | 0 | 页长 | 10 | |
int | × | 0 | 开始时间 | yyyy-MM-dd HH:mm:ss | |
int | × | 0 | 结束时间 | yyyy-MM-dd HH:mm:ss |
公共响应参数 #
参数 | 类型 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|
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格式数据,具体数据格式会在业务返回参数中定义) | 查看 |
业务返回参数 #
参数名称 | 类型 | 是否一定返回 | 返回最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
JSON | × | 10 | 返回信息 | 查看 | |
int | × | 0 | 巡店任务id | 4563 | |
int | × | 0 | 点检项个数 | 27 | |
int | × | 0 | 合格点检项数 | 22 | |
int | × | 0 | 不合格数 | 22 | |
int | × | 0 | 不适用数 | 22 | |
int | × | 0 | 得分 | 100 | |
int | × | 0 | 无用字段 | 无用字段 | |
int | × | 0 | 巡店有效时长(单位秒) | 60 | |
int | × | 0 | 巡店总时长(单位秒) | 180 | |
string | × | 0 | 任务创建时间 | test | |
int | × | 0 | 门店id | 888 | |
string | × | 0 | 门店名称 | 测试 | |
int | × | 0 | 额外扣分 | 2 | |
int | × | 0 | 奖惩类型(0奖励 1惩罚) | 1 | |
int | × | 0 | 奖惩金额 | 65 | |
int | × | 0 | moneyType 和 money 两个字段的结合,比如:moneyTpe =0 mongey = 5,则moneyStr=+5,反之moneyStr=-5 | 5 | |
int | × | 0 | 忽略此字段 | 忽略此字段 | |
int | × | 0 | 忽略此字段 | 忽略此字段 | |
int | × | 0 | 忽略此字段 | 忽略此字段 | |
int | × | 0 | 忽略此字段 | 忽略此字段 | |
int | × | 0 | 忽略此字段 | 忽略此字段 | |
int | × | 0 | 忽略此字段 | 忽略此字段 | |
int | × | 0 | 0:进行中,1:已完成(无需审核),2:已失效,3:待审核,4:已完成(审核通过),5:已完成(自动审核通过) | 0,1 | |
int | × | 0 | 任务提交是否在有效范围内(现场巡店), null:没有开启范围限制,0:不在有效范围内,1:在范围内 | 0,1 | |
int | × | 0 | 巡店人id | 123 | |
string | × | 0 | 巡店人显示名 | 张山 | |
int | × | 0 | 忽略此字段 | 忽略此字段 | |
int | × | 0 | 忽略此字段 | 忽略此字段 | |
int | × | 0 | 忽略此字段 | 忽略此字段 | |
string | × | 0 | 巡店任务提交时间 | test | |
int | × | 0 | 巡店任务模板id | 123 | |
string | × | 0 | 巡店任务模板名称 | 测试 | |
int | × | 0 | 是否使用模板,0或null:未使用,1:使用 | 0 | |
int | × | 0 | 此巡店任务使用的模板或者分类巡店组装的字符串 | 1 | |
int | × | 0 | history表id | 123 | |
int | × | 0 | 当前登录的用户和此巡店任务的审核人是否同一个人,1:是,0:否 | 0 | |
int | × | 0 | 审核人id | 12 | |
int | × | 0 | 0:现场巡店,1:远程巡店,11:远程巡店(计划巡店中远程巡店)10:现场巡店(计划巡店中现场巡店),12:门店自检 ,12:巡检计划,17:巡店任务-门店自检 | 0,1 | |
int | × | 0 | 企业id | 555 | |
int | × | 0 | 忽略此字段 | 忽略此字段 | |
int | × | 0 | 门店表的shopId字段 | 126 | |
int | × | 0 | 忽略此字段 | 忽略此字段 | |
int | × | 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 | 开放平台系统异常 | 重新发起请求 |
业务返回码 #
返回码名称 | 返回码 | 返回码描述 |
---|---|---|
0 | 成功 |