分布式考勤综合系统Web Service接口说明书V110.docx

1、分布式考勤综合系统Web Service接口说明书V110分布式考勤管理系统Web Service接口说明书V1.0 分布式考勤管理系统Web Service接口说明书摘要：本文档主要描述分布式考勤管理系统对第三方软件开放考勤业务数据的Web Service接口，对接口格式和相应的参数给出了详细的描述。1 总述 分布式考勤管理系统通过Web Service接口对外提供分布式考勤获取及人员派发等业务能力。1.1 接口总体说明 系统提供的Web Service接口：http:/IP:端口/WebService/Service.asmx后继接口可能需要客户端API鉴权，访问WebService时请添

2、加用户名，密码(test/)，暂时不用。1.2 调用接口方法下表列出系统定义的Web Service请求和事件报告所使用的接口方法：接口请求和事件方法（函数）获取考勤记录通过接口获取考勤记录String GetAttendanceRecords();读取设备状态通过接口获取设备状态String GetAttDevices();获取注册人员人像模板信息获取注册人员人像模板信息String GetUserTempInfo();获取设备注册人员获取设备当前的所有注册人员String GetUserByDevice();人员注册转发实现人员注册信息设备间的转发String SetUserAttDevi

3、ce ();注册人员删除删除设备注册人员String SetDelUserByDevice();1.3 调用方法流程(1) 第三方软件调用Web Service服务器的发送业务调用接口。(2) 如果鉴权成功，Web Service服务器把返回请求结果数据。2 接口定义2.1 获取考勤记录 接口说明：第三方软件通过该接口获取考勤记录信息，包括全部设备或具体某一个客户端。 接口格式：String GetAttendanceRecords(); 输入参数说明：参数类型必选/可选说明PKICODEString必选授权码，默认值为“PKI2011”MachinenumberString必选考勤设备系统编

4、号，查全部设备值为“”AttenTimeString必选考勤时间，格式必须为“YYYY-MM-DD HH24:mm:SS”BakCString可选备用字段，以后接口扩展 返回参数说明：参数类型必选/可选说明StringString必选返回参数为字符串，字符串内容格式为XML格式，如下表。 考勤记录结构： 返回例子： 7231 1 2011 12 24 11 9 7231 1 2011 12 24 11 9 2.2 读取设备状态 接口说明：第三方软件通过该接口读取设备状态。 接口格式：String GetAttDevices(); 输入参数说明：参数类型必选/可选说明MachinenumberS

5、tring必选考勤设备系统编号，查全部设备值为“”BakCString可选备用字段，以后接口扩展 返回参数说明：参数类型必选/可选说明StringString必选返回参数为字符串，字符串内容格式为XML格式，如下表。 记录结构： 返回例子： 7231 1 722 0 2.3 获取注册人员人像模板信息 接口说明：第三方系统通过该接口获取注册人员人像模板信息。 接口格式：String GetUserTempInfo();（待定） 输入参数说明：参数类型必选/可选说明String必选 返回参数说明：参数类型必选/可选说明StringString必选2.4 获取设备注册人员 接口说明：该接口用于第三方

6、软件获取设备当前的所有注册人员。 接口格式：String GetUserByDevice(); 输入参数说明：参数类型必选/可选说明MachinenumberString必选考勤设备系统编号，查全部设备值为“”BakCString可选备用字段，以后接口扩展 返回参数说明：参数类型必选/可选说明StringString必选返回参数为字符串，字符串内容格式为XML格式，如下表。 记录结构： 返回例子： 7231 12 7231 13 2.5 人员注册转发 接口说明：第三方软件通过该接口实现人员注册信息设备间的转发。 接口格式：String SetUserAttDevice (); 输入参数说明：参

7、数类型必选/可选说明MachinenumberString必选新考勤设备系统编号UsernumberString必选人员编号BakCString可选备用字段，以后接口扩展 返回参数说明：参数类型必选/可选说明StringString必选成功返回1 失败返回02.6 注册人员删除 接口说明：第三方软件通过该接口实现删除设备注册人员。 接口格式：String SetDelUserByDevice(); 输入参数说明：参数类型必选/可选说明MachinenumberString必选考勤设备系统编号UsernumberString必选人员编号BakCString可选备用字段，以后接口扩展 返回参数说明：参数类型必选/可选说明StringString必选成功返回1 失败返回0