# 接口操作
# 统一搜索分类内容接口
# 搜索指定模块内容
POST /contents/search
# 请求类型:Content-Type
application/json
# 请求参数
| 参数名 | 数据类型 | 必填 | 参数位置 | 参数说明 |
|---|---|---|---|---|
| keyword | string | Y | query | 关键字 |
| moduleId | string | Y | query | 分类模块id |
| limit | integer | N | query | 分页大小(默认10条) |
| cursor | integer | N | query | 分页偏移时间条件(时间戳:毫秒) |
# 返回结果
| 状态码 | 说明 | 返回值 | 响应头 |
|---|---|---|---|
| 200 | 成功响应 | ApiResultPage«UdsContents» | 无 |
| 201 | Created | 无 | 无 |
| 401 | Unauthorized | 无 | 无 |
| 403 | Forbidden | 无 | 无 |
| 404 | Not Found | 无 | 无 |
# 请求示例
POST /contents/search?cursor={cursor}&limit={limit}&moduleId={moduleId}&keyword={keyword}
Content-Type: application/json
# 返回示例
Content-Type: application/json
{
"data" : [ { //请求返回的数据
"id" : "string", //内容id
"title" : "string", //内容标题(如待办名称)
"subTitle" : "string", //内容副标题(可选参数-如待办正文信息)
"brief" : "string", //内容概要(可选参数)
"image" : "string", //内容图标(可选参数)
"author" : "string", //内容作者(可选参数)
"displayTime" : "long", //展示时间(时间戳--用于页面时间展示:毫秒)
"action" : "string", //点击处理动作信息,以json格式保存,支持不同端的处理,如:{\"android\":\"[OpenApp]\\nappCode=xxx\\nappUrl=xxx\",\"ios\":\"[OpenApp]\\nappCode=xxx\\nappUrl=xxx\",\"pc\":\"[OpenUrl]\\nurl=xxx\",\"web\":\"[OpenUrl]\\nurl=xxx\"}
"attachInfo" : "string", //附加信息(可选参数--如动态前两张图片地址)
"attachDescription" : "string" //附加信息描述(可选参数--如附件信息为图片时,可以补充说明图片数量)
} ],
"total" : "integer", //数据总数
"code" : "integer", //结果码 200:成功
"count" : "integer", //请求返回的数据总数
"message" : "string" //当状态码不是200时,错误信息
}
# 统一搜索分类模块接口
# 获取统一搜索分类模块
POST /modules
# 请求类型:Content-Type
application/json
# 请求参数
无
# 返回结果
| 状态码 | 说明 | 返回值 | 响应头 |
|---|---|---|---|
| 200 | 成功响应 | ApiResultCollection«UdsModulesDetail» | 无 |
| 201 | Created | 无 | 无 |
| 401 | Unauthorized | 无 | 无 |
| 403 | Forbidden | 无 | 无 |
| 404 | Not Found | 无 | 无 |
# 请求示例
POST /modules
Content-Type: application/json
# 返回示例
Content-Type: application/json
{
"data" : [ { //请求返回的数据
"id" : "string", //模块id
"name" : "string", //模块名称
"icon" : "string", //图标
"code" : "string", //模块code
"orderNo" : "integer", //排序号
"type" : "integer" //模块类型(1:文章,2:新闻 ......)
} ],
"total" : "integer", //数据总数
"code" : "integer", //结果码 200:成功
"count" : "integer", //请求返回的数据总数
"message" : "string" //当状态码不是200时,错误信息
}
← 发消息状态查询接口定义 数据源接入 →