BigAnt4.0 WebService接口规范文档
WebService调用技术文档
1．什么是webservice从表面上看，Web service 就是一个应用程序，它向外界暴露出一个能够通过Web进行调用的API。
这就是说，你能够用编程的方法通过Web来调用这个应用程序。
对Web service 更精确的解释：Web services是建立可互操作的分布式应用程序的新平台。
作为一个Windows程序员，你可能已经用COM或DCOM建立过基于组件的分布式应用程序。
COM是一个非常好的组件技术，但是我们也很容易举出COM并不能满足要求的情况。
Web service平台是一套标准，它定义了应用程序如何在Web上实现互操作性。
你可以用任何你喜欢的语言，在任何你喜欢的平台上写Web service ，只要我们可以通过Web service标准对这些服务进行查询和访问。
不管你的Web service是用什么工具，什么语言写出来的，只要你用SOAP协议(简单对象访问协议)通过HTTP来调用它，总体结构都应如下图所示。
通常，你用你自己喜欢的语言(如VB 6或者)来构建你的Web service，然后用SOAP Toolkit或者.NET的内建支持来把它暴露给Web客户。
于是，任何语言，任何平台上的客户都可以阅读其W SDL文档，以调用这个Web service。
客户根据WSDL描述文档，会生成一个SOAP请求消息。
Web service都是放在Web服务器(如IIS) 后面的，客户生成的SOAP请求会被嵌入在一个HTTP POST请求中，发送到Web服务器来。
Web服务器再把这些请求转发给Web service请求处理器。
对VB 6程序来说，Web service请求处理器是一个与SOAP Toolkit组件协同工作的ASP页面或ISAPI extension。
而对程序来说，Web service请求处理器则是一个.NET Framework自带的ISAPI extension。
请求处理器的作用在于，解析收到的SOAP请求，调用Web service，然后再生成相应的S OAP应答。
接口规范文档
接口规范文档
接口规范文档是描述如何使用接口以及接口的行为和功能的文档。
接口规范文档通常包括以下内容：
1. 接口描述：对接口的功能和作用进行详细描述。
2. 接口地址：指定接口的URL或者路径。
3. 接口请求方法：指定接口的请求方法，如GET、POST等。
4. 请求参数：列出接口需要的请求参数及其类型、是否必需、参数的取值范围等信息。
5. 请求示例：提供请求示例，展示如何构建请求参数以及请求的格式。
6. 响应参数：列出接口的响应参数及其类型、参数的含义等信息。
7. 响应示例：提供响应示例，展示接口请求后的返回结果及其格式。
8. 错误码说明：列出接口可能返回的错误码及其含义，方便开发者进行错误处理。
9. 接口权限：指定接口的访问权限，如是否需要认证、角色要求等。
10. 接口示意图：可选项，展示接口的流程和数据交互方式的
图表。
接口规范文档的编写需要考虑到与项目相关人员（如开发人员、测试人员、产品经理等）的沟通与调整，确保对接口的需求和使用方式有一个统一的理解。
同时，接口规范文档应该尽可能清晰简洁，方便开发人员理解和使用。
WebService接口实例说明文档
WebService接口说明文档文档说明本文档主要讲述如何用C Sharp创建一个简单的Web Service接口，并使用Java调用这个Web Service接口。
准备工作系统环境：安装JDK1.6或更新版本开发工具：Microsoft Visual Studio 2012、MyEclipse 10.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 接口说明
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接口说明文档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 数据库连接错误５没有需要修改的项目 6 角色不存在注释：如果许可为空的字段想变化为空的话，以空格为参数值，password，workCode，realName，sex的修改不能以空格表示为空，因为这２个字段不许可为空，如果参数为空则不会修改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 企业ＩＤ已经存在－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 为１时ID 可为空，否则不许可为空，在部门和员工查询时，如果企业不存在，则报部门或者员工不存在16、角色权限增加方法名称UserRole Add(String RoleName, String Rights ,String EID，String CRC，) 参数说明：返回类型: Integer返回值说明： -1 缺少必填参数， 1 查询数据时发生错误，－2 数据库连接错误 2 企业不存在 3 角色已存在０成功17、角色权限编辑方法名称UserRoleedit(String RoleName, String Rights ,String EID，String CRC，) 参数说明：返回类型: Integer返回值说明： -1 缺少必填参数， 1 查询数据时发生错误，－2 数据库连接错误，2修改类型错误，３新角色名称不能为空，４企业不存在，５角色不存在０成功18、角色权限删除方法名称UserRoleDel(String RoleName, String EID，String CRC，)参数说明：返回类型: Integer返回值说明： -1 缺少必填参数， 1 查询数据时发生错误，－2 数据库连接错误 2 企业不存在０成功。
webservice接口文档
WebService接口文档文档版本号：v9.9.5更新时间：2016年09月28日重要说明本人/本公司在使用本软件过程中，将严格遵守国家相关法律、法规、保证本公司信息发布的安全，并切实做到：（1）建立健全本公司信息发布的内部保障制度、信息安全保密制度、用户信息安全管理制度，建立健全本公司信息安全责任制度和信息发布的审批制度，严格审查本公司产品所发布信息。
（2）严格遵守《互联网信息服务管理办法》，对用户编辑的信息内容进行把关，保证信息内容的健康、合法。
（3）明确本企业的客户群和客户范围，所有通讯受众必须是自愿且明确同意接受企业服务。
（4）若发送未经用户允许的信息等所造成的影响、投诉等一切损失与本软件版权方无关、由本人/本公司承担全部责任；同时，本人/本公司也应承担若因此给本软件版权方造成的全部损失。
（5）不利用本软件制作、复制、发布、传播含有下列内容的信息：✧反对宪法所确定的基本原则的；✧危害国家安全，泄露国家秘密，颠覆国家政权，破坏国家统一的；✧损坏国家荣誉和利益的；✧煽动民族仇恨、民族歧视，破坏民族团结的；✧破坏国家民族宗教政策，宣扬邪教和封建迷信的；✧散布谣言，扰乱社会秩序，破坏社会稳定的；✧散布淫秽、色情、赌博、暴力、凶杀、恐怖或者教唆犯罪的；✧侮辱或者诽谤他人，侵害他人合法权益的；✧含有法律、行政法规禁止的其他内容的；（6）自信息发布六个月内不修改删除信息发送日志内容，日志记录的备份应至少保持6个月以上，在国家机关进行依法查询时，予以提供。
（7）若发现本公司所发布的信息明显属于上述第（5）款所列内容，保证立即停止传输，并向国家有关机关报告。
（8）对本公司所发布的信息一时难以辨别是否属于以上所列内容之一的，应报相关主管部门审核同意后再发布。
（9）对客户的个人信息保密，未经客户同意不得向他人泄漏，但法律规定的除外。
本人/本公司保证：在使用本软件进行信息发布活动中，服从监督和管理；若未做到上述一至八条，本人/本公司愿意承担由此引起的一切法律责任，并接受相应的处罚。
web service 标准
web service 标准Web Service标准。
Web Service是一种基于网络的应用程序接口（API），它可以通过网络进行交互。
它使用标准的网络协议来实现应用程序之间的通信，使得不同平台和不同语言的应用程序可以相互通信和协作。
在Web Service的发展过程中，出现了一些标准化的协议和规范，以确保Web Service的互操作性和可靠性。
本文将对Web Service 标准进行介绍和分析。
首先，Web Service标准包括了一系列的协议和规范，其中最重要的是SOAP （Simple Object Access Protocol）、WSDL（Web Services Description Language）和UDDI（Universal Description, Discovery and Integration）。
SOAP是一种基于XML 的消息协议，用于在Web Service之间进行通信。
它定义了一种简单的、轻量级的消息格式，可以在不同的网络协议和传输协议上进行交换。
WSDL是一种用于描述Web Service的语言，它定义了Web Service的接口、操作和消息格式等信息，使得客户端可以了解如何与Web Service进行交互。
UDDI是一种用于注册和发现Web Service的协议，它提供了一个统一的注册表，使得客户端可以方便地找到需要的Web Service。
其次，Web Service标准还包括了一些安全和可靠性方面的规范，以确保Web Service的安全和可靠。
例如，WS-Security是一种用于在Web Service之间进行安全通信的规范，它定义了一系列的安全机制和协议，包括消息加密、数字签名、身份认证和授权等功能。
另外，WS-ReliableMessaging是一种用于在Web Service之间进行可靠消息传递的规范，它定义了一种可靠的消息传递机制，可以确保消息的可靠传递和顺序传递。
接口文档规范
接口文档规范接口文档规范是指在设计和编写接口文档时应遵循的规范和标准。
一个良好的接口文档能够清晰地描述接口的功能、使用方法和参数要求等信息，提供给开发人员使用和集成。
以下是接口文档规范的一些建议和要求：1. 语言清晰简明：接口文档应使用简洁明了的语言描述接口的功能和使用方法，避免使用过于专业术语和复杂的语句，以方便开发人员理解和使用。
2. 接口说明：在接口文档中应包含对接口的功能和作用的详细说明，包括接口的用途、目的和期望的效果等信息。
3. 接口参数：接口文档中应列出接口所需的参数及其类型、说明和取值范围等信息。
对于必须的参数应明确标注其必填属性，对于可选的参数应说明其默认值和是否必填。
4. 接口返回：接口文档中应明确描述接口的返回结果及其类型、说明和可能的取值范围等信息。
对于不同的返回状态码应解释其含义和返回内容。
5. 接口示例：接口文档中应提供接口的使用示例，包括请求参数的示例和返回结果的示例，以方便开发人员理解接口的使用方法和效果。
6. 错误处理：接口文档中应明确描述接口的错误处理方式和可能出现的错误码及其含义。
对于不同的错误码应解释其含义和可能的原因。
7. 接口版本：接口文档中应标明接口的版本号和发布日期，以便开发人员对接口进行版本管理和追踪。
8. 更新记录：接口文档中应包含对接口的更新记录和变更说明，记录每个版本的变更内容和原因，以便开发人员了解接口的演化和调整。
9. 附加说明：接口文档中可以包含一些额外的说明和建议，如安全要求、性能要求、使用限制和注意事项等。
10. 参考资料：接口文档中应提供相关的参考资料和链接，如接口设计文档、数据字典、测试报告等，以便开发人员获取更详细的信息。
以上是接口文档规范的一些基本要素和建议，通过遵循这些规范，可以提高接口文档的可读性和可用性，帮助开发人员更好地理解和使用接口。
同时，良好的接口文档也可以提高团队合作效率，降低沟通成本。
因此，在进行接口开发和集成时，编写清晰规范的接口文档是非常重要的。
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接口说明文档
说明 所分配的用户名 密码 短信内容。70 字以内 目标号码。以逗号(,)分隔。发送状态
现 a. 定义 场 public QueryResult QuerySMS(string Username, string Password, string 拍 b. 参数 照 参数 说明 （ Username 所分配的用户名 取 Password 密码 得 SID 短信编号 客 户 c. 返回值 public class QueryResult 同 { 意 /// <summary> ） /// 查询状态（0：成功；-201：用户名/密码错误；-203：编号错误） 。
SID)
PS:双击获取文档。Ctrl+A，Ctrl+C,然后粘贴到word即可。 未能直接提供word版，抱歉。
b. 参数 参数 Username Password Content Numbers c. 返回值
public class SendResult { /// <summary> /// 发送状态（0：成功；-102：余额不足；-201：用户名/密码错误） /// </summary> public int State; /// <summary> /// 短信编号 /// </summary> public string SID; }
wsdl接口定义1sendsms发送短信定义publicsendresultsendsmsstringusernamestringpasswordstringcontentstringnumbers参数参数说明username所分配的用户名password密码content短信内容
WebService 接口说明文档
webservice技术文档
1、什么是webservice从表面上看：Webservices 就是一个应用程序，它向外界暴露出一个能够通过Web 进行调用的API。
这就是说，你能够用编程的方法通过Web来调用这个应用程序。
我们把调用这个Webservices 的应用程序叫做客户。
更专业的描述如下：Webservices是描述一些操作（利用标准化的XML 消息传递机制可以通过网络访问这些操作）的接口。
Webservices是用标准的、规范的XML 概念描述的，称为Webservices的服务描述。
这一描述囊括了与服务交互需要的全部细节，包括消息格式（详细描述操作）、传输协议和位置。
该接口隐藏了实现服务的细节，允许独立于实现服务基于的硬件或软件平台和编写服务所用的编程语言使用服务。
这允许并支持基于Webservices的应用程序成为松散耦合、面向组件和跨技术实现。
Webservices履行一项特定的任务或一组任务。
Webservices可以单独或同其它Webservices一起用于实现复杂的聚集或商业交易，以及企业集成（EAI）。
2、Webservices模型Webservices体系结构基于三种角色（服务提供者、服务注册中心和服务请求者）之间的交互。
交互涉及发布、查找和绑定操作。
这些角色和操作一起作用于Webservices构件：Webservices软件模块及其描述。
在典型（并非非典^_^）情况下，服务提供者托管可通过网络访问的软件模块（Webservices的一个实现）。
服务提供者定义Web 服务的服务描述并把它发布到服务请求者或服务注册中心。
服务请求者使用查找操作来从本地或服务注册中心检索服务描述，然后使用服务描述与服务提供者进行绑定并调用Web 服务实现或同它交互。
服务提供者和服务请求者角色是逻辑结构，因而服务可以表现两种特性。
下图图示了这些操作、提供这些操作的组件及它们之间的交互。
3、Webservices协议栈要以一种可互操作的方式执行发布、发现和绑定这三个操作，必须有一个包含每一层标准的Webservices协议栈。
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接口在当今信息化时代，Web服务已经成为了各种应用程序之间进行数据交换和通信的重要方式。
而标准webservice接口则是Web服务的重要组成部分，它定义了服务的操作和消息格式，使得不同平台和语言的应用程序能够相互通信和交换数据。
本文将介绍标准webservice接口的相关内容，包括其定义、特点、优势和应用场景等。
一、定义。
标准webservice接口是基于标准的Web服务技术实现的接口，它使用标准的协议和消息格式进行通信，如SOAP、WSDL和UDDI等。
通过这些标准化的接口，不同平台和语言的应用程序可以相互调用和交换数据，实现系统之间的集成和互操作。
二、特点。
1. 标准化，标准webservice接口采用统一的协议和消息格式，具有良好的标准化程度，可以确保不同系统之间的互操作性和通信稳定性。
2. 松耦合，标准webservice接口采用基于HTTP的传输协议，使得系统之间的耦合度较低，能够更好地适应不同环境和需求。
3. 平台无关，标准webservice接口可以跨越不同的平台和语言，实现不同系统之间的无缝集成和通信。
4. 安全性，标准webservice接口支持多种安全机制，如SSL、数字证书和WS-Security等，保障通信数据的安全性和完整性。
三、优势。
1. 提高系统之间的互操作性和集成性，降低系统集成和开发成本。
2. 支持跨平台和跨语言的通信和数据交换，提高系统的灵活性和可扩展性。
3. 通过标准webservice接口，可以更好地实现企业内部系统和外部系统之间的数据共享和交换。
4. 标准webservice接口具有良好的安全性和稳定性，能够保障通信数据的安全和完整。
四、应用场景。
1. 企业应用集成，不同部门和业务系统之间的数据共享和交换，如ERP、CRM和SCM系统等。
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 接口说明 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字节以内。
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
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.13 张维忠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.27 张维忠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?wsdl6.1.1用户新增 userAdd6.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 用户id6.1.2用户删除 userDelete6.1.2.1接口参数参数名类型描述loginNames string 用户帐号，支持批量操作，帐号之间以逗号分隔token string 接口调用token, 应与配置文件中的设置的ACCESS_TOKEN一致6.1.2.2返回值●Response XML 示例Response XML 标签说明标签名描述userid 用户id，用户不存在则为0loginname 用户帐号6.1.3用户更新 userUpdate6.1.3.1接口参数参数名类型描述userId int 用户IdloginName 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，用户不存在则为0loginname 用户帐号username 用户名称itemindex 人员排序email 邮箱mobile 手机号码phone 座机sex 性别jobtitle 职务description 描述issuper 是否超级用户 1 是 0 否disabled 帐号是否禁用 1 是 0 否6.1.5用户身份验证 userValid6.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 用户Idloginname 用户帐号username 用户名称itemindex 用户排序号email 邮箱mobile 手机phone 电话sex 性别 1 男 2女 0 未知jobtitle 职务description 用户描述issuper 是否是超级用户 1 是 0否desabled 是否禁用 1 禁用 0 启用6.1.8禁用启用帐号 disableUser6.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?wsdl6.2.1部门新增 deptAdd6.2.1.1接口参数参数名类型描述path string 部门路径如：“艾朴软件/技术中心/研发一部”itemIndex int 部门顺序号description string 描述token string 接口调用token, 应与配置文件中的设置的ACCESS_TOKEN一致6.2.1.2返回值●Response XML 示例●Response XML 标签说明标签名描述viewid 顶级视图IdempType 部门类型 4 顶级视图 2 部门empId 视图Id6.2.2部门删除 deptDelete6.2.2.1接口参数参数名类型描述path string 部门路径如：“艾朴软件/技术中心/研发一部”token string 接口调用token, 应与配置文件中的设置的ACCESS_TOKEN一致6.2.2.2返回值●Response XML 示例●Response XML 标签说明标签名描述viewid 顶级视图IdempType 部门类型 4 顶级视图 2 部门empId 视图Id6.2.3部门更新 deptUpdate6.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 顶级视图IdempType 部门类型 4 顶级视图 2 部门empId 视图Id6.2.4部门信息查询 deptInfo6.2.4.1接口参数参数名类型描述path string 部门路径如：“艾朴软件/技术中心/研发一部”token string 接口调用token, 应与配置文件中的设置的ACCESS_TOKEN一致6.2.4.2返回值●Response XML 示例●Response XML 标签说明标签名描述viewid 顶级视图IdempType 部门类型 4 顶级视图 2 部门empId 视图Idname 部门名称itemindex 部门顺序号description 描述6.2.5设置部门成员 deptSetMember6.2.5.1接口参数参数名类型描述path string 部门路径如：“艾朴软件/技术中心/研发一部”loginNames string 人员帐号，多个帐号以逗号分隔token string 接口调用token, 应与配置文件中的设置的ACCESS_TOKEN一致6.2.5.2返回值●Response XML 示例●Response XML 标签说明标签名描述userid 用户Idloginname 用户帐号6.2.6移除部门成员 deptRemoveMember6.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?wsdl6.3.1发送消息 sendMessage6.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发送公告 sendBoard6.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位MD5sendPassWord string 发送者密码groupId int 群组IdcontentType string 消息内容类型，Text/Text 纯文本消息、Text/Url url消息、Text/Html html消息subject string 消息标题content string 消息内容attachMent string 附件绝对路径，如无附件则留空token string 接口调用token, 应与配置文件中的设置的ACCESS_TOKEN一致6.3.3.2返回值Response XML 示例6.3.4向部门成员群发消息 sendMessageByPath6.3.4.1接口参数参数名类型描述sendLoginName string 发送人帐号sendUserName string 发送人名称passWordType int 密码类型， 0 明文 1 32位MD5sendPassWord string 发送者密码path string 部门路径如：艾朴软件/技术中心/研发一部contentType string 消息内容类型，Text/Text 纯文本消息、Text/Url url消息、Text/Html html消息subject string 消息标题content string 消息内容attachMent string 附件绝对路径，如无附件则留空token string 接口调用token, 应与配置文件中的设置的ACCESS_TOKEN一致6.3.4.2返回值●Response XML 示例6.3.5列出消息记录（支持分页） msgList 6.3.5.1接口参数参数名类型描述sendLoginName string 发送人帐号receiveLoginName string 接收人帐号fromDate string 开始日期如：2014-12-08 toDate string 截至日期如：2014-12-10 pageIndex int 当前页码pageSize int 每页数据条数token string 接口调用token, 应与配置文件中的设置的ACCESS_TOKEN一致6.3.5.2返回值●Response XML 示例Response XML 标签说明标签名描述col_id 消息Idcol_subject 消息标题col_sender 消息发送人帐号col_sendername 消息发送人姓名col_senddate 消息发送时间col_datapath 消息保存路径（用于查询消息内容）6.3.6查询消息内容 getMsgContent6.3.6.1接口参数参数名类型描述msgId string 消息IddataPath string 消息保存路径token string 接口调用token, 应与配置文件中的设置的ACCESS_TOKEN一致6.3.6.2返回值●Response XML 示例●Response XML 标签说明标签名描述msgcontent 消息内容6.4群组接口WSDL说明文件地址：http://服务器ip:8000/api/group.html?wsdl6.4.1群组新增 groupAdd6.4.1.1接口参数参数名类型描述groupName string 群组名称creator string 创建者帐号itemIndex int 群组顺序号description string 描述token string 接口调用token, 应与配置文件中的设置的ACCESS_TOKEN一致6.4.1.2返回值●Response XML 示例●Response XML 标签说明标签名描述groupid 群组Id 6.4.2群组删除 groupDelete6.4.2.1接口参数参数名类型描述groupId int 群组Idtoken string 接口调用token, 应与配置文件中的设置的ACCESS_TOKEN一致6.4.2.2返回值●Response XML 示例6.4.3群组修改 groupUpdate 6.4.3.1接口参数参数名类型描述groupId int 群组Idtoken string 接口调用token, 应与配置文件中的设置的ACCESS_TOKEN一致6.4.3.2返回值●Response XML 示例6.4.4群组信息查询 groupInfo 6.4.4.1接口参数参数名类型描述groupId int 群组Idtoken string 接口调用token, 应与配置文件中的设置的ACCESS_TOKEN一致6.4.4.2返回值●Response XML 示例●Response XML 标签说明标签名描述groupname 群组名称description 群组描述itemindex 群组排序号createtime 群组创建时间creator 群组创建人6.4.5群组踢出成员groupKickMember 6.4.5.1接口参数参数名类型描述groupId int 群组Idtoken string 接口调用token, 应与配置文件中的设置的ACCESS_TOKEN一致6.4.5.2返回值●Response XML 示例●Response XML 标签说明标签名描述loginname 用户帐号6.4.6获取群组成员groupListMember6.4.6.1接口参数参数名类型描述groupId int 群组Idtoken string 接口调用token, 应与配置文件中的设置的ACCESS_TOKEN一致6.4.6.2返回值●Response XML 示例●Response XML 标签说明标签名描述col_id 用户idcol_loginname 用户帐号col_name 用户姓名6.4.7群组设置成员groupSetMember6.4.7.1接口参数参数名类型描述groupId int 群组IdloginNames string 用户帐号，多帐号以逗号分隔token string 接口调用token, 应与配置文件中的设置的ACCESS_TOKEN一致6.4.7.2返回值●Response XML 示例●Response XML 标签说明标签名描述loginname 用户帐号6.5角色接口WSDL说明文件地址：http://服务器ip:8000/api/role.html?wsdl6.5.1角色新增 roleAdd6.5.1.1接口参数参数名类型描述roleName string 角色名称description string 描述token string 接口调用token, 应与配置文件中的设置的ACCESS_TOKEN一致6.5.1.2返回值●Response XML 示例●Response XML 标签说明标签名描述roleid 角色Id 6.5.2角色删除 roleDelete6.5.2.1接口参数参数名类型描述roleName string 角色名称token string 接口调用token, 应与配置文件中的设置的ACCESS_TOKEN一致6.5.2.2返回值●Response XML 示例●Response XML 标签说明标签名描述roleid 角色Id6.5.3角色更新 roleUpdate 6.5.3.1接口参数参数名类型描述roleId int 角色id roleName string 角色名称description string 描述token string 接口调用token, 应与配置文件中的设置的ACCESS_TOKEN一致6.5.3.2返回值●Response XML 示例6.5.4角色信息查询 roleInfo 6.5.4.1接口参数参数名类型描述roleName string 角色名称token string 接口调用token, 应与配置文件中的设置的ACCESS_TOKEN一致6.5.4.2返回值●Response XML 示例●Response XML 标签说明标签名描述roleid 角色Idrolename 角色名称description 描述6.5.5设置角色成员 roleSetMember6.5.5.1接口参数参数名类型描述roleName string 角色名称loginNames string 人员帐号，多个帐号以逗号分隔token string 接口调用token, 应与配置文件中的设置的ACCESS_TOKEN一致6.5.5.2返回值●Response XML 示例●Response XML 标签说明标签名描述userid 用户Idloginname 用户帐号7BigAnt插件说明7.1插件类型BigAnt提供以下以几插件：Tab插件 [BigAntVAddin]用户卡片插件 [BigAntVAddin]右键插件 [BigAntCAddin]主菜单插件 [BigAntCAddin] 7.2插件代码示例7.2.1Tab插件<?xml version="1.0" encoding="gb2312" ?><BODY><BigAntV Addin Name='Office' Site='1' Flag='2' TargetType='3'><Target><![CDATA[http://127.0.0.1/antpage/Home.aspx?loginname=[LoginName]&password=[pw5]]]></Target><DisplayName>BigAnt Office</DisplayName><Desc>Tab插件</Desc><Image>http://127.0.0.1/images/office.bmp</Image></BigAntV Addin></BODY>7.2.2右键插件<?xml version="1.0" encoding="gb2312" ?><BODY><BigAntCAddin Name='NewTask' Site='4' Flag='16' TargetType='3' Height='550' Width='700'><Target><![CDATA[http://127.0.0.1/task/TaskNew.aspx?source=Ant&LoginName=[LoginName]&password=[pw5]&selLoginNam e=[SelLoginName]&win=1]]></Target><DisplayName>分配任务</DisplayName><Desc>右键插件</Desc></BigAntCAddin></BODY>7.2.3主菜单插件7.3 插件参数说明BigAntVAddin BigAntCAddin BigAntVAddin(可见插件) BigAntCAddin(命令插件) Name插件名称，要唯一SiteBigAntVAddin 1 Tab4 InfoCardBigAntCAddin 2 任务栏右键菜单4 用户列表选择一个人的右键菜单 8 用户列表选择多个人的右键菜单 128 Main Menu 主菜单256 用户列表选择一个部门的右键菜单TargetType目标程序的类型： 0 CLASSID 1 CLASSID 2 程序ID3 使用默认程序打开网址4 使用IE 中显示打开网址 7 OCX 控件 8 VBSCRIPT 9 EXE 文件 11 图片Flag2 不显示滚动条4 自动激活(每次登录先激活) 如果两个功能都要则累加，值为6 Param 参数 DisplayName 显示的名称 Desc描述<?xml version="1.0" encoding="gb2312" ?> <BODY><BigAntCAddin Name="Office" Site="128" TargetType="4"><Target><![CDATA[http://127.0.0.1/include/Index.aspx?loginname=[LoginName]&password=[pw5]]]></Target> <DisplayName>OA</DisplayName> <Desc>主菜单插件</Desc><Image>http://127.0.0.1/images/office.bmp</Image></BigAntCAddin> </BODY>Image 图片的地址系统变量[AntServer]:当前登录时填写BigAnt服务器地址[LoginName]:当前用户的帐号[UserName]:当前用户的姓名[SelUserID]:右键选中的用户ID [Password]:当前用户的密码(明码)[pw5]:当前用户的密码(MD5码)[Token]:token8BigAnt外部启动说明8.1外部调用客户端启动8.1.1Cmd方式启动如果您想通过外部程序启动客户端的BigAnt，可通过Cmd命令的方式调用C:\Program Files\BigAntSoft\BigAnt\BigAnt.exe8.1.2协议方式启动bigant://login/?server=192.168.0.2&port=6660&loginname=test1&password=123456&pwdtype=0 &startup=18.1.3Html示例<ahref="bigant://login/?server=192.168.0.2&port=6660&loginname=caofc&password=123456&pwd type=0&startup=1">点击这里登录</a>8.1.4参数说明server：BigAnt服务器IPport：BigAnt消息服务端口loginname：BigAnt账号password：用户密码pwdtype:0 明文 1 32位MD5startup：(1) // 最小化启动(2) // 表示集成本地的帐号,服务器将不在验证帐号(4) // 表示这个版本是和DG集成的,没有Tray,不显示主对话框的(8) // 表示服务器的地址将在安装盘中指定,用户不能修改服务器.(16) // 表示安装在TS服务器上面(32) // 表示自动登陆不需要检查密码8.2外部启动聊天窗口8.2.1协议方式启动bigant://sendmsg/?sender=test1@&receiver=test2@8.2.2Html示例<a href="bigant://sendmsg/?sender=test1@&receiver=test2@">点击这里发消息</a>8.2.3参数说明sender：指定发送方账号receiver：指定接收者帐号后缀为BigAnt服务端安装时生成的，可在BigAntWeb管理器—系统工具—单位互联页面中查看得到（即单位ID）。