open.shopweb.liveCheck.getLiveCheckLog (获得所有巡店任务v2)
获得所有巡店任务v2
接口描述#
环境 | 接口方法 | 提交方式 | 是否需要签名 | HTTP请求路由 |
---|---|---|---|---|
正式环境 | open.shopweb.liveCheck.getLiveCheckLog | POST | true | http://cloudapi.ovopark.com/cloud.api |
公共请求参数#
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
_aid | String | 是 | 20 | 开放平台系统编号,固定为S107 | S107 |
_akey | String | 是 | 20 | 万店掌开放平台分配给第三方的开发者key | 认证平台开发者后获取 |
_mt | String | 是 | 100 | 接口名称 | open.shopweb.liveCheck.getLiveCheckLog |
_sm | String | 是 | 100 | 签名算法 md5,sha1 | md5 |
_requestMode | String | 是 | 100 | 请求方式post,get | POST |
_version | String | 是 | 100 | 版本号 | v2 |
_timestamp | String | 是 | 100 | 时间戳 | yyyyMMddHHmmss格式 |
_sig | String | 是 | 32 | 签名token | 根据签名算法生成,详情见签名算法规则 |
_format | String | 否 | 10 | format类型 | 目前默认仅支持json |
业务请求参数#
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
startTime | string | √ | 10 | 开始时间 | 2020-08-02 00:00:00 |
endTime | string | √ | 10 | 结束时间 | 2020 |
recordType | int | √ | 10 | 0我自己的,1我管辖的 (不传默认0) | 1 |
pageNumber | int | √ | 10 | 分页 | 1 |
pageSize | int | √ | 10 | 分页大小 | 10 |
edition | int | √ | 1 | 固定传3 | 3 |
checkType | int | × | 1 | 0现场巡店,1远程巡店(不传默认0) | 0 |
checkerId | int | × | 1 | 巡店人ids | 1,2,3 |
status | int | × | 3 | 巡店任务状态 -1 or null 全部 0未提交 1已完成 2已失效 | 1 |
depId | int | × | 3 | 门店id | 1 |
isInRange | string | × | 4 | 提交巡店任务时,是否在有效范围内 null没做范围限制 0不在范围内 1在范围内 | 1 |
auditStartTime | string | × | 0 | 审核开始时间 | |
auditEndTime | string | × | 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格式数据,具体数据格式会在业务返回参数中定义) | 查看 |
业务返回参数#
参数名称 | 类型 | 是否一定返回 | 返回最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
taskId | int | × | 1 | 任务id | |
evaluationCount | int | × | 1 | 点检项数量 | |
passCount | int | × | 0 | 检查项 合格数 | |
notPassCount | int | × | 0 | 不合格数 | |
notWorkCount | int | × | 0 | 不适用数 | |
score | int | × | 0 | 得分(百分比) | |
showScore | int | × | 0 | 得分 | |
scoreStr | int | × | 0 | 忽略此字段 | |
liveSeconds | int | × | 0 | 巡店有效时长 - 秒 | |
totalDuration | int | × | 0 | 巡店总时长 - 秒 | |
createTime | int | × | 0 | 创建时间 | |
deptId | int | × | 0 | 门店id | |
deptName | string | × | 0 | 门店名称 | |
extraMark | int | × | 0 | 特殊点检项 | |
moneyType | int | × | 0 | 0 奖励钱 1 扣钱 | |
money | int | × | 0 | 金额 | |
realScore | int | × | 0 | 点检项得分 | |
totalScore | int | × | 0 | 点检项总分 | |
company | int | × | 0 | 忽略此字段 | |
historyId | string | × | 0 | 审核通过(包括自动审核和无需审核)的任务此字段有值 | |
resultEvaluate | string | × | 0 | 巡店结果评价 | |
returnScorePercent | string | × | 0 | 返还得分率 | |
returnScoreStr | int | × | 0 | ||
isComplete | int | × | 0 | 巡店任务状态 0 进行中 1 完成 2 已失效 | |
isInRange | int | × | 0 | 提交巡店时,是否在有效范围内 null 没有开启范围限制 0 不在有效范围内 1 在范围内 | |
userId | int | × | 0 | 巡店人id | |
userName | int | × | 0 | userName | |
isApproval | int | × | 0 | 是否开启了 单次巡店报告审核 | |
parentDbViewShopList | int | × | 0 | 父类点检项 | |
summary | int | × | 0 | 巡店总结 | |
endTime | string | × | 0 | 提交时间 | |
templateId | int | × | 0 | 模板id | |
templateName | string | × | 0 | templateName | |
isTemplate | int | × | 0 | 是否使用模板巡店 | |
evaluationIds | string | × | 0 | 点检项信息,如;{"isTemplate":1,"templateId":1223,"templateName":"失分模板","version":21} | |
taskHistorySubmitId | int | × | 0 | 审核通过(包括自动审核和无需审核)的任务此字段有值 | |
samePerson | int | × | 0 | 忽略此字段 | |
reviewerId | int | × | 0 | 审核人id | |
checkType | int | × | 0 | 巡店类型 | |
groupId | int | × | 0 | 企业id | |
sourceType | int | × | 0 | 忽略此字段 | |
outDepId | int | × | 0 | 忽略此字段 | |
ev | int | × | 0 | 忽略此字段 | |
appendixContent | int | × | 0 | 附录内容 | |
shopId | int | × | 0 | 第三方门店id | |
cooperators | int | × | 0 | 协同巡店人 | |
multiCommitState | int | × | 0 | 多次提交状态 | |
status | int | × | 0 | 任务状态:0:未完成,1:已完成(无需审核),2:已失效,3:待审核,4:已审核,5:已自动审核,6:待提交,7:已失效(手动),8:待修改 | |
firstCommitTime | int | × | 0 | 第一次提交时间 | |
revokeTime | int | × | 0 | 撤回时间 | |
delayMins | int | × | 0 | 延迟提交时间,单位分钟 | |
mode | int | × | 0 | 巡店模式,0:普通,1:协同 | |
revertScoreDisplay | int | × | 0 | 是否显示失分 | |
redudenceScore | 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 | 开放平台系统异常 | 重新发起请求 |
业务返回码#
返回码名称 | 返回码 | 返回码描述 |
---|---|---|
code | 0 | success |