万店掌 开放平台 巡店报表详情

open.shopweb.liveCheck.statisticsDetailPageForCustomer (巡店报表详情)

这个接口主要功能是获取用户巡店报表相关信息,主要包括巡店人信息、巡店类型、创建时间、门店信息、问题状态、分数、细则、检查项信息、问题有效期、奖惩金额类型、金额、倒扣分、问题整改图片或整改视频等。sourceTypes: * 1.点检任务 * 2.摇一摇巡店 * 3.图片抓拍 * 4.手动创建问题 * 6.快拍 * 7.告警 * 8.现场巡店 * 9.远程巡店 * 10.AI 抓拍比对 * 11.AI 实时监控 * 12.门店自检 * 13.计划巡店中巡店任务的远程巡店 * 14.计划巡店中巡店任务的现场巡店 * 15.计划巡店中的巡检计划 * 16.小鸟探店 * 17.计划巡店中巡店任务的门店自检

接口描述 #

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

公共请求参数 #

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

业务请求参数 #

参数 类型 是否必填 最大长度 描述 示例值
pageNumber
int 11 页码 1
pageSize
int 11 每页显示的条数 20
enterpriseId
int 11 企业id 1084
startTime
string 100 开始时间 2021-01-03
endTime
string 100 结束时间 2021-03-23
sourceTypes
string × 100 检查方式,多个逗号隔开(1:点检任务,2:摇一摇巡店,4:手动创建问题,7:告警,8:现场巡店,9:远程巡店,10:AI 抓拍比对,11:AI 实时监控,12:门店自检,13:计划巡店中巡店任务的远程巡店,14:计划巡店中巡店任务的现场巡店,15:计划巡店中的巡检计划,17:计划巡店中巡店任务的门店自检) 1,2,3
templateIds
string × 0 模板 1,3,4
deptNode
string × 0 组织架构ID(门店以S_开头) S_123
userIds
string × 0 巡店人ids,多个逗号隔开 1,2
problemClassifyIds
string × 0 点检项ID,多个逗号隔开 1,2
openStatus
string × 0 门店状态0.准备中,1.营业,2.闭店 0
commitTimeStart
string × 0 提交开始时间 2022-04-06 10:56:59
commitTimeEnd
string × 0 提交结束时间 2022-04-06 10:56:59
checkStartTimeStart
string × 0 巡店开始时间 2022-04-06 10:56:59
approvalTimeStart
string × 0 审核开始时间 2022-04-06 10:56:59
approvalTimeEnd
string × 0 审核结束时间 2022-04-06 10:56:59

公共响应参数 #

参数 类型 最大长度 描述 示例值
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格式数据,具体数据格式会在业务返回参数中定义) 查看

业务返回参数 #

参数名称 类型 是否一定返回 返回最大长度 描述 示例值
total
int × 11 数据总数 0
data
JSON × 0 数据 查看
    
bh
string × 0 编号 111
    
deptId
string × 0 门店id 123
    
shopId
string × 0 第三方店铺id 测试门店
    
organizeName
string × 0 组织架构名称 1888
    
deptName
string × 0 门店名称 测试
    
managerOfDept
string × 0 门店店长 测试
    
templateName
string × 0 模板 测试
    
parentEvaluationName
string × 0 检查项分类名称 测试
    
evaluationName
string × 0 检查项名称 测试
    
allDetailRuleString
string × 0 细则 测试
    
detailedRuleNames
string × 0 违反细则 测试
    
status1
string × 0 结果 100
    
mark
int × 0 得分 20
    
evaluationScore
int × 0 点检项标准分 100
    
money
int × 0 奖惩金额 50
    
ruleDescription
string × 0 计分规则 测试
    
extraMark
string × 0 倒扣分 15
    
description
string × 0 描述 测试
    
problemPicList
JSON × 0 问题图片 查看
    
picList
JSON × 0 图片 查看
        
problemId
string × 0 test test
        
path
string × 0 test test
        
pictureName
string × 0 test test
        
picId
int × 0 test test
        
attachType
int × 0 test test
        
url
int × 0 test test
        
size
int × 0 test test
        
videoTime
int × 0 test test
        
aICheckContents
int × 0 test test
        
aiPic
boolean × 0 test test
    
reformPicList
JSON × 0 整改后的图片 查看
    
presetName
string × 0 场景名称 测试
    
updateTime
string × 0 已完成时间 2023-07-03 12:00:00
    
checkStartTime
string × 0 巡店开始时间 2023-07-03 12:00:00
    
createTime
string × 0 考核时间 2023-07-03 12:00:00
    
commitTime
string × 0 提交时间 2023-07-03 12:00:00
    
approvalTime
string × 0 审核时间 2023-07-03 12:00:00
    
isInvalid
boolean × 0 问题状态(1 已过期 0 未过期) 1
    
status2
string × 0 流程状态( 3:待复检,4:整改完成 ,5:待整改) 3
    
sourceTypeName
string × 0 检查形式 test
    
planTypeName
string × 0 计划类型(巡店任务、巡检计划、临时) 测试
    
rectifierName
string × 0 整改人名称 可能多整改人 用“|”隔开 测试
    
showName
string × 0 检查人名称 测试
    
roles
string × 0 检查人角色 测试
    
originName
string × 0 所属部门 测试
    
sourceType
string × 0 test 测试
    
moneyType
string × 0 奖惩类型,0:奖励,1:处罚 1
    
allRules
string × 0 检查项所有的细则 测试
    
evaluationId
string × 0 检查项id 测试
    
checktaskId
int × 0 巡店任务id 111
    
templateId
int × 0 模板id 111
    
supervision
string × 0 督导 测试
    
regionalManager
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 开放平台系统异常 重新发起请求

业务返回码 #

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