1、项目名称:某某项目XXX 信息中心XXXX 公司版本信息:1.0.0时间:2010-7-15第 2 页 共 34 页 目 录1 规范描述 _42 参考文档 _43 接口约定 _44 统一用户管理接口规范 _54.1 查询所有组织 _54.2 查询根组织 _54.3 查询指定组织下的下级组织 _64.4 查询指定组织下的用户 _74.5 查询指定组织下的下级组织和用户 _84.6 查询用户 _94.7 查询用户直接上级 _104.8 查询用户直接下级用户 _114.9 查询所有无上级组织的用户 _124.10 查询可使用指定应用系统的用户 _134.11 查询指定时间段内的变更集合 _134.1
2、2 查询所有全局组 _154.13 查询指定全局组下级组 _154.14 查询指定全局组下的用户 _164.15 查询指定全局组下级组和用户 _174.16 查询指定全局组下用户 _184.17 查询所有职务信息 _194.18 查询指定职务信息 _205 附录 _215.1 XML 数据规范 _215.1.1 认证 XML 数据 _215.1.2 组织 XML 数据 _215.1.3 用户 XML 数据 _235.1.4 全局组 XML 数据 _265.1.5 全局组关联关系 XML 数据 _275.1.6 职务 XML 数据 _285.2 操作类型定义(ActionType ) _29第
3、3 页 共 34 页 5.3 状态类型定义(Status) _305.4 组织类型定义(OrgType) _305.5 全局组关联关系定义(Relate) _305.6 数据属性表 _315.6.1 组织属性 _315.6.2 用户属性 _325.6.3 全局组属性 _335.6.4 全局组关联属性 _335.6.5 职务属性 _345.7 各应用系统编码 _34第 4 页 共 34 页 1 统一用户管理接口规范1.1 查询所有组织1. 接口定义接口名称 查询所有组织 getAllOrgs接口描述 实现查询所有组织的树形结构接口协议 SOAP主要使用者 各应用系统2. 请求参数名称 说明 数据
4、类型 长度(字节)IASID 应用系统编码,参见附录“各应用系统编码” String 3TimeStamp 当前时间戳,yyyy-MM-dd HH:mm:ss,其中 HH 取值为 00-23,时区为东八区 String19Authenticator 认证码,用于鉴别发送者。取值= base64 (3DES(IASID+TimeStamp)+IASID+TimeStamp)String3. 应答消息名称 说明 数据类型 长度(字节)IASID 应用系统编码,参见附录“各应用系统编码” String 3TimeStamp 当前时间戳,yyyy-MM-dd HH:mm:ss,其中 HH 取值为 00
5、-23,时区为东八区 String 19OrgList 组织集合,XML 表示,属性参见附录Result0:认证通过1:失败2:包数据格式不正确Int 2ErrorDescription 对错误/异常的详细描述信息 StringAuthenticator 认证码,用于鉴别发送者。取值= base64 (3DES(IASID+TimeStamp)+IASID+TimeStamp)String第 5 页 共 34 页 1.2 查询根组织1. 接口定义接口名称 查询根组织 getRootOrg接口描述 实现查询查询根组织接口协议 SOAP主要使用者 各应用系统2. 请求参数名称 说明 数据类型 长度
6、(字节)IASID 应用系统编码,参见附录”各应用系统编码” String 3TimeStamp 当前时间戳,yyyy-MM-dd HH:mm:ss,其中 HH 取值为 00-23,时区为东八区 String19Authenticator 认证码,用于鉴别发送者。取值= base64 (3DES(IASID+TimeStamp)+IASID+TimeStamp)String3. 应答消息名称 说明 数据类型 长度(字节)IASID 应用系统编码,参见附录”各应用系统编码” String 3TimeStamp 当前时间戳,yyyy-MM-dd HH:mm:ss,其中 HH 取值为 00-23,时
7、区为东八区 String 19OrgList 组织Result0:认证通过1:失败2:包数据格式不正确Int 2ErrorDescription 对错误/异常的详细描述信息 StringAuthenticator 认证码,用于鉴别发送者。取值= base64 (3DES(IASID+TimeStamp)+IASID+TimeStamp)String1.3 查询指定组织下的下级组织1. 接口定义第 6 页 共 34 页 接口名称 查询指定组织下的下级组织 getOrgChild接口描述 实现查询指定组织下的组织(树形结构)接口协议 SOAP主要使用者 各应用系统2. 请求参数名称 说明 数据类型
8、 长度(字节)IASID 应用系统编码,参见附录“各应用系统编码” String 3OrgID 指定组织编号 String 32TimeStamp 当前时间戳,yyyy-MM-dd HH:mm:ss,其中 HH 取值为 00-23,时区为东八区 String19Authenticator 认证码,用于鉴别发送者。取值= base64 (3DES(IASID+TimeStamp)+IASID+TimeStamp)String3. 应答消息名称 说明 数据类型 长度(字节)IASID 应用系统编码,参见附录”各应用系统编码” String 3TimeStamp 当前时间戳,yyyy-MM-dd H
9、H:mm:ss,其中 HH 取值为 00-23,时区为东八区 String 19OrgList 组织集合,XML 表示,组织属性参见附录Result0:认证通过1:失败2:包数据格式不正确Int 2ErrorDescription 对错误/异常的详细描述信息 StringAuthenticator 认证码,用于鉴别发送者。取值= base64 (3DES(IASID+TimeStamp)+IASID+TimeStamp)String1.4 查询指定组织下的用户1. 接口定义接口名称 查询指定组织下的用户 getUsersByOrgID接口描述 实现查询指定组织下的用户第 7 页 共 34 页
10、接口协议 SOAP主要使用者 各应用系统2. 请求参数名称 说明 数据类型 长度(字节)IASID 应用系统编码,参见附录”各应用系统编码” String 3OrgID 指定组织编号 String 32TimeStamp 当前时间戳,yyyy-MM-dd HH:mm:ss,其中 HH 取值为 00-23,时区为东八区 String19Authenticator 认证码,用于鉴别发送者。取值= base64 (3DES(IASID+TimeStamp)+IASID+TimeStamp)String3. 应答消息名称 说明 数据类型 长度(字节)IASID 应用系统编码,参见附录”各应用系统编码”
11、 String 3TimeStamp 当前时间戳,yyyy-MM-dd HH:mm:ss,其中 HH 取值为 00-23,时区为东八区 String 19User 用户集合,XML 表示,属性参见附录Result0:认证通过1:失败2:包数据格式不正确Int 2ErrorDescription 对错误/异常的详细描述信息 StringAuthenticator 认证码,用于鉴别发送者。取值= base64 (3DES(SHA1 (IASID+TimeStamp)+IASID+TimeStamp),3DES 采用 IASSecret 加密String1.5 查询指定组织下的下级组织和用户1. 接
12、口定义接口名称 查询指定组织下的下级组织和用户 getOrgsAndUsersByOrgID接口描述 实现查询指定组织下的下级组织和用户接口协议 SOAP主要使用者 各应用系统2. 请求参数第 8 页 共 34 页 名称 说明 数据类型 长度(字节)IASID 应用系统编码,参见附录”各应用系统编码” String 3OrgID 指定组织编号 String 32TimeStamp 当前时间戳,yyyy-MM-dd HH:mm:ss,其中 HH 取值为 00-23,时区为东八区 String19Authenticator 认证码,用于鉴别发送者。取值= base64 (3DES(SHA1 (IA
13、SID+TimeStamp)+IASID+TimeStamp),3DES 采用 IASSecret 加密String3. 应答消息名称 说明 数据类型 长度(字节)IASID 应用系统编码,参见附录”各应用系统编码” String 3TimeStamp 当前时间戳,yyyy-MM-dd HH:mm:ss,其中 HH 取值为 00-23,时区为东八区 String 19UserList 用户集合,XML 表示,属性参见附录OrgList 组织集合,XML 表示,属性参见附录Result0:认证通过1:失败2:包数据格式不正确Int 2ErrorDescription 对错误/异常的详细描述信息
14、StringAuthenticator (3DES(SHA1 (IASID+ OrgID+TimeStamp)+IASID+TimeStamp),3DES 采用 IASSecret 加密String1.6 查询用户1. 接口定义接口名称 查询指定用户属性信息 getUserByAccountName接口描述 实现查询指定用户属性信息接口协议 SOAP主要使用者 各应用系统2. 请求参数名称 说明 数据类型 长度(字节)IASID 应用系统编码,参见附录”各应用系统编码” String 3第 9 页 共 34 页 AccountName 用户帐号名 String 32TimeStamp 当前时间
15、戳,yyyy-MM-dd HH:mm:ss,其中 HH 取值为 00-23,时区为东八区 String19Authenticator 认证码,用于鉴别发送者。取值= base64 (3DES(IASID+TimeStamp)+IASID+TimeStamp)String3. 应答消息名称 说明 数据类型 长度(字节)IASID 应用系统编码,参见附录”各应用系统编码” String 3TimeStamp 当前时间戳,yyyy-MM-dd HH:mm:ss,其中 HH 取值为 00-23,时区为东八区 String 19User 用户集合,XML 表示,属性参见附录Result0:认证通过1:失
16、败2:包数据格式不正确Int 2ErrorDescription 对错误/异常的详细描述信息 StringAuthenticator 认证码,用于鉴别发送者。取值= base64 (3DES(IASID+TimeStamp)+IASID+TimeStamp)String1.7 查询用户直接上级1. 接口定义接口名称 查询指定用户直接上级信息 getLeaderByAccountName接口描述 实现查询指定用户直接上级集合接口协议 SOAP主要使用者 各应用系统2. 请求参数名称 说明 数据类型 长度(字节)IASID 应用系统编码,参见附录”各应用系统编码” String 3AccountN
17、ame 用户帐号名 String 32TimeStamp 当前时间戳,yyyy-MM-dd HH:mm:ss,其中 HH 取值为 00-23,时区为东八区 String19第 10 页 共 34 页 Authenticator 认证码,用于鉴别发送者。取值= base64 (3DES(IASID+TimeStamp)+IASID+TimeStamp)String3. 应答消息名称 说明 数据类型 长度(字节)IASID 应用系统编码,参见附录”各应用系统编码” String 3TimeStamp 当前时间戳,yyyy-MM-dd HH:mm:ss,其中 HH 取值为 00-23,时区为东八区
18、String 19User 直接上级用户集合,XML 表示,属性参见附录Result0:认证通过1:失败2:包数据格式不正确Int 2ErrorDescription 对错误/异常的详细描述信息 StringAuthenticator 认证码,用于鉴别发送者。取值= base64 (3DES(IASID+TimeStamp)+IASID+TimeStamp)String1.8 查询用户直接下级用户1. 接口定义接口名称 查询指定用户直接下级信息 getChildByAccountName接口描述 实现查询指定用户直接下级集合接口协议 SOAP主要使用者 各应用系统2. 请求参数名称 说明 数据
19、类型 长度(字节)IASID 应用系统编码,参见附录”各应用系统编码” String 3AccountName 用户帐号名 String 20TimeStamp 当前时间戳,yyyy-MM-dd HH:mm:ss,其中 HH 取值为 00-23,时区为东八区 String19Authenticator 认证码,用于鉴别发送者。取值= base64 (3DES(IASID+TimeStamp)+IASID+TimeStamp)String第 11 页 共 34 页 3. 应答消息名称 说明 数据类型 长度(字节)IASID 应用系统编码,参见附录”各应用系统编码” String 3TimeSta
20、mp 当前时间戳,yyyy-MM-dd HH:mm:ss,其中 HH 取值为 00-23,时区为东八区 String 19UserList 直接上级用户集合,XML 表示,属性参见附录Result0:认证通过1:失败2:包数据格式不正确Int 2ErrorDescription 对错误/异常的详细描述信息 StringAuthenticator 认证码,用于鉴别发送者。取值= base64 (3DES(IASID+TimeStamp)+IASID+TimeStamp)String1.9 查询所有无上级组织的用户1. 接口定义接口名称 查询所有无上级组织的用户 getUserNoneRoot接口
21、描述 实现查询所有无上级组织的用户接口协议 SOAP主要使用者 各应用系统2. 请求参数名称 说明 数据类型 长度(字节)IASID 应用系统编码,参见附录”各应用系统编码” String 3TimeStamp 当前时间戳,yyyy-MM-dd HH:mm:ss,其中 HH 取值为 00-23,时区为东八区 String19Authenticator 认证码,用于鉴别发送者。取值= base64 (3DES(IASID+TimeStamp)+IASID+TimeStamp)String3. 应答消息名称 说明 数据类型 长度(字节)IASID 应用系统编码,参见附录”各应用系统编码” Stri
22、ng 3第 12 页 共 34 页 TimeStamp 当前时间戳,yyyy-MM-dd HH:mm:ss,其中 HH 取值为 00-23,时区为东八区 String 19UserList 用户集合,XML 表示,属性参见附录Result0:认证通过1:失败2:包数据格式不正确Int 2ErrorDescription 对错误/异常的详细描述信息 StringAuthenticator 认证码,用于鉴别发送者。取值= base64 (3DES(IASID+TimeStamp)+IASID+TimeStamp)String1.10 查询可使用指定应用系统的用户1. 接口定义接口名称 查询可使用指
23、定应用系统的用户 getUsersByIASID接口描述 实现查询可使用指定应用系统的用户接口协议 SOAP主要使用者 各应用系统2. 请求参数名称 说明 数据类型 长度(字节)IASID 应用系统编码,参见附录“各应用系统编码” String 3TimeStamp 当前时间戳,yyyy-MM-dd HH:mm:ss,其中 HH 取值为 00-23,时区为东八区 String19Authenticator 认证码,用于鉴别发送者。取值= base64 (3DES(IASID+TimeStamp)+IASID+TimeStamp)String3. 应答消息名称 说明 数据类型 长度(字节)IAS
24、ID 应用系统编码,参见附录“各应用系统编码” String 3TimeStamp 当前时间戳,yyyy-MM-dd HH:mm:ss,其中 HH 取值为 00-23,时区为东八区 String 19Users 用户集合,XML 表示,属性参见附录Result 0:认证通过 Int 2第 13 页 共 34 页 1:失败2:包数据格式不正确ErrorDescription 对错误/异常的详细描述信息 StringAuthenticator 认证码,用于鉴别发送者。取值= base64 (3DES(IASID+TimeStamp)+IASID+TimeStamp)String1.11 查询指定时
25、间段内的变更集合1. 接口定义接口名称 查询指定时间段内的变更集合 getModifyRecords接口描述 实现查询指定时间段内的变更集合,时间段格式 表示, 以保 证对 特殊 字符 的正确 处理 ; 某节点 值为 空时(该 节 点 允 许 为 空 时 ),可 不填 该节点 。第 21 页 共 34 页 2.1.1认证 XML 数据返回节点 XML 实例 描述认证 0002010-07-19 15:25:000G2/uB6IfG7GLseibjHJVHYr6uwgHiMxHPfvow8NT54odwD6DgGSlUkA+wcg/nBJGE5IgqEg5O1G6OYAYtwRRIw=认证返回2
26、.1.2组织 XML 数据操作类型 XML 实例 描述ADD ADDorg123456789信息中心信息XXZX2org987654321202010-07-20 11:19:03user1234567892010-07-20 11:19:031.0新增组织DEL DELorg123456789删除组织第 22 页 共 34 页 MOD MODorg123456789信息中心信息XXZX2org987654321202010-07-20 11:19:03user1234567892010-07-20 11:19:031.0org123456789信息中心 2信息XXZX2org98765432
27、1202010-07-20 11:19:03user1234567892010-07-20 11:19:031.0修改组织MOV MOVorg123456789移动组织内组织第 23 页 共 34 页 forg987654321torg9876543212.1.3用户 XML 数据操作类型 XML 实例 描述ADD ADDuser123456789240000000123张 XX张 XXorg123456789duty987654321user9876543211234567899876543211982-07-20202010-07-20 11:19:03user1234567892010-
28、07-20 11:19:032010-07-20 11:19:032010-07-20 11:19:032010-07-20 11:19:031.0新增用户DEL DEL删除用户第 24 页 共 34 页 user123456789org123456789MOD MODuser123456789240000000123张 XX张 XXorg123456789duty987654321user9876543211234567899876543211982-07-20202010-07-20 11:19:03user1234567892010-07-20 11:19:032010-07-20 11
29、:19:032010-07-20 11:19:032010-07-20 11:19:031.0user123456789240000000123张 XX张 XXorg123456789duty987654321user987654321修改用户第 25 页 共 34 页 1234567899876543211982-07-20202010-07-20 11:19:03user1234567892010-07-20 11:19:032010-07-20 11:19:032010-07-20 11:19:032010-07-20 11:19:031.0MOV MOVuser123456789for
30、g987654321torg987654321移动组织内用户PWD PWDuser123456789oldpasswordnewpassword修改用户密码2.1.4全局组 XML 数据操作类型 XML 实例 描述ADD ADD新增全局组第 26 页 共 34 页 group123456789信息中心信息XXZXgroup987654321202010-07-20 11:19:03user1234567892010-07-20 11:19:031.0DEL DELgroup123456789group123456789删除全局组MOD MODgroup123456789信息中心信息XXZXgr
31、oup987654321202010-07-20 11:19:03user1234567892010-07-20 11:19:031.0group123456789信息中心 2信息修改全局组第 27 页 共 34 页 XXZXgroup987654321202010-07-20 11:19:03user1234567892010-07-20 11:19:031.02.1.5全局组关联关系 XML 数据操作类型 XML 实例 描述ADD ADDgroup1234567892user123456789新增全局组关联DEL DELid1234567892user123456789删除全局组关联MOV
32、 MOVgroup123456789group987654321移动全局组内关联第 28 页 共 34 页 2.1.6职务 XML 数据操作类型 XML 实例 描述ADD ADDduty123456789信息中心经理经理JL202010-07-20 11:19:03user1234567892010-07-20 11:19:031.0新增职务DEL DELduty123456789删除职务MOD MODduty123456789信息中心经理经理JL202010-07-20 11:19:03user1234567892010-07-20 11:19:031.0修改职务第 29 页 共 34 页
33、duty123456789信息中心经理 2经理JL202010-07-20 11:19:03user1234567892010-07-20 11:19:031.02.2 状态类型定义(Status )数据 说明0 逻辑删除1 有效2 预留使用3 冻结(输入多次密码错误)2.3 组织类型定义(OrgType)数据 说明0 组织根1 省局/各地市局/直属分局2 处室/中心/区县分局3 科室第 30 页 共 34 页 4 所/组/股/点2.4 全局组关联关系定义(Relate )数据 说明0 全局组-全局组1 全局组-组织2 全局组-用户2.5 数据属性表2.5.1组织属性表名:组织表(ORG)序号
34、 字段名 类型 长度 说明1. 1ORGID VARCHAR2 32 组织 ID2. 2ORGNAME VARCHAR2 50 组织名称3. 3SHORTNAME VARCHAR2 20 组织简称4. 4ORGCODE VARCHAR2 10 组织编码5. 5ORGTYPE NUMBER 1 组织类型6. 6PARENTID VARCHAR2 32 父组织 ID7. 15LEADER VARCHAR2 32 组织主管领导 ID8. ADDRESS VARCHAR2 100 地址9. POSTCODE VARCHAR2 8 邮编10. PHONE VARCHAR2 20 电话11. FAX VARCHAR2 20 传真12. HOMEPAGE VARCHAR2 100 主页或 EMAIL