分布式考勤综合系统WebService接口说明书V110教学文案.docx
《分布式考勤综合系统WebService接口说明书V110教学文案.docx》由会员分享，可在线阅读，更多相关《分布式考勤综合系统WebService接口说明书V110教学文案.docx（11页珍藏版）》请在冰豆网上搜索。
分布式考勤综合系统WebService接口说明书V110教学文案
分布式考勤管理系统
WebService接口说明书
V1.0
分布式考勤管理系统WebService接口说明书
摘要：
本文档主要描述分布式考勤管理系统对第三方软件开放考勤业务数据的WebService接口，对接口格式和相应的参数给出了详细的描述。
1总述
分布式考勤管理系统通过WebService接口对外提供分布式考勤获取及人员派发等业务能力。
1.1接口总体说明
系统提供的WebService接口：
http:
//IP:
端口/WebService/Service.asmx
后继接口可能需要客户端API鉴权，访问WebService时请添加用户名，密码（test/），暂时不用。
1.2调用接口方法
下表列出系统定义的WebService请求和事件报告所使用的接口方法：
接口
请求和事件
方法（函数）
获取考勤记录
通过接口获取考勤记录
StringGetAttendanceRecords（）;
读取设备状态
通过接口获取设备状态
String
GetAttDevices（）;
获取注册人员人像模板信息
获取注册人员人像模板信息
String
GetUserTempInfo（）;
获取设备注册人员
获取设备当前的所有注册人员
String
GetUserByDevice（）;
人员注册转发
实现人员注册信息设备间的转发
String
SetUserAttDevice（）;
注册人员删除
删除设备注册人员
String
SetDelUserByDevice（）;
1.3调用方法流程
（1）第三方软件调用WebService服务器的发送业务调用接口。
（2）如果鉴权成功，WebService服务器把返回请求结果数据。
2接口定义
2.1获取考勤记录
∙接口说明：
第三方软件通过该接口获取考勤记录信息，包括全部设备或具体某一个客户端。
∙接口格式：
StringGetAttendanceRecords（）;
∙输入参数说明：
参数
类型
必选/可选
说明
PKICODE
String
必选
授权码，默认值为“PKI2011”
Machinenumber
String
必选
考勤设备系统编号，查全部设备值为“”
AttenTime
String
必选
考勤时间，格式必须为“YYYY-MM-DDHH24:
mm:
SS”
BakC
String
可选
备用字段，以后接口扩展
∙返回参数说明：
参数
类型
必选/可选
说明
String
String
必选
返回参数为字符串，字符串内容格式为XML格式，如下表。
Ø考勤记录结构：
schemaxmlns=""xmlns:
xs="http:
//www.w3.org/2001/XMLSchema"xmlns:
msdata="urn:
schemas-microsoft-com:
xml-msdata"id="NewDataSet">
elementname="NewDataSet"msdata:
IsDataSet="true"msdata:
MainDataTable="TB_ATTENDANCE_RECORDS"msdata:
UseCurrentLocale="true">
complexType>
choiceminOccurs="0"maxOccurs="unbounded">
elementname="TB_ATTENDANCE_RECORDS">
complexType>
sequence>
--设备编号-->
elementname="MACHINENUMBER"type="xs:
int"minOccurs="0"/>
—人员编号-->
elementname="USERNUMBER"type="xs:
int"minOccurs="0"/>
—考勤年、月、日、时、分-->
elementname="ATTYEAR"type="xs:
int"minOccurs="0"/>
elementname="ATTMONTH"type="xs:
int"minOccurs="0"/>
elementname="ATTDAY"type="xs:
int"minOccurs="0"/>
elementname="ATTHOUR"type="xs:
int"minOccurs="0"/>
elementname="ATTMINUTE"type="xs:
int"minOccurs="0"/>
sequence>
complexType>
element>
choice>
complexType>
element>
schema>
Ø返回例子：
xmlversion="1.0"standalone="yes"?
>
7231
1
2011
12
24
11
9
7231
1
2011
12
24
11
9
……
2.2读取设备状态
∙接口说明：
第三方软件通过该接口读取设备状态。
∙接口格式：
StringGetAttDevices（）;
∙输入参数说明：
参数
类型
必选/可选
说明
Machinenumber
String
必选
考勤设备系统编号，查全部设备值为“”
BakC
String
可选
备用字段，以后接口扩展
∙返回参数说明：
参数
类型
必选/可选
说明
String
String
必选
返回参数为字符串，字符串内容格式为XML格式，如下表。
Ø记录结构：
schemaxmlns=""xmlns:
xs="http:
//www.w3.org/2001/XMLSchema"xmlns:
msdata="urn:
schemas-microsoft-com:
xml-msdata"id="NewDataSet">
elementname="NewDataSet"msdata:
IsDataSet="true"msdata:
MainDataTable="MACHINE_RECORDS"msdata:
UseCurrentLocale="true">
complexType>
choiceminOccurs="0"maxOccurs="unbounded">
elementname="MACHINE_RECORDS">
complexType>
sequence>
--设备编号-->
elementname="MACHINENUMBER"type="xs:
int"minOccurs="0"/>
—设备状态，0联接不上，1正常，－1未知-->
elementname="MACHINEFLG"type="xs:
int"minOccurs="0"/>
sequence>
complexType>
element>
choice>
complexType>
element>
schema>
Ø返回例子：
xmlversion="1.0"standalone="yes"?
>
7231
1
722
0
……
2.3获取注册人员人像模板信息
∙接口说明：
第三方系统通过该接口获取注册人员人像模板信息。
∙接口格式：
StringGetUserTempInfo（）;（待定）
∙输入参数说明：
参数
类型
必选/可选
说明
String
必选
∙返回参数说明：
参数
类型
必选/可选
说明
String
String
必选
2.4获取设备注册人员
∙接口说明：
该接口用于第三方软件获取设备当前的所有注册人员。
∙接口格式：
StringGetUserByDevice（）;
∙输入参数说明：
参数
类型
必选/可选
说明
Machinenumber
String
必选
考勤设备系统编号，查全部设备值为“”
BakC
String
可选
备用字段，以后接口扩展
∙返回参数说明：
参数
类型
必选/可选
说明
String
String
必选
返回参数为字符串，字符串内容格式为XML格式，如下表。
Ø记录结构：
schemaxmlns=""xmlns:
xs="http:
//www.w3.org/2001/XMLSchema"xmlns:
msdata="urn:
schemas-microsoft-com:
xml-msdata"id="NewDataSet">
elementname="NewDataSet"msdata:
IsDataSet="true"msdata:
MainDataTable="DEVUSER_RECORDS"msdata:
UseCurrentLocale="true">
complexType>
choiceminOccurs="0"maxOccurs="unbounded">
elementname="DEVUSER_RECORDS">
complexType>
sequence>
--设备编号-->
elementname="MACHINENUMBER"type="xs:
int"minOccurs="0"/>
—人员编号-->
elementname="USERNUMBER"type="xs:
int"minOccurs="0"/>
sequence>
complexType>
element>
choice>
complexType>
element>
schema>
Ø返回例子：
xmlversion="1.0"standalone="yes"?
>
7231
12
7231
13
……
2.5人员注册转发
∙接口说明：
第三方软件通过该接口实现人员注册信息设备间的转发。
∙接口格式：
StringSetUserAttDevice（）;
∙输入参数说明：
参数
类型
必选/可选
说明
Machinenumber
String
必选
新考勤设备系统编号
Usernumber
String
必选
人员编号
BakC
String
可选
备用字段，以后接口扩展
∙返回参数说明：
参数
类型
必选/可选
说明
String
String
必选
成功返回1
失败返回0
2.6注册人员删除
∙接口说明：
第三方软件通过该接口实现删除设备注册人员。
∙接口格式：
StringSetDelUserByDevice（）;
∙输入参数说明：
参数
类型
必选/可选
说明
Machinenumber
String
必选
考勤设备系统编号
Usernumber
String
必选
人员编号
BakC
String
可选
备用字段，以后接口扩展
∙返回参数说明：
参数
类型
必选/可选
说明
String
String
必选
成功返回1
失败返回0
升级会员 