查询账号列表3.7.1.SP6+

只允许获取非归档状态下的用户属性

接口说明

请求URL：http[s]://{网关地址}/minos-platform/user/getUserList

请求方式： POST

请求内容类型： application/json

响应内容类型： application/json

请求说明

请求体

字段名	参数名	是否必填	类型	描述
手机号	phone	*M	String	手机号，如果需要国际手机号请使用+86-153xxxx7182的格式
邮箱	email	*M	String	邮箱
证件号码	identityCode	*M	String	证件号码
证件类型代码	identifyTypeId	*M	String	当使用证件号码查询时有用 0： 居民身份证（默认） 1： 护照 2： 港澳台居民身份证 4：旅行证据 5：其他

提示

请求体中的入参手机号、邮箱、证件号码至少填写一个

请求示例

{
    "phone":"153xxxx7182",
    "email":"",
    "identityCode":""
}

响应说明

响应体

参数名	类型	描述
errcode	String	返回码
errmsg	String	返回描述
data	List<UserInfo>	返回数据

UserInfo

字段名	参数名	类型	描述
用户WID	wid	String	系统内部用户编码
自然人ID	personWid	String	自然人编码
用户名/学工号	userId	String	用户名/学工号，最大20个字符
其他关联账号3.8.2.Beta3+	otherUserId	String	其他关联用户名/学工号，多个以;隔离
姓名	userName	String	用户姓名，最大200个字符
性别	sexCode	String	0 男 1 女
身份分类代码	categoryCode	String	身份分类代码
身份分类名称	categoryName	String	身份分类名称
校内机构代码	originalOrgCode	String	校内机构的code，多个以;隔离
校内机构名称	originalOrg	String	校内机构名称，多个以;隔离
虚拟组织代码3.8.2.Beta3+	virtualOrgCode	String	虚拟组织的code，多个以;隔离
虚拟组织名称3.8.2.Beta3+	virtualOrgName	String	虚拟组织的名称，多个以;隔离
组织机构代码3.8.2.Beta3.SP2+	orgCode	String	组织机构的code，多个以;隔离
组织机构名称3.8.2.Beta3.SP2+	orgName	String	组织机构的名称，多个以;隔离
证件类型代码	identifyTypeId	String	0： 居民身份证 1： 护照 2： 港澳台居民身份证 4：旅行证据 5：其他
证件号码	identityCode	String	证件号码
手机号	phone	String	手机号，如果需要国际手机号请使用+86153xxxx7182的格式
邮箱	email	String	邮箱
专业	speciality	String	专业
入校年份/当前所在级	enterSchoolDate	String	入校年份
离校时间	leaveSchTime	String	离校时间
录取通知书号	admissionLetter	String	录取通知书号
班级	className	String	班级名称
用户头像3.8.2.Beta3+	headImageIcon	String	用户头像oss地址
用户证件照3.8.2.Beta3+	userIcon	String	用户证件照oss地址
生命周期状态	lifeCycle	String	生命周期 0：未入校 1：入校 2：离校
生命周期到期时间	lifeCycleExpire	String	生命周期到期时间，格式yyyy-MM-dd
激活状态	activeStatus	String	激活状态 0未激活 1正常
账号状态	accountStatus	String	账号状态 1正常 2冻结 4禁用

响应示例

{
    "errcode": "0",
    "errmsg": "success",
    "data": [{
        "wid": "945377503336701952",
        "personWid": "2230001Q",
        "userId": "xtWang",
        "userName": "xt",
        "categoryCode": "923968080198475776",
        "categoryName":"教师",
        "sexCode": null,
        "identifyTypeId": "0",
        "identityCode": "1",
        "phone": "86-12213456123",
        "email": null,
        "speciality": null,
        "enterSchoolDate": null,
        "leaveSchTime": null,
        "admissionLetter": null,
        "className": null,
        "headImageIcon": null,
        "userIcon": null,
        "originalOrg": "1002机构/123123;教师/机构3",
        "originalOrgCode": "232;jg003",
        "virtualOrgCode":"",
        "virtualOrgName":"",
        "orgCode":"",
        "orgName":"",
        "lifeCycle": "1",
        "lifeCycleExpire": "2021-11-14",
        "activeStatus": "1",
        "accountStatus": "1",
        "otherUserId": "01119253",
        "categoryName": "教务01/教务01001"
    }]
}

错误码

错误码	描述
111001	必填参数不能为空
111005	归档用户不可查询
116005	账号不存在

Demo

java

// 创建客户端
Client client = new DefaultClient(BASE_URL, APP_ID, APP_SECRET);
// 创建请求对象
GetUserListRequest request = new GetUserListRequest();
request.setPhone("43214321432");

BaseResponse response = client.execute(request);
//调用成功，则处理业务逻辑
if (response.isSuccess()) {
	//.....
}