BigAnt4.0 WebService接口规范文档
系统名称BigAnt4.0Websrvce服务接口
版本V1.6
项目负责人
作者张维忠
文档提交日期2014-10-15
杭州艾朴软件有限公司
(版权所有,翻版必究)
修改记录
No 修改后
版本号
修改内容简介修改日期修改人
1 V1.1 增加了群组接口：6.4.
2 – 6.4.7；2014.12.10 张维忠
2 V1.1 用户增加了接口：6.1.7 2014.12.1
3 张维忠
3 V1.2 1、消息增加了接口：6.3.3 – 6.3.6；
2、修改了接口调用端口：6669改为8000 2014.12.17 张维忠
4 V1.3 增加了用户禁用启用的接口:6.1.8 2014.12.29 张维忠
5 V1.4 增加了移除部门成员的接口：6.2.
6 2015.01.15 张维忠
6 V1.5 增加了BigAnt插件说明：第7章2015.01.2
7 张维忠
7 V1.6 增加了BigAnt外部启动说明：第8章2015.01.27 张维忠
目录
1背景 (5)
2规范适用对象说明 (5)
3接口配置 (5)
4响应输出格式规范 (5)
4.1XML输出格式 (5)
4.2json输出格式 (6)
5返回码定义 (6)
6API接口细则 (7)
6.1用户接口 (7)
6.1.1用户新增 userAdd (7)
6.1.2用户删除 userDelete (8)
6.1.3用户更新 userUpdate (9)
6.1.4用户信息查询 userInfo (10)
6.1.5用户身份验证 userValid (11)
6.1.6设置用户密码 setPassword (11)
6.1.7列出用户（支持分页） listUser (12)
6.1.8禁用启用帐号 disableUser (13)
6.2部门接口 (14)
6.2.1部门新增 deptAdd (14)
6.2.2部门删除 deptDelete (15)
6.2.3部门更新 deptUpdate (16)
6.2.4部门信息查询 deptInfo (16)
6.2.5设置部门成员 deptSetMember (17)
6.2.6移除部门成员 deptRemoveMember (18)
6.3消息接口 (19)
6.3.1发送消息 sendMessage (19)
6.3.2发送公告 sendBoard (20)
6.3.3向群组成员群发消息 sendMessageByGroup (20)
6.3.4向部门成员群发消息 sendMessageByPath (21)
6.3.5列出消息记录（支持分页） msgList (22)
6.3.6查询消息内容 getMsgContent (23)
6.4群组接口 (24)
6.4.1群组新增 groupAdd (24)
6.4.2群组删除 groupDelete (25)
6.4.3群组修改 groupUpdate (25)
6.4.4群组信息查询 groupInfo (26)
6.4.5群组踢出成员groupKickMember (27)
6.4.6获取群组成员groupListMember (27)
6.4.7群组设置成员groupSetMember (28)
6.5角色接口 (29)
6.5.1角色新增 roleAdd (29)
6.5.2角色删除 roleDelete (30)
6.5.3角色更新 roleUpdate (31)
6.5.4角色信息查询 roleInfo (31)
6.5.5设置角色成员 roleSetMember (32)
7BigAnt插件说明 (33)
7.1插件类型 (33)
7.2插件代码示例 (33)
7.2.1Tab插件 (33)
7.2.2右键插件 (34)
7.2.3主菜单插件 (34)
7.3插件参数说明 (35)
8BigAnt外部启动说明 (36)
8.1外部调用客户端启动 (36)
8.1.1Cmd方式启动 (36)
8.1.2协议方式启动 (36)
8.1.3Html示例 (36)
8.1.4参数说明 (36)
8.2外部启动聊天窗口 (37)
8.2.1协议方式启动 (37)
8.2.2Html示例 (37)
8.2.3参数说明 (37)
1背景
本文旨在为第三方合作系统访问BigAnt提供统一的SOAP接口调用与交互规范。
本文中描述的规范包括BigAnt人员接口、部门接口、群组接口、角色接口、消息接口等。
2规范适用对象说明
本规范仅适用于需要和BigAnt进行集成，实现数据同步、消息提醒、单点登录等功能的第三方系统。
3接口配置
接口主要配置两个参数，用文本编辑器打开BigAntConsole站点根目录下的config文件夹中的config.inc.php文件即可修改。配置项如下：
●ACCESS_TOKEN：用户调用接口时的口令，旨在保证接口安全，由管理员任意指定字符串。
●RESULT_TYPE：定义接口返回值的类型，目前支持XML和JSON两种。
4响应输出格式规范
响应数据包的格式由BigAnt服务端管理员在服务端配置文件中配置，目前支持XML和JSON。
4.1XML输出格式
●文档编码格式UTF-8
●单一操作数据返回格式：code返回操作状态码，message返回操作结果提示，data节点返
回操作对象信息
●批量操作数据返回格式：单个item节点返回具体的操作结果：
4.2json输出格式
API调用时如果接口配置文件中RESULT_TYPE为json（大小写不敏感），则正常响应包符合如下规范的json字符串：
●http响应头中的Content-Type指定为application/json,charset=utf-8
●字符串编码格式是UTF-8
字符串内容是XML输出数据所对应的PHP数组的标准JSON字符串
5返回码定义
BigAnt4.0 WebService接口调用过程中可能会返回的返回码定义如下表所示：
类别Code Message
全局10000 ACCESS TOKEN无效10001 未定义的错误类型
用户接口101000 用户操作成功101001 用户操作失败101002 用户已经存在101003 指定的用户不存在101004 密码错误
101005 该用户帐号已经存在101006 用户身份验证成功
部门接口102200 部门操作成功102201 部门操作失败
102202 部门已经存在102203 部门不存在102204 部门重名
消息接口103000 消息操作成功103001 网络连接错误103002 帐号或密码错误
群组接口104000群组操作成功104001 群组操作失败104003 指定的群组不存在104004 用户已经在该群中104005 用户不在该群中
角色接口105000 角色操作成功105001 角色操作失败105002 角色已经存在105003 指定的角色不存在105004 角色重名
6API接口细则
以下接口返回数据均是以XML格式为demo，JSON格式的字符串内容是XML输出数据所对应的PHP数组的标准JSON字符串。
6.1用户接口
WSDL说明文件地址：
http://服务器ip:8000/api/user.html?wsdl
6.1.1用户新增 userAdd
6.1.1.1接口参数
参数名类型描述
loginName string 用户帐号
userName string 用户名称
passWordType int 密码类型 0 为明码 1为32位MD5码
passWord string 密码
itemIndex int 人员排序
email string 邮箱
mobile string 手机号码
phone string 座机
sex int 性别 1 男 2 女jobTitle string 职务
description string 描述
isSuper int 是否超级用户 1 是 0 否disabled int 帐号是否禁用 1 是 0 否
token string 接口调用token, 应与配置文件中的设置的ACCESS_TOKEN一致
6.1.1.2返回值
●Response XML 示例
●Response XML 标签说明
标签名描述
userid 用户id
6.1.2用户删除 userDelete
6.1.2.1接口参数
参数名类型描述
loginNames string 用户帐号，支持批量操作，帐号之间以逗号分隔
token string 接口调用token, 应与配置文件中的设置的ACCESS_TOKEN一致
6.1.2.2返回值
●Response XML 示例
Response XML 标签说明
标签名描述
userid 用户id，用户不存在则为0
loginname 用户帐号
6.1.3用户更新 userUpdate
6.1.3.1接口参数
参数名类型描述
userId int 用户Id
loginName string 用户帐号
userName string 用户名称
passWordType int 密码类型 0 为明码 1为32位MD5码passWord string 密码
itemIndex int 人员排序
email string 邮箱
mobile string 手机号码
phone string 座机
sex int 性别 1 男 2 女
jobTitle string 职务
description string 描述
isSuper bool 是否超级用户 1 是 0 否
disabled bool 帐号是否禁用 1 是 0 否
token string 接口调用token, 应与配置文件中的设置的ACCESS_TOKEN一致
6.1.3.2返回值
●Response XML 示例
6.1.4用户信息查询 userInfo 6.1.4.1接口参数
参数名类型描述
loginName string 用户帐号
token string 接口调用token, 应与配置文件中的设置的ACCESS_TOKEN一致
6.1.4.2返回值
●Response XML 示例
●Response XML 标签说明
标签名描述
userid 用户id，用户不存在则为0
loginname 用户帐号
username 用户名称
itemindex 人员排序
email 邮箱
mobile 手机号码
phone 座机
sex 性别
jobtitle 职务
description 描述
issuper 是否超级用户 1 是 0 否
disabled 帐号是否禁用 1 是 0 否6.1.5用户身份验证 userValid
6.1.5.1接口参数
参数名类型描述
loginName string 用户帐号
passWord string 密码
token string 接口调用token, 应与配置文件中的设置的ACCESS_TOKEN一致
6.1.5.2返回值
Response XML 示例
6.1.6设置用户密码 setPassword 6.1.6.1接口参数
参数名类型描述
loginName string 用户帐号
passWord string 密码
token string 接口调用token, 应与配置文件中的设置的ACCESS_TOKEN一致
6.1.6.2返回值
●Response XML 示例
6.1.7列出用户（支持分页） listUser 6.1.
7.1接口参数
参数名类型描述
pageIndex int 当前页码
pageSize int 每页数据条数
token string 接口调用token, 应与配置文件中的设置的ACCESS_TOKEN一致
6.1.
7.2返回值
●Response XML 示例
Response XML 标签说明
标签名描述
recordcount 总用户数
userid 用户Id
loginname 用户帐号
username 用户名称
itemindex 用户排序号
email 邮箱
mobile 手机
phone 电话
sex 性别 1 男 2女 0 未知
jobtitle 职务
description 用户描述
issuper 是否是超级用户 1 是 0否desabled 是否禁用 1 禁用 0 启用
6.1.8禁用启用帐号 disableUser
6.1.8.1接口参数
参数名类型描述
loginName string 用户帐号
status int 0 表示启用非0 则禁用
token string 接口调用token, 应与配置文件中的设置的ACCESS_TOKEN一致
6.1.8.2返回值
●Response XML 示例
6.2部门接口
WSDL说明文件地址：
http://服务器ip:8000/api/department.html?wsdl
6.2.1部门新增 deptAdd
6.2.1.1接口参数
参数名类型描述
path string 部门路径如：“艾朴软件/技术中心/研发一部”
itemIndex int 部门顺序号
description string 描述
token string 接口调用token, 应与配置文件中的设置的ACCESS_TOKEN一致
6.2.1.2返回值
●Response XML 示例
●Response XML 标签说明
标签名描述
viewid 顶级视图Id
empType 部门类型 4 顶级视图 2 部门
empId 视图Id
6.2.2部门删除 deptDelete
6.2.2.1接口参数
参数名类型描述
path string 部门路径如：“艾朴软件/技术中心/研发一部”
token string 接口调用token, 应与配置文件中的设置的ACCESS_TOKEN一致
6.2.2.2返回值
●Response XML 示例
●Response XML 标签说明
标签名描述
viewid 顶级视图Id
empType 部门类型 4 顶级视图 2 部门
empId 视图Id
6.2.3部门更新 deptUpdate
6.2.3.1接口参数
参数名类型描述
path string 部门路径如：“艾朴软件/技术中心/研发一部”
newName string 新部门名称
itemIndex, int 部门顺序号
description string 描述
token string 接口调用token, 应与配置文件中的设置的ACCESS_TOKEN一致
6.2.3.2返回值
●Response XML 示例
●Response XML 标签说明
标签名描述
viewid 顶级视图Id
empType 部门类型 4 顶级视图 2 部门empId 视图Id
6.2.4部门信息查询 deptInfo
6.2.4.1接口参数
参数名类型描述
path string 部门路径如：“艾朴软件/技术中心/研发一部”
token string 接口调用token, 应与配置文件中的设置的ACCESS_TOKEN一致
6.2.4.2返回值
●Response XML 示例
●Response XML 标签说明
标签名描述
viewid 顶级视图Id
empType 部门类型 4 顶级视图 2 部门
empId 视图Id
name 部门名称
itemindex 部门顺序号
description 描述
6.2.5设置部门成员 deptSetMember
6.2.5.1接口参数
参数名类型描述
path string 部门路径如：“艾朴软件/技术中心/研发一部”
loginNames string 人员帐号，多个帐号以逗号分隔
token string 接口调用token, 应与配置文件中的设置的ACCESS_TOKEN一致
6.2.5.2返回值
●Response XML 示例
●Response XML 标签说明
标签名描述
userid 用户Id
loginname 用户帐号
6.2.6移除部门成员 deptRemoveMember
6.2.6.1接口参数
参数名类型描述
path string 部门路径如：“艾朴软件/技术中心/研发一部”
loginNames string 人员帐号，多个帐号以逗号分隔
token string 接口调用token, 应与配置文件中的设置的ACCESS_TOKEN一致
6.2.6.2返回值
●Response XML 示例
6.3消息接口
WSDL说明文件地址：
http://服务器ip:8000/api/message.html?wsdl
6.3.1发送消息 sendMessage
6.3.1.1接口参数
参数名类型描述
sendLoginName string 发送人帐号
sendUserName string 发送人名称
passWordType int 密码类型， 0 明文 1 32位MD5 sendPassWord string 发送者密码
receivers string 接收者帐号，多个帐号以逗号分隔
contentType string 消息内容类型，Text/Text 纯文本消息、Text/Url url消息、Text/Html html消息
subject string 消息标题
content string 消息内容
attachMent string 附件绝对路径，如无附件则留空
token string 接口调用token, 应与配置文件中的设置的ACCESS_TOKEN一致
6.3.1.2返回值 Response XML 示例
6.3.2发送公告 sendBoard
6.3.2.1接口参数
参数名类型描述
sendLoginName string 发送人帐号
sendUserName string 发送人名称
passWordType int 密码类型， 0 明文 1 32位MD5 sendPassWord string 发送者密码
receivers string 接收者帐号，多个帐号以逗号分隔subject string 公告标题
content string 公告内容
attachMent string 附件绝对路径，如无附件则留空
token string 接口调用token, 应与配置文件中的设置的ACCESS_TOKEN一致
6.3.2.2返回值
Response XML 示例
6.3.3向群组成员群发消息 sendMessageByGroup 6.3.3.1接口参数
参数名类型描述
sendLoginName string 发送人帐号
sendUserName string 发送人名称
passWordType int 密码类型， 0 明文 1 32位MD5
中国移动BOSS系统接口规范——代理接入部分 (Version 1.0) 中国移动通信集团公司 二○○一年八月
目录 1. 总则 (1) 1.1. 概述 (1) 1.2. 原则和目标 (1) 1.3. 适用范围 (2) 1.4. 起草单位 (2) 1.5. 解释权 (2) 2. 接入服务接口总体说明 (3) 2.1. 系统总体接口应用模型 (3) 2.2. 接口实现机制 (4) 2.3. 接口要求 (6) 3. 代理接口说明 (7) 3.1. 接口应用模型 (7) 3.2. 接口网络组织 (8) 3.2.1. 省中心网络接入 (8) 3.2.2. 地市中心网络接入 (9) 3.3. 接口安全控制 (10) 3.3.1. 安全评估 (10) 3.3.2. 访问控制 (11) 3.3.3. 入侵检测 (12) 3.3.4. 口令认证 (12) 3.3.5. 安全审计 (12) 3.3.6. 防（毒）恶意代码 (12) 3.3.7. 加密 (13) 3.3.8. 其他 (13) 3.4. 接口连接管理 (14) 3.4.1. 传输控制 (14) 3.4.2. 通讯服务 (14) 3.4.3. 动态资源管理 (15) 3.5. 接口逻辑管理 (16) 3.5.1. 数据管理 (16)
3.5.1.2. 数据压缩/解压 (16) 3.5.2. 优先级管理 (17) 3.5.3. 交换分发管理 (17) 3.5.4. 完整性管理 (18) 3.5.4.1. 实时交易业务 (19) 3.5.4.2. 批量传输业务 (19) 4. 接口服务详述 (20) 4.1. 业务受理 (20) 4.1.1. 功能界定 (20) 4.1.2. 开户 (21) 4.1.2.1. 业务描述 (21) 4.1.2.2. 接口服务 (21) 4.1.2.2.1. 开户初始接口服务 (21) 4.1.2.2.2. 客户身份检查接口服务 (21) 4.1.2.2.3. 客户信用度初始化接口服务 (21) 4.1.2.2.4. 客户建档接口服务 (22) 4.1.2.2.5. 资源查询接口服务 (22) 4.1.2.2.6. 套餐计划查询接口服务 (22) 4.1.2.2.7. 开户费用计算接口服务 (22) 4.1.2.2.8. 开户确认接口服务 (23) 4.1.2.2.9. 开户单据打印接口服务 (23) 4.1.2.2.10. 开户回退接口服务 (23) 4.1.3. 售不记名卡 (24) 4.1.3.1. 业务描述 (24) 4.1.3.2. 接口服务 (24) 4.1.3.2.1. 不记名卡查询接口服务 (24) 4.1.3.2.2. 不记名卡销售接口服务 (24) 4.1.3.2.3. 单据打印接口服务 (24) 4.1.3.2.4. 单据补打接口服务 (25) 4.1.3.2.5. 卡销售回退接口服务 (25) 4.1.4. 预销 (26) 4.1.4.1. 业务描述 (26) 4.1.4.2. 接口服务 (26)
系统需求规范
编制：审核：批准：
目录 1.简介 (5) 1.1.系统简介 (5) 1.2.文档目的 (5) 1.3.文档范围 (5) 1.4.与其它开发任务/文档的关系 (5) 1.5.需求来源 (5) 1.6.需求编号原则 (5) 1.7.术语和缩写词 (6) 2.参考文档 (7) 3.系统定义 (8) 4.系统结构 (9) 5.功能需求规范 (10) 6.性能需求规范 (11) 7.RAM需求规范 (12) 8.系统安全目标 (13) 9.接口需求规范 (14) 10.系统应用环境 (15) 10.1.气候环境 (15) 10.2.海拔要求 (15) 10.3.防雷要求 (15) 10.4.机械环境 (15) 10.5.电气环境 (15) 10.6.非法访问的保护 (16) 10.7.更严酷的环境 (16) 11.假设及限制条件 (17)
1.简介 1.1.系统简介 提示：对系统进行简要介绍，包括系统的安全目标，安全评估的类型等。 1.2.文档目的 提示：阐明此文档的目的 系统需求规范将用户需求用规范的形式条目化列举出来，每个需求清晰、准确、具体并具备可验证性，是系统后续开发测试的基础。系统需求规范作为用户需求与项目人员沟通的文件，针对的对象主要是项目开发人员、测试人员。 这里的系统需求规范和系统定义阶段产生的系统定义文档比较类似，只是在定义阶段，需求可能是以描述形式体现用户的需求，而不是规范的形式。 1.3.文档范围 1.4.与其它开发任务/文档的关系 提示：如安全计划和设计文档的关系 1.5.需求来源 提示：说明需求规范的来源/产生方式（标准、规范、Subsets、环境、其他相关系统、接口、平台等）及相关证据，可以用图来说明。 1.6.需求编号原则 提示：给出需求编号的原则和定义。文档下面描述的所有需求都要按照这个原则给出编号。 {需求标识方法，如序列化编号、层次化编号、层次化文本标签等方法。应确
系统设计说明书（架构、概要、详细）目录结构 虽然这些文档一般来说公司都是有模板的，但我写这些文档以来基本上是每写一次就把目录结构 给改一次，应该说这是因为自己对这些文档的理解开始加深，慢慢的越来越明白这些文档的作用 和其中需要阐述的东西，觉得这三份文档主要阐述了一个系统的设计和实现过程，从系统分解为层次、层次内的模块以及相互的接口、模块分解为对象以及对象的接口、实现这些对象接口的方法。这次又整了一份，A/ ，欢迎大家指正。 XXX架构设计说明书 （架构设计重点在于将系统分层并产生层次内的模块、阐明模块之间的关系）一?概述 描述本文的参考依据、资料以及大概内容。 二.目的 描述本文编写的目的。 三.架构设计 阐明进行架构设计的总体原则，如对问题域的分析方法。 3.1. 架构分析 对场景以及问题域进行分析，构成系统的架构级设计，阐明对于系统的分层思想。 3.2. 设计思想 阐明进行架构设计的思想，可参考一些架构设计的模式，需结合当前系统的 实际情况而定。 3.3. 架构体系 根据架构分析和设计思想产生系统的架构图，并对架构图进行描述，说明分层的原因、层次的职责，并根据架构图绘制系统的物理部署图，描述系统的部署体系。3.4. 模块划分 根据架构图进行模块的划分并阐明模块划分的理由，绘制模块物理图以及模
块依赖图。 341. 模块描述 根据模块物理图描述各模块的职责，并声明其对其他模块的接口要求。。 3.4.2. 模块接口设计 对模块接口进行设计，并提供一定的伪代码。 XXX概要设计说明书 （概要设计重点在于将模块分解为对象并阐明对象之间的关系） 一.概述 描述本文的参考依据、资料以及大概内容。 二.目的 描述本文的编写目的。 三.模块概要设计 引用架构设计说明书中的模块图，并阐述对于模块进行设计的大致思路。 3.1. 设计思想 阐明概要设计的思想，概要设计的思想通常是涉及设计模式的。 3.2. 模块A 3.2.1. 概要设计 根据该模块的职责对模块进行概要设计（分解模块为对象、描述对象的职责以及声明对象之间的接口），绘制模块的对象图、对象间的依赖图以及模块主要功能的序列图，分别加以描述并相应的描述模块异常的处理方法。 3.2.2. 模块接口实现 阐明对于架构设计中定义的模块接口的实现的设计。 XXX详细设计说明书 （详细设计重点在于对模块进行实现，将模块的对象分解为属性和方法，并阐述 如何实现）
国家标准《信息技术会计核算软件数据接口》（征求意见稿） 编制讲明 一、任务来源 国家标准化治理委员会2002年下达的国家标准项目打算中，列入了《信息技术会计核算软件数据》（编号为20020389—T—424 ）；2004年国家标准化治理委员会又下达《关于调整信息技术会计核算软件数据国家标准打算项目的复函》（标委办函[2004]6号），明确由中华人民共和国审计署、中华人民共和国财政部作为主管部门，组织《信息技术会计核算软件数据》的起草单位和相关单位，承担《信息技术会计核算软件数据接口》国家标准的制定。 二、要紧工作过程 2002年3月上海市技术监督局制定了《信息技术会计核算软件数据接口规范》，并作为地点标准。2002年依照国家标准项目打算中编号为20020398—T—424的国家标准打算项目《信息技术会计核算软件数据》，上海市技术监督局组织相关单位和专家进行该标准的起草工作，于2003年底提出了《信息技术会计核
算软件数据接口规范》国家标准草案文本。 审计署依照工作需要，自1999年以来开展了“会计核算软件数据接口”方面的研究和实践。经国家电子政务治理委员会、国务院信息化工作办公室批准，审计署于2002年2月开始组织研究编写《会计核算软件数据接口》国家标准，于2003年底提出标准草案文本。 2004年2月，依照国家标准化治理委员会“标委办函[2004]6号”—“关于调整《信息技术会计核算软件数据》国家标准打算项目的复函”的精神，审计署计算中心召集上海《信息技术会计核算软件数据》标准起草组成员，审计署南京特派员办事处、南京审计学院等相关专家与人员，在北京对上述两个标准草案文本进行了深入细致的分析研究，综合整理提出了《信息技术会计核算软件数据接口规范（企业、事业单位）（草案稿）》。 2004年3月，依照国家标准化治理委员会关于“要符合国家标准撰写格式及语言规范；要使用数据元素表示；会计核算软件数据输出文件要有文本和XML格式”的要求，组织审计署计算技术中心、财政部会计司、审计署南京特派员办事处、信息产业部电子标准化所、用友公司、金算盘公司、浪潮公司等相关人员共同研究，编制出《信息技术会计核算软件数据接口（征求意见
恒生公司ta与客服系统接口规范范 本(doc 37页) 部门： xxx 时间： xxx 整理范文，仅供参考，可下载自行编辑
登记过户系统与客户服务系统接口规范 文档修改记录
一、接口规范概述 1．用途 本接口规范仅描述登记过户系统给客户服务系统（包括CALL CENTER查询和网站查询）所提供数据的具体内容和形式。 2．数据处理规则为： (a)以文本文件定长记录方式提供数据； 约定：将来需要新增加的字段都增加在尾部，客服系统读记录时，不用校验记录的长度，以保持兼容。
(b)文件的第一行为数据的记录数 (c)最后一行为’END’ (d)文件数据体中，每行代表一条完整记录； (e)换行必须用回车（ODH）、换行（OAH）字符； (f)数据项类型，C:字符型；N:数字；A:字符型，填数字 (g)数字如是负数，第一位用’-‘表示，占用一个整数位 (h)数字左补零右对齐，字符右补空格左对齐； (i)带有小数点的数值型数据，传输时不传小数点；本接口中，没有特 别说明的，都表示2位小数。 (j)带下划线的字段为相应文件记录的主索引； 3．包括内容 本接口包含六个方面的数据：客户帐户信息、账户类确认数据、客户基金份额余额、客户交易流水（包括申请流水和确认流水）、基金分红信息和基金行情信息。 4．内容更新规则为： (a)每日由登记过户系统向客户服务系统提供一次数据； (b)每日所提供的数据仅表示截至到当日做完登记过户操作后的客户信 息和基金行情信息； (c)每次只提供变化（包括新增和更新）的数据；也可不定期提供全部 数据（文件名区分） 二、客户账户信息数据 1．数据生成规则： (a)客户帐户信息包括客户基本信息和基金帐号的登记信息两个方面的 内容，这两个方面的内容同步更新； (b)客户资料和客户的基金帐号资料合在一条记录里形成所谓“客户基 本信息”； (c)客户基本信息既支持新增客户记录模式又支持新增基金帐号记录模 式； (d)客户基本信息还支持修改已有记录模式，销户也算修改记录范畴；
文件修订页
目录 1 范围 (1) 1.1系统概述 (1) 1.2文档概述.................................................................................................错误!未定义书签。 1.3术语与缩略语 (1) 2 引用文档 (1) 3 接口设计 (1) 3.1外部接口 (1) 3.2用户接口 (2) 3.3内部接口 (2)
1 范围 1.1 系统概述 描述软件系统的运行环境、主要用途，描述软件系统的总体功能、构成、子系统构成。使得读者对系统有一个总体的概要的了解。 [读者看完系统概述知道了这个软件是做什么用的、主要的功能是什么，用在什么样的场合。这样读者就可以对系统有一个整体的了解]。 1.2 术语与缩略语 本文档使用的术语与缩略语： XXXX ：XXXXXXXXXXXX； ……； 2 引用文档 [1]《XXXXXXX》，XXXXXXXXXX，YYYY年MM月。 [2]《XXXXXXX》，XXXXXXXXXX，YYYY年MM月。 ……。 3 接口设计 3.1外部接口 说明该系统同外界的所有接口安排，包软件接口与硬件接口。 <说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、本系统与各支持软件之间的接口关系。> 例如：通讯接口、直接硬件接口、支撑软件接口以及与其它软件模块间的接口设计。 1）外部网络通讯接口设计 外部通讯网络接口设计是指与本系统范围外的网络接口，如上层管理网等的接口和协议、信息流向、信息、长度和通讯周期等。 2）外部串行口通讯接口设计 外部串行口通讯接口设计是指与本系统范围外的其它系统采用串行口通讯时的接口关系，包括通讯协议(握手方式、波特率、校验方式等)、信息流向、信息长度和通讯周期等。还应说明当通讯过于频繁或超时时的措施。
附件4：数据交换接口规范 一、概述 计量器具检定数据交换接口采用Web service作为数据传输机制，是自包含、自描述（WSDL）、模块化的应用，由省局发布、定位、各技术机构通过web方式调用。接口基于标准的互联网协议，支持超文本传输协议(HTTP)和XML。与省局交换的数据都封装成XML格式的文件，传输前以GZIP格式将文件压缩，然后设置BASE64编码，最后在接收端将其解压，解析读取数据。 二、软件准备 JDK1.6，tomcat6.0，Web service相关包以及数据库。三、数据交换示意图 四、服务端接收数据过程 1、用户合法性校验：服务端在接收数据时同样需要进行用户合法性 校验，并返回信息。
2、数据封装：为方便数据传输和解析，客户端通过Web service交 换的数据需要封装成可扩展标记语言XML的规范，并严格按照此规范。 3、数据压缩：为提高数据的传输效率和减小传输的数据量，客户端 在传输之前需将数据以GZIP格式进行压缩，并设置BASE64位编码，以便基于HTTP传输。 4、对上传文件进行规范性校验：服务端在接收数据之前，校验客户 端数据是否按照XML规范要求，并按GZIP格式进行压缩，设置BASE64编码，否则返回不合法文件格式。 5、返回结果：服务端进行完校验，解析成功并反馈给业务系统后， 会反馈成功信息给客户端，如不成功则返回不成功。 五、客户端接收数据过程（与服务端接收过程类似。） 六、术语说明
THANKS !!! 致力为企业和个人提供合同协议，策划案计划书，学习课件等等 打造全网一站式需求 欢迎您的下载，资料仅供参考
电力系统简单服务接口规范 1范围 本标准提出了应用于电力系统的简单服务接口规范，以字符串方式描述面向服务消费者和服务提供者的语法、语义规则及服务调用接口规范。本规范适用于访问简单服务的应用场合。 2规范性引用文件 下列文件对于本文的应用是必不可少的。凡是注日期的引用文件，仅注日期的版本适用于本文件。凡是不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。 GB/T 16262.1—2006：信息技术抽象语法记法一 (ASN.1) 第1部分:基本记法规范 Web Services Description Language (WSDL) 1.1 https://www.doczj.com/doc/1e16561903.html,/TR/wsdl.html：web服务描述语言 3术语和定义 下列术语和定义适用于本标准。 3.1 服务Service 服务提供者完成一组工作，为服务消费者交付所需的最终结果。最终结果通常会使使用者的状态发生变化，但也可能使提供者的状态改变，或者双方都产生变化。 3.2 服务消费者Service Consumer 根据服务接口描述访问服务的实体 3.3 服务提供者Service Provider 实现一定功能并提供访问接口描述的实体 3.4 WSDL Web服务描述语言（Web Service Description Language） 3.5 域Domain 电力系统中不同级别的调度机构 3.6 简单服务Simple Service 能够相对独立运行具有简单的输入参数和输出结果的应用 4符号定义和语法规范 4.1符号定义 WSDL是目前唯一的用于Web服务访问的工业标准，通过使用复杂的语法规则来实现服务的描述和访问。本规范参考了WSDL语言，提出了用于电力系统的简单服务接口规范，提供服务访问的功能并满足电力系统对效率的要求。表1是简单服务接口规范的符号定义，扩充了类型描述符、路径分隔符、
研发生产中心文档编号版本A1 密级商密A 项目名称Xx系统 项目来源 Xxx系统 详细设计说明书 (内部资料请勿外传) 编写：日期：检查：日期：审核：日期：批准：日期： XX公司 版权所有不得复制 文档变更记录
序号变更（+/-）说明作者版本号日期批准1 2
目录 1. 引言 (5) 1.1 编写目的和范围 (5) 1.2 术语表 (5) 1.3 参考资料 (5) 1.4 使用的文字处理和绘图工具 (5) 2. 全局数据结构说明 (7) 2.1 常量 (7) 2.2 变量 (8) 2.3 数据结构 (8) 3. 模块设计 (9) 3.1 用例图 (9) 3.2 功能设计说明 (10) 3.2.1 模块1 (10) 3.2.2 模块2 (11) 4. 接口设计 (12) 4.1 内部接口 (12) 4.2 外部接口 (12) 4.2.1 接口说明 (12) 4.2.2 调用方式 (12) 5. 数据库设计 (12) 6. 系统安全保密设计 (12) 6.1 说明 (12) 6.2 设计 (12) 6.2.1 数据传输部分 (12) 6.2.2 IP过滤分部 (13) 6.2.3 身份验证部分 (13) 7. 系统性能设计 (13) 8. 系统出错处理 (13)
1.引言 1.1背景 此文档的背景 1.2编写目的和范围 说明写这份详细设计说明书的目的。 本详细设计说明书编写的目的是说明程序模块的设计考虑，包括程序描述、输入/输出、算法和流程逻辑等，为软件编程和系统维护提供基础。本说明书的预期读者为系统设计人员、软件开发人员、软件测试人员和项目评审人员。 1.3术语表 定义系统或产品中涉及的重要术语，为读者在阅读文档时提供必要的参考信息。 序号术语或缩略语说明性定义 1 PM Project Manager,项目经理 2 1.4参考资料 列出有关资料的名称、作者、文件编号或版本等。参考资料包括： a．需求说明书、架构设计说明书等； b．本项目的其他已发表的文件； c．引用文件、资料、软件开发标准等。 资料名称作者文件编号、版本资料存放地点 1.5使用的文字处理和绘图工具 文字处理软件：[编写设计文档使用的文字处理软件，如RedOffice ] 绘图工具：[使用的UML工具，如Rose、Jude、Visio]
税控发票开票软件发票信息 数据接口规范V4.0 1概述 为进一步优化纳税服务，满足纳税人内部管理信息系统与增值税发票税控开票软件的衔接需要，国家税务总局下发了税控发票开票软件发票信息数据接口规范V1.0、V2.0、V3.0版。随着增值税发票管理新系统的全国推广和营改增的全面实施，公布的接口已经不能满足需要，现对该接口进行更新升级，形成V4.0版。 本接口规范适用于是增值税发票税控开票软件（金税盘版）与增值税发票税控开票软件（税控盘版）的商品编码版本（以下统一简称为税控发票开票软件），配合手工导入开具、自动导入开具和发票明细导出功能使用。 2接口说明 2.1待开发票信息导入接口 通过税控发票开票软件中的手工导入开具和自动导入开具功能，将待开发票的信息批量导入到税控发票开票软件，完成发票开具。 选择手工导入开具时，首先选择要导入的XML文件，再对导入发票信息逐张开具并打印发票。
选择自动导入开具时，首先设置文件存储路径和轮询时间。自动导入开具功能开启后，系统自动轮询指定路径下的XML文件，自动完成发票开具，并将开具结果写入指定文件目录。 2.2已开发票信息导出接口 通过税控发票开票软件中的发票明细导出功能，实现已开发票信息的批量导出，生成EXCEL文件或XML文件。 3接口定义 本接口规范内容包括待开发票信息导入接口和已开发票信息导出接口，发票类型为增值税专用发票、增值税普通发票、货物运输业增值税专用发票、机动车销售统一发票和二手车销售统一发票。3.1增值税专用发票和增值税普通发票 3.1.1修改说明 单据新增了Version节点，增加商品编码功能后的版本为2.0； 单据新增了Spbmbbh节点，增加商品编码功能后为税局下载的商品编码表版本号； 单据新增了Hsbz节点，用于区分营改增新增的5%不含税税率和中外合作油气田（原海洋石油）5%税率、1.5%税率、差额税； 单据商品明细中新增了Spbm（商品编码）、Qyspbm（企业商品编码）、Syyhzcbz（享受优惠政策）、Lslbz（零税率标识）、Yhzcsm
目录 1 接口类型 (2) 1.1 人机接口 (2) 1.2 软件-硬件接口 (2) 1.3 软件接口 (2) 1.4 通信接口 (2) 2 接口设计规范 (2) 2.1 基本内容 (2) 2.2 规格说明 (3) 2.2.1 人机接口 (3) 2.2.2 软件-硬件接口 (3) 2.2.3 软件接口 (3) 2.2.4 通信接口 (3) 3 接口设计文档提纲 (3)
1接口类型 1.1人机接口 人机接口是指计算机系统为完成人与机器之间互相传送信息而提供的功能的接口，包括硬件及程序。 1.2软件-硬件接口 软件-硬件接口是指软件系统中软件与硬件之间的接口。例如软件与接口设备之间的接口。 1.3软件接口 软件接口是软件系统中程序之间的接口。包括软件系统与其他系统或子系统之间的接口、程序模块之间的接口、程序单元之间的接口等。 1.4通信接口 通信接口是指处理机和标准通信子系统之间的接口。包括为实现数据通信用来完成接口功能的部件、装置及有关软件。 2接口设计规范 2.1基本内容 1、接口的名称标识 2、接口在该软件系统中的地位和作用 3、接口在该软件系统中与其他程序模块和接口之间的关系 4、接口的功能定义
5、接口的规格和技术要求，包括它们各自适用的标准、协议或约定 6、各个接口的数据特性 7、各个接口的资源要求，包括硬件支持、存储资源分配等 8、接口程序的数据处理要求 9、接口的特殊设计要求 10、接口对程序编制的要求 2.2规格说明 2.2.1人机接口 准确地说明人机接口的设计条件、设计特征、编程要求等技术内容。包括人机交互环境、人机接口部件、信息传输方式及传输特性、信息格式、数据处理、存储资源分配和程序编制要求等。 2.2.2软件-硬件接口 逐个描述每一个软件-硬件间接口的设计特性。包括接口硬件说明、接口功能说明、接口信息说明、接口处理方法、接口控制方式、接口时间特性、存储资源分配和程序编制要求等。 2.2.3软件接口 逐个说明本软件系统与其他软件系统间接口的设计特征。包括接口功能说明、接口约定、数据特性、数据处理方法、接口程序运行控制、接口时间特性、存储资源分配和程序编制要求等。 2.2.4通信接口 逐个描述各个通信接口的设计特性。包括硬件描述、接口功能说明、通信协议、报文处理、存储资源分配、程序接口设计和程序编制要求等。 3接口设计文档提纲 1 概述 (2) 1.1 编写目的 (2) 1.2 参考资料 (2) 1.3 术语和缩写词 (2)
登记过户系统与客户服务系统接口规范 文档修改记录
一、接口规范概述 1．用途 本接口规范仅描述登记过户系统给客户服务系统（包括CALL CENTER查询和网站查询）所提供数据的具体内容和形
式。 2．数据处理规则为： (a)以文本文件定长记录方式提供数据； 约定：今后需要新增加的字段都增加在尾部，客服系统读记录时，不用校验记录的长度，以保持兼容。 (b)文件的第一行为数据的记录数 (c)最后一行为’END’ (d)文件数据体中，每行代表一条完整记录； (e)换行必须用回车（ODH）、换行（OAH）字符； (f)数据项类型，C:字符型；N:数字；A:字符型，填数字 (g)数字如是负数，第一位用’-‘表示，占用一个整数位 (h)数字左补零右对齐，字符右补空格左对齐； (i)带有小数点的数值型数据，传输时不传小数点；本接 口中，没有特不讲明的，都表示2位小数。 (j)带下划线的字段为相应文件记录的主索引； 3．包括内容 本接口包含六个方面的数据：客户帐户信息、账户类确认数据、客户基金份额余额、客户交易流水（包括申请流水和
确认流水）、基金分红信息和基金行情信息。 4．内容更新规则为： (a)每日由登记过户系统向客户服务系统提供一次数据； (b)每日所提供的数据仅表示截至到当日做完登记过户操 作后的客户信息和基金行情信息； (c)每次只提供变化（包括新增和更新）的数据；也可不 定期提供全部数据（文件名区分） 二、客户账户信息数据 1．数据生成规则： (a)客户帐户信息包括客户差不多信息和基金帐号的登记 信息两个方面的内容，这两个方面的内容同步更新； (b)客户资料和客户的基金帐号资料合在一条记录里形成 所谓“客户差不多信息”； (c)客户差不多信息既支持新增客户记录模式又支持新增 基金帐号记录模式； (d)客户差不多信息还支持修改已有记录模式，销户也算 修改记录范畴； (e)基金帐号登记信息：只要某基金帐号下的账户登记信
＜项目名称＞ 软件需求说明书 作者： 完成日期： 签收人： 签收日期： 修改情况记录：
目录 1 引言 (1) 1.1 编写目的 (1) 1.2 范围 (1) 1.3 定义 (1) 1.4 参考资料 (1) 2 项目概述 (2) 2.1 产品描述 (2) 2.2 产品功能 (2) 2.3 用户特点 (2) 2.4 一般约束 (2) 2.5 假设和依据 (3) 3 具体需求 (3) 3.1 功能需求 (3) 3.1.1 功能需求1 (3) 3.1.2 功能需求2 (4) 3.1.n 功能需求n (5) 3.2 外部接口需求 (5) 3.2.1 用户接口 (5) 3.2.2 硬件接口 (5) 3.2.3 软件接口 (5) 3.2.4 通信接口 (6) 3.3 性能需求 (6) 3.4 设计约束 (6) 3.4.1 其他标准的约束 (6) 3.4.2 硬件的限制 (7) 3.5 属性 (7) 3.5.1 可用性 (7) 3.5.2 安全性 (7) 3.5.3 可维护性 (7) 3.5.4 可转移＼转换性 (8) 3.5.5 警告 (8) 3.6 其他需求 (8) 3.6.1 数据库 (8) 3.6.2 操作 (8) 3.6.3 场合适应性需求 (9) 4 附录 (9)
1 引言 1.1 编写目的 说明编写这份软件需求说明书的目的，指出预期的读者范围。 1.2 范围 说明： a．待开发的软件系统的名称； b．说明软件将干什么，如果需要的话，还要说明软件产品不干什么； c．描述所说明的软件的应用。应当： 1）尽可能精确地描述所有相关的利益、目的、以及最终目标。 2）如果有一个较高层次的说明存在，则应该使其和高层次说明中的类似的陈述相一致（例如，系统的需求规格说明）。 1.3 定义 列出本文件中用到的专门术语的定义和缩写词的原词组。 1.4 参考资料 列出要用到的参考资料，如： a．本项目的经核准的计划任务书或合同、上级机关的批文； b．属于本项目的其他已发表的文件； c．本文件中各处引用的文件、资料，包括所要用到的软件开发标准。 列出这些文件的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。
1 具体需求 功能需求 功能需求1 对于每一类功能或者有时对于每一个功能，需要具体描述其输入、加工和输出的需求。由四个部分组成： a．引言 描述的是功能要达到的目标、所彩的方法和技术，还应清楚说明功能意图的由来 和背景。 b．输入 1)详细描述该功能的所有输入数据，如：输入源、数量、度量单位、时间设定、 有效输入范围（包括精度和公差）； 2)操作员控制细节的需求。其中有名字、操作员活动的描述、控制台或操作员的 位置。例如：当打印检查时，要求操作员进行格式调整； 3)指明引用接口说明或接口控制文件的参考资料。 c．加工 定义输入数据、中间参数，以获得预期输出结果的全部操作。它包括如下的说明： 1)输入数据的有效性检查； 2)操作的顺序，包括事件的时间设定； 3)响应，例如，溢出、通信故障、错误处理等； 4)受操作影响的参数； 5)降级运行的要求； 6)用于把系统输入变换成相应输出的任何方法（方程式、数学算法、逻辑操作等）； 7)输出数据的有效性检查。 d．输出 1)详细描述该功能所有输出数据，例如：输出目的地、数量、度量单位、时间关
系、有效输出的范围（包括精度和公差）、非法值的处理、出错信息； 2)有关接口说明或接口控制文件的参考资料。 此外，对着重于输入输出行为的系统来说，需求说明应指定所有有意义的输入、 输出对及其序列。当一个系统要求记忆它的状态时，需要这个序列，使得它可以 根据本次输入和以前的状态作出响应。也就是说，这种情况犹如有限状态机。 功能需求2 ．．．．．． 功能需求n 外部接口需求 用户接口 提供用户使用软件产品时的接口需求。例如，如果系统的用户通过显示终端进行操作，就必须指定如下要求： a．对屏幕格式的要求； b．报表或菜单的页面打印格式和内容； c．输入输出的相对时间； d．程序功能键的可用性。 硬件接口 要指出软件产品和系统硬部件之间每一个接口的逻辑特点。还可能包括如下事宜：支撑什么样的设备，如何支撑这些设备，有何约定。
走过，留下种种希望。啊，朋友，我们从人生的四季走过，将给人生留下些什么? （项目名称） 系统需求规格说明书 文件版本 编写日期 发布日期 没有落日般的瑰丽，没有流云般的飘逸，但可以有水晶般的清纯与透明。没有大山般的巍峨，没
走过，留下种种希望。啊，朋友，我们从人生的四季走过，将给人生留下些什么? 文件修改记录 *变化状态：C――创建，A——增加，M——修改，D——删除 文档审批信息 没有落日般的瑰丽，没有流云般的飘逸，但可以有水晶般的清纯与透明。没有大山般的巍峨，没
走过，留下种种希望。啊，朋友，我们从人生的四季走过，将给人生留下些什么? 目录 1概述 (1) 1.1目的 (1) 1.2预期读者 (1) 1.3背景（可选） (1) 1.4参考资料 (1) 1.5标准（可选） (1) 1.6术语定义 (1) 1.7图例说明 (1) 2系统描述 (1) 2.1现状综述 (1) 2.2系统目标 (1) 2.3目标系统概述 (2) 2.4范围 (2) 2.5系统假设/约定 (2) 2.6接口与界面 (2) 2.6.1外部接口(可选) (2) 2.6.2硬件接口 (2) 2.6.3软件接口 (2) 2.6.4通信接口(可选) (2) 2.6.5用户界面 (3) 3功能需求 (3) 3.1系统流程图 (3) 3.2功能一览表 (3) 3.3功能描述 (3) 3.3.1功能1 (3) 3.3.2功能n (4) 3.4公共功能描述 (4) 3.4.1功能1 (4) 3.5数据描述（可选） (4) 3.5.1业务数据描述 (4) 没有落日般的瑰丽，没有流云般的飘逸，但可以有水晶般的清纯与透明。没有大山般的巍峨，没
中国财务软件数据接口标准(DOC7) 编者按:标准应该是衡量事务的准则。标准的制定一样都由国际/国家有关标准机构或行业主管部门完成。但一些行业的生产厂商为了爱护用户的投资,促进行业有序进展,也按照本行业的特点,联合起来制定了一些大伙儿认可并共同遵守的规范,这种做法在国外已被广泛采纳。随着中国改革开放的深入,国内一些行业的厂家也开始进行这方面的探究,本期我们刊登的《中国财务软件数据接口标准》确实是由该财务软件行业的民间组织——中国软件行业协会财务及企业治理软件分会制定的,起草者为闻名财务软件厂商深圳金蝶公司。 一、背景 目前,国内财务软件众多,它们采纳的数据库平台和数据库结构各不相同,不同财务软件之间的数据交换,因为数据库平台和结构不同而产生许多困难,几乎任意两个不同软件之间要实现数据传递都会存在专门的数据转换咨询题。烦琐的数据转换工作白费了大量人力和物力,同时也阻碍了财务软件产业的健康进展。国内财务软件的商业化差不多比较成熟,各财务软件公司都有一批用户。由于各种缘故,一些用户期望从一个软件交叉升级为另一软件。由于用户在旧软件上已做了大量的工作,必定期望升级后原有数据能移植到新的软件中,然而有些软件的数据文件通过加密或数据库结构未公布,要从中直截了当读取数据几乎不可能。为了爱护用户已付出的劳动,各财务软件需要提供一个标准的数据输入输出接口。如此,建立一个公用的数据交换标准是专门必要的。 用户在使用财务软件时,有一些需求通过财务软件本身是难以实现的,如:用户期望把会计报表通过电子表格软件处理输出为各种专门形式;另一些高级用户,则期望在其它治理软件中能取到财务数据。这些数据交换工作都需要有一个标准的数据接口来规范。财务会计通过长期的进展已形成一定的理论,财务会计工作也有规范可循,国内财务软件是在这些理论和规范的基础上开发出来的,各软件储存财务数据的模式也大同小异。财务数据要紧按会计科目、凭证、余额及发生额、报表几个部分分块储备,它们之间既
软件开发文档模板库 1 可行性研究报告 可行性研究报告的编写目的是：说明该软件开发项目的实现在技术、经济和社会条件方面的可行性；评述为了合理地达到开发目标而可能先择的各种方案；说明论证所选定的方案。 可行性研究报告的编写内容要求如下： 1.1 引言 1.1.1 编写目的 1.1.2 背景 1.1.3 定义 1.1.4 参考资料 1.2 可行性研究的前提 1.2.1 要求 1.2.2 目标 1.2.3 条件、假定和限制 1.2.4 进行可行性研究的方法 1.2.5 评价尺度 1.3 对现有系统的分析 1.3.1 数据流程和处理流程 1.3.2 工作负荷 1.3.3 费用开支 1.3.4 人员 1.3.5 设备 1.3.6 局限性 1.4 所建议的系统 1.4.1 对所建议系统的说明 1.4.2 数据流程各处理流程 1.4.3 改进之处 1.4.4 影响 1.4.4.1 对象设备的影响 1.4.4.2 对软件的影响 1.4.4.3 对用户单位机构的影响 1.4.4.4 对系统动行的影响 1.4.4.5 对开发的影响 1.4.4.6 对地点和设施的影响 1.4.4.7 对经费开支的影响 1.4.5 局限性 1.4.6 技术条件方面的可行性 1.5 可选择其他系统方案 1.5.1 可选择的系统方案1
1.5.2 可选择的系统方案2 …… 1.6 投资及收益分析 1.6.1 支出 1.6.1.1 基本建设投资 1.6.1.2 其他一次性支出 1.6.1.3 非一次性支出 1.6.2 收益 1.6. 2.1 一次性收益 1.6. 2.2 非一次性收益 1.6. 2.3 不可定量的收益 1.6.3 收益/投资比 1.6.4 投资回收周期 1.6.5 敏感性分析 1.7 社会条件方面的可行性 1.7.1 法律方面的可行性 1.7.2 使用方面的可行性 1.8 结论 2 项目开发计划 编制项目开发计划的目的是用文件的形式，把对于在开发过程中各项工作的负责人员、开发进度所需经费预算、所需软、硬件条件等问题作出安排记载下来，以便根据本计划开展和检查本项目的开发工作。编制内容要求如下： 2.1 引言 2.1.1 编写目的 2.1.2 背景 2.1.3 定义 2.1.4 参考资料 2.2 项目概述 2.2.1 工作内容 2.2.2 主要参加人员 2.2.3 产品及成果 2.2. 3.1 程序 2.2. 3.2 文件 2.2. 3.3 服务 2.2. 3.4 非移交产品 2.2.4 验收标准 2.2.5 完成项目的最迟期限 2.2.6 本计划的审查者与批准者 2.3 实施总计划 2.3.1 工作任务的分解 2.3.2 接口人员 2.3.3 进度 2.3.4 预算 2.3.5 关键问题
附件2 武汉市节能智慧管理系统 数据接口规范 武汉市发展和改革委员会 2013年12月
前言 为指导我市各级节能智慧管理系统建设，市发改委组织有关专家，以我国现行相关标准为依据，结合我市节能智慧管理系统建设、验收和运行管理要求，研究制定了本数据接口规范。 本规范包括主要用能单位上传数据接口标准规范和市区各级系统上传数据接口标准规范两部分，其中两部分包括了接口的标准应用范围、接口的实现、接口的要求、术语和定义和基本原则。 本规范由市发改委负责管理和解释。
目录 1. 主要用能单位上传数据接口规范 (5) 1.1标准应用范围 (5) 1.2术语和定义 (5) 1.3基本原则 (5) 1.4接口实现 (6) 1.4.1数据提供方 (6) 1.4.2数据接收方 (6) 1.4.3接口的实现方式 (7) 1.4.4传输方式 (7) 1.4.5传输协议 (7) 1.4.6传输过程 (7) 1.4.7编码原则 (8) 1.4.8接口的验证方式 (8) 1.4.9使用策略 (9) 1.5接口数据的要求及保障 (9) 2. 区分系统上传数据接口规范 (10) 2.1标准应用范围 (10) 2.2术语和定义 (10) 2.3基本原则 (10) 2.4接口实现 (11)
2.4.1数据提供方 (11) 2.4.2数据接收方 (12) 2.4.3接口的实现方式 (12) 2.4.4传输方式 (12) 2.4.5传输协议 (12) 2.4.6传输过程 (12) 2.4.7编码原则 (13) 2.4.8接口的验证方式 (13) 2.4.9使用策略 (14) 2.5接口数据的要求及保障 (14) 附录1 数据采集器身份认证过程和数据加密 (15) 附录2 数据采集器或子系统和市数据中心通信过程 (16) 附录3 数据传输的XML数据格式 (17)
附件1： 市级系统接口参考页面 1 说明 本文档是关于……，要求……。已达到……目的。 2 参考页面 第一步 客户端首先要设置web service的连接地址、用户名和密码三项。远程地址固定为：http://124.133.54.21/services/DataService。用户名和密码为省总队分配。 参考界面如下： 帐号：3702-00-01 密码:
第二步 企业填报自己月报数据然后提交。 第三步 市级用户审核企业提交的月报数据。 第四步 市级进入提交审核页面。审核通过的企业将在“企业列表”中显示。将企业选择进“已选企业”。然后点击“上传至省平台”按钮。操作完成。 参考界面如下：
附件2： 山东省节能信息系统数据导入接口协议 1 简介 本协议用于山东省节能信息系统与通过API接入山东省节能信息系统的客户端的数据传输通讯。两者的数据传输通讯采用TCP协议、短连接方式，山东省节能信息系统为服务器方。 缩略语清单： client ：所有通过Web Service接口接入山东省节能信息系统的客户端2 Web Service接口说明 2.1 山东省节能信息系统Web Service地址 WSDL：http://124.133.54.21/services/DataService?wsdl
地址：http://124.133.54.21/services/DataService 2.2 接口说明 2.2.1 i mportYearReportData方法 public String importYearReportData( String loginName, String loginPwd, String cityCode, int year, String reportData) 方法说明： 从各地市系统上传本市已经审核确认的企业年报数据到省系统，如果省系统中企业当年年报数据还未上传过，则添加年报数据，如果年报数据已经上传过，则更新已上传年报数据。 返回值定义：第一行为错误代码，其他行为调用失败时的详细错误信息 ok：数据导入成功 invalidate-city：错误的地市编码 invalidate-date：错误的年份 invalidate-user：访问用户不可用 not-allow-op：用户没有操作权限 illegal-report-data：不合法的报表数据格式 error-report-style：错误的报表样式 error-verify-relations：错误的校验关系 2.2.2 i mportMonthReportData方法 public String importMonthReportData( String loginName, String loginPwd,
智能化系统设计规 范
智能化系统设计标准 目录 GB 50116-2013 《火灾自动报警系统设计规范》（设计要求） (3) GBT 50200-1994 《有线电视系统工程技术规范》（设计要求） (4) GB 50198-2011《民用闭路监视电视系统工程技术规范》（要求） (6) GBT50314-2006《智能建筑设计标准》（设计要求） (8) GB50311-2007《综合布线与系统工程设计规范》（设计要求） (20) JGJ16-2008《民用建筑电气设计规范》 (23) GB_50343-2004《建筑物电子信息系统防雷技术规范》（设计） (30) GB50348-2004《安全防范工程设计规范》（设计要求） (31) GB 50394-2007 《入侵报警系统工程设计规范》（设计要求） (45) GB 50395-2007《视频安防监控系统工程设计规范》（设计要求） (46) GB 50396-2007 《出入口控制系统工程设计规范》（功能设计） (47)
GB 50116- 《火灾自动报警系统设计规范》( 设计要求) 系统形式的选择和设计要求 3.2.1 火灾自动报警系统形式的选择, 应符合下列规定: 1 仅需要报警, 不需要联动自动泊防设备的保护对象宜采用区域报警系统。 2 不但需要报警, 同时需要联动自动消防设备.且只设置一台具有集中控制功能的火灾报警控制器和消防联动控制器的保护对象, 应采用集中报警系统, 应设置一个消防控制室。 3 设置两个及以上消防控制室的保护对象, 或己设置两个及以上集中报警系统的保护对象, 应采用控制中心报警系统。 3.2.2 区域报警系统的设计, 应符合下列规定: 1 系统应由火灾探测器、于动火灾报警按钮、火灾声光警报器及火灾报警控制器等组成, 系统中可包括消防控制室图形显示装置和指示楼层的区域显示器。 2 火灾报警控制器应设置在有人值班的场所。 3 系统设置消防控制室图形显示装置时, 该装置应具有传输本规起附录A 和附录B 规定的有关信息的功能;系统未设置消防控制室图形显示装置时, 应设置火警传输设备。 3.2.3 集中报警系统的设计, 应符合下列规定: 1 系统应由火灾探测器、于动火灾报警按钮、火灾声光警报器、消防应急广播、消防专用电话、消防控制室图形显示装置、火灾报警控制器、消防联动控制器等组成。