注册

open.shopweb.liveCheck.getNewProfile （获取巡店记录详情）

巡店记录详情页

接口描述 #

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

公共请求参数 #

参数 类型 是否必填 最大长度 描述 示例值
_aid String 是 20 开放平台系统编号，固定为S107 S107
_akey String 是 20 万店掌开放平台分配给第三方的开发者key 认证平台开发者后获取
_mt String 是 100 接口名称 open.shopweb.liveCheck.getNewProfile
_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

业务请求参数 #

参数 类型 是否必填 最大长度 描述 示例值
historyId string √ 11 取“已完成记录列”表中的taskHistorySubmitId字段 123456

公共响应参数 #

参数 类型 最大长度 描述 示例值
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 × 11 返回json体 查看
summary string × 0 巡店总结JSON格式
cc JSON × 0 抄送人ID集合 查看
data JSON × 0 data 查看
deptId int × 0 门店ID
deptName string × 0 门店名称
deptArea string × 0 门店区域
deptManager string × 0 店长
shopId string × 0 shopId
reportType int × 0 巡店类型：1-点检, 8-现场巡店, 14-现场(巡店任务), 15-现场(巡检计划), 9-远程巡店, 13-远程(巡店任务), 21-远程(巡检计划),12-门店自检、17-门店自检(巡店任务),21:巡检计划-远程巡店
createrId int × 0 巡店人ID
createrName string × 0 巡店人名称
cooperatorNames string × 0 协同巡店人员集合
reviewTime string × 0 审核时间
reviewer string × 0 审核人
endTime string × 0 提交时间
createTime string × 0 开始时间
evaluationCount int × 0 检查项数
passCount int × 0 合格数
notPassCount int × 0 不合格数
notWorkCount int × 0 不适用数
scoreRate int × 0 得分率
totalScore int × 0 总分
sketchyScore int × 0 得分
scoreStr int × 0 extraScore
moneyType int × 0 奖惩类型：0 奖励钱 1 扣钱
money int × 0 金额
companyName string × 0 陪同人
stayTime string × 0 页面停留时长
allTime string × 0 总时长
isInRange int × 0 提交范围 1：范围内 0:范围外
templateName string × 0 模板名
templateId int × 0 模板id
taskId int × 0 任务id
onSiteUserId int × 0 现场责任人
onSiteUserName int × 0 现场责任人展示名
showOnSiteUser int × 0 是否显示现场责任人 0-不显示, 1-显示
realCreator string × 0 实际巡店人
resultEvaluate int × 0 巡店结果评价ID
evaluateContent string × 0 评价内容
planName string × 0 计划巡店或巡检任务名
showCreator int × 0 是否显示巡店人
templateEvaluationStr string × 0 模板评价：1-优秀 2-合格 3-不合格
color int × 0 color
locationList string × 0 巡店过程中，中途定位记录【集合】
returnScore int × 0 返还分
returnScoreRate int × 0 返还分得分率
revertScoreDisplay int × 0
redudenceScore int × 0
inspectionItemQualifiedPercentage int × 0
signInOut JSON × 0 object 签到签退信息 查看
taskId int × 0 巡店任务ID
signInAddress string × 0 签到地址
signInPicUrl string × 0 签到图片
signInPicId string × 0 签到图片id
signInTime string × 0 签到时间
signInInRange int × 0 签到时，是否超出范围：0:不在有效范围内，1：在范围内
signOutPicUrl string × 0 签退图片地址
signOutAddress string × 0 签退地址
signOutTime string × 0 签退时间
signOutInRange int × 0 签退时，是否超出范围：0:不在有效范围内，1：在范围内
signOut boolean × 0 是否有签退信息
signIn boolean × 0 是否有签到信息
approveDetail int × 0 附录内容，字符串
userId int × 0 审核人ID
userName string × 0 审核人展示名
isApproved int × 0 审核状态：1 人工已审， 0 人工未审
createTime string × 0 审核时间
updateTime string × 0 updateTime
isAuto int × 0 是否是自动通过（1 ：自动通过 ，0： 非自动）
reject boolean × 0 是否失效
operate int × 0 操作：1：审核通过，2：失效
reason int × 0 原因
reviewerSignUrl string × 0 审核人签名图片Url
pics string × 0 pics
sign JSON × 0 object 签名信息 查看
id int × 0 签名信息
taskId int × 0
inspectorPicUrl string × 0
managerPicUrl string × 0 店长签名图片url
shiplogUrl 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