接口设计文档V1.0

合集下载

用友ERP-U8V8.71版管理软件_PDM接口V1.0接口规范

用友ERP-U8V8.71版管理软件_PDM接口V1.0接口规范

U8接口
* 读取PDM系统数据 ** * *
[删除 PDM 系统注册]:删除当前注册信息。注意:如果中间表中存在要删除系统的数据则不允许 删除。删除前要弹出提示框让用户确认是否真要删除,避免误操作。
6
用友软件股份有限公司
行业开发部
U8ERP-PDM 接口规范 V1.0
[取消]:关闭对话框,取消操作。
4.接口界面功能说明
本接口提供给 PDM 软件厂商规范的数据共享开发接口,PDM 软件厂商按照系统提供的开发规 范组织 PDM 数据包校验后发送至 ERP 系统,由 ERP 系统接收数据包并校验数据,补充缺失信息然 后导入 ERP 系统。 同时 ERP 系统的基础数据可通过 PDM 软件厂商的提供的数据映射功能直接被 PDM 软件使用,达到系统基础数据的共享的目的。U8PDM 数据接口提供两种方式:同步方式、异步方 式。同步方式由 PDM 主动触发,U8 软件方不需要认为干预,PDM 数据自动导入 U8;异步方式允许 PDM 导入 U8 系统前进行部分数据的修改, 修改后再由 U8 基础数据的负责人将 PDM 数据导入 U8 系 统。 (注:演示版仅提供异步方式)


动 态 数 据
PDM 动态数据接口
j 校验、导入

k.校验、传递
U8 库存量在制品 工时、材料消耗
PDM 产品规划
h 校验、导入

i.校验、传递
U8 销售订单
静 态 数 据
PDM 工艺路线
f.校验、传递 导入 d.校验、 传递 导入 b.校验、 传递 导入

g 补充信息、校验
U8 物料工艺路线
PDM 产品结构
用友软件股份有限公司
行业开发部

软件开发文档模板GF-接口设计说明(GJB 438B-2009)-2785-推荐下载

软件开发文档模板GF-接口设计说明(GJB 438B-2009)-2785-推荐下载

文档标识及版本号: XX项目标识.IDD V1.0密级:秘密*5年编制/修订日期:yyyy-mm-dd[规范性]文档名称: XX项目中文名称-接口设计说明接口设计说明《XX项目中文名称》接口设计说明Interface Design Description ofXX项目英文名称编制单位:江苏科技大学新技术研究所编写:CNISILS项目组XXX审核:YYY批准:ZZZ编写记录修改记录目录1 范围 (1)1.1标识 (1)1.2系统概述 (1)1.3文档概述 (1)2 引用文档 (1)3 接口设计 (2)3.1接口标识和接口图 (2)3.2(接口的项目唯一的标识符)【原标准中此处编号为3.X,为后续使用方便,故用自动编号】 (2)4 需求的可追踪性 (4)5 注释 (4)文档模板使用和裁剪说明使用本文档模板时,首先另存为“<实际文档名>”,然后通过Word的“文档属性”来设置文档属性,包括:文档标识及版本号、密级及保密期限、文档名称、文档类别(中、英文)、项目名称(中、英文)、编制单位、编写人、审批人、批准人等。

具体操作方法:Word标题栏的Office按钮菜单→准备→属性→文档属性→高级属性→自定义→在“属性”列表中,选择属性的“名称”,在“取值”框输入要设定的值,然后按“更改”按钮。

文档属性设置完成后,选中全部文档内容,执行右键菜单“更新域”操作(文档中的所有文档属性参数引用均被替换为最新设定的取值)→双击任意内容页面的页眉区,选中全部页眉内容,执行右键菜单“更新域”操作(页眉中的所有参数引用均被替换为最新设定的取值)。

本文档模板依据《GJB438B-2009 军用软件开发文档通用要求》制定,模板中的文档编写说明均引自《GJB438B-2009 军用软件开发文档通用要求》,并用方括号“【”和“】”括起来,以及使用蓝色文字区分,主要用于指导文档的编写,应在文档编写完成后或正式提交前予以删除(包括删除本说明)。

EC20_Mini_PCIe(Audio版本)_硬件设计手册_V1.0

EC20_Mini_PCIe(Audio版本)_硬件设计手册_V1.0
2 产品综述 ................................................................................................................................................. 8 2.1. 本章概述..................................................................................................................................... 8 2.2. 产品简介..................................................................................................................................... 8 2.3. 关键特性..................................................................................................................................... 9 2.4. 主要功能................................................................................................................................... 11
1 引言 ........................................................................................................................................................ 7 1.1. 安全须知..................................................................................................................................... 7

中国联通客户网管系统接口规范v1.0

中国联通客户网管系统接口规范v1.0

中国联通公司企业标准QB/CU 204-2011中国联通客户网络管理系统接口规范China Unicom Customer Network Management System Interface Specification(v1.0)2011-06-22发布2011-06-22实施中国联通公司发布目录1 范围 (2)2 规范性引用文件 (2)3 缩略语 (2)4 接口概述 (4)5 客户网管系统部省级接口 (6)5.1 接口简要描述 (6)5.2 网络连接方式 (6)5.3 接口功能需求 (6)5.3.1过滤条件设置 (6)5.3.2数据信息接口 (6)5.3.3告警故障接口 (7)5.3.4性能信息接口 (8)5.4 接口方式及协议 (8)5.5 接口详细描述 (8)5.5.1连接测试 (8)5.5.2过滤条件设置 (9)5.5.3数据信息接口 (10)5.5.4告警故障接口 (17)5.5.5性能信息接口 (20)6 与资源管理系统间接口 (23)6.1 接口简要描述 (23)6.2 接口功能需求 (23)6.2.1资源数据同步 (23)6.2.2资源数据查询 (24)6.2.3资源数据变更通知 (24)6.3 接口方式及协议 (24)6.4 接口详细描述 (24)6.4.1采用Webservice+FTP方式 (24)6.4.2采用中间表方式 (33)7 与电子运维系统间接口 (38)7.1 接口简要描述 (38)7.2 接口功能需求 (38)7.2.1故障派单 (38)7.2.2故障单管理 (38)7.2.3重保电路信息同步 (38)7.2.4电路割接信息同步 (39)7.3 接口方式及协议 (39)7.4 接口详细描述 (39)7.4.1接口数据 (39)7.4.2电子运维系统侧接口服务定义 (42)7.4.3客户网管侧接口服务定义 (44)8 与传输网综合网管系统间接口 (48)8.1 接口简要描述 (48)8.2 接口功能需求 (48)8.2.1过滤条件设置 (48)8.2.2告警同步 (48)8.2.3告警同步通知 (48)8.2.4告警实时上报 (48)8.2.5告警结束通知 (49)8.2.6性能任务定制 (49)8.2.7性能数据获取通知 (49)8.3 接口方式及协议 (49)8.4 接口交互数据 (49)8.4.1告警信息 (49)8.4.2性能数据 (50)8.5 接口详细描述 (51)8.5.1传输网综合网管系统侧接口服务定义 (51)8.5.2客户网管系统侧服务定义 (55)9 与IP网综合网管系统间接口 (60)9.1 接口简要描述 (60)9.2 接口功能需求 (60)9.2.1告警同步 (60)9.2.2告警实时上报 (60)9.2.3过滤条件设置 (60)9.2.4定制性能任务 (60)9.2.5性能数据获取通知 (61)9.2.6节点间IP网络层时延测试 (61)9.2.7MPLS VPN电路:获取各QoS等级带宽占用百分比 (61)9.3 接口方式及协议 (61)9.4 交互数据定义 (62)9.4.1IP电路相关性能参数定义表 (62)9.4.2告警信息 (63)9.5 接口详细描述 (64)9.5.1IP综合网管系统侧服务定义 (64)9.5.2客户网管系统侧服务定义 (71)10 与数据ATM网管理系统间接口 (75)10.1 接口简要描述 (75)10.2 接口功能需求 (75)10.2.1告警同步 (75)10.2.2告警实时上报 (75)10.2.3过滤条件设置 (75)10.2.4定制性能任务 (75)10.2.5性能数据文件获取 (76)10.3 接口方式及协议 (76)10.4 接口交互数据 (76)10.4.1告警信息 (76)10.4.2性能数据 (77)10.5 接口详细描述 (77)10.5.1数据ATM管理系统侧接口服务定义 (77)10.5.2客户网管系统侧服务定义 (81)附录A接口服务定义代码说明 (85)A.1 错误代码表 (85)A.2 系统代码表 (85)A.3 同步请求标识和通知标识的编号规则 (85)A.4 Filter的BNF范式说明 (86)A.5 资源数据文件命名规则 (88)附录B 客户网管部省接口WSDL (89)前言中国联通客户网管系统,是以对客户租用电路和客户设备的实时监测为主要目标,从面向客户、面向业务的角度对网管数据进行分析和呈现,实现大客户网络的状态监视、故障定位以及性能分析等功能,同时为大客户提供统计报表和SLA报告,使其成为中国联通为大客户服务的重要支撑平台。

定点医疗机构的HIS系统与省级平台的接口参考手册

定点医疗机构的HIS系统与省级平台的接口参考手册

附件四定点医疗机构的HIS系统与省级平台的接口参考手册(V1.0)河南省卫生厅0一0年七月二十日目录1. 引言 (4)1.1. 文档编制目的 (4)1.2. 读者对象 (4)1.3. 参考文献 (4)1.4. 术语与缩写解释 (4)2. 接口设计 (5)2.1. 接口方式 (5)2.2. 接口定义 (5)2.3. 调用流程 (7)2.4. 标准字典目录规范 (8)3. 接口方法明细 (8)3.1. 基础应用类 (8)3.1.1. 接口初始化 (8)3.1.2. 药品、诊疗项目关联信息上报 (9)3.2. 业务处理类 (10)3.2.1. 就诊登记 (10)3.2.2. 登记信息修改 (11)3.2.3. 登记信息撤销 (13)3.2.4. 处方明细上报 (14)3.2.5. 处方明细撤销 (15)3.2.6. 预结算 (16)3.2.7. 出院登记 (18)3.2.8. 正式结算 (19)3.2.9. 结算撤销 (23)3.2.10. 获取转诊患者信息 (24)4. 查询下载 (25)4.1. 字典数据 (26)4.2. 上传处方明细查询 (26)4.3. 结算明细/汇总信息查询 (26)4.4. 打印补偿凭证 (26)5. 附字典目录 (26)5.1. 项目类型 (26)5.2. 项目类别 (27)5.3. S101-01 性别代码 (27)5.4. S101-02婚姻状况代码 (28)5.5. S101-03 民族代码 (28)5.6. S101-04 地区代码 (30)5.7. S101-05健康状况代码 (30)5.8. S101-06家庭关系代码 (31)5.9. S101-07职业分类代码 (32)5.10. S101-08专业技术职务代码 (32)5.11. S101-09行政职务代码 (33)5.12. S101-10户属性代码 (33)5.13. S101-11迁移标志代码 (33)5.14. S201-01卫生机构代码(编码说明) (34)5.15. S201-02机构隶属关系代码 (34)5.16. S201-03机构经济类型代码 (35)5.17. S201-04诊疗科室代码 (35)5.18. S201-05机构类别代码 (40)5.19. S201-06定点医疗机构类型代码 (42)5.20. S201-07资助部门类型代码 (43)5.21. S201-08医疗机构级别代码 (43)5.22. S301-01疾病分类代码 (43)5.23. S301-02入院状态代码 (43)5.24. S301-03出院状态代码 (44)5.25. S301-04医疗服务项目代码(使用《全国医疗服务价格项目规范》) (44)5.26. S301-05就诊类型代码 (44)5.27. S301-06补偿类别代码 (44)5.28. S301-07参合属性代码 (45)5.29. S301-09补偿帐户类别代码 (45)5.30. S401-01基本药品代码(见国家基本药物目录) (45)5.31. S701-01是否标识代码 (46)1.引言1.1. 文档编制目的实现全省各市、县(区)参合转诊患者到省市定点医疗机构的就诊管理,并实现补偿费用现场减免结算。

基于SJA1000的CAN节点设计v1.0

基于SJA1000的CAN节点设计v1.0

基于SJA1000的CAN节点设计文件信息类别内容关键词SJA1000,CTM系列隔离CAN收发器基于SJA1000的CAN节点设计摘要修订历史版本日期原因Rev X1 2006-12-13 内部制定初稿Rev 1.0 2006-12-15 第一次发布目录1. 基于SJA1000的CAN节点设计 (3)1.1 硬件设计电路 (3)1.1.1收发器隔离电路设计 (3)1.1.2 CAN总线接口设计 (4)1.2 软件设计 (5)程序清单1.1 定义片选地址 (5)程序清单1.2 初始化SJA1000 (5)程序清单1.3 发送报文 (6)2. 应用实例 (7)3. 声明 (1)1.基于SJA1000的CAN节点设计1.1 硬件设计电路CAN总线是一种最有前途的现场总线,因其优异性能而在工业控制、汽车电子、安防等方面得到广泛应用。

设计CAN-bus通讯接口是很重要的一个环节,设备的正确运行与其密切相关。

如图 1.1给出了一个实际的CAN-bus通讯单元电路图,电路结构为:MCU(P89C52)+CAN控制器(SJA1000)+隔离CAN收发器(CTM Module)。

图 1.1 CAN-bus通讯单元原理图如图 1.1所示,整个系统电源采用+5V电源输入,上电复位芯片(CAT810L)可保证上电时正确的启动系统。

微处理器采用PHILIPS的P89C52单片机,该系列单片机是80C51微控制器的派生器件,采用先进的CMOS工艺制造,指令系统与80C51完全相同。

CAN控制器采用PHILIPS的SJA1000,SJA1000是一款独立的控制器,用于汽车和一般工业环境中的控制器局域网络。

它是PHILIPS半导体PCA82C200 CAN控制器(BasicCAN)的替代产品。

而且,它增加了一种新的工作模式(PeliCAN),这种模式支持具有很多新特性的CAN 2.0B 协议,是目前市面上用的最广的一款CAN控制器。

GJB438B 接口设计说明IDD 模板

GJB438B 接口设计说明IDD 模板

[键入文字]文档标识及版本号:XX项目标识.IDD V1.0 密级:秘密★5年编制/修订日期:yyyy-mm-dd文档名称:XX项目中文名称-接口设计说明接口设计说明《XX项目》接口设计说明编制单位:编写:审核:批准:修改记录目录1 范围 (1)1.1标识 (1)1.2系统概述 (1)1.3文档概述 (1)2 引用文档 (2)3 接口设计 (2)3.1接口标识和接口图 (2)3.X(接口的项目唯一的标识符) (3)4 需求的可追踪性 (6)5 注释 (7)1 范围1.1标识【本条应描述本文档所适用的系统、接口实体和接口的完整标识,适用时,包括其标识号、名称、缩略名、版本号和发布号。

】表1-1本文档所适用的系统、接口实体和接口1.2系统概述【本条应概述本文档所适用的系统和软件的用途,还应描述系统与软件的一般特性;概述系统开发、运行和维护的历史;标识项目的需方、用户、开发方和保障机构等;标识当前和计划的运行现场;列出其他有关文档。

】(本章若无内容,则标识为“本章无内容”,并说明理由。

)1.3文档概述【本条应概述本文档的用途和内容,并描述与它的使用有关的保密性方面的要求。

】(本章若无内容,则标识为“本章无内容”,并说明理由。

)2 引用文档【本章应列出引用文档的编号、标题、编写单位、修订版及日期,还应标识不能通过正常采购活动得到的文档的来源。

】(本章若无内容,则标识为“本章无内容”,并说明理由。

)3 接口设计3.1接口标识和接口图【对于1.1中所标识的每个接口,本条应描述赋予该接口的项目唯一的标识符,适当时应使用名称、编号、版本和文档引用等标识接口实体(系统、配置项、用户等)。

该标识应说明哪些实体具有固定的接口特性(要给出这些接口实体的接口需求),哪些实体正被开发或修改(这些实体已有各自的接口需求)。

适当时,可使用一个或多个接口图来描述这些接口。

】(本章若无内容,则标识为“本章无内容”,并说明理由。

)3.X(接口的项目唯一的标识符)【本条(从3.2开始编号)应通过项目唯一的标识符标识接口,应简要标识接口实体,并且应根据需要分条描述接口实体的单方或双方的接口特性。

中国移动CM-IMS_MRF接口规范V1.0.0..

中国移动CM-IMS_MRF接口规范V1.0.0..

.中国移动通信企业标准 版本号:中国移动通信集团公司 发布2011-4-12发布 2011-4-12实施QB-C-010-2011 中国移动C M -I M S M R F 接口规范 C h i n a M o b i l e C M -I M S M R F I n t e r f a c e S p e c i f i c a t i o n目录前言 (III)1.范围 (1)2.规范性引用文件 (1)3.术语、定义和缩略语 (2)4.网络结构 (3)4.1组网架构 (3)4.2网元功能描述 (3)4.2.1 AS (3)4.2.2 MRF (4)4.2.3 S-CSCF (4)4.2.4 IM-MGW (4)4.2.5 SBC (4)4.2.6 网管系统 (4)4.2.7媒体资源服务器 (4)4.3 接口描述 (4)4.3.1 AS与MRF之间的Cr/Mr’接口 (4)4.3.2 S-CSCF与MRF之间的Mr接口 (7)4.3.3 MGW,SBC与MRF之间的Mb接口 (7)4.3.4 网管系统与MRF之间的接口 (7)4.3.5媒体资源服务器与MRF之间的接口 (7)5.AS与MRF之间的接口定义 (7)5.1音视频播放接口定义 (8)5.1.1NETANN方式音视频播放接口定义 (8)5.1.2INVITE+INFO方式音视频播放接口定义 (12)5.2.音频和视频录制接口定义 (18)5.2.1INVITE+INFO方式音频和视频录制接口定义 (18)5.3.收号接口定义 (23)5.3.1INVITE+INFO方式收号接口定义 (23)5.4.会议接口定义 (28)5.4.1接口流程 (28)5.4.1.1用户作为会议发起方创建会议并加入会议流程 (28)5.4.1.2用户作为参与方创建会议并加入会议流程 (29)5.4.1.3点击会议INVITE不带SDP流程 (30)5.4.2 SIP消息定义 (30)5.4.3会议MSML脚本定义 (33)5.4.4会议MSML脚本举例 (39)5.5.健康性检查接口定义 (39)5.5.1设备健康性检查接口定义 (39)5.5.2会话健康性检查接口定义 (41)6 编制历史 (44)附录A(标准性附录)播放语种 (44)附录B(标准性附录)文件类型 (45)附录C(标准性附录)编解码类型 (46)附录D(标准性附录)Money子类型 (46)附录E(标准性附录)MSML通用接口定义 (46)E.1MSML核心包元素定义 (46)E.2MSML核心包元素使用样例 (47)E.3MSML的dialog包元素定义 (47)E.4MSML的dialog包元素使用样例 (48)E.5MSML的conf包元素 (48)E.6Result元素 (48)E.7event事件 (49)E.8exit元素 (49)附录F(标准性附录)PATTERN的digits属性定义 (49)附录G(标准性附录)MSML响应码定义 (49)附录H(资料性附录)会议MSML脚本举例 (51)前言本标准为中国移动CM-IMS的MRF接口规范。

PROP数据交换系统用户接口说明书-中国结算

PROP数据交换系统用户接口说明书-中国结算
系统概述 .....................................................................................................................................5 PROP数据交换系统的概念 ...................................................................................................5 PROP数据交换系统的组成 ...................................................................................................6 PROP数据交换系统的特点 ...................................................................................................7
初始化环境函数PROP_InitEnv............................................................................................19 2. 连接PMX函数PROP_Connect..............................................................................................20 3. 发送函数PROP_ Send ..........................................................................................................21 4. 接收函数PROP_Recv ...........................................................................................................23 5. 侦听函数PROP_ Listen ........................................................................................................24 6. 接受连接函数PROP_ Accept................................................................................................26 7. 关闭连接函数PROP_ Close .................................................................................................26 8. 释放环境函数PROP_ FreeEnv.............................................................................................27 9. 释放函数PROP_ Free...........................................................................................................27 10. 检测函数PROP_ Ping.......................................................................................................28 11. 连接句柄I/O状态检测函数PROP_ Select .......................................................................29

预约挂号平台HIS接口设计.

预约挂号平台HIS接口设计.

文档编号:密级:预约挂号系统接口设计说明书(HIS部分)编制:审核:批准:2010年 10文档修改记录1总体设计1.1 总体要求预约挂号系统平台与各医院HIS之间是一对多的接入关系,因医院HIS系统各不相同:建设厂家不同,版本不同,环境不同;与平台间的网络连接方式也存在差异。

为保证平台的兼容性和可扩展性,要求该接口规范具备高通用性,可跨平台、跨语言实现,且适用于不同的网络环境和硬件设备。

1.2 系统拓扑1.3 模块说明本文档涉及的接口应用布署于拓扑图中的“医院His前置”上。

预约挂号系统包括两大类应用:一.HIS向预约挂号平台上传预约挂号系统所需的基本信息(如:医院信息、科室信息、医生信息、排班信息、停诊信息等)和其他交易信息(如:患者预约后的实际就诊情况、患者投诉情况、患者注册信息等)。

该类交易平台为服务端,HIS为客户端。

平台方提供DLL函数接口,供HIS调用。

二.平台向HIS发起的实时交易请求(如:预约挂号、预约取消、患者信息向医院传送等)。

该类交易平台为客户端,HIS为服务端。

HIS提供存储过程供平台调用。

三.详细业务部分请参阅《省预约挂号平台业务操作规范.doc》2平台与医院HIS接口平台与医院HIS前置之间采用TCP/IP通讯协议,建立两对SOCKET端口(互为客户/服务端):一对用于医院HIS系统发起的交易(HisToEbs),一对用于平台发起的交易(EbsToHis)。

其中客户端作为发送数据端口,服务端作为接收数据端口。

HIS作为客户端时,通过调用平台提供的DLL函数发起交易请求;HIS作为服务端时,向平台开放存储过程。

交易方式采用短链接的方式。

在一个TCP/IP连接上完成数据包的发送和接收,在成功发送了一个数据包,并收到成功应答后,即中断该连接。

HisToEbs和EbsToHis均采用同步方式。

文件传输采用FTP方式。

2.1 HisToEbs该接口主要用于HIS系统向平台传输院方相关基础及变更信息,如:医院介绍、科室设置、医生、排班等。

接口文档范例示意

接口文档范例示意

接口文档范例示意文章标题:接口文档范例示意 - 简单易懂的API文档设计与编写引言:在软件开发过程中,为了实现不同系统之间的互联互通,接口文档的编写变得尤为重要。

好的接口文档不仅能够提供清晰的指导,还能减少开发者之间的沟通成本,提高开发效率。

本文将以一个示意的接口文档范例为例,探讨如何编写一份简单易懂的API文档。

第一部分:接口概述1.1 接口名称和版本信息在接口概述中,首先需要明确接口的名称和版本信息。

例如:接口名称:用户管理接口版本号:v1.01.2 接口描述在接口描述中,应该简要说明该接口的作用和功能。

例如:该接口用于对系统中的用户进行管理,包括用户的创建、查询、更新和删除等操作。

1.3 接口区域信息和请求方式在接口区域信息和请求方式中,需要提供接口的URL区域信息以及HTTP请求的方式。

例如:接口区域信息:/api/users请求方式:GET第二部分:请求参数2.1 公共请求参数公共请求参数是指在每个接口中都需要使用的参数,例如身份认证信息、时间戳等。

在该部分中,列举出每个公共请求参数的名称、类型和是否必填。

例如:- access_token(字符串,必填):用于身份认证的令牌。

- timestamp(字符串,必填):请求的时间戳。

2.2 接口请求参数接口请求参数是指该接口所需的具体参数,包括请求方法(GET、POST等),请求体中的参数以及可选的路由参数等。

在该部分中,详细描述每个请求参数的名称、类型、是否必填、描述以及示例值。

例如:- name(字符串,必填):用户姓名。

- age(整数,选填):用户年龄。

- gender(字符串,选填):用户性别。

示例值:'male'或'female'。

第三部分:响应参数3.1 公共响应参数公共响应参数是指在每个接口的响应结果中都会返回的参数,例如状态码、错误信息等。

在该部分中,列举出每个公共响应参数的名称、类型和描述。

EC20_Mini_PCIe(Audio版本)_硬件设计手册_V1.0

EC20_Mini_PCIe(Audio版本)_硬件设计手册_V1.0

作者 Lyndon LIU
变更表述 初始版本
2 / 37
EC20 Mini PCIe (Audio 版本) 硬件设计手册
目录
文档历史 ........................................................................................................................................................ 2 目录 ............................................................................................................................................................... 3 表格索引 ........................................................................................................................................................ 5 图片索引 ........................................................................................................................................................ 6
1 引言 ........................................................................................................................................................ 7 1.1. 安全须知..................................................................................................................................... 7

智能家居接口文档V1.0.1

智能家居接口文档V1.0.1

类型 int int int
string int
array int string int int
说明 命令码,8 版本 1 状态,0:失败,1: 成功,-1:token 不 匹配 网关 mac 返回剩下设备的 个数 终端列表 终端 id 厂家标识 终端主类型 终端次类型
dev_info
false
dev_num
智慧云:远程管理智能设备的云服务端。
2、 通信模式 根据移动客户端所处网段环境,分为内网和外网控制模式。内网环境下,移动客户
端与处于同一网段下的网关直接通信;外网环境下,移动客户端与智慧云通信,终端(使 用轮询、长连接或 P2P 的模式)查询智慧云的控制命令,间接控制终端。如无特殊说明, 下面的通信流程均基于该模式。
智慧云服务信息 通信类型,0:udp, 1:tcp,2:http ip 端口 网址
{ “cmd”:”1”, “version”:”1”, “user”:”foo”, “config_pwd”:”pwd”, “crypt_type”:”0” “conn_pwd”:”pwd” “servers”: [ { “type”:”0”, “ip”:”10.10.10.12”, “port”:”8000” }, { “type”:”2”,
添加终端,当前只描述添加未绑定到网关的终端: a)发送搜索终端命令到网关 b)网关返回终端列表给移动客户端 c)移动客户端发送添加终端命令到网关,网关执行添加操作 2) 查询终端状态 可以查询设备在线状态,开关,类型,在线时长,功耗等信息。
3) 控制终端 控制设备开关,及设备独有支持的控制,如灯亮度,颜色等。 重新配置网关等。
参数名
cmd version user mac token id

技术设计方案文档模板V1.0

技术设计方案文档模板V1.0

技术设计方案文档模板V1.0技术设计方案文档模板项目名称:(填写项目名称)版本号:(填写版本号)文档历史记录:| 版本号 | 日期 | 作者 | 变更说明 || ------ | ------ | ------ | ------ || 1.0 | (填写日期) | (填写作者)| 第一版 |1. 项目概述1.1 目的本文档旨在提供项目的技术设计方案,包括系统架构、模块设计、数据库设计、接口设计等内容,以确保项目顺利进行并符合客户要求。

1.2 背景(填写项目背景)1.3 参考资料(列出项目设计过程中所参考的资料)2. 系统架构设计2.1 总体结构(填写系统总体结构图,包括其主要模块和交互关系)2.2 模块设计2.2.1 模块分解(列出系统中的所有模块并说明其作用)2.2.2 接口设计(填写各模块间的接口说明,包括传输数据格式、数据内容、传输方式等)2.2.3 模块详细设计(对每个模块进行详细设计说明,包括其内部结构、流程等)3. 数据库设计3.1 数据库架构布局(填写数据库结构图,包括其表结构和关系)3.2 表设计详细说明(对每个表进行详细设计说明,包括其字段、数据类型、索引等)4. 技术选型(填写所选用的技术和技术原因,对比其他选项)5. 安全策略设计(填写系统安全策略设计,包括用户权限、数据加密、防盗窃等)6. 性能设计(填写系统性能设计,包括系统负载、响应速度、存储容量等)7. 上线与测试方案(填写上线方案,包括上线日期、部署方式、测试方案等)8. 系统维护及升级方案(填写系统维护和升级方案,包括维护周期、维护方式等)9. 前期准备9.1 人员配备(填写参与项目的各职位所需人数及责任描述)9.2 硬件设备(填写所需的硬件设备,包括服务器、存储设备等)9.3 软件设备(填写所需的软件设备,包括开发工具、编程语言等)9.4 环境要求(填写开发、测试、上线等环境所需的要求,包括软件、硬件、网络环境等)10. 其他说明(填写其他需要说明的内容,例如项目进度计划)。

百胜FIS2.0-OMD子系统-工程师审核接口设计v1.0

百胜FIS2.0-OMD子系统-工程师审核接口设计v1.0

百胜FIS 2.0-OMD子系统工程师审核接口设计说明书方正国际软件有限公司文档控制接口方法设计说明1、数据操作采用面向对象方式进行。

2、对象的Json格式在详细设计时提供。

3、接口方法设计只是初步方案,具体实现中可能有所改动,届时会予以通知。

接口设计考虑:1、系统架构问题,omd2.0系统采用ORM方式访问数据库。

2、很多数据验证和内部操作和更新数据在对象保存过程中进行,这种方式的数据处理比较成熟,已经经过大量测试实践验证、具有可靠性,安全性,系统影响小,风险低。

3、接口实现与具体移动端需求无关。

4、开发成本和测试成本低。

5、减少对原系统的访问数量,及操作。

接口设计变更说明:1、新增接口GetRepairSheetList2、新增接口GetAttachmentList接口使用说明:1、UrlEnCode编码问题:基于安全性、可实现性方面考虑,对实体传输进行了编码详细使用只要先取的实体的集合,处理后,编码传输即可2、对子项进行增删改操作时请按照:新增子项:复制现有项格式,修改ID=0,update操作删除子项:实体字符串中,删除该节点及子节点,update操作修改子项:实体字符串中,直接修改相应项,update操作一、接口方法GetRepairSheetList1、GetRepairSheetList1.1 (GetRepairSheetList) 方法参数:1. 2返回值描述:"MalfunctionDesc": "", 码二、接口方法GetAttachmentList2、GetAttachmentList2.1 (GetAttachmentList) 方法参数:2. 2返回值描述:"ID": "646",。

软件开发文档模板GF_接口设计说明书(GJB438B_2009)_27

软件开发文档模板GF_接口设计说明书(GJB438B_2009)_27

WORD格式编辑整理文档标识及版本号: XX项目标识.IDD V1.0 密级:秘密*5年编制/修订日期:yyyy-mm-dd[规范性]文档名称: XX项目中文名称-接口设计说明接口设计说明《XX项目中文名称》接口设计说明Interface Design Description ofXX项目英文名称编制单位:江苏科技大学新技术研究所编写:CNISILS项目组XXX审核:YYY批准:ZZZ专业知识分享编写记录修改记录目录1 范围 (1)1.1标识 (1)1.2系统概述 (1)1.3文档概述 (1)2 引用文档 (1)3 接口设计 (2)3.1接口标识和接口图 (2)3.2(接口的项目唯一的标识符)【原标准中此处编号为3.X,为后续使用方便,故用自动编号】 (2)4 需求的可追踪性 (4)5 注释 (4)文档模板使用和裁剪说明使用本文档模板时,首先另存为“<实际文档名>”,然后通过Word的“文档属性”来设置文档属性,包括:文档标识及版本号、密级及保密期限、文档名称、文档类别(中、英文)、项目名称(中、英文)、编制单位、编写人、审批人、批准人等。

具体操作方法:Word标题栏的Office按钮菜单→准备→属性→文档属性→高级属性→自定义→在“属性”列表中,选择属性的“名称”,在“取值”框输入要设定的值,然后按“更改”按钮。

文档属性设置完成后,选中全部文档内容,执行右键菜单“更新域”操作(文档中的所有文档属性参数引用均被替换为最新设定的取值)→双击任意内容页面的页眉区,选中全部页眉内容,执行右键菜单“更新域”操作(页眉中的所有参数引用均被替换为最新设定的取值)。

本文档模板依据《GJB 438B-2009 军用软件开发文档通用要求》制定,模板中的文档编写说明均引自《GJB 438B-2009 军用软件开发文档通用要求》,并用方括号“【”和“】”括起来,以及使用蓝色文字区分,主要用于指导文档的编写,应在文档编写完成后或正式提交前予以删除(包括删除本说明)。

软件开发硬件接口设计说明书V1.0

软件开发硬件接口设计说明书V1.0

XXXX项目
硬件接口设计说明书
修订记录
使用说明
1)文中的一级、二级标题不允许删除,如无内容,则在章节描述下面填写“无”。

在当前基础上,允许增加一级标题、二级标题和内容;
2)文中的三级、四级标题仅供参考使用,可根据需要自行调整和增减;
3)请注意及时更新目录,确保与文中章节编号和页码的一致性。

目录
1前言 (1)
1.1目的 (1)
1.2术语定义 (1)
1.3参考资料 (1)
2逻辑框图 (1)
3设计说明 (1)
4其他说明 (1)
1前言
1.1目的
1.2术语定义
[列写文档中使用的专门术语及定义,以及外文首字母组词的完整含义]
1.3参考资料
[列写该文档所参考的资料]
2逻辑框图
[展示系统整体接口设计框架图]
3设计说明
[阐述系统的硬件接口设计内容]
4其他说明
[描述接口设计的其他说明内容]。

  1. 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
  2. 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
  3. 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。

1.
修订历史
版本
章节
类型
日期
作者
备注
1.0
所有
创建
2018-09-18
段志军
2.
2.1.
方法说明
查询客户资料
请求方式
RESTful HTTP
提交类型
POST
请求路径
http://10.66.0.49/
请求参数
content(JSON报文):StringNot null;
开发人员
黄玮
数据报文
请求报文
租户ID
数据报文








{
"ret":"200",
"msg":"执行成功",
"data":[{
}]
}
节点名
数据类型
非空
说明
ret
String
Y
处理结果代码,如处理失败或无数据data节点为空。(参见附件代码说明)
msg
String
Y
消息内容
data
String[]
N
数据对象
2.2.
方法说明
查询所有客户资料
完整消息
{
"customerName": "string",
"tenantId": "string"
}
示例
{
"customerName": "树根",
"tenantId": "114"
}
节点名
数据类型
非空
说明
customerName
String
Y
客户名称(支持模糊查询)
tenantId
String
Y








{
"ret":"200",
"msg":"执行成功",
"data":[{
}]
}
节点名
数据类型
非空
说明
ret
String
Y
处理结果代码,如处理失败或无数据data节点为空。(参见附件代码说明)
msg
String
Y
消息内容
data
String[]
N
数据对象
请求方式
RESTful HTTP
提交类型
POST
请求路径
http://10.66.0.49/icsm/customer/query-all-customer-list
请求参数
content(JSON报文):StringN数据报文
请求报文
完整消息
示例
节点名
数据类型
非空
说明
数据报文
相关文档
最新文档