@myyzs
2021-07-13T01:42:46.000000Z
字数 2098
阅读 108
公告
| 环境 | 域名 |
|---|---|
| 测试 | https://qy-ci.fdccloud.com |
| 预发 | https://qy-qa.fdccloud.com |
| 生产 | https://www.fdccloud.com |
接口地址:
HOST/api/tenant-open/get-notice-sort?access_token=ACCESS_TOKEN
传参方式:
GET
返回结果：
成功
{
"errcode": 0,
"errmsg": "ok",
"data": [{
"sort_id": 1,
"sort_name": "企业通知"
}]
}
失败
{
"errcode" => "错误代码",
"errmsg" => "错误信息",
"data" => ""
}
| 参数 | 值 | 说明 |
|---|---|---|
| sort_id | 1 | 内置分类 “企业通知” |
| sort_id | 2 | 内置分类 “新闻” |
接口地址:
HOST/api/tenant-open/get-notice-list?access_token=ACCESS_TOKEN
传参方式:
POST
参数
{
"sort_id" : "分类id",
"page_index" :1,
"page_size" : 20,
"user_code" : "zhangs01",
"keyword" : "abc",
"has_cover_img" : 0
}
| 参数 | 必填 | 说明 |
|---|---|---|
| sort_id | 否 | 如果传了sort_id则会返回指定分类下的公告，否则返回全部分类下的公告 |
| page_index | 否 | 翻页，默认为第1页 |
| page_size | 否 | 分页数量，默认20条数据 |
| user_code | 是 | 用户代码 |
| keyword | 否 | 搜索关键字，支持公告标题和公告发布者 |
| has_cover_img | 否 | 是否含有封面：0-全部返回，不过滤；1-只返回没封面的；2-只返回有封面 |
返回结果：
成功
{
"errcode": 0,
"errmsg": "ok ",
"data": {
"total_count": 192,
"list": [{
"notice_id": 27,
"title": "放假通知",
"author": "人事部",
"cover_img": "公告封面",
"overview": "内容概要",
"content": "公告内容详情富文本或者链接地址",
"create_time": "2020-01-01 10:01:02",
"notice_type": 1,
"sort_id": 1,
"from": "yzs",
"attachments": [{
"file_url": "https://oss-xx/x",
"file_name": "技术文档.pdf",
"file_size": 10871476
}]
}]
}
}
失败
{
"errcode" => "错误代码",
"errmsg" => "错误信息",
"data" => ""
}
| 参数 | 说明 |
|---|---|
| total_count | 该分类下的公告总条数 |
| notice_id | 公告id |
| title | 公告标题 |
| author | 公告发送者 |
| cover_img | 公告封面 |
| overview | 公告的内容概要 |
| content | 公告的内容 |
| notice_type | 公告类型 1:公告内容为富文本 2：公告内容为跳转链接 |
| sort_id | 公告分类id |
| from | 公告来源 yzs,erp等 |
| attachments | 公告附件相关信息 |
| file_url | 附件下载地址 |
| file_name | 附件名称 |
| file_size | 附件大小，单位字节B |
接口地址:
HOST/api/tenant-open/get-notice-detail?access_token=ACCESS_TOKEN
传参方式:
POST
参数
{
"notice_id" : "公告id",
"user_code" : "zhangs01"
}
| 参数 | 必填 | 说明 |
|---|---|---|
| notice_id | 是 | 公告id |
| user_code | 是 | 用户代码,判断公告权限用 |
返回结果：
成功
{
"errcode": 0,
"errmsg": "ok ",
"data": {
"notice_id": 27,
"title": "放假通知",
"author": "人事部",
"cover_img": "公告封面",
"overview": "内容概要",
"content": "公告内容详情富文本或者链接地址",
"create_time": "2020-01-01 10:01:02",
"notice_type": 1,
"sort_id": 1,
"from": "yzs",
"attachments": [{
"file_url": "https://oss-xx/x",
"file_name": "技术文档.pdf",
"file_size": 10871476
}]
}
}
失败
{
"errcode" => "错误代码",
"errmsg" => "错误信息",
"data" => ""
}
| 参数 | 说明 |
|---|---|
| notice_id | 公告id |
| title | 公告标题 |
| author | 公告发送者 |
| cover_img | 公告封面 |
| overview | 公告的内容概要 |
| content | 公告的内容 |
| notice_type | 公告类型 1:公告内容为富文本 2：公告内容为跳转链接 |
| sort_id | 公告分类id |
| from | 公告来源 yzs,erp等 |
| attachments | 公告附件相关信息 |
| file_url | 附件下载地址 |
| file_name | 附件名称 |
| file_size | 附件大小，单位字节B |