万店掌 开放平台 查看评论(分页)

open.shopweb.liveCheck.task.getComment (查看评论(分页))

查看评论(分页)

接口描述 #

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

公共请求参数 #

参数 类型 是否必填 最大长度 描述 示例值
_aid String 20 开放平台系统编号,固定为S107 S107
_akey String 20 万店掌开放平台分配给第三方的开发者key 认证平台开发者后获取
_mt String 100 接口名称 open.shopweb.liveCheck.task.getComment
_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体请求 查看
    
pageSize
int 0 页大小
    
historyId
string 0 正常传这个(与messageId两者必传一个)
    
messageId
string 0 消息入口传这个
    
pageNumber
string 0 1 开始

公共响应参数 #

参数 类型 最大长度 描述 示例值
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 × 11 json 查看
    
isError
boolean × 0 isError
    
data
JSON × 0 object 查看
        
total
int × 0 total
        
records
JSON × 0 array 查看
            
id
int × 0
            
historyId
int × 0
            
comment
string × 0 总体评价
            
summary
string × 0 评价概要 (/分隔 页面显示用)
            
attachment
JSON × 0 array 查看
                
path
int × 0 地址
            
user
JSON × 0 object 查看
                
id
int × 0
                
name
int × 0 用户名称
            
child
JSON × 0 array 查看
                
comment
string × 0 子评论
                
itemName
string × 0 点检项名称
                
attachment
JSON × 0 子评论附件 查看
                    
path
string × 0 地址
            
commentProjectVo
JSON × 0 object 查看
                
comment
int × 0 评论
                
attachment
JSON × 0 评论项目 查看
                    
path
int × 0 地址
                
projectItems
JSON × 0 array 查看
                    
commentItemId
int × 0 评论项目id
                    
commentItemName
int × 0 评论项目名称
                    
int × 0 评论项目分数
                    
evaluationScore
int × 0 设置的分数
    
pageNumber
int × 0 pageNumber
    
pageSize
int × 0 pageSize

公共返回码 #

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