完整的接口解决方案说明书讲解.doc

文档编号： T-JKJS 文档版本： 0.01 项目编号： XX-DX- PECS 《XX电信工程外部协作系统》 Project Exterior Cooperation System 施工单位接口技术解决方案 编写人： 南疯 日期： 2006-10-30 审核人： 日期： 批准人： 日期： XXXXXX信息科技股份有限公司 地址： XXXXXXX 邮编：XXXXXX 电话： XXXXXXXX 传真：XXXXXX 网站： XXXXXXXXX 修改记录（Revision Chart） 版本号 批准人 修改人 修改日期 修改记录 0.01 南疯 2006-10-30 第一次创建 0.02详细修改记录： 序号 内容 1 引言 1.1 编写目的 1.2 覆盖范围 1.3 预期读者与阅读建议 1.4 文档约定 1.5 术语与缩略语 1.6 参考文献 2 概述 3 接口方式 4 接口安全 4.1 接口认证 4.2 数据安全 5 事务处理 6 性能考虑 7 容错处理 8 数据格式 8.1 约定 8.2 施工系统向外协系统发送请求 8.2.1 请求查询一个业务数据 8.2.2 新增一条记录，得到记录的键值 8.2.3 修改一条记录 8.2.4 删除一条记录 8.2.5 文档上传 8.2.6 一条记录中一个文档字段上传多个文件 8.2.7 补充上传文档 8.2.8 在记录中删除一个文档 8.2.9 获得文档的基本信息 8.2.10 获得文档的所有兄弟信息 8.2.11 获得文档的所有父亲信息 8.2.12 下载一个文档 8.2.13 获得字典 8.3 外协系统向施工系统发送请求 8.3.1发送变更后的数据 8.3.2发送变更后的字典 8.3.3文档发送请求 9 信息数据项 9.1 数据表 9.2 字段信息 9.3 字典类型 10 网页地址 11 Web Service接口 11.1 接口命名规范 11.2 输入参数 11.3 输出参数 11.4 外协系统提供的其他接口 12 附录：待定问题 1 引言 1.1 编写目的 本文档为XX电信工程外部协作系统（以下简称外协系统）与电信工程施工单位内部系统（以下简称施工系统）接口技术解决方案，以此作为外协系统与施工系统实施接口的技术方案依据和项目设计标准。 1.2 覆盖范围 XX电信工程外部协作系统项目组 施工系统接口开发技术组 1.3 预期读者与阅读建议 XX电信企业信息化部 XX电信工程建设部 XXXX公司开发人员 施工系统开发人员 1.4 文档约定 粗体正文表示强调内容 红色正文表示未完成或需要今后考虑的内容 蓝色正文表示待讨论内容 1.5 术语与缩略语 术语、缩略语 定 义 外协系统 XX电信工程外部协作系统 施工系统 电信工程施工单位内部系统 PECS XX电信工程外部协作系统英文简称 1.6 参考文献 (XXXX) 2 概述 建设XX电信工程外部协作系统的目标，是在工程项目的管理、建设、使用和实施单位之间搭建起数据交换和协同工作的信息平台，延伸与拓展工程建设管理信息化的应用范围，实现通信工程建设过程的信息化管理，促进工程项目的管理部门、建设部门、实施部门和使用部门之间业务流程协调有序地开展，实现工程项目设计、施工、监理管理功能，将相关的设计、施工、监理单位纳入到工程建设管理中，完善工程项目建设过程管理体系，通过信息化推动管理的规范化，在信息化的应用过程中不断探索市场环境下工程建设管理的新思路和新方法。 根据工程部业务工作的实际情况，项目首先满足工程建设管理中应用最广泛、问题最突出的基本需求。 项目功能需求包括： ? 建立工程外部协作系统与MSS等系统的接口； ? 建立设计协作服务、监理协作服务、施工协作服务模块，为邮电设计院、电话监理公司和电信工程公司提供工程部所需的协作服务，保证工程建设