# 公告模块接口

# 接口调用方式

本接口为主OA Http Rest，允许被异构系统远程调用，调用前需要调用Rest接口文档 (opens new window)获取Restful token身份凭证。

# 公告相关结构说明

公告由多个版块组成，版块下有若干公告，故需要知道“公告版块”和“公告”的数据对象结构。

# 公告版块对象示例

{
  "id" : -5312468945559469360,
  "accountId" : -5254486337235892280,
  "auditFlag" : false,
  "auditUser" : 0,
  "createDate" : 1395637157000,
  "createUser" : 0,
  "description" : "",
  "spaceType" : 2,
  "topCount" : 0,
  "typeName" : "人事公告",
  "updateDate" : 1397631508000,
  "updateUser" : -7437328440410879447,
  "usedFlag" : true,
  "managerUserIds" : "-8361687019900091749",
  "sortNum" : 0
}

# 公告版块属性说明

参数	说明
id	公告版块主键
accountId	公告版块所属单位ID
auditFlag	公告版块是否审核
auditUser	公告版块审核员ID
createDate	公告版块创建时间
createUser	公告版块创建人ID
description	公告版块描述
spaceType	公告版块所在空间类型，3：集团 2：单位 1：部门
topCount	公告版块允许公告最大置顶数
typeName	公告版块名称
updateDate	公告版块最近更新时间
updateUser	公告版块最近更新人员
usedFlag	公告版块是否使用
managerUserIds	公告版块管理员ID，以英文逗号分隔，如：12345,67890
sortNum	公告版块排序号

# 公告对象示例

{
  "id" : -8482438586517405384,
  "title" : "我的公告",
  "publishScope" : "Department|4367506212596958822",
  "publishDepartmentId" : 4367506212596958822,
  "brief" : "",
  "keywords" : "",
  "dataFormat" : "HTML",
  "createDate" : 1397631709000,
  "createUser" : -8361687019900091749,
  "auditDate" : null,
  "auditUserId" : null,
  "auditAdvice" : null,
  "publishDate" : 1397631709000,
  "publishUserId" : -8361687019900091749,
  "pigeonholeDate" : null,
  "pigeonholeUserId" : null,
  "pigeonholePath" : null,
  "updateDate" : 1397631709000,
  "updateUser" : -8361687019900091749,
  "readCount" : 0,
  "topOrder" : 0,
  "state" : 30,
  "deletedFlag" : false,
  "accountId" : -5254486337235892280,
  "typeId" : -5312468945559469360,
  "typeName" : "人事公告",
  "attachmentsFlag" : false,
  "publishMemberName" : "张三",
  "publishDeptName" : "平台架构部",
  "showPublishUserFlag" : false
}

# 公告属性说明

参数	说明
id	公告主键
title	公告标题
publishScope	公告发布范围
publishDepartmentId	公告发布部门
brief	公告摘要
keywords	公告关键字
dataFormat	公告正文格式
createDate	公告创建时间
createUser	公告创建人ID
auditDate	公告审核时间
auditUserId	公告审核员ID
auditAdvice	公告审核意见
publishDate	公告发布时间
publishUserId	公告发布者ID
pigeonholeDate	公告归档时间
pigeonholeUserId	公告归档者ID
pigeonholePath	公告归档目录
updateDate	公告最近更新时间
updateUser	公告最近更新人员
readCount	公告阅读次数
topOrder	大于0为置顶，没有其他顺序
state	公告状态，0：草稿；10：已提交未审核；20：已审核未发布；30：已发布未归档；40：审核未通过；100：已归档
deletedFlag	公告是否删除
typeId	公告所在版块ID
typeName	公告所在版块名称
attachmentsFlag	公告是否有附件
publishMemberName	公告发布人员名称
publishDeptName	公告发布部门名称
showPublishUserFlag	是否显示公告发布人员

# 单位公告版块列表

获取某一单位下的公告版块列表。

接口请求说明：

http请求方式：GET
http://ip:port/seeyon/rest/bulletin/bulType/unit/{unitId}
例如：http://127.0.0.1:8088/seeyon/rest/bulletin/bulType/unit/1438182393845429500

注：请求需要携带token，否则无法使用，获取并传递token方法参考：https://open.seeyoncloud.com/seeyonapi/781/

参数说明：

参数	是否必须	说明
unitId	是	单位ID

返回说明

正常情况下，会返回的是JSON格式公告板块信息，JSON数据包参考：公告版块对象示例

参数说明请参考：公告版块属性说明

# 集团公告版块列表

获取集团下的公告版块列表。

接口请求说明：

http请求方式：GET
http://ip:port/seeyon/rest/bulletin/bulType/group
例如：http://127.0.0.1:8088/seeyon/rest/bulletin/bulType/group

注：请求需要携带token，否则无法使用，获取并传递token方法参考：https://open.seeyoncloud.com/seeyonapi/781/

参数说明：

根据此URI直接访问即可，无需参数。

返回说明

正常情况下，会返回的是JSON格式公告板块信息，JSON数据包参考：公告版块对象示例

参数说明请参考：公告版块属性说明

# 有权限的公告列表(指定版块)

获取指定版块下某个人有权限能看到的公告列表数据。

接口请求说明：

http请求方式：GET
http://ip:port/seeyon/rest/bulletin/bulType/{typeId}?ticket={ticket}
例如：http://127.0.0.1:8088/seeyon/rest/bulletin/bulType/1438182393845429500?ticket=macx

注：请求需要携带token，否则无法使用，获取并传递token方法参考：https://open.seeyoncloud.com/seeyonapi/781/

比如typeId=跳蚤市场版块ID，ticket=老王的登录名，则返回数据是老王在跳蚤市场版块能看到的全部公告。

参数说明：

参数	是否必须	说明
typeId	是	公告版块ID
ticket	是	用户的OA登录名，或使用SSO单点登录认证提取的ticket，可以尝试用该集团/单位公告管理员帐号获取最大权限

返回说明

正常情况下，会返回的是JSON格式公告信息，JSON数据包参考：公告对象示例

参数说明请参考：公告属性说明

# 有权限公告列表（指定单位）

获取指定单位下某个人有权限能看到的公告列表数据。

接口请求说明：

http请求方式：GET
http://ip:port/seeyon/rest/bulletin/unit/{unitId}?ticket={ticket}
例如：http://127.0.0.1:8088/seeyon/rest/bulletin/unit/967547186016371000?ticket=macx

注：请求需要携带token，否则无法使用，获取并传递token方法参考：https://open.seeyoncloud.com/seeyonapi/781/

比如unitId=深圳分公司ID，ticket=老王的登录名，则返回数据是老王在深圳分公司能看到的全部公告。

参数说明：

参数	是否必须	说明
unitId	是	单位ID
ticket	是	用户的OA登录名，或使用SSO单点登录认证提取的ticket，可以尝试用该单位公告管理员帐号获取最大权限

返回说明

正常情况下，会返回的是JSON格式公告信息，JSON数据包参考：公告对象示例

参数说明请参考：公告属性说明

# 新增公告(Since:V5.6)

创建公告【如果要直接发布公告，请取消栏目审核】。

接口请求说明：

http请求方式：POST
http://ip:port/seeyon/rest/bulletin/

注：请求需要携带token，否则无法使用，获取并传递token方法参考：https://open.seeyoncloud.com/seeyonapi/781/

参数说明：

参数	是否必须	说明
typeId	是	公告栏目ID
senderuser	是	发送公告人员的登录名。【公告发起人必须是对应栏目的管理员，拥有发起权限，否则无法发起公告】
content	是	正文信息。
contentName	是	赋值""信息。
dataFormat	是	正文类型，现阶段只支持HTML 的正文格式，赋值"html".
ext5	是	赋值""信息。
publishDepartmentId	是	发起人员部门ID，赋值""信息。
publishScope	是	接受公告范围，如果是草稿状态：赋值""信息。如果直接发送，赋值例如【"Post\|6279300026643924673,Level\|-6807464151015665857"】
title	是	公告标题
ext3	是	草稿状态：赋值"null";直接发布:赋值"0"
state	是	草稿状态：赋值"0";直接发布:赋值"30"
publishDate	是	发布日期，赋值例如"2015-06-08 17:03:09"
publishUserId	是	发布人ID赋值""
createDate	是	创建日期，赋值例如"2015-06-08 17:03:09"
expireDate	是	截止公示期日期，赋值例如"2015-06-08 17:03:09",V8.0SP1及以下版本不需要传递
ext1	是	访问记录信息赋值"0"
ext2	是	是否允许打印赋值"0 或者1"
showPublishUserFlag	是	是否显示发布人赋值"false 或者 true"
updateDate	是	更新日期，赋值例如"2015-06-08 17:03:09"
updateUser	是	更新人员ID，赋值""
readCount	是	阅读计数，赋值0
attachmentsFlag	是	附件标记，暂不支持附件，，赋值"false"

返回说明

发布成功，会返回公告JSON信息，如果发布失败返回-1.

返回参数说明

请参考公告列表（指定版块）返回参数说明

# 通过公告ID获取公告信息(Since:V7.0)

通过公告ID获取公告信息。

接口请求说明：

http请求方式：GET
http://ip:port/seeyon/rest/bulletin/{bulletinId}

注：请求需要携带token，否则无法使用，获取并传递token方法参考：https://open.seeyoncloud.com/seeyonapi/781/

参数说明：

参数	是否必须	说明
bulletinId	是	公告ID

返回说明

查询成功，会返回公告JSON信息，如果查询失败返回-1.

返回参数说明

请参考公告列表（指定版块）返回参数说明

# 通过人员登录名返回对应人员的公告列表(Since:V7.0)

通过人员登录名返回，对应人员的公告列表。

接口请求说明：

http请求方式：GET
http://ip:port/seeyon/rest/bulletin/user/loginName/{loginName}

注：请求需要携带token，否则无法使用，获取并传递token方法参考：https://open.seeyoncloud.com/seeyonapi/781/

参数说明：

参数	是否必须	说明
loginName	是	人员登录名称
firstNum	否	分页开始页数，从0开始
pageSize	否	分页每页数量

返回说明

查询成功，会返回公告JSON信息，如果查询失败返回-1.

返回参数说明

请参考公告列表（指定版块）返回参数说明

# 通过人员登录名返回对应人员的公告总数(Since:V7.0)

通过人员登录名返回，对应人员的公告总数。

接口请求说明：

http请求方式：GET
http://ip:port/seeyon/rest/bulletin/count/loginName/{loginName}

注：请求需要携带token，否则无法使用，获取并传递token方法参考：https://open.seeyoncloud.com/seeyonapi/781/

参数说明：

参数	是否必须	说明
loginName	是	人员登录名称

返回说明

查询成功，会返回公告总数信息，如果查询失败返回 1，message:获取人员信息异常.

返回参数说明

参数	说明
code	请求返回信息 0：成功，1：失败
dataCount	请求成功公告总数
message	请求失败，获取人员信息异常！

编撰人：het

快速跳转

公告模块接口

← 新闻模块讨论模块 →