基础信息开放接口

轻码猿2023年5月24日大约 11 分钟

更新历史

记录此文档的更新时间和内容，方便他人了解内容变更详情

更新日期	更新人	更新说明
2022年8月15日	张毅	初稿

简介

基础信息的部分对外公共接口。

API概览

接口名称	接口功能
/sysBase/getOrgData	获取机构数据
/sysBase/getOrgInfoByCode	获取机构数据根据机构编码
/sysBase/getSubNodesByOrgCode	获取机构的子节点数据根据机构编码
/sysBase/getSuperNodesByOrgCode	获取父级节点数据根据机构编码
/sysBase/getUserInfo	获取用户信息根据账号
/sysBase/getUserInfoById	获取用户信息根据用户id
/sysBase/getRoleUserByRoleId	获取角色用户根据角色id
/sysBase/getRoleUserByRoleCode	获取角色用户根据角色编码
/sysBase/getPositionUserData	获取职务下用户根据职务id
/sysBase/getRoleList	获取业务域下业务角色列表
/sysBase/getRoleTree	获取业务角色数据

调用方式

请求结构

微服务间调用接口都需要添加服务 baseinfo-service 服务前缀

参数名称	必选	类型	描述
getOrgTree	获取机构数据	/sysBase/getOrgTree	获取机构数据

公共参数

参数名称	类型

机构相关接口

获取机构数据

1. 接口描述
口请求地址：/sysBase/getOrgData
接口请求方式：GET
根据传入数据获取机构树数据
默认接口请求频率限制：无。
是否需要Token：是。

2. 输入参数

参数名称	必选	类型	描述

3. 输出参数

参数名称	必选	类型	描述
code	状态码	int	状态码返回为0表示请求成功。
msg	消息内容	String	返回的提示消息。
data	返回结果数据	JSON	返回数据

4. 示例
示例1 请求和返回示例
输入示例

https://<地址>/<机构编码>

输出示例

{

  "code": 0, 
  "msg": "操作成功", 
  "data": [{ "name" : "名称 ", "pid" : "-1", "id" : "1", "type" : 0, "level" : 1, "children" : []}]|, 
  "ok": true
}

获取组织机构信息根据编码

1. 接口描述
接口请求地址：/sysBase/getOrgInfoByCode
接口请求方式：GET
根据传入数据获取机构树数据
默认接口请求频率限制：无。
是否需要Token：是。

2. 输入参数

参数名称	参数发送方式	必选	类型	描述
orgCode	PATH参数	是	String	机构的编码

3. 输出参数

参数名称	必选	类型	描述
code	状态码	int	状态码返回为0表示请求成功。
msg	消息内容	String	返回的提示消息。
data	返回结果数据	JSON	返回数据

4. 示例
示例1 请求和返回示例
输入示例

https://<地址>/<机构编码>

输出示例


  "code": 0, 
  "msg": "操作成功", 
  "data": "轻码猿科技信息大学", 
  "ok": true
}

获取机构的子节点数据根据机构编码

1. 接口描述
接口请求地址：/sysBase/getSubNodesByOrgCode
接口请求方式：GET
根据传入数据获取机构树数据
默认接口请求频率限制：无。
是否需要Token：否。

2. 输入参数

参数名称	参数发送方式	必选	类型	描述
orgCode	PATH参数	是	String	机构的编码

3. 输出参数

参数名称	必选	类型	描述
code	状态码	int	状态码返回为0表示请求成功。
msg	消息内容	String	返回的提示消息。
data	返回结果数据	JSON	返回数据

4. 示例
示例1 请求和返回示例
输入示例

https://<地址>/<机构的编码>

输出示例

{
    "code": 0,
    "msg": "操作成功",
    "data": "subCode1, subCode2",
    "ok": true
}

获取机构的所有上级节点

1. 接口描述
接口请求地址：/sysBase/getSuperNodesByOrgCode
接口请求方式：GET
根据传入数据获取机构树数据
默认接口请求频率限制：无。
是否需要Token：否。

2. 输入参数

参数名称	参数发送方式	必选	类型	描述
orgCode	PATH参数	是	String	机构的编码

3. 输出参数

参数名称	必选	类型	描述
code	状态码	int	状态码返回为0表示请求成功。
msg	消息内容	String	返回的提示消息。
data	返回结果数据	JSON	返回数据

4. 示例
示例1 请求和返回示例
输入示例

https://<地址>/<机构的编码>

输出示例

{
    "code": 0,
    "msg": "操作成功",
    "data": "superCode1, superCode2",
    "ok": true
}

用户相关接口

获取用户信息根据账号

1. 接口描述
接口请求地址：/sysBase/getUserInfo
接口请求方式：GET
根据传入数据获取机构树数据
默认接口请求频率限制：无。
是否需要Token：否。

2. 输入参数

参数名称	参数发送方式	必选	类型	描述
userAccount	path参数	是	String	用户账号
queryType	url参数	否	String	查询类型

3. 输出参数

参数名称	必选	类型	描述
code	状态码	int	状态码返回为0表示请求成功。
msg	消息内容	String	返回的提示消息。
data	返回结果数据	JSON	返回数据

4. 示例
示例1 请求和返回示例
输入示例

https://<地址>/<用户账号>?queryType=<查询类型>

输出示例

{
    "code": 0,
    "msg": "操作成功",
    "data": {
        "csrq": "2021-09-05",
        "sfzjh": "4344354546546546546",
        "xbm": "男",
        "nation": "汉族",
        "rxrq": "",
        "xm": "李四",
        "phone": "14565656565",
        "user_identity": "校外人员",
        "zzmm": "",
        "id": "4564565",
        "jg": "11, 1101, 110101",
        "sfzjlxm": "身份证",
        "email": "18112036542@123.com"
    },
    "ok": true
}
{
    "code": 0,
    "msg": "操作成功",
    "data": {
        "viewFields": {
            "identityExtendFiled": [
                {
                    "教职工": [
                        {
                            "hiddenStatus": 1,
                            "disable": "false",
                            "columnFieldType": "varchar",
                            "sort": 999,
                            "columnField": "work_id",
                            "columnName": "工号"
                        }
                    ]
                }
            ],
            "baseField": [
                {
                    "hiddenStatus": 1,
                    "disable": "true",
                    "columnFieldType": "text",
                    "sort": 999,
                    "columnField": "user_identity",
                    "columnName": "身份"
                }
            ]
        },
        "viewData": {
            "sfzjh": "51162219440445435",
            "work_id": "12324",
            "xbm": "男",
            "superior": "",
            "staff_post": "轻码猿科技信息大学: 年级主任职务: 正职: 有权限",
            "last_login_time": "2022-08-15 15:52:27",
            "xm": "admin",
            "phone": "12454545454",
            "user_identity": "教职工, 超级管理员",
            "id": "1",
            "sfzjlxm": "身份证"
        }
    },
    "ok": true
}

获取用户信息根据id

1. 接口描述
接口请求地址：/sysBase/getUserInfoById
接口请求方式：POST
根据传入数据获取机构树数据
默认接口请求频率限制：无。
是否需要Token：否。

2. 输入参数

参数名称	参数发送方式	必选	类型	描述
userId	body	是	String	用户id
queryType	body	否	String	查询类型，可选参数base, all。

3. 输出参数

参数名称	必选	类型	描述
code	状态码	int	状态码返回为0表示请求成功。
msg	消息内容	String	返回的提示消息。
data	返回结果数据	JSON	返回数据

4. 示例
示例1 请求和返回示例
输入示例

https://<地址>/<用户id>?queryType=<查询类型>

输出示例

{
    "code": 0,
    "msg": "操作成功",
    "data": {
        "csrq": "2021-09-05",
        "sfzjh": "4344354546546546546",
        "xbm": "男",
        "nation": "汉族",
        "rxrq": "",
        "xm": "李四",
        "phone": "14565656565",
        "user_identity": "校外人员",
        "zzmm": "",
        "id": "4564565",
        "jg": "11, 1101, 110101",
        "sfzjlxm": "身份证",
        "email": "181120@123.com"
    },
    "ok": true
}

获取角色用户根据角色id

1. 接口描述
接口请求地址：/sysBase/getRoleUserByRoleId/{businessRoleId}
接口请求方式：GET
获取角色用户根据角色id
默认接口请求频率限制：无。
是否需要Token：否。

2. 输入参数

参数名称	参数发送方式	必选	类型	描述
businessRoleId	PATH参数	是	String	角色id

3. 输出参数

参数名称	必选	类型	描述
code	状态码	int	状态码返回为0表示请求成功。
msg	消息内容	String	返回的提示消息。
data	返回结果数据	JSON	返回数据

4. 示例
示例1 请求和返回示例
输入示例

https://<地址>/<角色id>

输出示例

{
    "code": 0,
    "msg": "操作成功",
    "data": [
        {
            "staffPost": "413:41310901:1:1",
            "userName": "张三",
            "userId": "1234354334"
        }
    ],
    "ok": true
}

角色职务接口

获取角色用户根据角色编码

1. 接口描述
接口请求地址：/sysBase/getRoleUserByRoleCode/{businessRoleCode}
接口请求方式：GET
根据角色编码获取相关用户数据
默认接口请求频率限制：无。
是否需要Token：是。

2. 输入参数

参数名称	参数发送方式	必选	类型	描述
businessRoleCode	PATH参数	是	String	角色编码

3. 输出参数

参数名称	必选	类型	描述
code	状态码	int	状态码返回为0表示请求成功。
msg	消息内容	String	返回的提示消息。
data	返回结果数据	JSON	返回数据

4. 示例
示例1 请求和返回示例
输入示例

https://<地址>/<角色编码>

输出示例

{
    "code": 0,
    "msg": "操作成功",
    "data": [
        {
            "staffPost": "413:41310901:1:1",
            "userName": "张三",
            "userId": "1234354334"
        }
    ],
    "ok": true
}

根据用户id获取用户的角色数据

1. 接口描述
接口请求地址：/sysBase/getUserRoleDataByUserId/{userId}
接口请求方式：GET
根据用户id获取用户的角色数据
默认接口请求频率限制：无。
是否需要Token：是。

2. 输入参数

参数名称	参数发送方式	必选	类型	描述
userId	PATH参数	是	String	用户id

3. 输出参数

参数名称	必选	类型	描述
code	状态码	int	状态码返回为0表示请求成功。
msg	消息内容	String	返回的提示消息。
data	返回结果数据	JSON	返回数据

4. 示例
示例1 请求和返回示例
输入示例

https://<地址>/<用户id>

输出示例

{
    "code": 0,
    "msg": "操作成功",
    "data": {
        "static": [
            {
                "id": "1471386065",
                "businessRoleName": "心理教师",
                "businessRoleCode": "xlls",
                "businessDomainCode": "laywy",
                "businessRoleType": "static",
                "specialRoleType": 0,
                "status": 1
            }
        ],
        "dynamic": []
    },
    "ok": true
}

获取职务下用户根据职务id

1. 接口描述
接口请求地址：/sysBase/getPositionUserData/{positionId}
接口请求方式：GET
获取职务下用户根据职务id
默认接口请求频率限制：无。
是否需要Token：是。

2. 输入参数

参数名称	参数发送方式	必选	类型	描述
positionId	PATH参数	是	String	职务id

3. 输出参数

参数名称	必选	类型	描述
code	状态码	int	状态码返回为0表示请求成功。
msg	消息内容	String	返回的提示消息。
data	返回结果数据	JSON	返回数据

4. 示例
示例1 请求和返回示例
输入示例

https://<地址>/<用户id>?queryType=<查询类型>

输出示例

{
    "code": 0,
    "msg": "操作成功",
    "data": [
        {
            "userName": "张三",
            "userId": "1471370704129"
        }
    ],
    "ok": true
}

获取业务域下业务角色列表

1. 接口描述
接口请求地址：/sysBase/getRoleList
接口请求方式：GET
获取业务域下业务角色列表
默认接口请求频率限制：无。
是否需要Token：是。

2. 输入参数

参数名称	参数发送方式	必选	类型	描述
id	URL参数	否	String	业务域id
searchParam	URL参数	否	String	查询参数

3. 输出参数

参数名称	必选	类型	描述
code	状态码	int	状态码返回为0表示请求成功。
msg	消息内容	String	返回的提示消息。
data	返回结果数据	JSON	返回数据

4. 示例
示例1 请求和返回示例
输入示例

https://<地址>/<用户id>?queryType=<查询类型>

输出示例

{
    "code": 0,
    "msg": "操作成功",
    "data": [
        {
            "id": "1111",
            "businessRoleName": "辅导员",
            "businessRoleCode": "fdy",
            "businessDomainCode": "fdyy",
            "businessRoleType": "static",
            "specialRoleType": 1,
            "specialRoleClassify": 3,
            "status": 1
        }
    ],
    "ok": true
}

获取业务角色数据

1. 接口描述
接口请求地址：/sysBase/getRoleTree
接口请求方式：GET
获取业务域下业务角色列表
默认接口请求频率限制：无。
是否需要Token：是。

2. 输入参数

参数名称	参数发送方式	必选	类型	描述

3. 输出参数

参数名称	必选	类型	描述
code	状态码	int	状态码返回为0表示请求成功。
msg	消息内容	String	返回的提示消息。
data	返回结果数据	JSON	返回数据

4. 示例
示例1 请求和返回示例
输入示例

https://<地址>/<用户id>?queryType=<查询类型>

输出示例

{
    "code": 0,
    "msg": "操作成功",
    "data": [
        {
            "checkable": 0,
            "level": 1,
            "children": [
                {
                    "checkable": 1,
                    "level": 2,
                    "children": [],
                    "name": "大一",
                    "id": "154537",
                    "pTId": "xs",
                    "type": "role",
                    "tId": "xsy"
                }
            ],
            "name": "学生",
            "id": "15086",
            "pTId": "",
            "type": "domain",
            "tId": "yxxs"
        }
    ],
    "ok": true
}

动态查询用户ids数据

1. 接口描述
接口请求地址：/sysBase/getUserIdsByDynamicCondition
接口请求方式：POST
动态查询用户ids数据
默认接口请求频率限制：无。
是否需要Token：是。

2. 输入参数

参数名称	参数发送方式	必选	类型	描述
businessRoleCode	body	是	String	角色编码
criteriaFieldName	body	是	String	条件字段名称
criteria	body	是	String	条件
criteriaParam	body	是	String	条件参数
criteriaType	body	是	String	条件类型(in-包含、notIn-不包含)

3. 输出参数

参数名称	必选	类型	描述
code	状态码	int	状态码返回为0表示请求成功。
msg	消息内容	String	返回的提示消息。
data	返回结果数据	JSON	返回数据

4. 示例
示例1 请求和返回示例
输入示例

https://<地址>/<用户id>?queryType=<查询类型>

输出示例

{
    "code": 0,
    "msg": "操作成功",
    "data": [
        2343,
        123234
    ],
    "ok": true
}

错误码

如果返回结果中code存在不是0，则表示调用 API 接口失败。例如：

{
  "code": 4001,
  "msg": "参数错误！",
  "ok": false
}