注册

open.shopDetect.agentShopDetailsYmdj （获取暗访明细）

暗访明细

接口描述 #

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

公共请求参数 #

参数 类型 是否必填 最大长度 描述 示例值
_aid String 是 20 开放平台系统编号，固定为S107 S107
_akey String 是 20 万店掌开放平台分配给第三方的开发者key 认证平台开发者后获取
_mt String 是 100 接口名称 open.shopDetect.agentShopDetailsYmdj
_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 √ 100 页码
pageSize int √ 0 最大20
startTime string √ 0 2024-06-14
endTime string √ 0 2024-06-14
depId int × 0 门店id
shopId string × 0 三方门店编码 “12342”

公共响应参数 #

参数 类型 最大长度 描述 示例值
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 × 111 返回json 查看
records JSON × 0 records（Array） 查看
code string × 0
message string × 0
result string × 0
isError boolean × 0
data JSON × 0 data 查看
records JSON × 0 records（Array） 查看
title string × 0 计划标题
organizeName string × 0 organizeName
mark string × 0 暗访得分
totalMark string × 0 暗访总分
scorePercent string × 0 暗访得分率
depId int × 0 门店id
checkParentVisitVos JSON × 0 checkParentVisitVos（Array） 查看
parentName string × 0 检查项大类
checkItemVisitVos JSON × 0 checkItemVisitVos（Array） 查看
itemName string × 0 检查项项名称
totalMark string × 0 检查项得分
mark string × 0 检查项总分
percentMark string × 0 检查项得分率
signInTime string × 0 进店时间
signOutTime string × 0 离店时间
shopName string × 0 门店名称
agentShopTime string × 0 探店日期
shopId string × 0 三方门店编码 “12312”
reportUrl string × 0 报告链接 "url"
×
×
taskStatus int × 0 任务状态： 0审核中，1已通过
total int × 0 total
size int × 0 size
current int × 0 current
orders JSON × 0 array 查看
optimizeCountSql boolean × 0 optimizeCountSql
hitCount boolean × 0 hitCount
pages int × 0 pages

公共返回码 #

返回码名称 返回码 返回码描述 解决方案
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