open.shopweb.liveCheck.pen.pageList （计划巡店-巡店任务）
计划巡店-巡店任务
接口描述#
| 环境 | 接口方法 | 提交方式 | 是否需要签名 | HTTP请求路由 |
|---|---|---|---|---|
| 正式环境 | open.shopweb.liveCheck.pen.pageList | POST | true | http://cloudapi.ovopark.com/cloud.api |
公共请求参数#
| 参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|---|
| _aid | String | 是 | 20 | 开放平台系统编号，固定为S107 | S107 |
| _akey | String | 是 | 20 | 万店掌开放平台分配给第三方的开发者key | 认证平台开发者后获取 |
| _mt | String | 是 | 100 | 接口名称 | open.shopweb.liveCheck.pen.pageList |
| _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 | √ | 11 | json传参 | 查看 |
| int | √ | 11 | page | ||
| int | √ | 11 | pageSize | ||
| string | × | 11 | 任务名（支持模糊查询） | ||
| string | × | 11 | 创建人id | ||
| string | × | 11 | 创建时间的起始时间 | ||
| string | × | 11 | 创建时间的截止时间 | ||
| JSON | × | 11 | List集合 | 查看 | |
| int | × | 11 | 陈列任务的一级列表筛选条件 | ||
| int | × | 11 | 状态2,"执行中",4,"已完成",5,"已过期",7,"未生效",10,"待执行" | ||
| int | × | 0 | 执行类型0:人带门店，1:门店带人 | ||
| int | √ | 11 | 企业id |
公共响应参数#
| 参数 | 类型 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|
| 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 | 返回参数 | 查看 |
| int | × | 0 | 页码 | ||
| int | × | 0 | 每页数量 | ||
| int | × | 0 | 总数 | ||
| int | × | 0 | 总页码 | ||
content | JSON | × | 0 | 返回参数 | 查看 |
| int | × | 0 | id | ||
| string | × | 0 | 任务名 | ||
| int | × | 0 | 任务类型 | ||
| int | × | 0 | 创建人 | ||
| int | × | 0 | 创建人名 | ||
| string | × | 0 | 模版名 | ||
| int | × | 0 | 目标完成数量 | ||
| int | × | 0 | 已完成数量 | ||
| int | × | 0 | 完成比例 | ||
| int | × | 0 | 提交比例 | ||
| int | × | 0 | 创建日期 | ||
| int | × | 0 | 开始时间 | ||
| int | × | 0 | 截止时间 | ||
| int | × | 0 | 提醒时间 | ||
| int | × | 0 | 备注 | ||
| int | × | 0 | 执行类型0:人带门店，1:门店带人 | ||
| int | × | 0 | 大任务状态 | ||
| int | × | 0 | 过期完成数 | ||
| string | × | 0 | 过期完成比例 | ||
| int | × | 0 | 门店提交数 | ||
| int | × | 0 | 目标门店数 | ||
| int | × | 0 | 执行人数 | ||
| 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 | 开放平台系统异常 | 重新发起请求 |
业务返回码#
| 返回码名称 | 返回码 | 返回码描述 |
|---|---|---|
| coede | 0 | success |