万店掌 开放平台 获得所有巡店任务v2

open.shopweb.liveCheck.getLiveCheckLog (获得所有巡店任务v2)

获得所有巡店任务v2

接口描述#

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

公共请求参数#

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

业务请求参数#

参数类型是否必填最大长度描述示例值
startTime
string10 开始时间2020-08-02 00:00:00
endTime
string10 结束时间2020
recordType
int10 0我自己的,1我管辖的 (不传默认0)1
pageNumber
int10 分页1
pageSize
int10 分页大小 10
edition
int1 固定传33
checkType
int×10现场巡店,1远程巡店(不传默认0)0
checkerId
int×1巡店人ids1,2,3
status
int×3巡店任务状态 -1 or null 全部 0未提交 1已完成 2已失效1
depId
int×3门店id1
isInRange
string×4提交巡店任务时,是否在有效范围内 null没做范围限制 0不在范围内 1在范围内1
auditStartTime
string×0审核开始时间
auditEndTime
string×0审核结束时间

公共响应参数#

参数类型最大长度描述示例值
statJSON-网关状态(具体参数描述如下:)查看
stat.cidString100http请求的标识符
stat.codeString100网关返回码
stat.codenameString100网关返回码名称
stat.systimeStringLong接口调用的当前时间
resultString100接口返回提示信息
dataJSON-接口调用返回的业务信息(一般是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×00 奖励钱 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×0userName
isApproval
int×0是否开启了 单次巡店报告审核
parentDbViewShopList
int×0父类点检项
summary
int×0巡店总结
endTime
string×0提交时间
templateId
int×0模板id
templateName
string×0templateName
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扣除分数

公共返回码#

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

业务返回码#

返回码名称返回码返回码描述
code
0 success