查询指定用户信息
GET /v1/api/user/info?userIds={userIds}
指定用户ID查询用户信息。
Name |
Required |
Type |
Description |
x-api-tenantId |
yes |
string |
租户编号 |
x-api-token |
yes |
string |
认证token |
x-language |
no |
string |
语言,zh-CN、en-US |
Request Parameters
Name |
Required |
Type |
Description |
userIds |
yes |
List |
用户ID,支持多个,用逗号分隔 |
Response
Name |
Type |
Description |
result |
boolean |
成功标识,返回true,表示请求成功,false表示请求失败 |
mcode |
string |
错误码,成功时返回m00000,失败时返回对应的错误码,见文档默认错误码说明 |
data |
object |
报表数据 |
errorMessage |
string |
错误提示信息,部分错误码时有值 |
1、data数据类型
Name |
Type |
Description |
id |
long |
用户ID |
email |
string |
邮箱 |
roleId |
integer |
用户角色ID |
levelId |
integer |
用户层级ID |
parentId |
integer |
上级用户ID |
entityNo |
number |
用户编码 |
name |
number |
用户名 |
address |
string |
地址 |
phone |
Phone |
电话 |
country |
string |
国家ID |
province |
string |
省份ID |
city |
string |
城市ID |
comment |
string |
评论 |
serverId |
integer |
账户服务器ID |
login |
integer |
账户ID |
Example
请求示例
GET /v1/api/user/info?userIds=71
返回示例:成功
{
"data": [
{
"address": "",
"city": "",
"comment": "",
"country": "",
"email": "[email protected]",
"entityNo": "SO8T",
"id": 71,
"levelId": 6,
"name": "A1",
"parentId": 4,
"password": "",
"phone": {
"countryCode": "",
"phone": ""
},
"province": "",
"roleId": 2,
"sendEmail": false
}
],
"mcode": "m0000000",
"result": true
}
返回示例:失败
{
"mcode": "PUB_AUTH_0000007",
"result": false
}
2. Error 错误处理
错误码表(Error Code)
mcode |
MessageBW_API_ |
BW_API_0000001 |
token为空 |
BW_API_0000003 |
无效租户ID |
BW_API_0000004 |
未开通OPENAPI权限 |
-1 |
服务异常,请稍后再试 |