"该文档是关于致远协创协同办公系统A8-M平台API的参考手册,主要介绍了如何使用API进行新闻和公告的发布,以及服务的启用、编码、验证和组织模型管理等。"
在协同办公系统中,API的使用对于集成不同模块和实现自动化操作至关重要。本手册详细讲解了如何利用API接口来实现新闻和公告的发布功能。服务名为`documentService`,提供了两个关键方法:`exportRecentNews`用于新闻发布,`exportRecentAccountBulletin`用于公告发布。
1. **新闻发布**
- `exportRecentNews`方法用于导出最近的新闻。需要提供以下参数:
- `token`: 通过登录验证获取的身份令牌。
- `accountId`: 需要导出新闻的单位ID。
- `ticket`: SSO成功后由外部系统生成的身份令牌。
- `firstNum`: 指定要导出的新闻第一条的起始位置(从0开始,用于分页)。
- `pageSize`: 每次导出的新闻数量。
返回值为XML格式的新闻数据,如果操作成功,否则抛出`ServiceException`。
2. **公告发布**
- `exportRecentAccountBulletin`方法用于导出指定单位最近的公告。需要的参数包括:
- `token`: 登录验证后获得的身份令牌。
- `ticket`: SSO认证成功后由外部系统产生的身份令牌。
这两个方法都是为了将A8系统的新闻和公告数据导出,以便于在外网发布或者封装成标准portlet。
3. **API启用与编码**
- 开发者需要启用Web服务,并配置好开发环境,支持Java和C#两种编程语言。
- 对于Java,需要生成ADBClientStub并编写客户端代码。
- 对于C#,则需添加服务引用并编写相应的客户端代码。
4. **验证服务**
- 提供了登录验证功能,通过`UserToken`实体进行身份验证。
5. **组织模型管理**
- 包括单位管理(AccountInfoParam_All实体)、人员管理和部门管理。
- 单位管理涉及创建、获取、删除和修改单位信息。
- 人员管理涵盖人员的创建、信息获取、修改、删除以及启用/停用操作,还有修改密码的功能。
- 部门管理未在此摘要中详细展开,但通常会包含部门的创建、查询、修改和删除等操作。
这个API参考手册对于开发者来说是一份重要的资源,它详细阐述了如何与致远协创协同办公系统A8-M平台进行交互,实现各种业务功能。通过理解和运用这些API,开发者可以高效地集成系统、自动化工作流程,提升办公效率。