省系统接口说明范文
附件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/DataService2.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,String cityCode,int year,int month,String reportData)方法说明：从各地市系统上传本市已经审核确认的企业月报数据到省系统，如果省系统中企业当月月报数据还未上传过，则添加月报数据，如果月报数据已经上传过，则更新已上传月报数据。
返回值定义：第一行为错误代码，其他行为当调用失败时的详细错误信息ok：数据导入成功invalidate-city：错误的地市编码invalidate-date：错误的年份或月份invalidate-user：访问用户不可用not-allow-op：用户没有操作权限illegal-report-data：不合法的报表数据格式error-report-style：错误的报表样式error-verify-relations：错误的校验关系2.2.3 e xportDictionarypublic String exportDictionary(String catalog)方法说明：导出省级系统定义的各类字典编码数据，企业注册信息、月报数据、年报数据中相关字段所使用的编码将从系统定义的字典编码中选取。
参数说明：返回值定义：返回的各种字典编码数据，每行为一条编码，每个编码包含code和name，中间用“$@$”分隔。
返回值示例：1.能源种类01$@$原煤02$@$洗精煤…2.计量单位0103$@$毫克0106$@$微克…3.产品指标0001$@$万元产值综合能耗（当量值）$@$万元产值综合能耗（等量值）…4.企业类型001$@$国家千家重点用能单位002$@$省千户重点用能单位003$@$市属重点用能单位5.行业分类06$@$煤炭17$@$纺织…6.行业编码06$@$煤炭开采和洗选业08$@$黑色金属采选业…7.产业编码1$@$第一产业2$@$第二产业3$@$第三产业4$@$其他产业8.省级编码$@$山东…9.地市编码$@$济南$@$青岛…10.区县编码$@$市辖区$@$历下区$@$市中区…3 错误码使用说明对于方法调用的返回值，ok代表数据导入成功，其他表示失败，具体错误码见下表。
4 附录4.1 报表数据格式定义1. 年报和月报数据格式包含多个表数据（表定义见附录4.3、4.4、4.5），每个表包含1到多个用能单位的上报数据，即：表1的上报数据，表2的上报数据，…,表n的上报数据。
2. 每个表数据第一行是表名标识行，以“@@”开头，后跟表数据所对应的表的编码，第二行是表字段定义行，定义了该表所使用的字段名称，各个字段名之间用“$@$”分隔。
剩下行是表数据行，存放各个企业对该表的上报数据，要求数据行的各个字段值必须和字段定义行的各个字段相一致，各个数据值之间用“$@$”分隔。
各行之间用回车换行（\r\n）分隔。
3. 填报的数据，对于字符型和日期型，要求在数据两边加单引号。
4. 报表数据各行的各个字段要求必须有值，如果企业数据没有填写，那么使用初始数据填充，数值型数据初始值为0，字符型和日期型数据初始值为空字符串（不是null）。
5. 要求导入的数据要遵循对应报表的数据校验关系，系统会根据数据校验关系对数据进行校验，校验不通过时不能被导入，并返回错误码。
6. 导入数据可以传入指定报表的某个年月的多家企业的报表数据。
导入时如果该企业该年月有数据则采用覆盖的方式处理，否则数据为添加的方式。
7. 每次调用接口上报年报或月报的企业数量不要超过50家，如果需要上报企业超过50家，建议分为多次调用上报。
月报报表数据格式示例：@@nyqyzcxxbqy_code$@$qy_name$@$qy_qyfl_code$@$qy_address$@$qy_hy_code$@$qy_province$@$qy_city$@$qy_coun ty$@$qy_sscy$@$des'-0'$@$'山东XXXX有限公司'$@$'06'$@$'山东省xx 市xx 路xx 号'$@$'001'$@$''$@$''$@$''$@$''$@$'1'$@$''…@@nygjxfkcbqy_code$@$nyzl_code$@$qkcl$@$gjl_swl$@$gjl_je$@$xfl_gyscxf$@$xfl_gyscxf_yyycl$@$xfl_fgyscxf$ @$xfl_ysgjxf$@$qmkcl$@$cyzbxs$@$dwfzr$@$tjfzr$@$tbr$@$dh$@$tbrq…@@nygjxfkcb_zyzbqy_code$@$bq_zhnyxfl$@$sq_zhnyxfl$@$bq_gyzcz_dnj$@$bq_gyzcz_snj$@$sq_gyzcz_dnj$@$sq_fgyscxf$ @$sq_dlxfhj$@$sq_gyscdlxf$@$sq_dlcc$@$sq_hlfdtr…@@nygjxfkcfbqy_code$@$nyzl_code$@$hlfd$@$gr$@$ymrx$@$lj$@$ly$@$zq$@$trqyh$@$jgmzp$@$nyjgzhcc$@$hsly$@$dw fzr$@$tjfzr$@$tbr$@$dh$@$tbrq…@@dwcpzhnhzbqkbqy_code$@$cpzb_code$@$bnd_zxz$@$bnd_mxz$@$snd_mxz$@$snd_zxz$@$dwfzr$@$tjfzr$@$tbr$@$dh$@$tbrq…4.2 地市编码表4.3 企业注册信息表定义4.4 需要导入年报报表定义暂无4.5 需要导入月报报表定义4.6 客户端调用方法本节介绍如何使用XFire工具访问数据接口进行数据操作，开发语言为JAVA。
你也可以采用其他你所熟悉的SOAP兼容库进行开发。
该程序只作为参考实现，未考虑运行效率，请客户端开发者根据自己实际情况修改。
首先我们通过 http://124.133.54.21/services/DataService?wsdl可以获得 WSDL 文件 DataService.wsdl ，并将其放在 src 目录下面，接着我们通过程序访问该 WSDL 文件，并调用需测试的方法。
此时测试类 WebServiceClientTest.java 的关键代码如下所示：String wsdl = " DataService.wsdl " ; // 对应的WSDL文件Resource resource = new ClassPathResource(wsdl);Client client = new Client(resource.getInputStream(), null ); // 根据WSDL创建客户实例Object[] params = new Object[6];params [0] = "loginUser" ; //用户名params [1] = "loginPwd" ; //用户口令params [2] = "3701" ; //地市编码params [3] = 2010 ; //年报年份params [4] = "" ; //年报数据// 调用特定的Web Service方法Object[] results = client.invoke( "importYearReportData" , params);System.out.println( "result: " + results[0]);。
HIS系统接口的说明
HIS系统接⼝的说明四川省新型农村合作医疗信息系统医院信息系统(HIS)接⼝规范版本号:1.0四川省卫⽣信息中⼼发布2007年5⽉31⽇⽬录第⼀部分接⼝介绍 (4)第⼆部分新型农村合作信息系统接⼝中的函数功能介绍 (4)类(函数的返回值或传⼊值标准) (4)1、public class FalseOrTrue (4)2、public class AccreditCode (5)3、public class RevertHospitalID (5)4、public class IsPatientClass (6)5、public class InfosP (6)6、public class PersonInfo (6)7、public class InfosU (8)8、public class Users (8)9、public class InfosM (9)10、public class Med (9)11、public class InfosSW (10)12、public class SW (11)13、public class InfosI (11)14、public class Items (12)15、public class ValidateInfoClass (13)16、public class QDInfoClass (13)17、public class QDReturn1 (14)18、public class QDReturn2 (15)19、public class QDError (15)20、public class ToCode (16)21、public class QueryPatientQD (16)22、public class QDInfo (16)23、public class QueryHospitalBC (18)24、public class BCInfo0 (18)25、public class BCInfo1 (19)26、public class InfosI1 (21)27、public class InfosM1 (21)28、public class Med1 (22)函数 (23)1、CheckDB() (23)2、CheckHosAccredit1(string HACCCODE) (23)3、CheckUser(string UID,string HACCCODE) (24)4、CheckMed(int MID, decimal MPRICE, int HID) (24)5、CheckSW(int SID, decimal SPRICE, int HID) (25)6、CheckItem(int IID, decimal IPRICE, int HID, string ADDPRICEREASON) (25)7、CheckPersonCode (string PERSONCODE) (26)8、IsPatient1 (string PERSONCODE) (26)9、QueryPersoninfo (string QUERYCONDITION, string QUERYKEY) (27)10、QueryMed(string HACCCODE) (28)11、QuerySW(string HACCCODE) (28)12、QueryItem(string HACCCODE) (28)13、QueryUsersTable(string HACCCODE) (29)14、WriteQD1(ValidateInfoClass vinfo, QDInfoClass[] qdinfo) (29)15、WriteQD2(ValidateInfoClass vinfo, QDInfoClass[] qdinfo) (30)16、ModifyQD1(ValidateInfoClass vinfo, QDInfoClass[] qdinfo) (31)17、ModifyQD2(int qdid, decimal count, decimal zfund, string DLB, string reason, int xmid, string doctor, string UID, string HACCCODE) (31)18、DeleteQD1 (int hqdid, ValidateInfoClass vinfo) (32)19、DeleteQD2(int qdid,string UID, string HACCCODE) (33)20、QueryQD(string HACCCODE, string PERSONCODE) (34)21、QueryBC(string HACCCODE, DateTime BeginTime, DateTime EndTime,int choose) (34)22、QueryItem1(string HACCCODE，int pagenum) (35)23、QueryMed1(string HACCCODE) (35)第三部分新型农村合作信息系统接⼝实施使⽤流程 (36)使⽤接⼝的流程说明： (38)初始化操作 (38)对码表维护操作 (38)⼊院操作 (39)每⽇清单操作 (39)出院操作 (41)统计结算查询 (41)其他函数说明： (41)接⼝测试⽹址： (43)WSDL地址： (43)第⼀部分接⼝介绍四川省新型农村合作医疗信息系统(简称“新农合信息系统”)接⼝主要是为了解决有HIS系统的医疗机构在病⼈⼊院期间的每⽇清单录⼊问题，暂不涉及⼊院、出院、结算和农合的其他补偿⽅式,因此相关操作仍需要通过新农合系统来进⾏。
接口设计说明书(软件设计文档范例)
接口设计说明书(软件设计文档范例)接口设计说明书(软件设计文档范例)1.引言1.1 文档目的本文档旨在描述软件系统的接口设计，提供开发人员进行开发和集成工作的指导。
1.2 读者对象本文档适用于软件开发团队、测试人员和其他与系统开发和集成相关的人员。
2.系统概述2.1 系统描述系统为一个类型的软件系统，主要功能包括但不限于、和。
2.2 系统架构系统采用了架构，主要包括以下模块和组件：- 模块1：描述模块1的功能和接口- 模块2：描述模块2的功能和接口-3.接口设计3.1 接口概述系统的接口主要分为内部接口和外部接口，用于不同模块之间的通信和数据传递。
3.2 内部接口3.2.1 模块1接口模块1提供以下接口供其他模块使用：- 接口1：描述接口1的功能和输入输出参数- 接口2：描述接口2的功能和输入输出参数-3.2.2 模块2接口模块2提供以下接口供其他模块使用：- 接口1：描述接口1的功能和输入输出参数- 接口2：描述接口2的功能和输入输出参数-3.3 外部接口3.3.1 数据输入接口系统支持以下数据输入接口：- 接口1：描述接口1的功能和输入参数格式- 接口2：描述接口2的功能和输入参数格式-3.3.2 数据输出接口系统支持以下数据输出接口：- 接口1：描述接口1的功能和输出数据格式- 接口2：描述接口2的功能和输出数据格式-4.接口标准4.1 接口命名规范- 内部接口：采用驼峰命名法，例如getUserName()- 外部接口：采用大写字母和下划线的形式，例如GET_USER_INFO4.2 接口参数规范- 参数类型：根据具体需求确定参数的类型，例如字符串、整数等- 参数命名：采用有意义的命名，易于理解和使用4.3 接口返回值规范- 返回值类型：根据具体需求确定返回值的类型，例如字符串、整数等- 返回值说明：对返回值的含义和可能取值进行详细说明5.附件本文档涉及的附件包括：- 附件1：x- 附件2：x-6.法律名词及注释6.1 法律名词1：定义1- 注释1：x6.2 法律名词2：定义2- 注释2：x7.全文结束。
系统对接方案说明
系统对接方案说明系统对接方案说明1、引言1.1 文档目的本文档旨在提供系统对接方案的详细说明，包括对接流程、数据传输、安全性、测试计划等内容，以便确保系统对接的顺利完成。
1.2 参考资料1.3 术语和缩略语为方便理解，以下列出一些本文档中经常使用的术语和缩略语的定义：- API：应用程序编程接口，用于软件系统之间的交互- ERP：企业资源计划，用于管理企业的各种资源- CRM：客户关系管理，用于维护和管理客户关系的软件系统- XML：可扩展标记语言，用于描述和传输结构化的数据2、系统对接流程2.1 前期准备在进行系统对接之前，需要进行以下准备工作：- 确定对接双方的系统功能和业务要求- 确定数据传输方式和安全机制- 确定对接接口的协议和格式- 制定对接计划和时间安排2.2 数据传输方式根据系统对接的需求和要求，可以采用以下数据传输方式：- 批量传输：将数据打包成文件进行批量传输，如使用等协议进行文件传输- 实时传输：通过API接口进行实时数据传输，如使用SOAP、REST等协议进行接口调用2.3 数据安全性为确保数据的安全传输和存储，需要采取以下安全机制：- 数据加密：对传输的数据进行加密处理，如使用SSL/TLS等加密协议- 访问控制：对系统进行权限控制，限制对接口的访问权限- 数据备份：定期备份数据，以防数据丢失或损坏3、系统对接接口3.1 接口协议根据系统对接的需求和要求，可以选择以下常用的接口协议：- SOAP：一种基于XML的通信协议，适用于较为复杂的对接场景- REST：一种轻量级的网络传输协议，适用于对接简单的数据传输场景3.2 接口格式根据双方系统之间的数据交互需求，可以确定以下接口格式：- XML格式：将数据以XML格式进行传输和解析- JSON格式：将数据以JSON格式进行传输和解析4、测试计划为确保系统对接的质量和可靠性，需要进行详细的测试计划和测试案例编写，包括以下内容：- 冒烟测试：对基本功能进行测试，确保系统能正常运行- 边界测试：测试系统在极端情况下的处理能力和稳定性- 兼容性测试：测试系统在不同操作系统、浏览器等环境下的兼容性- 性能测试：测试系统的性能指标，如响应时间、并发性能等5、文档附件本文档涉及以下附件：- 附件1：系统接口文档- 附件2：测试计划表- 附件3：测试用例表6、法律名词及注释- 版权：指对作品享有独立性和完整性的权利。
xxx系统数据对接接口说明-设计
XXXXXX管理系统数据接口说明版本：1.0修改时间：2014年11月定稿时间：*年*月目录目录 (2)一、主要内容 (2)二、流程文件及风险点数据接口 (2)（1）流程文件及风险点概念说明 (2)（2）使用过程说明 (3)（3）接口说明 (3)2.3.1. 接口概述 (3)2.3.2. 接口调用方式 (4)2.3.3. 接口文件概述 (5)一、主要内容门户对外提供如下接口：XXXXXX系统流程文件及风险点数据接口二、流程文件及风险点数据接口（1）流程文件及风险点概念说明流程文件⏹指包含业务流程的制度文件⏹一个业务流程可对应多个子流程，子流程即为流程文件所包含的各个业务流程图⏹一个子流程一定被包含在某个业务流程关系的节点风险点⏹指流程文件中的子流程在某个环节可能涉及到的风险⏹一个业务流程文件可对应多个子流程，一个子流程可以对应多个业务环节，一个业务环节可对应多个风险点（2）使用过程说明使用过程如下：⏹外部系统开发者和XX系统管理员协商，确定外部系统的IP地址及权限协议等（XX系统提供的是FTP文件传输协议提供数据）⏹外部系统想要获取文件必输建立与XX系统连接的FTP协议通道⏹外部系统获取的文件为完整的XML文件，通过FTP下载到本地后解析能获取完整的数据（3）接口说明2.3.1.接口概述由于XX系统中已入库的流程文件及风险点不允许二次修改，所以不提供修改增量数据，但提供废止、删除增量数据。
数据接口如下：⏹导出完整的流程文件及风险点数据外部系统可以通过XX接口获得一整套全量数据，从而建立起本系统所需要的流程文件及风险点，而无须从零开始建立。
⏹导出废止流程文件增量数据外部系统还可以通过XX接口获得这些流程文件的最新状态，是否已被废止。
使得外部系统可以方便地和XX数据保持一致。
⏹导出删除流程文件增量数据外部系统还可以通过XX接口获得这些流程文件的最新状态，是否已被删除。
使得外部系统可以方便地和XX数据保持一致。
(整理)四川省检测站联网系统接口使用说明v14
机动车检测联网监管系统接口使用手册(V1.0.0.4)编制 ________________________审核 ________________________批准 ________________________四川省交警总队第一部分接口调用规范1.1 接口访问地址外接系统请求服务的接口访问地址：http://ip:port/trffweb/services/TmriOutAccess.asmx?wsdl 其中IP标识Web服务器地址；port对应系统应用服务的端口号，启用80的不填写。
1.2 调用注意事项1.2.1 XML文档的数据格式（1）传入信息【传入数据字段值】中文字符必须URLEncoder成utf-8格式（转换函数为URLEncoder.encode(xmlDoc, "utf-8")；后再封装成XML文档。
（2）XML文档的【传入数据字段】的标签均为小写字符。
XML文档【节点标签】必须和手册中注明的保持一致，如果手册中标签有大写字符，请以小写为准。
（3）返回XML文档结点值需要URLEncoder.Decode(xmlDoc, "utf-8")解码方可得到正确值（4）数据结构定义中的数据类型只是反映联网系统平台数据字段属性，外接系统调用时应传入相应字符串，请务必按照结构定义中的要求传值。
1.2.2返回结果错误代码说明正常返回结果code为成功与否标记（0、失败；1、成功），网络异常或接口权限异常等系统原因时返回$E的标记。
写入失败时的message返回详细描述信息。
第二部分系统接口说明2.1 机动车检测线联网写入接口定义序号名称功能2.1.1 机动车单项检验结果上传接口01C71 将机动车单项检验结果信息（各单项检验是否合格）上传到行政管理部门。
2.1.2 机动车安全技术检验判定结果上传接口01C72 将机动车安全技术检验判定结果（该车检验是否合格）记录上传到行政管理部门。
省干保医院接口说明
江苏省干部保健信息管理系统医院接口说明南京莱斯信息技术股份有限公司二○一二年十二月1 接口组成及运行环境医院接口软件是由南京莱斯公司提供，包含干部保健业务处理的动态库程序；接口软件由三部分组成：接口数据库、接口动态库、系统管理软件。
【接口数据库】：SQLServer2000，安装在医院前置服务器上，放置在医院本地，用于存放就诊相关信息（三级医院配置，其它医院不设置前置服务器）。
医院前置服务器建议配置为：1G以上内存，硬盘剩余空间40G以上，P4，操作系统Windows2000/XP（建议配置PC服务器及以上档次机器）。
【接口动态库】：TInterface.dll文件，由Delphi7编写，其中封装了卡读写、数据上传下载、本地数据库处理等干部保健相关业务的政策算法，HIS开发商通过调用接口动态库中的函数与干部保健信息管理应用系统进行数据交换。
调用接口动态库的客户端PC机建议配置为：128M以上内存，硬盘剩余空间10G以上，需预装Windows2000/XP，MDAC（2.7或以上版本）。
【系统管理软件】：是医院进行初始设置、日常维护及对帐报表等。
2 接口函数说明调用时需注意函数名中字母的大小写函数返回值为0时表示成功，非0表示失败I表示传入参数，O表示传出参数，V表示传入传出参数以下参数必须传入：就诊号、编码、名称、数量、规格、售价、医疗方式、医疗类别、结算方式、诊断、病种、医生、病区、科室等，其他参数医院能够采集尽可能传入。
接口软件在门诊、住院结账时不打印票据，只是返回结账信息，接口医院HIS系统根据此信息打印结账发票；本接口与市干保HIS接口及调用方式、流程基本相同，不同地方在：‘就诊号’和‘结账流水号’长度调整为C19。
卡号与市干保不同，为5位数字。
接口函数说明如下：2.1 取就诊号说明：医院HIS系统调用该接口函数获取接口软件生成的门诊就诊流水号或住院就诊流水号，用于关联医院HIS就诊记录和保健系统就诊记录。
接口文档范文
接口文档范文1. 引言接口文档是软件开发中非常重要的一部分，它定义了系统与外部系统或组件之间的通信接口。
本文档旨在提供一个接口文档范文，以便开发人员编写规范的接口文档，确保系统能够与其他系统或组件正确地交互。
2. 接口概述本接口文档描述了一个名为“示例系统”的接口规范。
该系统提供了一组RESTful API，用于管理用户信息。
通过这些接口，可以进行用户的创建、读取、更新和删除操作。
2.1 接口基本信息•接口名称：用户管理接口•接口版本：1.0.0•接口地址：``2.2 接口认证本接口要求进行身份认证，使用OAuth 2.0协议进行授权。
在每个请求中，需要在请求头中添加Authorization字段，其值为Bearer <access_token>，access_token需要通过授权服务器获取。
3. 接口详细说明3.1 获取用户列表•接口路径：GET /users•接口描述：获取所有用户的列表信息•请求参数：无•响应参数：–id：用户ID（整数）–name：用户姓名（字符串）–email：用户邮箱（字符串）–created_at：用户创建时间（字符串，格式为YYYY-MM-DD HH:MM:SS）•响应示例：[{"id": 1,"name": "John Doe","email":"****************","created_at": "2021-01-01 10:00:00"},{"id": 2,"name": "Jane Smith","email":"****************","created_at": "2021-01-02 11:00:00"}]3.2 获取单个用户信息•接口路径：GET /users/{id}•接口描述：根据用户ID获取单个用户的详细信息•请求参数：–id：用户ID（整数，路径参数）•响应参数：–id：用户ID（整数）–name：用户姓名（字符串）–email：用户邮箱（字符串）–created_at：用户创建时间（字符串，格式为YYYY-MM-DD HH:MM:SS）•响应示例：{"id": 1,"name": "John Doe","email":"****************","created_at": "2021-01-01 10:00:00"}3.3 创建用户•接口路径：POST /users•接口描述：创建一个新用户•请求参数：–name：用户姓名（字符串，必填）–email：用户邮箱（字符串，必填）•响应参数：–id：用户ID（整数）–name：用户姓名（字符串）–email：用户邮箱（字符串）–created_at：用户创建时间（字符串，格式为YYYY-MM-DD HH:MM:SS）•响应示例：{"id": 3,"name": "Alice Brown","email":"*****************","created_at": "2021-01-03 12:00:00"}3.4 更新用户信息•接口路径：PUT /users/{id}•接口描述：更新指定用户的信息•请求参数：–id：用户ID（整数，路径参数）–name：用户姓名（字符串，可选）–email：用户邮箱（字符串，可选）•响应参数：–id：用户ID（整数）–name：用户姓名（字符串）–email：用户邮箱（字符串）–created_at：用户创建时间（字符串，格式为YYYY-MM-DD HH:MM:SS）•响应示例：{"id": 1,"name": "John Doe","email":"********************","created_at": "2021-01-01 10:00:00"}3.5 删除用户•接口路径：DELETE /users/{id}•接口描述：删除指定用户•请求参数：–id：用户ID（整数，路径参数）•响应参数：无•响应示例：无4. 错误处理本接口遵循HTTP状态码规范进行错误处理。
HIS系统接口的说明3.0.
四川省新型农村合作医疗信息系统医院信息系统 (HIS接口规范版本号 :3.0四川省卫生信息中心发布2013年 5月 15日目录第一部分接口介绍 . ...................................................................................................................... 5第二部分新型农村合作信息系统接口中的住院接口功能介绍 ................................................. 6接口住院工作流程图 . .............................................................................................................. 6类 (函数的返回值或传入值标准 .. (7)1、 public classFalseOrTrue (7)2、 public classAccreditCode (7)3、 public classRevertHospitalID . (7)4、 public classIsPatientClass (8)5、 public class InfosP (8)6、 public classPersonInfo (9)7、 public classInfosU . (10)8、 public classUsers . (10)9、 public classInfosM ................................................................................................... 11 10、 public class Med . ..................................................................................................... 11 11、public class InfosSW ............................................................................................... 13 12、public class SW ....................................................................................................... 13 13、public class InfosI ................................................................................................... 14 14、public class Items .................................................................................................... 14 15、public class ValidateInfoClass . .. (16)16、 public class QDInfoClass (16)17、 public class QDReturn1 (17)18、 public class QDReturn2 (17)19、 public class QDError . ..............................................................................................18 20、 public class ToCode ................................................................................................18 21、 public class QueryPatientQD ..................................................................................19 22、 public class QDInfo.................................................................................................19 23、 public class QueryHospitalBC ................................................................................20 24、 public class BCInfo0 ...............................................................................................21 25、 public class BCInfo1 ...............................................................................................22 26、 public class InfosI1 .................................................................................................23 27、 public class InfosM1 ...............................................................................................24 28、 public classMed1 . ................................................................................................... 24 29、 public class InfosSW1 . ............................................................................................ 24 30、public class SW1 ..................................................................................................... 25 31、public class Time . . (25)32、 public class ZY . .......................................................................................................26 33、 public class JB . ........................................................................................................26 34、 public class JYMoney ..........................................................................................2635、 public class MZInfo .............................................................................................26 36、 public class FYMX ..............................................................................................27 37、 public class FUHEReturn . ....................................................................................27函数 (27)1、CheckDB( (28)2、 CheckHosAccredit1(stringHACCCODE . (28)3、 CheckUser(string UID,stringHACCCODE (28)4、 CheckMed(int MID, decimal MPRICE, intHID . (29)5、 CheckSW(int SID, decimalSPRICE, int HID . (29)6、 CheckItem(int IID, decimalIPRICE, int HID, stringADDPRICEREASON . (30)7、 CheckPersonCode (stringPERSONCODE (31)8、 IsPatient1 (stringPERSONCODE . (31)9、 QueryPersoninfo (string QUERYCONDITION, stringQUERYKEY .................... 32 10、 QueryMed(stringHACCCODE . ............................................................................ 32 11、 QuerySW(string HACCCODE .............................................................................. 33 12、 QueryItem(string HACCCODE . ............................................................................ 33 13、QueryUsersTable(string HACCCODE .................................................................. 34 14、WriteQD1(ValidateInfoClass vinfo, QDInfoClass[] qdinfo . . (34)15、 WriteQD2(ValidateInfoClass vinfo, QDInfoClass[] qdinfo . ..................................35 16、 ModifyQD1(ValidateInfoClass vinfo, QDInfoClass qdinfo ..................................35 17、 ModifyQD2(int qdid, decimal count, decimal zfund, string DLB, string reason,int xmid, string doctor, string UID, string HACCCODE ....................................................36 18、 DeleteQD1 (int hqdid, ValidateInfoClass vinfo .....................................................37 19、 DeleteQD2(int qdid,string UID, string HACCCODE............................................37 20、 QueryQD(string HACCCODE, string PERSONCODE ........................................38 21、 QueryBC(string HACCCODE, DateTime BeginTime, DateTime EndTime,int choose (39)22、 QueryItem1(string HACCCODE, int pagenum (39)23、 QueryMed1(string HACCCODE . (40)24、 QuerySW1(string HACCCODE (40)25、 ModifyRYTime(ValidateInfoClass vinfo, Time intime (41)26、 ModifyCYTime (ValidateInfoClass vinfo, Time intime (41)27、 RYHandle(string HACCCODE, string PERSONCODE, string UID, string ZYCODE, string JZTYPE, string RYKS, string CWCODE, string DOCTORNAME,string RYSTATUS, string RYOPERATOR, string ERROID, jb[] jbbm (42)28. CYBL(string HaccCode, string zylshID, string userID, string cyZtbm, string cyKs, string[] jbBm . (43)29. ModifyRY(string HACCCODE, string ZYID, string UID, string JZTYPE, string ZYCODE, string RYSTATUS, string RYKS, string CWCODE, string DOCTORNAME, string ERROID, jb[] jbbm (43)30、 IsPatient2 (string PERSONCODE . (44)31、 DeleteQD3(int[] qdid,string UID, string HACCCODE . (45)住院接口使用流程 . ................................................................................................................ 45初始化操作 . .. (47)对码表维护操作 . ............................................................................................................ 47入院操作 . ........................................................................................................................ 48每日清单操作 . ................................................................................................................ 48出院操作 . (50)统计结算查询 . (50)其他函数说明:. (50)第三部分新型农村合作信息系统接口中的门诊统筹接口功能介绍 ..................................... 52类 (函数的返回值或传入值标准 (52)1、 public classMZTCZInfo . (52)2、 public classMZTCZMXInfo (55)3、 public classYYKS (57)4、 public classInfosKS . (57)5、 public class JBBM (58)6、 public class InfosJB (58)7、 public classMZQDError . (59)8、 public class MZQDRetrun { ..................................................................................... 60函数 .........................................................................................................................................601、QuerySystemTime( (60)2、 QueryJBBM(intpagenum . (61)3、 QueryYYKS(stringHACCCODE (61)4、 MZTCZLoginInt(MZTCZ.MZTCZInfo info, int choose, decimal hcmztczID, string personCode, stringHaccCode . (62)5、 MZTCZSureInt(string HaccCode, decimal mztczID, stringuserID (62)6、 MZTCZDeleteInt(string HaccCode, decimal mztczID, stringuserID . (63)7、 MZTCZHCInt(string HaccCode, decimal mztczID, string userID, stringreason (63)8、 QueryMZTCInfo1(string personCode, string HaccCode, string status, DateTime beginTime, DateTime endTime (64)9、 QueryMZTCInfo2(string HaccCode, string status . ..................................................65 10、 QueryMZTCInfo3(string personCode, string HaccCode, string status..................65门诊统筹接口使用流程 . ........................................................................................................ 66第四部分 2.0版本更新介绍和之前版本实施中的问题及解决方案 .. (67)一、 2.0版本更新介绍 . (67)二、之前版本实施中的问题及解决方案 . (67)1、 IS 供应商对 webservice 模式不清楚的 (67)2、某些平台出现报错(图 . (68)3、诊疗项目对码表下载失败 . (68)的问题 .........4、中文时比如说传处方医生姓名时传进农合系统变成“ ???????? ”685、负数冲帐的问题 . (68)6、安装接口服务器的情况 . (68)7、农合对价格控制问题 . .............................................................................................. 69接口测试网址和技术人员联系方式:. (69)第一部分接口介绍接口主要是为了解四川省新型农村合作医疗信息系统 (简称“新农合信息系统” 决有 HIS 系统的医疗机构在病人入院期间的每日清单录入问题,暂不涉及入院、出院、结算和农合的其他补偿方式 , 因此相关操作仍需要通过新农合系统来进行。
接口说明文档
6 接口设计6.1 接口基本要求为保证平台信息交互稳定性、便捷性和可扩展性，管道基础大数据平台服务接口应满足以下基本要求：a）接口对外接入应提供企业级的支持，在系统高并发时提供安全可靠的接入，应防止大量访问以及大量占用资源的情况发生，以实现对信息的全面保护，保障系统的正常运行；b）接口能够实现系统的平滑移植和扩展，在系统并发增加时提供系统资源的动态扩展；c）在进行扩容、新增扩展时，接口应能提供快速、方便、准确的信息交互实现方式；d）应支持跨语言、跨操作系统调用。
6.2 数据格式要求1、字符串遵循GB2312-1980 《信息交换用汉字编码字符集》的相关规定。
2、接口编码方式接口编码主要是对管道大数据平台所提供的调用接口进行统一的编码标识和命名。
本着适用、常用、易理解的原则，接口以帕斯卡命名法（pascal）方式编码，每个单词首字母大写。
3、接口参数格式参数格式规定如下：a）分为请求类参数和响应返回类参数，部分参数只有其中一类；b）所有的请求及响应返回类型可以是JSON，默认的类型在服务器启动参数里设置，也可以通过type=json参数强制指定；c）字段说明应包括参数名称、参数个数、参数类型和值。
4、接口响应格式接口响应的数据基于JSON（成功与失败通用返回）格式，其他要求如下：a）接口响应数据所使用的编码方式必须在返回encoding属性中说明；b）接口响应通用状态码如表1表1 接口响应通用状态码6.3 数据清单6.3.1 数据接口6.3.2 通用功能接口6.4 接口说明6.4.1 数据接口1、应急资源数据●接口描述：应急资源数据●请求参数：●请求类型：GET●响应字段说明2、应急仓库数据●接口描述：应急仓库数据●请求参数●请求类型：GET请求●响应字段说明3、应急队伍数据●接口描述：应急队伍数据●请求参数●请求类型：GET请求●响应字段说明4、传感器实时监测数据●接口描述：传感器实时监测数据●请求参数●请求类型：POST请求●响应字段说明5、城市基础地图数据●接口描述：城市基础地图数据●请求参数●请求类型：GET请求●响应字段说明6、城市行政区划数据●接口描述：城市行政区划数据●请求参数●请求类型：GET请求●响应字段说明6.4.2 通用接口1、镜头操控（1）定点巡查●镜头飞定点调用示例ue4api.camera.FlyTo(_x, _y, _z, _roll, _pitch, _yaw, _callBack, _time= 2);参数说明●停止镜头飞行调用示例ue4api.camera.cancelFlight();（2）镜头切换●设置镜头位置调用示例let options = {destination : new Vector3(36.81, -78.35, 24.4),orientation: new Rotator(0, -15, -46)}ue4api.camera.setView(options);参数说明（3）镜头围绕观察调用示例ue4api.camera.rotate (_time, _degrees, function (data) { (data);});参数说明2、POI点操控（1）添加文字调用示例：初始化let param = {id : 1, //唯一标识，不可重复,ue4x : 1000, //x轴ue4坐标ue4y : 1000, //y轴ue4坐标ue4z : 0,//z轴ue4坐标size : new Vector2(480, 180),//label的大小text : '测试文字',//显示的文字scale : 1,//缩放type : 'Type1',//可选字符串参数：Default,Type1,Type2backgroundColor : new Color(0.266356, 0.467784, 0.021219, 1),//文字框背景色fillColor : DefaultColor.yellow,//文字颜色distanceDisplayCondition : new Vector2(),//预留字段visibility : true//默认是否显示}var obj = ue4api.ObjectFactory.CreateLabel(param);参数说明：显示文字obj.show(true);隐藏文字obj.show(false);移除文字obj.removeFromMap();点选功能ue4api.measure.PickPosition(function (e) { (e);//点选文字的id});框选功能开启框选ue4api.SelectTool.select(function (data) { (data);data.selectedObj;//框选的文字的id数组})关闭框选ue4api.SelectTool.disSelect();（2）添加POI点调用示例：初始化let param = {id : 1, //唯一标识，不可重复,ue4x : 1000, //x轴ue4坐标ue4y : 1000, //y轴ue4坐标ue4z : 0,//z轴ue4坐标image: https:///down/png/1904/food-icons-const/waffles.png,//图片地址scale : 0.5,//缩放clickedScale : 0.7,visibility : true//默认是否显示alertWindow : {//可选，点击弹窗url : "http://localhost/testAlertWindow.html",//弹窗地址size : new Vector2(180, 90),//弹窗大小offset : new Vector2(50,-100)//弹窗位置，右：x正，下：y正}}var obj = ue4api.ObjectFactory.CreateBillboard(param);参数说明：显示POIobj.show(true);隐藏POIobj.show(false);移除POIobj.removeFromMap();点选功能ue4api.measure.PickPosition(function (e) {(e);//点选的点位信息//其中e.clickType做为单击事件，还是双击事件的判断//当单击点选时，e.clickType = 1//当双击点选时，e.clickType = 2});框选功能开启框选ue4api.SelectTool.select(function (data) {(data);data.selectedObj;//框选的文字的id数组})关闭框选ue4api.SelectTool.disSelect();3、路线操控（1）绘制路径调用示例：初始化let param = {id : 1, //唯一标识，不可重复showLength : true,//是否显示总长度pathWidth : 5000,//路径宽度faceScreen : false,//始终面向相机pathColor : DefaultColor.green,//路径颜色data : [new Vector3(-129.99,-7.41,0),new Vector3(-131.00,-134.96,0),new Vector3(113.83,-128.26,0),new Vector3(123.84,-550.99,0)… …]//路径点位数组，ue4坐标}var obj = ue4api.ObjectFactory.CreatePolyline(param);参数说明4、量测功能（1）高度量测调用示例开启量测var temp = ue4api.analysis.getMeasureHeight(function (e) {//回调alert(JSON.stringify(e));});移除量测temp.deleteObject();（2）折线距离量测调用示例开启量测var temp = ue4api.analysis.getDistanceHorizontal(function (e) { //回调alert(JSON.stringify(e));});移除量测temp.deleteObject();（3）平面面积量测调用示例开启量测var temp = ue4api.analysis.getPlaneArea(function (e) {//回调alert(JSON.stringify(e));});移除量测temp.deleteObject();（4）获取坐标调用示例开启获取坐标ue4api.measure.PickPosition(function (e) {alert(JSON.stringify(e));//e. objectName:模型内部编号//e. location:点击点位的ue4坐标});**拾取：左键双击**取消：右键单击5、特殊效果（5）时间特效调用示例ue4api.environment.ShowEffect(param);参数说明ue4api.environment.ShowEffect('evening'); 移除特效调用示例ue4api.environment.DisableEffect(param);参数说明同上指定时间调用示例ue4api.environment.SpecificTime(time);参数说明ue4api.environment.SpecificTime('8:15');（6）热力图特效调用示例let param = {id:1, //唯一标识，不可重复bbox: new bounds(-105000, 105000, 105000, -105000),//热力图覆盖区域边界，ue4坐标，（西，东，南，北）height:1000,//热力图整体高度data:[{x:0,//热力点ue4坐标y:0, //热力点ue4坐标value:0.8,//热力值，0~1radius: 5000//热力点范围},{x:500,y:500,value:0.5,radius: 3000}… …]}let heatObj = ue4api.ObjectFactory.CreateHeatmap(param);参数说明显示heatObj.show(true);隐藏heatObj.show(false);移除heatObj.removeFromMap();6、组件控件（1）柱状统计调用示例1、初始化let param = {id : 1, //唯一标识，不可重复value : 500,//值，必填buildingName :"SM_Building_20",//ue4中的建筑名称，可通过PickPosition获取location: new Vector(0,0,1000),//此参数跟buildingName二选一，指定柱状位置uintValue : 100,//单位高度代表的值，默认2500uintHeight: 1000,//单位高度，默认1000radius: 500, //柱子半径，默认500fontSize: 24,//显示数字大小，默认24divideValue : [150,450],//分组值，长度可变divideColor : [new Color(0.266356, 0.467784, 0.021219, 1), new Color(0.8125, 0.450415, 0, 1), new Color(0.817708, 0.017036, 0.017036,1)] //分组颜色，长度比divideValue多一个}ue4api.View.CreateStatisticCylinder(param);参数说明2.显示柱状obj.show(true);3、隐藏柱状obj.show(false);4、移除柱状obj.removeFromMap();。
省系统接口说明
附件1：市级系统接口参考页面1 说明本文档是关于……，要求……。
已达到……目的。
2 参考页面第一步客户端首先要设置web service的连接地址、用户名和密码三项。
远程地址固定为：http://124.133.54.21/services/DataService。
用户名和密码为省总队分配。
参考界面如下：帐号：3702-00-01密码: 123456第二步企业填报自己月报数据然后提交。
第三步市级用户审核企业提交的月报数据。
第四步市级进入提交审核页面。
审核通过的企业将在“企业列表”中显示。
将企业选择进“已选企业”。
然后点击“上传至省平台”按钮。
操作完成。
参考界面如下：附件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/DataService2.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,String cityCode,int year,int month,String reportData)方法说明：从各地市系统上传本市已经审核确认的企业月报数据到省系统，如果省系统中企业当月月报数据还未上传过，则添加月报数据，如果月报数据已经上传过，则更新已上传月报数据。