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

文档编号：T—JKJS文档版本：0.01项目编号：XX-DX- PECS《XX 电信工程外部协作系统》Project Exterior Cooperation System施工单位接口技术解决方案编写人：南疯日期:2024—10—30审核人：日期：批准人：日期:XXXXXX 信息科技股份有限公司地址:XXXXXXX邮编：XXXXXX电话:XXXXXXXX传真:XXXXXX网站：XXXXXXXXX修改记录（Revision Chart）版本号批准人修改人修改日期0。01南疯2024—10—300。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 网页地址 11Web 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 电信工程...