万店掌 开放平台 巡店新排名报表-组织架构排名

open.shopweb.liveCheck.getOrganizeRanking (巡店新排名报表-组织架构排名)

巡店新排名报表-组织架构排名

接口描述#

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

公共请求参数#

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

业务请求参数#

参数类型是否必填最大长度描述示例值
json
JSON11入参json查看
    
depNodes
JSON11选择组织架构节点,必传。默认有权限的最上级组织架构(集合) 查看
    
customStartDate
string11自定义开始时间
    
customEndDate
string11自定义结束时间
    
templateIds
JSON×11模版(集合)查看
    
roleIds
JSON×11角色(集合)查看
    
openStatus
string×11门店状态,0:筹建,1:在营,2:闭店,3:临时闭店
    
sourceTypes
JSON×11检查方式 (集合)查看
    
userIds
JSON×0巡检人 查看
    
pageSize
int×0每页多少
    
pageNumber
int×0当前页
    
sortIndicator
int×0哪个字段排序
    
sortType
int×01-升序 -1降序 0不排序
    
showTheNextLevel
int×0是否展示下一级
    
modes
string0巡店模式,0:单人巡店,1:协同巡店

公共响应参数#

参数类型最大长度描述示例值
statJSON-网关状态(具体参数描述如下:)查看
stat.cidString100http请求的标识符
stat.codeString100网关返回码
stat.codenameString100网关返回码名称
stat.systimeStringLong接口调用的当前时间
resultString100接口返回提示信息
dataJSON-接口调用返回的业务信息(一般是json格式数据,具体数据格式会在业务返回参数中定义)查看

业务返回参数#

参数名称类型是否一定返回返回最大长度描述示例值
data
JSON×11返回参数查看
    
depNode
int×11部门节点
    
name
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未检查门店数
    
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检查项合格率
    
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申诉通过率
    
problemExpiredNum
int×0过期数
    
problemExpiredRate
int×0过期率
    
checkerNum
int×0检查人数
    
leader
int×0负责人
    
taskTotalNum
int×0任务总数/巡店次数
    
validCheckNum
int×0有效巡店次数
    
spotInspectionTaskTotalNum
int×0任务总数-点检任务
    
onSiteTaskTotalNum
int×0任务总数-现场巡店
    
remoteTaskTotalNum
int×0任务总数-远程巡店
    
selfInspectionTaskTotalNum
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未检查门店名称集合
    
problemCompletionOnTime
int×0按时完成次数
    
problemCompletionOnTimeRate
int×0按时完成率
    
problemExpirationCompletionRate
int×0过期完成率
    
committedNotInRangeNum
int×0未在门店范围内提交次数
    
director
int×0上级负责人
    
inspectionItemUnqualifiedRate
int×0检查项不合格率
    
lightspotSharedNum
int×0亮点分享次数
    
penalty
int×0惩罚金额
    
problemOverdueCompletion
int×0过期完成次数
    
problemOverdueNum
int×0问题逾期数:处于【已过期】的点检项数量
    
problemOverdueRate
int×0问题逾期率:处于【已过期】的点检项数量 /(不合格点检项数量+申诉通过项数)
    
problemSharedNum
int×0问题分享次数
    
problemToRecheckNum
int×0待复检数
    
problemToRecheckRate
int×0待复检率
    
rankingDepartmentGearVos
int×0门店分档xxx门店数量、xxx门店比例
    
reformExpire
int×0过期完成整改数
    
reformExpireRate
int×0按时完成整改率
    
reformOnTime
int×0按时完成整改数
    
reformOnTimeRate
int×0按时完成整改率
    
refusedRate
int×0被驳回率 被驳回过的巡店任务数 / (巡店次数-无需审批的巡店任务数)*100%
    
regionalManager
int×0区域经理
    
returnScoreRate
int×0得分率(含还回分)
    
rewards
int×0奖励金额
    
storeAbsoluteAverageReturnScore
int×0绝对平均分(含还回分)
    
storeScoreRateRatio
int×0门店得分率环比
    
storeUncheckedOrOutsideNum
int×0未检查未到访门店数
    
supervision
int×0督导
    
supervisors
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
0success