1、ELN 企业信息化公共服务平台接口规范上海时代光华2008-9-12制作：李鹏ELN web serviceELN 企业信息化公共服务平台接口是为客户自主提交数据所提供的符合 SOAP 标准的 Web Service 服务程序。 可以通过：http:/ 查询 ELN 提供的 web service 接口。注意ELN 提供的所有接口调用需要 ELN 的身份验证。可参见第 2 节。1 用户使用应用服务流程12.用户登陆 AP。3.AP 用户成功登陆后，AP 将该用户所有的应用显示出来。4.用户请求 WS 服务。5.AP 系统进行参数处理，转发请求应用服务提供商（ELN） 。67. ELN 验证请求
2、的有效性，并返回处理结果给 AP。8AP 返回操作信息给用户。2 身份认证服务端利用 ValidateUserTokenHandler进行身份认证。所有调用 ELN web service 服务的 SOAP 请求头中必须包含身份验证信息。对应结点名和格式如：coopCodeuserNameDES(username=”ELN 学员管理的接口定义如下：3.1.添加/修改学员：接口名称 增加学员接口接口描述 增加或者修改学员学员基本信息。接口协议 SOAP命名空间 http:/接口描述 http:/ PersonnelService?wsdl接口方法 saveSysPersonnelInfoWS(S
3、tring coopCode,SysPersonnelInfo sysPersonnelInfo,String loginName)请求参数：名称 说明 类型 长度（字节）coopCode 公司 ID StringsysPersonnelInfo（详细解释见下：）待保存的学员实例 SysPersonnelInfologinName 新增/修改学员的登录名 StringsysPersonnelInfo 对象详细解释 :名称 说明 类型 长度（字节）birthdate 生日 dateTimecoopCode 企业 ID（必填项） stringemail 邮箱（若填写，则不能重复） stringmo
4、bile 手机 stringorgIdStr 组织 ID 串， stringorganizeId 组织 ID（如果新增的人员 organizeId 为空，则默认增加到根组织。）stringorganizeName 组织名称 stringpositionId 岗位 ID stringpositionName 岗位名称 stringsex 性别（必填项，必须=0 或 1， 0=女，1=男） stringuserId 学员 ID,新增学员可以不填，系统自动生成。 stringuserName 姓名（必填项，不能重复） stringworkId 工号（必填项，不能重复） string返回：增加/修改成
5、功返回（Y|用户 ID） 。增加/修改失败返回（N|错误提示信息） 。3.2 删除学员：接口名称 删除接口接口描述 ASP 系统的系统管理员通过 ASP 调用该接口通知 ELN 系统根据 ID 删除学员。接口协议 SOAP命名空间 http:/接口描述 http:/ PersonnelService?wsdl接口方法 removeSysPersonnelInfoWS(String coopCode, String userId)请求参数：名称 说明 类型 长度（字节）coopCode 公司 ID StringuserId 用户 ID String返回：无返回。3.3 查看学员：接口名称 查看接
6、口接口描述 根据用户 ID 查看用户详细信息。接口协议 SOAP命名空间 http:/接口描述 http:/ PersonnelService?wsdl接口方法 getSysPersonnelInfoWS(String coopCode,String userId)请求参数：名称 说明 类型 长度（字节）coopCode 公司 ID StringuserId 待查看的用户 ID String返回学员基本信息。3.4.根据企业 ID 查看学员列表：接口名称 查看接口接口描述 ASP 系统的系统管理员通过 ASP 调用该接口通知 ELN 系统为查看该公司的部门。接口协议 SOAP命名空间 http
7、:/接口描述 http:/ PersonnelService?wsdl接口方法 getPersonnelInfoByCoopCodeWS(String coopCode, int pageNo, int pageSize)请求参数：名称 说明 类型 长度（字节）coopCode 公司 ID StringpageNo 页号 intpageSize 每页大小 int返回学员列表。4 组织管理服务接口ELN 学员管理的 web service 描述地址是： http:/ ELN 学员管理提供了如下接口：A 增加组织public String addSysOrganizeWS(String coopC
8、ode, String parentOrgId, SysOrganize sysOrganize)B 删除组织public void removeSysOrganizeWS(String coopCode, String organizeId) C 查看组织public SysOrganize getSysOrganizeWS(String coopCode, String organizeId) D 修改组织public void saveSysOrganizeWS(String coopCode, SysOrganize sysOrganize) E 根据企业 ID 查询组织列表publi
9、c List getSysOrganizeByCoopCodeWS(String coopCode) ELN 组织管理的接口定义如下：4.1.添加组织：接口名称 增加组织接口接口描述 增加组织。接口协议 SOAP命名空间 http:/接口描述 http:/ OrgService?wsdl接口方法 addSysOrganizeWS(String coopCode, String parentOrgId, SysOrganize sysOrganize)请求参数：名称 说明 类型 长度（字节）coopCode 公司 ID String 50parentOrgId 待增加组织的父组 ID Strin
10、g 32sysOrganize 待保存的组织实例 SysOrganizeSysOrganize 对象详细解释:名称 说明 类型 长度（字节）coopCode 企业 ID（必填项） string 50orgIdStr 组织 ID 串 （不填，由系统自动生成） string 500organizeId 组织 ID（不填，由系统自动生成） string 32organizeName 组织名称（必填项） string 30organizeNo （备用） （选填项） string 50返回：增加的组织的 ID，若增加失败返回 “0”4.2 删除组织：接口名称 删除接口接口描述 根据组织 ID 删除组织。
11、接口协议 SOAP命名空间 http:/接口描述 http:/ OrgService?wsdl接口方法 removeSysOrganizeWS(String coopCode, String organizeId)请求参数：名称 说明 类型 长度（字节）coopCode 公司 ID String 50organizeId 待删除的组织 ID String 32返回：无返回4.3.查看组织：接口名称 组织查看接口接口描述 根据组织 ID 查看组织。接口协议 SOAP命名空间 http:/接口描述 http:/ getSysOrganizeWS(String coopCode, String or
12、ganizeId)请求参数：名称 说明 类型 长度（字节）coopCode 公司 ID String 50organizeId 待查看的组织 ID String 32返回组织详细信息4.4.修改组织：接口名称 增加组织接口接口描述 增加组织。接口协议 SOAP命名空间 http:/接口描述 http:/ OrgService?wsdl接口方法 saveSysOrganizeWS(String coopCode, SysOrganize sysOrganize)请求参数：名称 说明 类型 长度（字节）coopCode 公司 ID String 50sysOrganize 待保存的组织实例 Sys
13、Organize对象SysOrganize 对象详细解释:名称 说明 类型 长度（字节）coopCode 企业 ID（必填项） string 50orgIdStr 组织 ID 串 （必填项） string 500organizeId 组织 ID（必填项） string 32organizeName 组织名称（必填项） string 30organizeNo （备用） （选填项） string 50返回：增加的组织的 ID，若增加失败返回 “0”4.5.根据企业 ID 查看组织列表：接口名称 查询组织列表接口接口描述 根据企业 ID 查询组织列表。接口协议 SOAP命名空间 http:/接口描述
14、 http:/ getSysOrganizeByCoopCodeWS(String coopCode)请求参数：名称 说明 类型 长度（字节）coopCode 公司 ID String 50pageNo 页号 int 11pageSize 每页大小 int 11返回组织详细信息列表5 课程管理服务接口ELN 课程管理的 web service 描述地址是： http:/ CourseService?wsdl当前的 ELN 课程管理提供了如下接口：A 查看课程public CourseInfo getCourseInfo(String coopCode, String courseId)B 根据
15、企业 ID 查询课程列表public List getCourseByCoopCode(String coopCode, int pageNo, int pageSize)5.1.查看课程：接口名称 课程查看接口接口描述 根据课程 ID 查看课程详细信息。接口协议 SOAP命名空间 http:/接口描述 http:/ CourseInfo getCourseInfo(String coopCode, String courseId)请求参数：名称 说明 类型 长度（字节）coopCode 公司 ID String 50courseId 待查询的课程 ID String 32返回课程基本信息5.
16、2 根据企业 ID 查看课程列表：接口名称 查询公司课程列表接口接口描述 根据企业 ID 查询公司课程列表接口协议 SOAP命名空间 http:/接口描述 http:/ CousrseService?wsdl接口方法 getCourseByCoopCode(String coopCode, int pageNo, int pageSize)请求参数：名称 说明 类型 长度（字节）coopCode 公司 ID String 50pageNo 页号 int 11pageSize 每页大小 int 11返回课程 ID 列表6 企业公告服务接口ELN 课程管理的 web service 描述地址是：
17、http:/ BulletinService?wsdl当前的 ELN 课程管理提供了如下接口：-public CommonBulletin getBulletin(String bulletinId)查看企业公告-public List getBulletinByCoopCode(String coopCode)根据企业 ID 查询公告列表6.1.查看公告：接口名称 查看接口接口描述 查看公告接口协议 SOAP命名空间 http:/webservice. 接口描述 http:/ getBulletin(String bulletinId)请求参数：名称 说明 类型 长度（字节）bulletin
18、Id 用户 ID String 32返回公告6.2.根据企业 ID 查看公告列表：接口名称 查看接口接口描述 查看公司公告列表接口协议 SOAP命名空间 http:/webservice. 接口描述 http:/ getBulletinByCoopCode(String coopCode,int pageNo,int pageSize)请求参数：名称 说明 类型 长度（字节）coopCode 企业 ID String 50pageNo 页码 int 11pageSize 每页显示的条数 int 11返回公告列表7 岗位管理服务接口ELN 学员管理的 web service 描述地址是： htt
19、p:/ ELN 学员管理提供了如下接口：A 增加岗位public String addBasPositionWS(String coopCode,BasPosition BasPosition)B 删除岗位public void removeBasPositionWS(String coopCode, String username,String password, String organizeId) C 查看岗位public BasPosition getBasPositionWS(String coopCode, String organizeId) D 修改岗位public void
20、saveBasPositionWS(String coopCode, BasPosition BasPosition) E 根据企业 ID 查询岗位列表public List getBasPositionByCoopCodeWS(String coopCode) ELN 岗位管理的接口定义如下：7.1.添加岗位：接口名称 增加岗位接口接口描述 增加岗位。接口协议 SOAP命名空间 http:/接口描述 http:/ OrgService?wsdl接口方法 addBasPositionWS(String coopCode, String username,String password, Bas
21、Position BasPosition)请求参数：名称 说明 类型 长度（字节）coopCode 公司 ID String 50BasPosition 待保存的岗位实例 BasPosition 对象BasPosition 对象详细解释:名称 说明 类型 长度（字节）coopCode 企业 ID（必填项） string 50positionId 岗位 ID （新增，由系统自动生成） string 32positionName 岗位名称（必填项） string 50positionNo 岗位编号（必填项，不能重复） string 50返回：增加的岗位的 ID，若增加失败返回 “0”7.2 删除岗
22、位：接口名称 删除接口接口描述 根据岗位 ID 删除岗位。接口协议 SOAP命名空间 http:/接口描述 http:/ OrgService?wsdl接口方法 removeBasPositionWS(String coopCode, String positionId)请求参数：名称 说明 类型 长度（字节）coopCode 公司 ID String 50positionId 待删除的岗位 ID String 32返回：无返回7.3.查看岗位：接口名称 岗位查看接口接口描述 根据岗位 ID 查看岗位。接口协议 SOAP命名空间 http:/接口描述 http:/ getBasPosition
23、WS(String coopCode, String positionId)请求参数：名称 说明 类型 长度（字节）coopCode 公司 ID String 50positionId 待查看的岗位 ID String 32返回岗位详细信息7.4.修改岗位：接口名称 增加岗位接口接口描述 增加岗位。接口协议 SOAP命名空间 http:/接口描述 http:/ OrgService?wsdl接口方法 saveBasPositionWS(String coopCode, BasPosition BasPosition)请求参数：名称 说明 类型 长度（字节）coopCode 公司 ID Stri
24、ng 50BasPosition 待保存的岗位实例 BasPosition 32BasPosition 对象详细解释:名称 说明 类型 长度（字节）coopCode 企业 ID（必填项） string 50positionId 岗位 ID （必填项） string 32positionName 岗位名称（必填项） string 50positionNo 岗位编号（必填项，不能重复） string 50返回：增加的岗位的 ID，若增加失败返回 “0”7.5.根据企业 ID 查看岗位列表：接口名称 查询岗位列表接口接口描述 根据企业 ID 查询岗位列表。接口协议 SOAP命名空间 http:/接口描述 http:/ getBasPositionByCoopCodeWS(String coopCode)请求参数：名称 说明 类型 长度（字节）coopCode 公司 ID String 50pageNo 页号 int 11pageSize 每页大小 int 11返回岗位详细信息列表
