获取用户详情信息

接口描述:

获取指定用户的详情信息

接口地址:

请求方式:

  • GET

请求头:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
X-App-Id 客户端 clientId header true string

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
accessToken 接口访问凭证 query true string
userId 用户ID query true integer(int64)

响应状态

状态码 说明 schema
200 OK ApiRestResponse«List«UserInfoVO»»

其他状态码参见:全局状态码

响应示例:

正确时返回:

{
    "code": 200,
    "status": "success",
    "message": "请求成功",
    "data": {
        "userId": "619583637909737479",
        "nickname": "t**",
        "gender": 1,
        "account": "Test2022#11111111",
        "avatar": "",
        "phone": "",
        "email": "",
        "orgList": [
            {
                "orgId": "1594497749264621570",
                "orgCode": "10020027",
                "orgName": "027 新增职业高中测试",
                "roleList": [
                    {
                        "roleId": "8",
                        "roleCode": "js_000008",
                        "roleName": "教职工"
                    }
                ]
            }
        ]
    }
}

错误时返回:

{
    "code": 500,
    "data": {},
    "message": "成功或异常消息",
    "status": "fail"
}

响应参数:

参数名称 参数说明 类型 schema
code 成功或异常编码 integer(int32) integer(int32)
data 成功或异常数据 UserInfoVO UserInfoVO
message 成功或异常消息 string
status 旧接口成功、失败或异常辅助判断标记:success、fail、error,可用值:success,fail,error string
Schema 属性:

UserInfoVO

参数名称 参数说明 类型 schema
userId 用户id integer(int64)
account 登录账户 string
avatar 用户头像:图片路径或图标样式 string
email 电子邮箱 string
gender 性别:(1:男,2:女) integer(int32)
nickname 用户别名(昵称) string
phone 手机号码 string
orgList 所属组织机构 id/code/name array UserOrgVO

UserOrgVO

参数名称 参数说明 类型 schema
orgId 角色授权机构ID integer(int64)
orgCode 所属机构代码 string
orgName 所属机构名称 string
roleList 用户在该组织机构下的角色 id/code/name array UserOrgRoleVO

UserOrgRoleVO

参数名称 参数说明 类型 schema
roleId 角色ID integer(int64)
roleCode 角色编码 string
roleName 角色名称 string

调用示例:

NodeJs - Axios:

var axios = require('axios');

var config = {
  method: 'get',
  url: 'https://api_server_url/user/info?accessToken=AT-4-Q8z-8PhSfm4RYp10WUcpuWSXbjpUIRtW&userId=1',
  headers: {
    'X-App-Id': '1'
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

Java - OkHttp 示例:

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
Request request = new Request.Builder()
  .url("https://api_server_url/user/info?accessToken=AT-4-Q8z-8PhSfm4RYp10WUcpuWSXbjpUIRtW&userId=1")
  .method("GET", null)
  .addHeader("X-App-Id", "1")
  .build();
Response response = client.newCall(request).execute();
作者:杭州天音  创建时间:2022-09-09 01:53
最后编辑:杭州天音  更新时间:2025-08-22 15:44