Web Services业务接口规范说明书
WEBSERVICE接口实例说明文档
WebService接口说明文档文档说明本文档主要讲述如何用C Sharp创建一个简单的Web Service接口,并使用Java调用这个Web Service接口。
准备工作系统环境:安装JDK1.6或更新版本开发工具:Microsoft Visual Studio2012、MyEclipse10.5、axis2-1.6.2C Sharp服务端1.首先,创建一个Web Service项目。
依次点击:文件—新建—项目,在弹出的新建项目窗口中选择Web下的空Web应用程序。
如下图:2.接下来我们需要创建我们的Web Service接口实现文件。
鼠标右击我们的项目,依次点击:添加—新建项,在弹出窗口中选择Web服务。
可修改新建项的文件名,注意文件名后缀后.asmx。
如下图:新建完成后我们的项目结构如下:3.打开我们新建的MyService.asmx下的MyService.asmx.cs文件,可以看到其中已经有默认的HelloWorld方法。
我们可以直接运行查看下运行的效果,效果如下图:点击HelloWorld,再点击调用可以看到页面返回:4.接下来我们完善我们的Web Service接口功能。
主要对Web Service接口进行参数类型的测试,文本型、布尔型、数值型、类(Class)等。
新增Add()等运算方法:新增strcat()连接字符串方法:新增GetBool()返回布尔值方法:新增GetTest()返回测试类,并新增Test类运行我们的项目,可以看到我们的结果如下图:点击add方法测试:输入add的参数i和j点击调用按钮,可以看到返回计算结果:5.到此为止我们C Sharp创建的Web Service程序完成。
接下来看Java如何调用我们的Web Service接口。
Java调用Web Service准备对于一个Web Service接口我们当前只知道访问的地址,我们如何用Java去访问接口呢?已知Web Service接口地址:http://localhost:11766/MyService.asmx?WSDLJava调用Web Service的方式有以下1.使用HttpClient2.使用Xfire3.使用axis2本文档示例选择的是axis2,首先到axis2网站下载axis2,网址:/axis2/java/core/download.cgi当前最新版本1.6.2。
宽乐通信WebService接口中间件接口说明书
宽乐通信Web Service接口中间件使用说明书广东省电信有限公司研究院2007年4月目录1总述 (3)1.1宽乐通信Web Service接口中间件简介 (3)1.2在第三方服务器内内作用和应用模式 (4)1.3第三方服务器应用开发架构 (5)2系统管理接口 (6)2.1业务参数管理服务 (6)2.2宽乐通信注册服务 (8)3用户接口 (10)3.1CTD接口 (10)3.1.1发起CTD呼叫 (11)3.1.2停止CTD呼叫 (12)3.1.3查询CTD呼叫信息 (13)3.2CTC接口 (14)3.2.1发起CTC呼叫 (15)3.2.2终止CTC的呼叫 (16)3.2.3添加与会者 (17)3.2.4剔除与会者 (18)3.2.5查询会议列表 (18)3.2.6查询会议信息 (19)3.3SMS接口 (21)3.3.1发送SMS (22)4第三方服务器应用对本中间件的回调服务 (23)4.1接收后向呼叫处理事件 (24)4.1.1设置回调地址回调事件 (24)4.1.2发起CTD呼叫回调事件 (24)4.1.3呼叫释放回调事件 (25)4.1.4发起CTC会议回调事件 (25)4.1.5与会者进入会议回调事件 (26)4.1.6与会者退出会议回调事件 (26)4.1.7会议释放回调事件 (27)4.1.8发送短信回调事件 (27)4.2SMS回执 (28)4.3接收SMS (29)5通用失败码 (30)摘要:本文档主要描述宽乐通信Web Service接口中间件在第三方服务器部署时为第三方服务器应用提供的接口说明。
对第三方服务器应用调用本中间件接口的开发架构,以及接口方法参数定义作了详细说明。
1总述1.1宽乐通信Web Service接口中间件简介宽乐通信Web Service接口中间件封装了宽乐通信平台Web Service接口通信的能力。
该中间件部署于第三方服务器上,使得第三方服务器上的应用可以通过对本中间件的接口调用而达到接入和使用宽乐通信业务多媒体通信能力的目的。
Web-Service接口使用说明
短信接口使用说明短信接口简介公司网址:56短信网接口是采用C#.Net开发的Web Service,URL地址为:/WebServiceInterface.asmx支持的接口用户可以通过Web Service接口实现用户登陆,发送短信,密码修改,我们还可以根据不同的需要给客户提供不同的接口功能.接口优势1.与移动,联通,电信运营商合作,快捷,高效,成功率达到99% 以上.2.接入方式可灵活使用,保证客户短信的质量。
3.24小时发送,单条即发即收,群发可能少有延迟。
4.适用于各种软件\系统\平台\网站\OA\CRM\ERP\SCM等使用5.发送内容,手机号,自行设定,可定时发送.6.支持500个字的超长短信,可自定义签名。
7.为您提供多种接口,任何语言均可方便,简单接入.8.提供技术支持,免费接入短信接口。
参数说明1. 发送短信调用方法:int SendNote(string handtels,string _content,string userName,string password,string cid,string _sendtime,string _smsnumber)返回值说明:2.用户登陆调用方法: UserLogin(string userName, string password,string cid)返回值说明:3.修改密码调用方法: EditUserPwd(string username, string userpwd,string newpwd,string cid)4.短信剩余条数调用方法: int ReturnUserFullMoney(string username, string password,string cid)返回值说明:5.接受回复短信调用方法: string NoteBack(string _cid, string _username, string _userpwd, string zid, string返回值说明:Xml回复格式<?xml version="1.0" encoding="GBK" ?><backnotes><backnote>//手机号<back_content>老地方见吧</back_content> //内容<back_zid>12</back_zid> //子号<back_time>2011-6-16 16:38:48</back_time> //回复时间</backnote><backnote>//手机号<back_content>你是说</back_content> //内容<back_zid>12</back_zid> //子号<back_time>2011-6-16 16:38:50</back_time> //回复时间</backnote></backnotes>Text 回复格式回复短信和短信之间是用分号分开(说明:如果回复的内容中出现|或;号,请用其它字符替换,如果不能替换的,请调用xml回复格式)格式:手机号|回复短信的内容|时间;6.调用接口新开用户(此接口只适合代理用户)调用方法:string AddNewUser(string aid, string auserName, string apwd, string nusername, string npwd, string customername, string customertel, string customerqq, string customeremaill, string返回值说明:7.短信充值,此接口只适合代理用户(此接口只适合代理用户)调用方法:string FullMoney(string aid, string aname, string apwd, string userid, string username, string tomoney, string action)返回值说明:。
webservice接口说明文档
webservice接口说明文档1、组织结构–部门原始资料增加(一般用在初始化数据时) (2)2、组织结构–部门原始资料更新(紧跟DptAdd函数执行) (2)3、组织结构–部门删除 (2)4、组织结构–部门更新 (3)5、组织结构–单个部门增加 (3)6、组织结构–员工原始资料更新(将服务器临时表里的员工原始资料导入到使用的数据表里) (4)7、组织结构–员工原始资料添加 (4)8、组织结构–人员删除 (5)9、组织结构–人员增加(直接更新到后台数据库) (5)10、组织结构–人员更新 (6)11、OA调用发消息 (7)12、组织结构–增加企业 (8)13、组织结构–编辑企业 (8)14、删除企业 (9)15、企业、部门、员工查询 (9)16、角色权限增加 (10)17、角色权限编辑 (10)18、角色权限删除 (11)注明:所有函数的CRC值默认为calling1、组织结构–部门原始资料增加(一般用在初始化数据时)方法名称DptAdd (String DepartID, String DepartName, String ParentID,, String EID,String CRC)参数说明:返回类型: Integer返回值说明: -1 缺少必填参数,0 增加成功,1 增加数据发生未知错误,2 企业不存在 -2 数据库连接错误2、组织结构–部门原始资料更新(紧跟DptAdd函数执行)方法名称DptAddExe (String EID,String CRC,)参数说明:返回类型: Integer返回值说明: -1 缺少必填参数,0 操作成功,1 更新数据时发生错误,2 企业不存在-2 数据库连接错误3、组织结构–部门删除方法名称DptDelete (String DepartID)参数说明:返回类型: Integer返回值说明: -1 缺少必填参数,0 删除成功,1 删除数据发生未知错误,2 部门不存在,3企业不存在-2 数据库连接错误4、组织结构–部门更新方法名称: DptEdit (String DepartID,String DepartName,StringParentID, String EID, String CRC)参数说明:返回类型: Integer返回值说明: -1 缺少必填参数,0 编辑成功,1 删除数据发生未知错误,2部门不存在,3父部门不存在,4 没有要修改的项目,5 企业不存在-2 数据库连接错误5、组织结构–单个部门增加方法名称: DptAddOne (String DepartID,String DepartName,StringParentID,, String EID, String CRC)参数说明:返回类型: Integer返回值说明: -1 缺少必填参数,0 增加成功,1 增加数据发生未知错误,2父部门不存在,3 企业不存在 4 部门已经存在-2 数据库连接错误6、组织结构–员工原始资料更新(将服务器临时表里的员工原始资料导入到使用的数据表里)方法名称EmpAddExe (String EID,String CRC)参数说明:返回类型: Integer返回值说明: -1 缺少必填参数,0 操作成功,1 更新数据时发生错误,2 企业不存在-2 数据库连接错误7、组织结构–员工原始资料添加(将人员资料插入一条到服务器上的临时表里,一般用在起初数据初始化的时候,将记录先循环插入到临时表里,然后使用DptAddExe 函数更新临时表,将原始人员资料导入到使用的数据表里)方法名称EmpAdd(String ID, String CorporationId, String DepartmentId, String duty, String email, String mobile, String realName , String sex, String workCode,String password, String telphone, String String Fax, String CodeType, String CRC)参数说明:返回类型: Integer返回值说明: -1 缺少必填参数,0 增加成功,1 增加数据发生未知错误,-2 数据库连接错误2 部门不存在3 员工已存在4 企业不存在8、组织结构–人员删除方法名称EmpDelete (String ID, String EID,String CRC)参数说明:返回类型: Integer返回值说明: -1 缺少必填参数,0 删除成功,1 删除数据发生未知错误,2 员工不存在3 企业不存在-2 数据库连接错误9、组织结构–人员增加(直接更新到后台数据库)方法名称EmpAddOne (String ID, String CorporationId, String DepartmentId, Stringduty, String email, String mobile, String realName , String sex, String workCode, String password, String telphone, String String Fax, String CodeType, String CRC) 参数说明:返回类型: Integer返回值说明: -1 缺少必填参数,0 增加成功,1 增加数据发生未知错误,2部门不存在,3员工已经存在,4 企业不存在-2 数据库连接错误10、组织结构–人员更新方法名称EmpEdit (String ID, String EID, String DepartID, String duty, String email, String mobile, String realName , String sex, String workCode, String password, String telphone, String String Fax,String CodeType, String CRC,String State)参数说明:返回类型: Integer返回值说明: -1 缺少必填参数,0 增加成功,1 增加数据发生未知错误,2部门不存在3 员工不存在 4 企业不存在-2 数据库连接错误5没有需要修改的项目 6 角色不存在注释:如果许可为空的字段想变化为空的话,以空格为参数值,password,workCode,realName,sex的修改不能以空格表示为空,因为这2个字段不许可为空,如果参数为空则不会修改11、OA调用发消息方法名称:SendOAMessage(String Sender, String Receiver,String BContent, String Title, String MessageType ,String MessageImport, String EID, String CRC)返回类型: integer返回结果: 0 成功,1 失败,-1 缺少必填参数,2 企业不存在,3发送者不存在,4接受者有不存在, 5 网络错误-2 数据库连接错误12、组织结构–增加企业方法名称:CorpAdd(String EID,String brief, String address, String email, String fax, String fullName,String CRC)参数说明:返回类型: Integer返回值说明: -1 缺少必填参数,0 增加成功,1 增加数据发生未知错误,2 输入的公司人数超过了系统的许可, 3 企业ID已经存在-2 数据库连接错误13、组织结构–编辑企业方法名称:CorpEdit(String EID, String brief,String address, String email, String fax, String fullName,String CRC)参数说明:返回类型: Integer返回值说明: -1 缺少必填参数,0 操作成功,1 删除数据时发生错误,2企业不存在3 没有要编辑的项目-2 数据库连接错误注释:如果许可为空的字段想变化为空的话,以空格为参数值,对于brief,不修改则为空,如果为空则不修改14、删除企业方法名称: CorpDelete (String EID,String CRC)参数说明:返回类型: Integer返回值说明: -1 缺少必填参数,0 操作成功,1 删除数据时发生错误,2 企业不存在-2 数据库连接错误15、企业、部门、员工查询方法名称: GetIDBool (String GetType,String EID,String ID, String CRC) 参数说明:返回类型: Integer返回值说明: -1 缺少必填参数, 1 查询数据时发生错误,-2 数据库连接错误-3 企业不存在 3 企业存在 -4 部门不存在 4 部门存在 -5 员工不存在 5 员工存在 6 查询类型错误注释:GetType 为1时ID 可为空,否则不许可为空,在部门和员工查询时,如果企业不存在,则报部门或者员工不存在16、角色权限增加方法名称UserRole Add(String RoleName, String Rights ,String EID,String CRC,) 参数说明:返回类型: Integer返回值说明: -1 缺少必填参数, 1 查询数据时发生错误,-2 数据库连接错误 2 企业不存在 3 角色已存在0成功17、角色权限编辑方法名称UserRoleedit(String RoleName, String Rights ,String EID,String CRC,) 参数说明:返回类型: Integer返回值说明: -1 缺少必填参数, 1 查询数据时发生错误,-2 数据库连接错误,2修改类型错误,3新角色名称不能为空,4企业不存在,5角色不存在0成功18、角色权限删除方法名称UserRoleDel(String RoleName, String EID,String CRC,)参数说明:返回类型: Integer返回值说明: -1 缺少必填参数, 1 查询数据时发生错误,-2 数据库连接错误 2 企业不存在0成功。
webservice 接口说明
webservice 接口说明WebService 接口说明:WebService 是一种基于 Web 技术开发的软件系统,它使用标准的 HTTP 协议进行通信,通过网络提供各种功能的接口。
本文将介绍 WebService 接口的基本概念和使用方法。
1. 接口类型:WebService 接口分为两种类型:SOAP 和 REST。
SOAP(Simple Object Access Protocol)是一个基于 XML 的协议,用于在 Web 上进行分布式计算。
它使用 SOAP 消息进行通信,可以在不同的平台和语言之间进行交互。
而 REST (Representational State Transfer)是一种轻量级的 Web 服务架构风格,基于 HTTP 协议实现资源的表述和访问。
2. 接口描述语言:WebService 接口使用描述语言来定义接口和数据格式。
常用的描述语言有WSDL(Web Services Description Language)和 Swagger。
WSDL 是一种 XML 格式的描述语言,用于描述 WebService 接口的操作、消息和数据类型。
Swagger 是一种由 JSON 或 YAML 编写的开源工具,可以生成易于阅读的接口文档。
3. 接口功能:WebService 接口提供了各种功能,包括数据查询、修改、上传、下载等。
通过调用接口,可以获取或提交数据,实现不同系统之间的数据交互。
接口功能由具体的接口方法来实现,方法的参数和返回值通常使用 XML 或 JSON 格式进行传输。
4. 接口调用:WebService 接口的调用可以使用各种编程语言和开发工具。
开发者可以根据接口描述文档,使用相应的语言生成客户端代码或使用现有的 SOAP 或 REST 客户端库进行接口调用。
在调用接口时,需要提供相应的参数,并按照接口要求进行数据格式转换和加密等操作。
5. 接口安全:WebService 接口的安全性非常重要,需要采取一些安全措施来保护接口的访问和数据的传输。
webservice接口文档
WebService接口文档文档版本号:v9.9.5更新时间:2016年09月28日重要说明本人/本公司在使用本软件过程中,将严格遵守国家相关法律、法规、保证本公司信息发布的安全,并切实做到:(1)建立健全本公司信息发布的内部保障制度、信息安全保密制度、用户信息安全管理制度,建立健全本公司信息安全责任制度和信息发布的审批制度,严格审查本公司产品所发布信息。
(2)严格遵守《互联网信息服务管理办法》,对用户编辑的信息内容进行把关,保证信息内容的健康、合法。
(3)明确本企业的客户群和客户范围,所有通讯受众必须是自愿且明确同意接受企业服务。
(4)若发送未经用户允许的信息等所造成的影响、投诉等一切损失与本软件版权方无关、由本人/本公司承担全部责任;同时,本人/本公司也应承担若因此给本软件版权方造成的全部损失。
(5)不利用本软件制作、复制、发布、传播含有下列内容的信息:✧反对宪法所确定的基本原则的;✧危害国家安全,泄露国家秘密,颠覆国家政权,破坏国家统一的;✧损坏国家荣誉和利益的;✧煽动民族仇恨、民族歧视,破坏民族团结的;✧破坏国家民族宗教政策,宣扬邪教和封建迷信的;✧散布谣言,扰乱社会秩序,破坏社会稳定的;✧散布淫秽、色情、赌博、暴力、凶杀、恐怖或者教唆犯罪的;✧侮辱或者诽谤他人,侵害他人合法权益的;✧含有法律、行政法规禁止的其他内容的;(6)自信息发布六个月内不修改删除信息发送日志内容,日志记录的备份应至少保持6个月以上,在国家机关进行依法查询时,予以提供。
(7)若发现本公司所发布的信息明显属于上述第(5)款所列内容,保证立即停止传输,并向国家有关机关报告。
(8)对本公司所发布的信息一时难以辨别是否属于以上所列内容之一的,应报相关主管部门审核同意后再发布。
(9)对客户的个人信息保密,未经客户同意不得向他人泄漏,但法律规定的除外。
本人/本公司保证:在使用本软件进行信息发布活动中,服从监督和管理;若未做到上述一至八条,本人/本公司愿意承担由此引起的一切法律责任,并接受相应的处罚。
02接口说明-03WebService使用验证说明
WebService使用验证说明何彬贤v1.0版本记录[此部分要记录该文数据形成过程中的历次版本变更过程及变更的内容,如果有CQ记录,填写变更号]版本变更日期变更内容变更人审批人变更号** 2010-06-29 WebService使用验证说明何彬贤服务清单服务服务文件说明部门服务**流程服务**登录服务**邮件服务**物料服务**工艺服务**用户服务**业务类型服务**以上各种服务都可以进行使用验证操作。
使用验证启用说明由于PLMService已在比较多的接口程序中使用,为了兼容旧的接口程序(有源代码或无源代码),所以对PLMService使用验证的启用作了一个配置项。
具体配置如下:在Web.config下找到如下字符串:<add key="IsUseValidate"value="true"/>当IsUseValidate的值为true时启用身份认证,当不添加该行或设置其值为false时,不启用身份认证。
不启用身份认证时,旧的WebService调用方式可以使用。
用户服务(作例子)服务概述提供获取用户信息、添加用户等服务。
应用场景此处描述该服务场景的应用场景;服务信息服务全名称接口说明类型(中英文)入/返说明可空接口名称(中英文)上下文对象SecurityContext入该对象包括Y在每一个WebService中。
它包括以下两个属性字段:UserCode与PassWord用户账号UserCode 入PLM系统数Y据库的用户账号,并且该用户要是管理员角色才能调用Service服务Y 用户密码PassWord 入PLM数据库的用户密码接口详细描述此处描述接口数据的实体关系图,请从中截图;Note:1)接口务求详细描述;2)非空存在两种解释,一、该字段在实体数据模型上是非空的;二、该字段在本服务接口是非空的;此处非空应理解为第2中,即:数据模型非空,但是服务内部对该字段有默认设置,故该字段在本服务中属于可空(或者应不可见)测试用例[给出主要的流程的黑盒测试用例]应用案例-场景:PLM用户信息获取代码示例范例场景BOM创建服务的使用;范例代码调用的是用户服务(UserWebService.asmx),源代码在PLMWSDemo.rar压缩包文件夹下的:Program.cs与TestUserService.cs下。
webservice 接口格式
webservice 接口格式WebService(Web服务)是一种基于标准化的协议和格式进行数据交换的服务,通过HTTP协议进行通信,可实现跨平台和跨语言的数据交互。
在使用WebService时,接口格式是非常重要的,它定义了请求和响应的数据结构、编码方式、协议以及其他通信细节。
本文将介绍WebService接口格式的一些常见规范和最佳实践。
首先,一个标准的WebService接口通常使用XML(可扩展标记语言)格式来描述请求和响应的数据。
XML是一种结构化的数据格式,可以很好地描述各种数据类型和复杂的数据结构。
因此,采用XML格式可以提供更灵活和可扩展的接口。
接口格式的定义通常包括以下几个方面:1. SOAP(Simple Object Access Protocol)标准:SOAP是一种基于XML的通信协议,用于在Web服务之间交换结构化的数据。
SOAP定义了消息的格式、编码方式、通信协议等内容。
在使用SOAP协议时,请求和响应的数据将被封装在SOAP Envelope中,并通过HTTP进行传输。
SOAP协议的优势在于它的跨平台和跨语言特性,可以实现不同系统之间的数据交互。
2. WSDL(Web Services Description Language)描述:WSDL是一种用于描述WebService接口的语言,它使用XML格式描述接口的各个方面,包括输入参数、输出参数、方法、消息格式等。
WSDL文件可以帮助客户端和服务器之间建立有效的通信,并在使用WebService时提供自动化生成代码的功能。
3. 数据编码方式:WebService接口通常使用XML编码数据,但也可以使用其他编码方式,如JSON(JavaScript Object Notation)等。
JSON是一种轻量级的数据交换格式,易于阅读和理解。
使用JSON格式可以减少数据的传输量,并提高数据交换的效率。
在选择数据编码方式时,需要根据实际需求和系统约束进行选择。
webservice 接口调用规则
Web服务接口调用规则是用于规范和描述如何与Web应用程序交互的一组协议和规范。
这些规则通常包括以下方面:1. URL:Web服务接口的统一资源定位符(URL)用于标识接口的位置。
通常,URL 遵循这样的格式:`scheme://hostname[:port]/path`。
其中,scheme表示协议(如http或https),hostname表示服务器的主机名,port表示服务器的端口号,path表示接口的路径。
2. 请求方法:Web服务接口通常支持多种HTTP请求方法,如GET、POST、PUT、DELETE等。
这些方法用于指定对资源的操作类型。
3. 请求参数:请求参数是传递给Web服务接口的数据。
它们可以包含在URL中(对于GET方法)或在请求体中(对于POST、PUT和DELETE方法)。
参数通常采用键值对的形式,其中键表示参数名,值表示参数值。
4. 请求头:请求头包含在HTTP请求中,用于传递有关请求的其他信息,如内容类型、编码格式、认证信息等。
5. 请求体:请求体是用于传递具体数据的HTTP请求部分。
它通常包含在POST、PUT 和DELETE请求中。
请求体可以采用不同的格式,如JSON、XML或表单数据。
6. 响应状态码:Web服务接口返回的HTTP响应状态码用于表示请求的结果。
状态码通常是一个三位数,其中,2xx表示成功,3xx表示重定向,4xx表示客户端错误,5xx表示服务器错误。
7. 响应头:响应头包含在HTTP响应中,用于传递有关响应的其他信息,如内容类型、编码格式、认证信息等。
8. 响应体:响应体是用于传递具体数据的HTTP响应部分。
它通常包含在2xx状态码的响应中。
响应体可以采用不同的格式,如JSON、XML或HTML。
9. 认证和授权:Web服务接口可能需要进行认证和授权,以确保只有具有相应权限的用户才能访问。
这通常通过在请求头中传递认证凭据(如用户名和密码)或使用令牌(如JWT)来实现。
webservice 接口调用规则
webservice 接口调用规则全文共四篇示例,供读者参考第一篇示例:Webservice是一种基于网络的通信协议,通过HTTP协议进行数据交换的一种技术。
在现代的软件开发中,使用Webservice接口可以方便不同系统之间的数据交换和通信。
在实际的开发过程中,了解和遵循Webservice接口调用规则是非常重要的,可以确保系统之间的正常通信和数据交换。
下面我们就来介绍一些关于Webservice接口调用规则的内容。
1. 接口文档的重要性在使用Webservice接口进行开发之前,首先需要阅读并了解相关的接口文档。
接口文档通常包括接口的详细说明、参数的说明、返回结果的格式等内容。
通过仔细阅读接口文档,开发人员可以清楚地了解接口的使用方法和规则,从而能够正确地调用接口,并处理返回的数据。
2. 参数的传递方式在调用Webservice接口时,通常需要传递一些参数给接口,以便接口能够正确地处理请求并返回相应的结果。
在传递参数时,需要遵循一定的规则,例如参数的格式、参数的类型等。
通常情况下,参数可以通过URL的查询字符串传递,也可以通过POST请求的正文传递。
开发人员需要根据接口文档的要求,正确地传递参数给接口。
3. 接口的认证和授权为了保证接口的安全性,通常需要进行接口的认证和授权。
接口的认证可以通过用户名和密码进行,也可以通过令牌进行。
在调用接口时,需要正确地提供认证信息,以便接口能够验证请求的合法性。
接口还需要进行授权,即检查调用者是否有权限调用接口。
开发人员需要明确了解接口的认证和授权规则,并正确地进行认证和授权。
4. 接口的错误处理在调用Webservice接口时,可能会出现一些错误,例如网络故障、参数错误等。
在接口返回错误时,开发人员需要正确地处理错误,例如记录错误日志、返回错误信息等。
接口也应该提供清晰的错误码和错误信息,以便调用者能够及时地识别和处理错误。
开发人员需要根据接口文档中定义的错误码和错误信息,正确地处理接口返回的错误。
WebServices业务接口规范说明书
开放式虚拟仿真实验教学系统Web Services业务接口规范说明书1.范围本规范文档主要适用于开放式虚拟仿真实验教学系统和其它业务系统信息数据的接入。
2.术语、定义和缩略语2.1术语、定义2.2缩略语3.接口设计3.1接口公共参数接口服务器通过:http://IP:port/EIP/WebService/ 连接服务器,同时对外提供业务功能接口,接收的参数和返回的参数都用一定的xml格式进行封装。
3.1.1请求参数1.请求类型为String类型<?xml version="1.0" encoding="utf-8" ?><request><header type ="xx01" version="1.0" reqtype="0" userid="user000000000001"></header><param></param></request>2.头部参数体head定义请求参数的头部参数体header格式固定,定义如下:3.请求参数体param定义参数体param中的具体请求参数,根据不同的业务而不同,详见各业务接口。
3.1.2返回参数1.返回类型为String类型<?xml version="1.0" encoding="utf-8"?><response><header type ="XX01" value="XX00" info="成功"></header><result></result></response>2.头部参数体head定义返回参数的头部参数体header格式固定,定义如下:3.返回值参数体result定义参数体result中的具体返回参数,根据不同的业务而不同。
webservice接口标准
webservice接口标准Webservice接口标准。
一、概述。
Webservice是一种基于Web的远程接口技术,通过使用XML标准来传输数据,实现不同平台、不同语言之间的通信。
在实际开发中,为了确保不同系统之间的互操作性和稳定性,需要遵循一定的Webservice接口标准,以便统一接口规范,提高系统集成的效率和质量。
二、Webservice接口标准的重要性。
1. 提高系统互操作性,Webservice接口标准可以确保不同系统之间的互操作性,使得系统能够无缝集成,实现数据的共享和交换。
2. 统一接口规范,通过制定Webservice接口标准,可以统一接口规范,减少接口的冗余和混乱,提高开发效率。
3. 降低系统集成成本,遵循Webservice接口标准可以减少系统集成的成本,提高系统集成的效率和质量。
三、Webservice接口标准的内容。
1. 接口命名规范,接口命名应该简洁明了,能够准确描述接口的功能和用途,避免使用过于复杂的命名方式。
2. 接口参数规范,接口参数应该明确规定参数的类型、长度、取值范围等,确保接口参数的准确性和安全性。
3. 接口返回规范,接口返回的数据格式应该统一规范,例如使用JSON或XML格式,便于不同系统进行解析和处理。
4. 接口错误处理规范,接口应该规范定义错误码和错误信息,便于调用方进行错误处理和排查问题。
5. 接口安全规范,接口需要考虑安全性,例如使用HTTPS协议进行数据传输,对接口进行权限控制等。
四、Webservice接口标准的实施。
1. 制定统一的接口标准文档,在项目开发初期,需要制定统一的Webservice接口标准文档,明确规定接口的命名规范、参数规范、返回规范等。
2. 基于标准进行开发,开发人员在实际开发过程中,需要严格按照接口标准文档进行开发,确保接口的一致性和规范性。
3. 接口测试和验收,在接口开发完成后,需要进行接口测试和验收,验证接口的准确性和稳定性。
webservice接口说明文档模板
竭诚为您提供优质文档/双击可除webservice接口说明文档模板篇一:项目接口需求及设计说明文档(模板)客户化开发需求规格说明书媒讯集团eas项目ctc与eas接口需求及设计说明书文档作者:创建日期:20xx-05-10确认日期:当前版本:1.0拷贝数量:1审批签字:客户方:实施方:文档控制目录1.概述..............................................................................................41.1读者................................................. ................................................... ..............................................41.2图例................................................. ................................................... ..............................................41.3目的................................................. ................................................... ..............................................4二、业务现状................................................. .............................. ................................................... ...............5三、概要设计................................................. ................................................... (5)3.1接口通讯方................................................... ...............................53.2通讯内容定义................................................. ................................................... ...............................53.3媒讯ctc系统提供接口使用范例................................................. . (53).4金蝶eas提供接口使用范例................................................. ................................................... ......53.5媒讯ctc系统提供接口服务地址................................................. . (73).6金蝶eas提供接口服务地址................................................. ................................................... ......73.7接口需求................................................. ................................................... .......................................7四、详细设................................................... (8)4.1xxeas接口................................................. ................................................... .. (8)1.概述金蝶与用户及用户业务系统方通过多次讨论,制定了接口开发需求设计说明书,作为双方后续开发指引。
WebService 接口说明 1下载文档
WebService 接口说明 1下载文档WebService2006-8-5一、接口定义a) SendMessage 批量发送短信方法 (userID)i. public SendState SendMessage(string UserId, string Password, string Msg, stringDestnumbers)ii. 参数说明:UserId 用户Id(晴朗平台识别的用户号码), 49字节以内。
Password 密码, 99字节以内Msg 短信内容, 159字节以内 Destnumbers 目标号码,用分号(;)分隔,在一万条以内。
iii. 返回值public class SendState{public int state;public string WrongNumbers;public string YDGroupId; // 发送到移动的短信的批次号public string LTGroupId; // 发送到联通的短信的批次号}state 0: success2: 失败需要重发4: 内容不合法5: 身份验证错误6: 服务器错误8: 短信数超过可用数12: 该用户不允许使用子用户ID13: 错误的号码格式WrongNumbers 为错误的目标号码,用分号分隔,目前只是按移动和联通进行过滤。
即不属于联通或移动的号码会被放入这里。
YDGroupId, LTGroupId 发送的短信所属的批次号,用于以后查询短信的发送状态。
b) SendMessageWithSub 发送短信时带有子号码 (userID)i. public SendState SendMessageWithSub(string UserId, string SubId, stringPassword, string Msg, string Destnumbers)ii. 参数说明UserId 用户Id(晴朗平台识别的用户号码),49字节以内。
龙通讯webservice使用说明(简版)
短信接口使用说明目录一.Webservice接口 (3)1.1 webservice返回集合对照表 (3)1.2 注册 (3)1.3 充值 (4)1.4 balance 查询余额 (4)1.5 mo 接收短信 (5)1.6 msgid 获取msgid (5)1.7 mt 短信发送 (5)二.Jar包 (6)2.1 Client 初始化 (6)2.2 注册 (6)2.3 充值 (7)2.4 getBalance 获取余额 (7)2.5 mt 发送短信 (7)2.6 mo 接收短信 (8)2.7 msgid 获取msgid (8)一.Webservice接口Webservice地址:http://ip:port /webservice.asmx,详细地址请咨询客户经理Sn:软件序列号(XXX-XXX-XXX-XXXXX,如SDK-BBX-010-00001)pwd:加密密码md5(sn+password) ,password是序列号的6位密码如无特殊说明,参数均为Stirng类型1.1 webservice返回集合对照表1.2 注册返回值:执行结果(String)1.3 充值返回值:执行结果(String)1.4 balance 查询余额函数返回值:String(余额)示例:序列号SDK-BBX-010-00001 密码123456参数输入:SN= SDK-BBX-010-00001PWD=3B5D3C427365F40C1D27682D78BB31E0 参数输出:1031.5 mo 接收短信函数返回值:Stirng返回值说明:mo ID,特服号,手机号,内容(对内容进行gb2312解码),时间,如有多条回车换行隔开返回示例:4464020,62891,138****065,ceshi%2fchangsheng,2009-10-1915:51:05 4464023,62891,139****404,test%2fchangsheng,2009-10-19 15:51:171.6 msgid 获取msgid函数返回值:String (序列号最近100次发送成功的msgid,以英文逗号隔开)返回示例:200910191451432500,200910191302279218,200910191209564687,20 0910191209009375,2009101912004209371.7 mt 短信发送函数返回值:String (唯一标识,即当前发送短信批次的唯一标识,和rrid对应,如为空则返回系统生成的rrid)示例1:输入参数:SN= SDK-BBX-010-00001PWD=3B5D3C427365F40C1D27682D78BB31E0Mobile:139***404,138***213…………….Content:测试Ext:21(如果不是网络版,请置空)Stime: 2009-10-19 16:34:00 (如果不需要定时,请置空)Rrid:123456 (如果填写则系统返回填写内容,如果置空,返回系统生成的rrid)输出参数:123456示例2SN= SDK-BBX-010-00001PWD=3B5D3C427365F40C1D27682D78BB31E0Mobile:139***404,138***213…………….Content:测试Ext:Stime:Rrid:输出参数:200910191639362343二.Jar包2.1 Client 初始化返回值:无2.2 注册返回值:执行结果(String)2.3 充值返回值:执行结果(String)2.4 getBalance 获取余额传入参数:无返回值:余额(String)2.5 mt 发送短信示例1:返回值:rrid(唯一标识String)Mobile:139***404,138***213…………….Content:测试Ext:21(如果不是网络版,请置空)Stime: 2009-10-19 16:34:00 (如果不需要定时,请置空)Rrid:123456 (如果填写则系统返回填写内容,如果置空,返回系统生成的rrid)输出参数:123456示例2:Mobile:139***404,138***213…………….Content:测试Ext:Stime:Rrid:输出参数:2009101916393623432.6 mo 接收短信传入参数:无返回值:Stirng返回值说明:mo ID,特服号,手机号,内容(对内容进行URL解码),时间,如有多条回车换行隔开返回示例:4464020,62891,138****065,ceshi%2fchangsheng,2009-10-1915:51:05 4464023,62891,139****404,test%2fchangsheng,2009-10-19 15:51:172.7 msgid 获取msgid函数返回值:String (序列号最近100次发送成功的msgid,以英文逗号隔开)返回示例:200910191451432500,200910191302279218,200910191209564687,20 0910191209009375,200910191200420937。
WebService 接口说明 1下载文档
WebService 接口说明 1下载文档WebService2006-8-5一、接口定义a) SendMessage 批量发送短信方法 (userID)i. public SendState SendMessage(string UserId, string Password, string Msg, stringDestnumbers)ii. 参数说明:UserId 用户Id(晴朗平台识别的用户号码), 49字节以内。
Password 密码, 99字节以内Msg 短信内容, 159字节以内 Destnumbers 目标号码,用分号(;)分隔,在一万条以内。
iii. 返回值public class SendState{public int state;public string WrongNumbers;public string YDGroupId; // 发送到移动的短信的批次号public string LTGroupId; // 发送到联通的短信的批次号}state 0: success2: 失败需要重发4: 内容不合法5: 身份验证错误6: 服务器错误8: 短信数超过可用数12: 该用户不允许使用子用户ID13: 错误的号码格式WrongNumbers 为错误的目标号码,用分号分隔,目前只是按移动和联通进行过滤。
即不属于联通或移动的号码会被放入这里。
YDGroupId, LTGroupId 发送的短信所属的批次号,用于以后查询短信的发送状态。
b) SendMessageWithSub 发送短信时带有子号码 (userID)i. public SendState SendMessageWithSub(string UserId, string SubId, stringPassword, string Msg, string Destnumbers)ii. 参数说明UserId 用户Id(晴朗平台识别的用户号码),49字节以内。
WebService接口配置说明
WebService接口说明Ver 1.0四川恒光科技信息有限公司2006.5一、调用地址http://61.236.127.167/sms/smsservice.asmx?wsdl二、接口定义1.SendSMS 发送短信a.定义public SendResult SendSMS(string Username, string Password, string Content, stringNumbers)b.c.返回值public class SendResult{/// <summary>/// 发送状态(0:成功;-102:余额不足;-201:用户名/密码错误)/// </summary>public int State;/// <summary>/// 短信编号/// </summary>public string SID;}2.QuerySMS 查询短信发送状态a.定义public QueryResult QuerySMS(string Username, string Password, string SID)b.参数c.public class QueryResult{/// <summary>/// 查询状态(0:成功;-201:用户名/密码错误;-203:编号错误)/// </summary>public int QueryState;/// <summary>/// 发送总数/// </summary>public int Total;/// <summary>/// 成功数/// </summary>public int Success;/// <summary>/// 发送状态/// </summary>public int SendState;/// <summary>/// 内容/// </summary>public string Content;/// <summary>/// 失败号码/// </summary>public string[] FailedNum;}3.QueryRest 查询余额a.定义public RestResult QueryRest(string Username, string Password)b.参数c.返回值public class RestResult{/// <summary>/// 状态(0:成功;-201:用户名/密码错误)/// </summary>public int State;/// <summary>/// 余额/// </summary>public int Count;}4.ChangePwd 修改密码a.定义public int ChangePwd(string Username, string OldPwd, string NewPwd)b.参数c.返回值0:成功-201:用户名/原密码错误5.ReceiveSMS 接收上行短信a.定义public ReceiveResult ReceiveSMS(string Username, string Password) b.c.public class ReceiveResult{/// <summary>/// 状态(0:成功;-201:用户名/密码错误)/// </summary>public int State;/// <summary>/// 总数/// </summary>public int Count;/// <summary>/// 来源/// </summary>public string[] From;/// <summary>/// 内容/// </summary>public string[] Content;/// <summary>/// 时间/// </summary>public string[] Time;}三、常见问题1.每个号码之间使用半角逗号(,)分隔。
泛微OA工作流WebService接口使用说明书
工作流WebService接口使用说明一、检查部署是否成功:输入下面的地址192.168.4.183(换成实际的地址):8060(实际的端口号)/services/,界面中有如下服务即可:采用Web Serverice技术进行协同系统和业务系统进行数据交互,由协同系统方开发实现Web Serverice服务,业务系统方需在本地实现Web Serverice本地代理来进行调用。
协同系统方需提供的服务接口如下:1、流程创建接口2、流程流转控制接口提供流程提交,退回和转发控制接口3、需业务系统处理的任务列表根据用户id和流程id获取该人员需要业务系统处理的任务列表,如果需要获取表单的数据在通过reqestid调用获取表单数据接口4、获取表单数据接口根据协同系统中流程主键requestid获取表单中所有数据5、已归档任务列表根据创建人id和流程id获取已经归档的任务列表2.2.2接口说明接口名称参数说明返回值功能描述创建新流程:doCreateWorkflowReques t WorkflowRequestInfo wri:请求信息对象userId:用户idString:新流程的requestid如果小于0表示失败-1:创建流程失败-2:用户没有流程根据请求信息对象创建一条新的流程,请求信息对象中需包含创建人、创建流程id和表单的数接口对象说明:1)WorkflowRequestInfo 工作流请求信息/*** 请求ID*/private String requestId;/*** 请求标题*/private String requestName;/*** 请求重要级别*/private String requestLevel;/*** 短信提醒*/private String messageType;/*** 流程类型*/private WorkflowBaseInfo workflowBaseInfo;/*** 当前节点名称*/private String currentNodeName;/*** 当前节点Id*/private String currentNodeId;/*** 流程状态*/private String status;/*** 创建者*/private String creatorId;/*** 创建时间*/private String createTime;/*** 最后操作者名称*/private String lastOperatorName;/*** 最后操作时间*/private String lastOperateTime;/*** 是否可查看*/private boolean canView;/*** 是否可编辑*/private boolean canEdit;/*** 签字意见是否必填*/private boolean mustInputRemark;/*** 主表信息*/private WorkflowMainTableInfo workflowMainTableInfo;/*** 明细表信息*/private WorkflowDetailTableInfo[] workflowDetailTableInfos;/*** 流转日志信息*/private WorkflowRequestLog[] workflowRequestLogs;/*** HTML显示模板* 0 iPad* 1 iPhone*/private String[] WorkflowHtmlTemplete;/*** 解析后的HTML显示内容* 0 iPad* 1 iPhone*/private String[] WorkflowHtmlShow;/*** 被代理人*/private String beagentid;/*** 流程短语*/private String[][] workflowPhrases;2)WorkflowBaseInfo 工作流信息/*** 工作流ID*/private String workflowId;/*** 工作流标题*/private String workflowName;/*** 工作流类型ID*/private String workflowTypeId;/*** 工作流类型名称*/private String workflowTypeName;2.2.3调用实例根据实际的webservice客户端实现的客户端代码均不相同.以下仅供参考. 1)创建流程wrti[1] = new WorkflowRequestTableField();wrti[1].setFieldName("remark");//留言内容wrti[1].setFieldValue("test");wrti[1].setView(true);wrti[1].setEdit(true);wrti[2] = new WorkflowRequestTableField();wrti[2].setFieldName("resource_n");//留言人wrti[2].setFieldValue("111");wrti[2].setView(true);wrti[2].setEdit(true);wrti[3] = new WorkflowRequestTableField();wrti[3].setFieldName("fj2");//附件wrti[3].setFieldType("http:baidu_sylogo1.gif");//http:开头代表该字段为附件字段wrti[3].setFieldValue(".baidu./img/baidu_sylogo1.gif");//附件地址wrti[3].setView(true);wrti[3].setEdit(true);WorkflowRequestTableRecord[] wrtri = newWorkflowRequestTableRecord[1];//主字段只有一行数据wrtri[0] = new WorkflowRequestTableRecord();wrtri[0].setWorkflowRequestTableFields(wrti);WorkflowMainTableInfo wmi = new WorkflowMainTableInfo();wmi.setRequestRecords(wrtri);//明细字段WorkflowDetailTableInfo wdti[] = new WorkflowDetailTableInfo[2];//两个明细表0明细表1,1明细表2//明细表1 startwrtri = new WorkflowRequestTableRecord[2];//数据行数,假设添加2行明细数据//第一行wrti = new WorkflowRequestTableField[3]; //每行3个字段wrti[0] = new WorkflowRequestTableField();wrti[0].setFieldName("sl");//数量wrti[0].setFieldValue("11");wrti[0].setView(true);wrti[0].setEdit(true);wrti[1] = new WorkflowRequestTableField();wrti[1].setFieldName("dj");//单价wrti[1].setFieldValue("2");wrti[1].setView(true);wrti[1].setEdit(true);wrti[2] = new WorkflowRequestTableField();wrti[2].setFieldName("xj");//小记wrti[2].setFieldValue("22");wrti[2].setView(true);wrti[2].setEdit(true);wrtri[0] = new WorkflowRequestTableRecord();wrtri[0].setWorkflowRequestTableFields(wrti);//第二行wrti = new WorkflowRequestTableField[3]; //每行3个字段wrti[0] = new WorkflowRequestTableField();wrti[0].setFieldName("sl");//数量wrti[0].setFieldValue("110");wrti[0].setView(true);wrti[0].setEdit(true);wrti[1] = new WorkflowRequestTableField();wrti[1].setFieldName("dj");//单价wrti[1].setFieldValue("2");wrti[1].setView(true);wrti[1].setEdit(true);wrti[2] = new WorkflowRequestTableField();wrti[2].setFieldName("xj");//小记wrti[2].setFieldValue("220");wrti[2].setView(true);wrti[2].setEdit(true);wrtri[1] = new WorkflowRequestTableRecord();wrtri[1].setWorkflowRequestTableFields(wrti);wdti[0] = new WorkflowDetailTableInfo();wdti[0].setWorkflowRequestTableRecords(wrtri);//加入明细表1的数据//明细表1 end//明细表2 startwrtri = new WorkflowRequestTableRecord[1];//数据行数,假设添加1行明细数据//第一行wrti = new WorkflowRequestTableField[3]; //每行3个字段wrti[0] = new WorkflowRequestTableField();wrti[0].setFieldName("cl3");//wrti[0].setFieldValue("11");wrti[0].setView(true);wrti[0].setEdit(true);wrti[1] = new WorkflowRequestTableField();wrti[1].setFieldName("cl1111");//wrti[1].setFieldValue("2");wrti[1].setView(true);wrti[1].setEdit(true);wrtri[0] = new WorkflowRequestTableRecord();wrtri[0].setWorkflowRequestTableFields(wrti);wdti[1] = new WorkflowDetailTableInfo();wdti[1].setWorkflowRequestTableRecords(wrtri);//加入明细表2的数据//明细表2 endWorkflowBaseInfo wbi = new WorkflowBaseInfo();wbi.setWorkflowId("5");//workflowid 5 代表内部留言WorkflowRequestInfo wri = new WorkflowRequestInfo();//流程基本信息wri.setCreatorId("111");//创建人idwri.setRequestLevel("2");//0 正常,1重要,2紧急wri.setRequestName("留言测试接口");//流程标题wri.setWorkflowMainTableInfo(wmi);//添加主字段数据wri.setWorkflowBaseInfo(wbi);wri.setWorkflowDetailTableInfos(wdti);//执行创建流程接口WorkflowServicePortTypeProxy WorkflowServicePortTypeProxy = new WorkflowServicePortTypeProxy();String requestid =WorkflowServicePortTypeProxy.doCreateWorkflowRequest(wri, 111); System.out.println("requestid:"+requestid);}2)获取代办列表数量* 获得代办事宜数量* throws RemoteException*/publicstaticvoid getDaiBanShuLiang() throws RemoteException{ WorkflowServicePortTypeProxy WorkflowServicePortTypeProxy = new WorkflowServicePortTypeProxy();int count =WorkflowServicePortTypeProxy.getToDoWorkflowRequestCount(111, null); System.out.println("代办事宜数量:"+count);//获取待办事宜接口//带查询条件查询,只能写关于这2个表的查询条件 workflow_requestbaset1,workflow_currentoperator t2//查询条件里面不需要写andString conditions[] = new String[2];conditions[0] = "t1.currentnodetype = 2 ";//状态为审批conditions[1] = "t1.creater = 111 ";//创建人为111count = WorkflowServicePortTypeProxy.getToDoWorkflowRequestCount(111, conditions);System.out.println("代办事宜数量:"+count);//获取待办事宜接口}3)获得代办事宜列表。
CMD-webservice接口说明书
CMD之webservice接口说明书拟制日期审核日期批准日期修订历史记录1接口综述●接口链接类似:http://10.95.87.39:8080/cmd/api/v1/me/waybill/order●以上http://10.92.2.29:8080是测试环境,生产请用http://10.109.142.11:8080或http://10.109.142.12:8080●参数传递方式:GET/POST方式(暂不提供PUT和DELETE方式)●加密压缩规则:不加密,压缩和解压由CXF框架完成●编码格式:UTF-82网络访问关系访问CMD接口需开通以下网络访问关系:3接口列表3.1进口运单读取3.1.1接口简介●根据开始发运日期和结束发运日期来查询材料信息。
●接口示例:●接口链接类似:http://10.95.87.39:8080/cmd/api/v1/me/waybill/order3.1.2请求参数●Key-Value键值对的形式传入●参数说明3.1.3使用说明●如示例中http://10.95.87.39:8080/cmd/api/v1/me/waybill/order是接口在服务器端的目录,问号后面带传入的参数,参数形式startDate=?&endDate=?以上http://10.92.2.29:8080是测试环境,生产请用http://10.109.142.11:8080或http://10.109.142.12:80803.1.4返回格式Json格式3.1.5返回结果结果集字段说明表运单航材基本信息返回结果示例[{"weight":111.0,"orderNo":"111","flightNo":"11","orderMaterialDt o":[],"attachmentId":"http:\/\/10.89.113.184\/roNo\/downLoadDocument. do?fileId=0901ccf8800ed090&fileName=SupplierPrice_20150623161209.pdf& supplierno=GOODRD&fileSize=9138","remark":"机务工程部机务工程部机务工程部机务工程部机务工程部机务工程部机务工程部机务工程部机务工程部机务工程部机务工程部机务工程部机务工程部机务工程部机务工程部机务工程部机务工程部机务工程部机务工程部机务工程部机务工程部机务工程部机务工程部机务工程部机务工程部","userId":"8ad9f138549e78100154a4055cec0061","freight":"11.0","packType":"wooden","lastModifyDate":"2016-07-0810:57","shipDate":"2016-07-08","currencyType":"USD"},{"weight":666.0, "orderNo":"555","flightNo":"666","orderMaterialDto":[{"orderNo":"555" ,"totalWeight":110.0,"contractNo":"027020534","arriverGoodsNum":5,"pi eceNo":"341261A44R01","currencyType":"US","totalPrice":0.0}],"attachm entId":"http:\/\/10.89.113.184\/roNo\/downLoadDocument.do?fileId=0901 ccf8800ec9cf&fileName=%25E5%258D%2597%25E8%2588%25AA%25E8%25BF%2590%2 5E4%25BB%25A3.pdf&supplierno=GOODRD&fileSize=78559","remark":"wwwwwww wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww","userId":"8ad9f138549e7810 0154a4055cec0061","freight":"666.0","packType":"other","lastModifyDat e":"2016-08-1710:17","shipDate":"2016-07-26","currencyType":"CNY"},{"weight":1.0,"o rderNo":"999-44234352","flightNo":null,"orderMaterialDto":[{"orderNo" :"999-44234352","totalWeight":0.0,"contractNo":"R14011554","arriverGo odsNum":1,"pieceNo":"018550-000","currencyType":"RM","totalPrice":0.0 }],"attachmentId":"http:\/\/10.89.113.184\/roNo\/downLoadDocument.do? fileId=0901ccf8800ec9ce&fileName=%25E5%259C%25A8MyEclipse%25E4%25B8%2 5AD%25E4%25BD%25BF%25E7%2594%25A8ant.pdf&supplierno=Leader&fileSize=2 43435","remark":null,"userId":"8ad9f13855a479b50155be41defb0064","fre ight":"200.0","packType":"paper","lastModifyDate":"2016-07-0615:24","shipDate":"2016-07-07","currencyType":"USD"},{"weight":1.0,"o rderNo":"1234","flightNo":"111","orderMaterialDto":[{"orderNo":"1234" ,"totalWeight":0.0,"contractNo":"R13051057","arriverGoodsNum":1,"piec eNo":"6277<script>alert(1)<\/script>3-304MOD2","currencyT ype":"RM","totalPrice":0.0},{"orderNo":"1234","totalWeight":2.0,"cont ractNo":"R13063107","arriverGoodsNum":1,"pieceNo":"0154JU","currencyT ype":"US","totalPrice":0.0}],"attachmentId":"http:\/\/10.89.113.184\/ roNo\/downLoadDocument.do?fileId=0901ccf8800ed08f&fileName=SupplierPr ice_20150623153414.pdf&supplierno=GOODRD&fileSize=20505","remark":nul l,"userId":"8ad9f138549e78100154a4055cec0061","freight":"123.0","pack Type":"wooden","lastModifyDate":"2016-07-0810:54","shipDate":"2016-07-08","currencyType":"EUR"},{"weight":22334. 0,"orderNo":"ffddfff","flightNo":null,"orderMaterialDto":[{"orderNo": "ffddfff","totalWeight":0.5,"contractNo":"R14008898","arriverGoodsNum ":1,"pieceNo":"0102ME2GE","currencyType":"US","totalPrice":989.53},{" orderNo":"ffddfff","totalWeight":2.0,"contractNo":"R13063109","arrive rGoodsNum":1,"pieceNo":"WW","currencyType":"US","totalPrice":4722.87} ,{"orderNo":"ffddfff","totalWeight":0.0,"contractNo":"X14100535","arr iverGoodsNum":1,"pieceNo":"7001330H03","currencyType":"US","totalPric e":0.0},{"orderNo":"ffddfff","totalWeight":0.0,"contractNo":"X1410053 5","arriverGoodsNum":1,"pieceNo":"7001330H03","currencyType":"US","totalPrice":0.0},{"orderNo":"ffddfff","totalWeight":0.0,"contractNo":"X 14100535","arriverGoodsNum":1,"pieceNo":"7001330H03","currencyType":" US","totalPrice":0.0}],"attachmentId":"http:\/\/10.89.113.184\/roNo\/ downLoadDocument.do?fileId=0901ccf8800ec9cd&fileName=11.pdf&suppliern o=Leader&fileSize=149449","remark":null,"userId":"8ad9f13855a479b5015 5be41defb0064","freight":"2234.0","packType":"wooden","lastModifyDate ":"2016-07-0615:13","shipDate":"2016-07-14","currencyType":"USD"},{"weight":14.0," orderNo":"297-60131820","flightNo":null,"orderMaterialDto":[{"orderNo ":"297-60131820","totalWeight":0.5,"contractNo":"130207432","arriverG oodsNum":10,"pieceNo":"11-6557-5A","currencyType":"US","totalPrice":8 5.15}],"attachmentId":"http:\/\/10.89.113.184\/roNo\/downLoadDocument .do?fileId=0901ccf8800ee175&fileName=lru_spare_parts_list.pdf&supplie rno=MPI&fileSize=146020","remark":null,"userId":"8ad9f13856439c3b0156 543948320063","freight":"190.0","packType":"paper","lastModifyDate":" 2016-08-04 14:45","shipDate":"2016-08-04","currencyType":"USD"}]。
分布式考勤综合系统Web-Service接口说明书V1[1].0教学文案
分布式考勤管理系统Web Service接口说明书V1.0分布式考勤管理系统Web Service接口说明书摘要:本文档主要描述分布式考勤管理系统对第三方软件开放考勤业务数据的Web Service接口,对接口格式和相应的参数给出了详细的描述。
1 总述分布式考勤管理系统通过Web Service接口对外提供分布式考勤获取及人员派发等业务能力。
1.1 接口总体说明系统提供的Web Service接口:http://IP:端口/WebService/Service.asmx后继接口可能需要客户端API鉴权,访问WebService时请添加用户名,密码(test/),暂时不用。
1.2 调用接口方法下表列出系统定义的Web Service请求和事件报告所使用的接口方法:1.3 调用方法流程(1)第三方软件调用Web Service服务器的发送业务调用接口。
(2)如果鉴权成功,Web Service服务器把返回请求结果数据。
2 接口定义2.1 获取考勤记录•接口说明:第三方软件通过该接口获取考勤记录信息,包括全部设备或具体某一个客户端。
•接口格式:String GetAttendanceRecords();2.2 读取设备状态•接口说明:第三方软件通过该接口读取设备状态。
•接口格式:String GetAttDevices();2.3 获取注册人员人像模板信息•接口说明:第三方系统通过该接口获取注册人员人像模板信息。
•接口格式:String GetUserTempInfo();(待定)2.4 获取设备注册人员•接口说明:该接口用于第三方软件获取设备当前的所有注册人员。
•接口格式:String GetUserBy Device();2.5 人员注册转发•接口说明:第三方软件通过该接口实现人员注册信息设备间的转发。
•接口格式:String SetUserAtt Device ();2.6 注册人员删除•接口说明:第三方软件通过该接口实现删除设备注册人员。
- 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。
XXXX系统
Web Services业务接口规范说明书
拟制
审核
会签
批准
【公司名称】
版本历史
目录
1.范围 (1)
2.术语、定义和缩略语 (1)
2.1 术语、定义 (1)
2.2 缩略语 (1)
3.接口设计 (1)
3.1 接口公共参数 (1)
3.1.1请求参数 (1)
3.1.2返回参数 (2)
3.2 业务功能接口 (3)
3.2.1业务模块1 (3)
4.MD5加密 (6)
5.参考文献 (6)
1.范围
本规范文档主要适用于XXXX系统和其它业务系统信息数据的接入。
2.术语、定义和缩略语
2.1术语、定义
2.2缩略语
3.接口设计
3.1接口公共参数
接口服务器通过:http://IP:port/EIP/WebService/ 连接服务器,同时对外提供业务功能接口,接收的参数和返回的参数都用一定的xml格式进行封装。
3.1.1请求参数
1.请求类型为String类型
<?xml version="1.0" encoding="utf-8" ?>
<request>
<header type ="xx01" version="1.0" reqtype="0" userid="user000000000001">
</header>
<param>
</param>
</request>
2.头部参数体head定义
请求参数的头部参数体header格式固定,定义如下:
3.请求参数体param定义
参数体param中的具体请求参数,根据不同的业务而不同,详见各业务接口。
3.1.2返回参数
1.返回类型为String类型
<?xml version="1.0" encoding="utf-8"?>
<response>
<header type ="XX01" value="XX00" info="成功">
</header>
<result>
</result>
</response>
2.头部参数体head定义
返回参数的头部参数体header格式固定,定义如下:
3.返回值参数体result定义
参数体result中的具体返回参数,根据不同的业务而不同。
详见各业务功能返回值参数体result定义。
注意:在value值标识为失败时,无论在任何业务功能下result都有可能为空。
4.返回value 值
<-- 注释
例如:
3.2业务功能接口3.2.1业务模块1 3.2.1.1模块说明1.
<-- 注释
2.
<-- 注释
例如:
3.2.1.2功能1
1.功能描述
主要对功能1进行描述,说明功能1主要完成什么功能。
2.请求参数体param定义
<?xml version="1.0" encoding="utf-8" ?>
<request>
<header type ="xxxx" version="" reqtype="0" userid="">
</header>
<param param1=" " param2=" ">
</param>
</request>
头部参数体header中的定义参数,详见本文档“请求参数头部参数体header定义”(以下各业务接口中头部参数体header定义相同,不再赘述)。
type属性值xxxx,参数体param说明如下:
<-- 注释
例如:
<?xml version="1.0" encoding="utf-8" ?>
<request>
<header type ="1101" version="1.0" reqtype="0" userid="">
</header>
<param username="admin" password="E10ADC3949BA59ABBE56E057F20F883E ">
</param>
</request>
头部参数体header中的定义参数,详见本文档“请求参数头部参数体header定义”(以下各业务接口中头部参数体header定义相同,不再赘述),type属性值1101,参数体param 说明如下:
3.返回值参数体result定义
<?xml version="1.0" encoding="utf-8" ?>
<response>
<header type="xxxx" value="" info=" "></header>
<result result1=" " result2=" " >
</result>
</response>
头部参数体header中的定义参数,详见本文档“返回参数头部参数体header定义”(以下各业务接口中头部参数体header定义相同,不再赘述),
<-- 注释
例如:
<?xml version="1.0" encoding="utf-8" ?>
<response>
<header type="1101" value="1100" info="成功"></header>
<result username="admin" userid="user000000000001" realname="管理员">
</result>
</response>
头部参数体header中的定义参数,详见本文档“返回参数头部参数体header定义”(以下各业务接口中头部参数体header定义相同,不再赘述),type属性值1101,参数体result 说明如下:
3.2.1.3功能2
1.功能描述
主要对功能1进行描述,说明功能1主要完成什么功能。
4. 请求参数体param 定义
<?xml version="1.0" encoding="utf-8" ?> <request> <header type ="xxxx " version="" reqtype="0" userid=""> </header> <param param1=" " param2=" "> </param> </request>
头部参数体header 中的定义参数,详见本文档“请求参数头部参数体header 定义”(以下各业务接口中头部参数体header 定义相同,不再赘述)。
type 属性值xxxx ,参数体param 说明如下:
2. 返回值参数体result 定义
<?xml version="1.0" encoding="utf-8" ?> <response>
<header type="xxxx" value="" info=" "></header> <result result1=" " result2=" " > </result> </response>
头部参数体header 中的定义参数,详见本文档“返回参数头部参数体header 定义” (以下各业务接口中头部参数体header 定义相同,不再赘述),
4. MD5加密
5. 参考文献
《XXXX
系统需求规格说明书》。