文档介绍：完整的接口解决方案说明书
文档编号：
T-JKJS
文档版本：

项目编号：
XX-DX- PECS
《XX电信工程外部协作系统》
Project Exterior Cooperation System

施工单位接口技术解决方案
编写人：
南疯
日期：
2006-10-30
审核人：
日期：

批准人：
日期：

XXXXXX信息科技股份有限公司

地址：
XXXXXXX
邮编：XXXXXX
电话：
XXXXXXXX
传真：XXXXXX
网站：
XXXXXXXXX
修改记录（Revision Chart）
版本号
批准人
修改人
修改日期
修改记录

南疯
2006-10-30
第一次创建

：
序号
内容

1 引言
编写目的
覆盖范围
预期读者与阅读建议
文档约定
术语与缩略语
参考文献
2 概述
3 接口方式
4 接口安全
接口认证
数据安全
5 事务处理
6 性能考虑
7 容错处理
8 数据格式
约定
施工系统向外协系统发送请求
请求查询一个业务数据
新增一条记录，得到记录的键值
修改一条记录
删除一条记录
文档上传
一条记录中一个文档字段上传多个文件
补充上传文档
在记录中删除一个文档
获得文档的基本信息
获得文档的所有兄弟信息
获得文档的所有父亲信息
下载一个文档
获得字典
外协系统向施工系统发送请求

9 信息数据项
数据表
字段信息
字典类型
10 网页地址
11 Web Service接口
接口命名规范
输入参数
输出参数
外协系统提供的其他接口
12 附录：待定问题

1 引言
编写目的
本文档为XX电信工程外部协作系统（以下简称外协系统）与电信工程施工单位内部系统（以下简称施工系统）接口技术解决方案，以此作为外协系统与施工系统实施接口的技术方案依据和项目设计标准。
覆盖范围
XX电信工程外部协作系统项目组
施工系统接口开发技术组
预期读者与阅读建议
XX电信企业信息化部
XX电信工程建设部
XXXX公司开发人员
施工系统开发人员
文档约定
粗体正文表示强调内容
红色正文表示未完成或需要今后考虑的内容
蓝色正文表示待讨论内容
术语与缩略语
术语、缩略语
定义
u 接口数据传输采用XML数据交换格式，utf-8编码。
u 在外协系统中提供Web Service的API接口。提供由施工系统调用获得信息；并且提供施工系统提交信息的API接口。
u 同样，在施工系统中提供Web Service的API接口。提供由外协系统提交信息的API接口。
u 考虑到工程外协中的数据信息不仅包括了XX电信工程公司的数据而且还包含了其他的施工单位的数据信息。而这些单位也各有其各自工程应用系统。这样，外协系统对各个施工单位系统所提供的接口API及其参数信息、格式均是统一的。同时，也要求各个施工单位所提供的接口API及其参数、格式等也必须要求统一。外协系统与施工系统属于一对多的关系。
u 外协系统要求能够