注册

open.shopweb.liveCheck.getDepartmentTagRanking （获取新门店标签排名）

巡店新排名报表-新门店标签排名

接口描述 #

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

公共请求参数 #

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

业务请求参数 #

参数 类型 是否必填 最大长度 描述 示例值
json JSON √ 1 入参json 查看
×
sortIndicator int × 0 哪个字段使用具体
sortType int × 0 1-升序-1降序0不排序使用,SortTypeEnum[DESC,ASC,NOT_SORTED,type]
subIndicator int × 0 @paramsubIndicator细分指标排序标识,sourceType或者roleId
subIndicatorType int × 0 @paramsubIndicatorType细分指标排序类型0.巡店类型,1.用户角色
indicatorSubject int × 0 指标主体
gearIndicator int × 0 0-xxx门店数量1-xxx门店比例
whichType int × 0 0-web调取1-h5调取
customStartDate string √ 0 自定义开始时间
customEndDate string √ 0 自定义结束时间
timeRange int × 0 时间范围
depNodes string √ 0 组织架构 ,String集合
roleIds int × 0 角色 ,Integer 集合
userIds int × 0 Integer 集合
templateIds int × 0 模板 ,Integer 集合
inspectionItemClassificationIds int × 0 点检项分类 ,Integer 集合
sourceTypes int × 0 Integer集合
pageNumber int × 0
pageSize int × 0
openStatus string × 0
showTheNextLevel boolean × 0 是否展示下一级
regionalManagerOrSupervisors JSON × 0 区域经理或者督导 ,DepNodeBo 查看

公共响应参数 #

参数 类型 最大长度 描述 示例值
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 JSON × 1 返回参数 查看
depNode int × 0 部门节点
name int × 0 部门节点名称
depIds JSON × 0 区域经理或者督导下的门店集合 ,Integer 查看
depId int × 0 门店ID
shopId int × 0 第三方店铺ID
orgStructure int × 0 所属组织架构
storeAverageScore int × 0 平均得分
storeScoreRate int × 0 得分率
storeAbsoluteAverageScore int × 0 绝对平均分
storeInspectionRatio int × 0 门店检查比例
storeQualifiedRatio int × 0 门店合格比例
storeTotalNum int × 0 总门店数
storeExcellentNum int × 0 优秀门店数
storeQualifiedNum int × 0 合格门店数
storeUnqualifiedNum int × 0 不合格门店数
storeCheckedNum int × 0 检查门店数
storeUncheckedNum int × 0 未检查门店数
storeUncheckedOrOutsideNum int × 0 未检查未到访门店数
storeNoProblemFoundNum int × 0 未发现问题门店数
storeInspectionNum int × 0 门店检查次数
storeCheckAverageDurationStr int × 0 巡店平均时长 国际化 用于前端展示
storeCheckAverageDuration int × 0 巡店平均时长 单位秒 用于排序
storeCreateTimePeriodStr int × 0 门店创建距今时长 国际化 用于前端展示
storeCreateTimePeriod int × 0 门店创建距今时长 用于排序
storeSumLossScore int × 0 累计扣分
inspectionItemTotalNum int × 0 点检项检查次数
inspectionItemQualifiedRate int × 0 检查项合格率
inspectionItemUnqualifiedRate int × 0 检查项不合格率
inspectionItemQualifiedNum int × 0 合格项数
inspectionItemUnqualifiedNum int × 0 不合格项数
problemToRectificationNum int × 0 待整改数
problemToRectificationRate int × 0 待整改率
problemCompletedNum int × 0 已完成数
problemCompletedRate int × 0 已完成率
problemToAppealNum int × 0 待申诉数
problemToAppealRate int × 0 待申诉率
problemToApprovalNum int × 0 待审批数
problemToApprovalRate int × 0 待审批率
problemAppealNotPassNum int × 0 申诉不通过数
problemAppealNotPassRate int × 0 申诉不通过率
problemAppealPassNum int × 0 申诉通过数
problemAppealPassRate int × 0 申诉通过率
problemToRecheckNum int × 0 待复检数
problemToRecheckRate int × 0 待复检率
problemExpiredNum int × 0 过期数
problemExpiredRate int × 0 过期率
checkerNum int × 0 检查人数
director int × 0 上级负责人
supervisors int × 0 上级领导
taskTotalNum int × 0 任务总数
validCheckNum int × 0 有效巡店次数
spotInspectionTaskTotalNum int × 0 任务总数-点检任务
onSiteTaskTotalNum int × 0 任务总数-现场巡店
remoteTaskTotalNum int × 0 任务总数-门店自检
timeStrSinceLastTask int × 0 上次任务距今时长 国际化 用于前端展示
timeSinceLastTask int × 0 上次任务距今时长 用于排序
taskTotalDurationStr int × 0 任务总时长 国际化 用于前端展示
taskTotalDuration int × 0 任务总时长 单位秒 用于排序
taskApprovalTypeDistribution int × 0 审批方式分布 自动/人工/不需
taskAverageApprovalDurationStr int × 0 审批平均时长 国际化 用于前端展示
taskAverageApprovalDuration int × 0 审批平均时长 单位秒 用于排序
storeCheckedNames int × 0 检查门店集合
storeUncheckedNames int × 0 未检查门店名称集合
storeUncheckedList JSON × 0 未检查门店集合 查看
storeUncheckedOrOutsideList JSON × 0 未检查未到访门店 集合 查看
problemOverdueCompletion int × 0 过期完成次数
rewards int × 0 奖励金额
penalty int × 0 惩罚金额
problemOverdueNum int × 0 问题逾期数：处于【已过期】的点检项数量
problemOverdueRate int × 0 问题逾期率：处于【已过期】的点检项数量 /（不合格点检项数量+申诉通过项数）
problemSharedNum int × 0 问题分享次数
lightspotSharedNum int × 0 亮点分享次数
supervision int × 0 督导
regionalManager int × 0 区域经理
storeScoreRateRatio int × 0 门店得分率环比
problemCompletionOnTime int × 0 按时完成次数=待办单流程状态显示【已完成】的【未过期】次数
problemCompletionOnTimeRate int × 0 按时完成率=按时完成次数（不合格次数+申诉通过次数）
problemExpirationCompletionRate int × 0 过期完成率=过期完成次数（不合格次数+申诉通过次数）
returnScoreRate int × 0 得分率（含还回分）
storeAbsoluteAverageReturnScore int × 0 绝对平均分（含还回分）
rankingDepartmentGearVos int × 0 门店分档xxx门店数量、xxx门店比例 ,RankingDepartmentGearVo
reformOnTime int × 0 按时完成整改数
reformExpire int × 0 过期完成整改数
reformOnTimeRate int × 0 按时完成整改率
reformExpireRate int × 0 过期完成整改率
refusedRate int × 0 被驳回率,被驳回过的巡店任务数(巡店次数-无需审批的巡店任务数)100%
committedNotInRangeNum 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