ELN企业信息化公共服务平台接口规范.docx
《ELN企业信息化公共服务平台接口规范.docx》由会员分享，可在线阅读，更多相关《ELN企业信息化公共服务平台接口规范.docx（21页珍藏版）》请在冰豆网上搜索。
ELN企业信息化公共服务平台接口规范
ELN企业信息化公共服务平台接口规范
上海时代光华
2008-9-12
制作：
李鹏
ELNwebservice
ELN企业信息化公共服务平台接口是为客户自主提交数据所提供的符合SOAP标准的WebService服务程序。
可以通过：
service接口。
注意ELN提供的所有接口调用需要ELN的身份验证。
可参见第2节。
1用户使用应用服务流程
1~2.用户登陆AP。
3.AP用户成功登陆后，AP将该用户所有的应用显示出来。
4.用户请求WS服务。
5.AP系统进行参数处理，转发请求应用服务提供商（ELN）。
6~7.ELN验证请求的有效性，并返回处理结果给AP。
8．AP返回操作信息给用户。
2身份认证
服务端利用ValidateUserTokenHandler进行身份认证。
所有调用ELNwebservice服务的SOAP请求头中必须包含身份验证信息。
对应结点名和格式如：
Envelopexmlns:
soap="http:
//schemas.xmlsoap.org/soap/envelope/"
xmlns:
xsd="http:
//www.w3.org/2001/XMLSchema"
xmlns:
xsi="http:
//www.w3.org/2001/XMLSchema-instance">
Header>
coopCode
userName
DES（username=””&password=””&coopcode=””&time=””）
MD5（Contents+key）
Header>
Body>
………
Body>
Envelope>
参数解释：
CoopCode=企业在ELN系统中的ID
userName=公司系统管理员的用户名
Contents=DES（username=””&password=””&coopcode=””&time=””）
username:
公司系统管理员的用户名
password:
公司系统系统管理员的密码的MD5值
coopcode:
企业ID
time:
1970-01-0100:
00:
00到当前时间的秒数。
DES加密的密钥为password进行MD5后的值。
Verify=MD5（Contents+key）
Key=Contents进行DES的加密的密钥
3学员管理服务接口
ELN学员管理的webservice描述地址是：
http:
//localhost:
8080/eln3_asp/services/PersonnelService?
wsdl
当前的ELN学员管理提供了如下接口：
A修改/增加学员
publicStringsaveSysPersonnelInfoWS（StringcoopCode,
SysPersonnelInfosysPersonnelInfo,StringloginName）
B删除学员
publicvoidremoveSysPersonnelInfoWS（StringcoopCode,Stringusername,
Stringpassword,StringuserId）
C查看学员
publicSysPersonnelInfogetSysPersonnelInfoWS（StringcoopCode,
finalStringuserId）
D查看学员列表
publicListgetPersonnelInfoByCoopCodeWS（StringcoopCode,
intpageNo,intpageSize）
E修改学员
publicStringmodifySysPersonnelInfoWS（StringcoopCode,
SysPersonnelInfosysPersonnelInfo,StringloginName）
throwsXFireFault;
ELN学员管理的接口定义如下：
3.1.添加/修改学员：
接口名称
增加学员接口
接口描述
增加或者修改学员学员基本信息。
接口协议
SOAP
命名空间
接口描述
PersonnelService?
wsdl
接口方法
saveSysPersonnelInfoWS（StringcoopCode,
SysPersonnelInfosysPersonnelInfo,
StringloginName）
请求参数：
名称
说明
类型
长度（字节）
coopCode
公司ID
String
sysPersonnelInfo
（详细解释见下：
）
待保存的学员实例
SysPersonnelInfo
loginName
新增/修改学员的登录名
String
sysPersonnelInfo对象详细解释:
名称
说明
类型
长度（字节）
birthdate
生日
dateTime
coopCode
企业ID（必填项）
string
email
邮箱（若填写，则不能重复）
string
mobile
手机
string
orgIdStr
组织ID串，
string
organizeId
组织ID（如果新增的人员organizeId为空，则默认增加到根组织。
）
string
organizeName
组织名称
string
positionId
岗位ID
string
positionName
岗位名称
string
sex
性别（必填项，必须=0或1，0=女，1=男）
string
userId
学员ID,新增学员可以不填，系统自动生成。
string
userName
姓名（必填项，不能重复）
string
workId
工号（必填项，不能重复）
string
返回：
增加/修改成功返回（Y|用户ID）。
增加/修改失败返回（N|错误提示信息）。
3.2删除学员：
接口名称
删除接口
接口描述
ASP系统的系统管理员通过ASP调用该接口通知ELN系统根据ID删除学员。
接口协议
SOAP
命名空间
接口描述
PersonnelService?
wsdl
接口方法
removeSysPersonnelInfoWS（StringcoopCode,StringuserId）
请求参数：
名称
说明
类型
长度（字节）
coopCode
公司ID
String
userId
用户ID
String
返回：
无返回。
3.3查看学员：
接口名称
查看接口
接口描述
根据用户ID查看用户详细信息。
接口协议
SOAP
命名空间
接口描述
PersonnelService?
wsdl
接口方法
getSysPersonnelInfoWS（StringcoopCode,StringuserId）
请求参数：
名称
说明
类型
长度（字节）
coopCode
公司ID
String
userId
待查看的用户ID
String
返回
学员基本信息。
3.4.根据企业ID查看学员列表：
接口名称
查看接口
接口描述
ASP系统的系统管理员通过ASP调用该接口通知ELN系统为查看该公司的部门。
接口协议
SOAP
命名空间
接口描述
PersonnelService?
wsdl
接口方法
getPersonnelInfoByCoopCodeWS（StringcoopCode,
intpageNo,intpageSize）
请求参数：
名称
说明
类型
长度（字节）
coopCode
公司ID
String
pageNo
页号
int
pageSize
每页大小
int
返回
学员列表。
4组织管理服务接口
ELN学员管理的webservice描述地址是：
当前的ELN学员管理提供了如下接口：
A增加组织
publicStringaddSysOrganizeWS（StringcoopCode,StringparentOrgId,SysOrganizesysOrganize）
B删除组织
publicvoidremoveSysOrganizeWS（StringcoopCode,StringorganizeId）
C查看组织
publicSysOrganizegetSysOrganizeWS（StringcoopCode,StringorganizeId）
D修改组织
publicvoidsaveSysOrganizeWS（StringcoopCode,SysOrganizesysOrganize）
E根据企业ID查询组织列表
publicListgetSysOrganizeByCoopCodeWS（StringcoopCode）
ELN组织管理的接口定义如下：
4.1.添加组织：
接口名称
增加组织接口
接口描述
增加组织。
接口协议
SOAP
命名空间
接口描述
OrgService?
wsdl
接口方法
addSysOrganizeWS（StringcoopCode,StringparentOrgId,SysOrganizesysOrganize）
请求参数：
名称
说明
类型
长度（字节）
coopCode
公司ID
String
50
parentOrgId
待增加组织的父组ID
String
32
sysOrganize
待保存的组织实例
SysOrganize
SysOrganize对象详细解释:
名称
说明
类型
长度（字节）
coopCode
企业ID（必填项）
string
50
orgIdStr
组织ID串（不填，由系统自动生成）
string
500
organizeId
组织ID（不填，由系统自动生成）
string
32
organizeName
组织名称（必填项）
string
30
organizeNo
（备用）（选填项）
string
50
返回：
增加的组织的ID，若增加失败返回“0”
4.2删除组织：
接口名称
删除接口
接口描述
根据组织ID删除组织。
接口协议
SOAP
命名空间
接口描述
OrgService?
wsdl
接口方法
removeSysOrganizeWS（StringcoopCode,StringorganizeId）
请求参数：
名称
说明
类型
长度（字节）
coopCode
公司ID
String
50
organizeId
待删除的组织ID
String
32
返回：
无返回
4.3.查看组织：
接口名称
组织查看接口
接口描述
根据组织ID查看组织。
接口协议
SOAP
命名空间
接口描述
接口方法
getSysOrganizeWS（StringcoopCode,StringorganizeId）
请求参数：
名称
说明
类型
长度（字节）
coopCode
公司ID
String
50
organizeId
待查看的组织ID
String
32
返回
组织详细信息
4.4.修改组织：
接口名称
增加组织接口
接口描述
增加组织。
接口协议
SOAP
命名空间
接口描述
OrgService?
wsdl
接口方法
saveSysOrganizeWS（StringcoopCode,
SysOrganizesysOrganize）
请求参数：
名称
说明
类型
长度（字节）
coopCode
公司ID
String
50
sysOrganize
待保存的组织实例
SysOrganize
对象
SysOrganize对象详细解释:
名称
说明
类型
长度（字节）
coopCode
企业ID（必填项）
string
50
orgIdStr
组织ID串（必填项）
string
500
organizeId
组织ID（必填项）
string
32
organizeName
组织名称（必填项）
string
30
organizeNo
（备用）（选填项）
string
50
返回：
增加的组织的ID，若增加失败返回“0”
4.5.根据企业ID查看组织列表：
接口名称
查询组织列表接口
接口描述
根据企业ID查询组织列表。
接口协议
SOAP
命名空间
接口描述
接口方法
getSysOrganizeByCoopCodeWS（StringcoopCode）
请求参数：
名称
说明
类型
长度（字节）
coopCode
公司ID
String
50
pageNo
页号
int
11
pageSize
每页大小
int
11
返回
组织详细信息列表
5课程管理服务接口
ELN课程管理的webservice描述地址是：
CourseService?
wsdl
当前的ELN课程管理提供了如下接口：
A查看课程
publicCourseInfogetCourseInfo（StringcoopCode,StringcourseId）
B根据企业ID查询课程列表
publicListgetCourseByCoopCode（StringcoopCode,intpageNo,intpageSize）
5.1.查看课程：
接口名称
课程查看接口
接口描述
根据课程ID查看课程详细信息。
接口协议
SOAP
命名空间
接口描述
接口方法
CourseInfogetCourseInfo（StringcoopCode,StringcourseId）
请求参数：
名称
说明
类型
长度（字节）
coopCode
公司ID
String
50
courseId
待查询的课程ID
String
32
返回
课程基本信息
5.2根据企业ID查看课程列表：
接口名称
查询公司课程列表接口
接口描述
根据企业ID查询公司课程列表
接口协议
SOAP
命名空间
接口描述
CousrseService?
wsdl
接口方法
getCourseByCoopCode（StringcoopCode,intpageNo,intpageSize）
请求参数：
名称
说明
类型
长度（字节）
coopCode
公司ID
String
50
pageNo
页号
int
11
pageSize
每页大小
int
11
返回
课程ID列表
6企业公告服务接口
ELN课程管理的webservice描述地址是：
BulletinService?
wsdl
当前的ELN课程管理提供了如下接口：
--publicCommonBulletingetBulletin（StringbulletinId）
查看企业公告
--publicListgetBulletinByCoopCode（StringcoopCode）
根据企业ID查询公告列表
6.1.查看公告：
接口名称
查看接口
接口描述
查看公告
接口协议
SOAP
命名空间
http:
//webservice.
接口描述
接口方法
getBulletin（StringbulletinId）
请求参数：
名称
说明
类型
长度（字节）
bulletinId
用户ID
String
32
返回
公告
6.2.根据企业ID查看公告列表：
接口名称
查看接口
接口描述
查看公司公告列表
接口协议
SOAP
命名空间
http:
//webservice.
接口描述
接口方法
getBulletinByCoopCode（StringcoopCode,intpageNo,intpageSize）
请求参数：
名称
说明
类型
长度（字节）
coopCode
企业ID
String
50
pageNo
页码
int
11
pageSize
每页显示的条数
int
11
返回
公告列表
7岗位管理服务接口
ELN学员管理的webservice描述地址是：
当前的ELN学员管理提供了如下接口：
A增加岗位
publicStringaddBasPositionWS（StringcoopCode,
BasPositionBasPosition）
B删除岗位
publicvoidremoveBasPositionWS（StringcoopCode,Stringusername,
Stringpassword,StringorganizeId）
C查看岗位
publicBasPositiongetBasPositionWS（StringcoopCode,StringorganizeId）
D修改岗位
publicvoidsaveBasPositionWS（StringcoopCode,BasPositionBasPosition）
E根据企业ID查询岗位列表
publicListgetBasPositionByCoopCodeWS（StringcoopCode）
ELN岗位管理的接口定义如下：
7.1.添加岗位：
接口名称
增加岗位接口
接口描述
增加岗位。
接口协议
SOAP
命名空间
接口描述
OrgService?
wsdl
接口方法
addBasPositionWS（StringcoopCode,Stringusername,
Stringpassword,BasPositionBasPosition）
请求参数：
名称
说明
类型
长度（字节）
coopCode
公司ID
String
50
BasPosition
待保存的岗位实例
BasPosition
对象
BasPosition对象详细解释:
名称
说明
类型
长度（字节）
coopCode
企业ID（必填项）
string
50
positionId
岗位ID（新增，由系统自动生成）
string
32
positionName
岗位名称（必填项）
string
50
positionNo
岗位编号（必填项，不能重复）
string
50
返回：
增加的岗位的ID，若增加失败返回“0”
7.2
升级会员 