智简魔方文档

GET 公告详情

接口概览

项目内容
文档类型前台接口
请求方式GET
接口地址/console/v1/announcement/{id}
所属业务插件
来源模块/系统公告中心
认证方式Bearer Token(用户令牌)

完整请求

请求

bash
正在加载示例…

失败请求

bash
正在加载示例…

接口说明

公告详情

请求参数

名称位置类型必选说明
idpathinteger(int32)是公告 ID

成功响应

json
正在加载示例…

失败响应 400:请求参数或业务校验失败

json
正在加载示例…

失败响应 401:未认证或登录已失效

json
正在加载示例…

失败响应 403:无权执行当前操作

json
正在加载示例…

失败响应 404:接口或业务资源不存在

json
正在加载示例…

失败响应 500:服务器内部错误

json
正在加载示例…

响应状态

状态码状态码含义说明数据模型
200OK成功响应内联对象
400Bad Request请求参数或业务校验失败内联对象
401Unauthorized未认证或登录已失效内联对象
403Forbidden无权执行当前操作内联对象
404Not Found接口或业务资源不存在内联对象
500Internal Server Error服务器内部错误内联对象

响应参数

状态码 200

名称类型必选约束中文名说明
statusinteger(int32)否——状态码
msgstring否——提示信息
dataobject否———
data.announcementobject否——公告
data.announcement.idinteger(int32)否——公告 ID
data.announcement.addon_idcsmart_announcement_type_idinteger(int32)否——分类 ID
data.announcement.typestring否——分类名
data.announcement.titlestring否——标题
data.announcement.contentstring否——内容
data.announcement.keywordsstring否——关键字
data.announcement.attachmentstring否——附件
data.announcement.create_timeinteger(int32)否——创建时间
data.announcement.update_timeinteger(int32)否——更新时间
data.announcement.prevobject否——上一条公告
data.announcement.prev.idstring | integer否——公告 ID
data.announcement.prev.titlestring否——标题
data.announcement.nextobject否——下一条公告
data.announcement.next.idstring否——公告 ID
data.announcement.next.titlestring否——标题

失败状态码 400、401、403、404、500 共用以下结构:

名称类型必选约束中文名说明
statusinteger(int32)是——错误状态码
msgstring是——错误提示