ELN企业信息化公共服务平台接口规范.doc

ELN企业信息化公共服务平台接口规范上海时代光华2008-9-12制作：李鹏 ELN web serviceELN企业信息化公共服务平台接口是为客户自主提交数据所提供的符合SOAP标准的 Web Service服务程序。 可以通过：/eln3_asp/services查询ELN提供的web service接口。注意ELN提供的所有接口调用需要ELN的身份验证。可参见第2节。1 用户使用应用服务流程12.用户登陆AP。3.AP用户成功登陆后，AP将该用户所有的应用显示出来。4.用户请求WS服务。5.AP系统进行参数处理，转发请求应用服务提供商（ELN）。67. ELN验证请求的有效性，并返回处理结果给AP。8AP返回操作信息给用户。2 身份认证服务端利用ValidateUserTokenHandler进行身份认证。所有调用ELN web service服务的SOAP请求头中必须包含身份验证信息。对应结点名和格式如： coopCodeuserNameDES(username=”&password=”&coopcode=”&time=”)MD5(Contents+key) 参数解释：CoopCode = 企业在ELN系统中的IDuserName = 公司系统管理员的用户名Contents = DES(username=”&password=”&coopcode=”&time=”)username:公司系统管理员的用户名password:公司系统系统管理员的密码的MD5值coopcode:企业IDtime: 1970-01-01 00:00:00到当前时间的秒数。DES加密的密钥为password进行MD5后的值。Verify = MD5(Contents+key)Key= Contents 进行DES的加密的密钥3 学员管理服务接口ELN 学员管理的web service描述地址是：http:/localhost:8080/eln3_asp/services/PersonnelService?wsdl当前的ELN学员管理提供了如下接口：A 修改/增加学员public String saveSysPersonnelInfoWS(String coopCode, SysPersonnelInfo sysPersonnelInfo, String loginName)B 删除学员public void removeSysPersonnelInfoWS(String coopCode, String username,String password, String userId)C 查看学员public SysPersonnelInfo getSysPersonnelInfoWS(String coopCode,final String userId)D 查看学员列表public List getPersonnelInfoByCoopCodeWS(String coopCode, int pageNo, int pageSize)E 修改学员public String modifySysPersonnelInfoWS(String coopCode,SysPersonnelInfo sysPersonnelInfo, String loginName)throws XFireFault;ELN学员管理的接口定义如下：3.1.添加/修改学员：接口名称增加学员接口接口描述增加或者修改学员学员基本信息。接口协议SOAP命名空间接口描述/eln3_asp/services/ PersonnelService?wsdl接口方法saveSysPersonnelInfoWS(String coopCode,SysPersonnelInfo sysPersonnelInfo,String loginName)请求参数：名称说明类型长度（字节）coopCode公司IDStringsysPersonnelInfo（详细解释见下：）待保存的学员实例SysPersonnelInfologinName新增/修改学员的登录名StringsysPersonnelInfo对象详细解释:名称说明类型长度（字节）birthdate生日dateTimecoopCode企业ID（必填项）stringemail邮箱（若填写，则不能重复）stringmobile手机stringorgIdStr组织ID串， stringorganizeId组织ID（如果新增的人员organizeId为空，则默认增加到根组织。）stringorganizeName组织名称stringpositionId岗位IDstringpositionName岗位名称stringsex性别（必填项，必须=0或1，0=女，1=男）stringuserId学员ID,新增学员可以不填，系统自动生成。stringuserName姓名（必填项，不能重复）stringworkId工号（必填项，不能重复）string返回：增加/修改成功返回（Y|用户ID）。增加/修改失败返回（N|错误提示信息）。3.2 删除学员：接口名称删除接口接口描述ASP系统的系统管理员通过ASP调用该接口通知ELN系统根据ID删除学员。接口协议SOAP命名空间接口描述/eln3_asp/services/ PersonnelService?wsdl接口方法removeSysPersonnelInfoWS(String coopCode, String userId)请求参数：名称说明类型长度（字节）coopCode公司IDStringuserId用户IDString返回：无返回。3.3 查看学员：接口名称查看接口接口描述根据用户ID查看用户详细信息。接口协议SOAP命名空间接口描述/eln3_asp/services/ PersonnelService?wsdl接口方法getSysPersonnelInfoWS(String coopCode,String userId)请求参数：名称说明类型长度（字节）coopCode公司IDStringuserId待查看的用户IDString返回学员基本信息。3.4.根据企业ID查看学员列表：接口名称查看接口接口描述ASP系统的系统管理员通过ASP调用该接口通知ELN系统为查看该公司的部门。接口协议SOAP命名空间接口描述/eln3_asp/services/ PersonnelService?wsdl接口方法getPersonnelInfoByCoopCodeWS(String coopCode, int pageNo, int pageSize)请求参数：名称说明类型长度（字节）coopCode公司IDStringpageNo页号intpageSize每页大小int返回学员列表。4 组织管理服务接口ELN 学员管理的web service描述地址是： /eln3_asp/services/OrgService?wsdl当前的ELN学员管理提供了如下接口：A增加组织public String addSysOrganizeWS(String coopCode, 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查询组织列表public List getSysOrganizeByCoopCodeWS(String coopCode) ELN组织管理的接口定义如下：4.1.添加组织：接口名称增加组织接口接口描述增加组织。接口协议SOAP命名空间接口描述/eln3_asp/services/ OrgService?wsdl接口方法addSysOrganizeWS(String coopCode, String parentOrgId, SysOrganize sysOrganize)请求参数：名称说明类型长度（字节）coopCode公司IDString50parentOrgId待增加组织的父组IDString32sysOrganize待保存的组织实例SysOrganizeSysOrganize对象详细解释:名称说明类型长度（字节）coopCode企业ID（必填项）string50orgIdStr组织ID串 （不填，由系统自动生成）string500organizeId组织ID（不填，由系统自动生成）string32organizeName组织名称（必填项）string30organizeNo（备用）（选填项）string50返回：增加的组织的ID，若增加失败返回“0”4.2 删除组织：接口名称删除接口接口描述根据组织ID删除组织。接口协议SOAP命名空间接口描述/eln3_asp/services/ OrgService?wsdl接口方法removeSysOrganizeWS(String coopCode, String organizeId)请求参数：名称说明类型长度（字节）coopCode公司IDString50organizeId待删除的组织IDString32返回：无返回4.3.查看组织：接口名称组织查看接口接口描述根据组织ID查看组织。接口协议SOAP命名空间接口描述/eln3_asp/services/OrganizeService?wsdl接口方法getSysOrganizeWS(String coopCode, String organizeId)请求参数：名称说明类型长度（字节）coopCode公司IDString50organizeId待查看的组织IDString32返回组织详细信息4.4.修改组织：接口名称增加组织接口接口描述增加组织。接口协议SOAP命名空间接口描述/eln3_asp/services/ OrgService?wsdl接口方法saveSysOrganizeWS(String coopCode, SysOrganize sysOrganize)请求参数：名称说明类型长度（字节）coopCode公司IDString50sysOrganize待保存的组织实例SysOrganize对象SysOrganize对象详细解释:名称说明类型长度（字节）coopCode企业ID（必填项）string50orgIdStr组织ID串 （必填项）string500organizeId组织ID（必填项）string32organizeName组织名称（必填项）string30organizeNo（备用）（选填项）string50返回：增加的组织的ID，若增加失败返回“0”4.5.根据企业ID查看组织列表：接口名称查询组织列表接口接口描述根据企业ID查询组织列表。接口协议SOAP命名空间接口描述/eln3_asp/services/OrganizeService?wsdl接口方法getSysOrganizeByCoopCodeWS(String coopCode)请求参数：名称说明类型长度（字节）coopCode公司IDString50pageNo页号int11pageSize每页大小int11返回组织详细信息列表5 课程管理服务接口ELN 课程管理的web service描述地址是： /eln3_asp/services/ CourseService?wsdl当前的ELN课程管理提供了如下接口：A查看课程public CourseInfo getCourseInfo(String coopCode, String courseId)B根据企业ID查询课程列表public List getCourseByCoopCode(String coopCode, int pageNo, int pageSize)5.1.查看课程：接口名称课程查看接口接口描述根据课程ID查看课程详细信息。接口协议SOAP命名空间接口描述/eln3_asp/services/CourseService?wsdl接口方法CourseInfo getCourseInfo(String coopCode, String courseId)请求参数：名称说明类型长度（字节）coopCode公司IDString50courseId待查询的课程IDString32返回课程基本信息5.2根据企业ID查看课程列表：接口名称查询公司课程列表接口接口描述根据企业ID查询公司课程列表接口协议SOAP命名空间接口描述/eln3_asp/services/ CousrseService?wsdl接口方法getCourseByCoopCode(String coopCode, int pageNo, int pageSize)请求参数：名称说明类型长度（字节）coopCode公司IDString50pageNo页号int11pageSize每页大小int11返回课程ID列表6 企业公告服务接口ELN 课程管理的web service描述地址是： /eln3_asp/services/ BulletinService?wsdl当前的ELN课程管理提供了如下接口：-public CommonBulletin getBulletin(String bulletinId)查看企业公告-public List getBulletinByCoopCode(String coopCode)根据企业ID查询公告列表6.1.查看公告：接口名称查看接口接口描述查看公告接口协议SOAP命名空间http:/webservice. 接口描述/eln3_asp/services/BulletinService?wsdl接口方法getBulletin(String bulletinId)请求参数：名称说明类型长度（字节）bulletinId用户IDString32返回公告6.2.根据企业ID查看公告列表：接口名称查看接口接口描述查看公司公告列表接口协议SOAP命名空间http:/webservice. 接口描述/eln3_asp/services/BulletinService?wsdl接口方法getBulletinByCoopCode(String coopCode,int pageNo,int pageSize)请求参数：名称说明类型长度（字节）coopCode企业IDString50pageNo页码int11pageSize每页显示的条数int 11返回公告列表7 岗位管理服务接口ELN 学员管理的web service描述地址是： /eln3_asp/services/OrgService?wsdl当前的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 saveBasPositionWS(String coopCode, BasPosition BasPosition) E根据企业ID查询岗位列表public List getBasPositionByCoopCodeWS(String coopCode) ELN岗位管理的接口定义如下：7.1.添加岗位：接口名称增加岗位接口接口描述增加岗位。接口协议SOAP命名空间接口描述/eln3_asp/services/ OrgService?wsdl接口方法addBasPositionWS(String coopCode, String username,String password, BasPosition BasPosition)请求参数：名称说明类型长度（字节）coopCode公司IDString50BasPosition待保存的岗位实例BasPosition对象BasPosition对象详细解释:名称说明类型长度（字节）coopCode企业ID（必填项）string50positionId岗位ID （新增，由系统自动生成）string32positionName岗位名称（必填项）string50positionNo岗位编号（必填项，不能重复）string50返回：增加的岗位的ID，若增加失败返回“0”7.2 删除岗位：接口名称删除接口接口描述根据岗位ID删除岗位。接口协议SOAP命名空间接口描述/eln3_asp/services/ OrgService?wsdl接口方法removeBasPositionWS(String coopCode, String positionId)请求参数：名称说明类型长度（字节）coopCode公司IDString50positionId待删除的岗位IDString32返回：无返回7.3.查看岗位：接口名称岗位查看接口接口描述根据岗位ID查看岗位。接口协议SOAP命名空间http:/webservi