主题
新建用户
- 本接口一次只允许添加一个账户
- 即便注册的接口中包含用户的密码,用户第一次登陆时,都需要重新输入密码
- 新增的账户如果满足合并自然人的规则,则系统会自动将账户合并到对应的自然人体系下
- 如果账户已经存在,不允许添加
- 如果新增的账户合并自然人属性计算出不是同一个自然人,不允许添加
接口说明
请求URL:http[s]://{网关地址}/minos-platform/user/add
请求方式: POST
请求内容类型: application/json
响应内容类型: application/json
请求说明
请求体
| 字段名 | 参数名 | 必填 | 类型 | 描述 |
|---|---|---|---|---|
| 用户名/学工号 | userId | M | String(20) | 用户名/学工号,最大20个字符 |
| 姓名 | userName | M | String(200) | 用户姓名,最大200个字符 |
| 身份分类代码 | categoryCode | M | String | 身份分类代码 |
| 校内机构代码3.7.4.SP8+ | originalOrgCode | O | String(1000) | 校内机构code,多个机构中间用英文分号分割,最多10个 |
| 性别 | sexCode | O | String | 0 男 1 女 |
| 证件类型代码 | identifyTypeId | O | String | 0: 居民身份证 1: 护照 2: 港澳台居民身份证 4:旅行证据 5:其他 |
| 证件号码 | identityCode | O | String | 证件号码 |
| 手机号 | phone | O | String | 手机号,如果需要国际手机号请使用+86153xxxx7182的格式 |
| 邮箱 | O | String | 邮箱 | |
| 专业 | speciality | O | String | 专业 |
| 入校年份/当前所在级 | enterSchoolDate | O | String | 入校年份 |
| 离校时间 | leaveSchTime | O | String | 离校时间 |
| 录取通知书号 | admissionLetter | O | String | 录取通知书号 |
| 班级 | className | O | String | 班级名称 |
| 是否立即激活 | activateNow | O | String | 是否立即激活 1: 是 0 :否(默认) |
| 初始密码 | initPwd | O | String | 初始用户密码 |
| 账号状态3.5.4.beta3+ | accountStatus | O | String | 1:正常 (默认) 4:禁用 |
| 生命周期3.5.4.beta3+ | lifeCycle | O | String | 0:未入校 1:入校 2:离校 |
| 是否需要用户重置密码 | needPwdUserReset | O | String | 0:否 1:是 (默认) |
提示
- 在3.5.4.beta3版本添加账号状态,生命周期字段;如果生命周期字段有值,账号的生命周期将跟账号状态无关。
- 从3.6.1.SP6版本开始,60秒内创建同一个账号接口只能调用一次
请求示例
json
{
"userId":"newUserWxt1",
"userName":"newUserWxt",
"categoryCode":"20000",
"originalOrgCode":"232",
"sexCode":"0",
"identifyTypeId":"0",
"identityCode":"4324x",
"phone":"43214321432",
"email":"43214321432@qwq.com",
"speciality":"speciality",
"enterSchoolDate":"2022",
"leaveSchTime":"2022-07-07",
"admissionLetter":"rewrw2312erwer",
"className":"ewrwer3545",
"activateNow":"1",
"needPwdUserReset":"0"
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
响应说明
响应体
| 参数名 | 类型 | 描述 |
|---|---|---|
| errcode | String | 返回码 |
| errmsg | String | 返回描述 |
| data | UserInfo | 返回数据 |
| 字段名 | 参数名 | 类型 | 描述 |
|---|---|---|---|
| 用户WID | wid | String | 系统内部用户编码 |
| 自然人ID | personWid | String | 自然人编码 |
| 用户名/学工号 | userId | String | 用户名/学工号,最大20个字符 |
| 姓名 | userName | String | 用户姓名,最大200个字符 |
| 身份分类代码 | categoryCode | String | 身份分类代码 |
| 性别 | sexCode | String | 0 男 1 女 |
| 证件类型代码 | identifyTypeId | String | 0: 居民身份证 1: 护照 2: 港澳台居民身份证 4:旅行证据 5:其他 |
| 证件号码 | identityCode | String | 证件号码 |
| 手机号 | phone | String | 手机号,如果需要国际手机号请使用+86153xxxx7182的格式 |
| 邮箱 | String | 邮箱 | |
| 专业 | speciality | String | 专业 |
| 入校年份/当前所在级 | enterSchoolDate | String | 入校年份 |
| 离校时间 | leaveSchTime | String | 离校时间 |
| 录取通知书号 | admissionLetter | String | 录取通知书号 |
| 班级 | className | String | 班级名称 |
| 校内机构代码 | originalOrgCode | String | 校内机构代码 |
| 校内机构名称 | originalOrg | String | 校内机构名称 |
响应示例
json
{
"errcode": "0",
"errmsg": "success",
"data": {
"wid": "999318026786930688",
"personWid": "2270001T",
"userId": "newUserWxt1",
"userName": "newUserWxt",
"categoryCode": "20000",
"sexCode": "0",
"identifyTypeId": "0",
"identityCode": "4324x",
"phone": "43214321432",
"email": "43214321432@qwq.com",
"speciality": "speciality",
"enterSchoolDate": "2022",
"leaveSchTime": "2022-07-07",
"admissionLetter": "rewrw2312erwer",
"className": "ewrwer3545",
"headImageIcon": null,
"userIcon": null,
"originalOrg": "1002机构/123123",
"originalOrgCode": "232"
}
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
错误码
| 错误码 | 描述 |
|---|---|
| 111001 | 必填参数不能为空 |
| 111002 | 请求参数格式错误 |
| 111003 | 请求参数长度超出范围 |
| 111004 | 账户正在创建,无法重复创建 |
| 115005 | 入校年份只能到年 |
| 115006 | 离校日期具体到天 |
| 115007 | categoryCode不符合格式要求 |
| 115011 | originalOrgCode不存在 |
Demo
java
// 创建客户端
Client client = new DefaultClient(BASE_URL, APP_ID, APP_SECRET);
// 创建请求对象
UserAddRequest request = new UserAddRequest();
request.setUserId("campususertest001");
request.setUserName("campususertest001");
request.setCategoryCode("1000001");
request.setOriginalOrgCode("24830");
request.setSexCode("0");
request.setIdentifyTypeId("0");
request.setIdentityCode("320106201201313572");
request.setPhone("13987654321");
request.setEmail("campususertest001@wisedu.com");
request.setSpeciality("计算机");
request.setEnterSchoolDate("2022");
request.setLeaveSchTime("2022-07-07");
request.setAdmissionLetter("rewrw2312erwer");
request.setClassName("1班");
request.setActivateNow("1");
// request.setInitPwd();
request.setAccountStatus("1");
request.setLifeCycle("0");
request.setNeedPwdUserReset("0");
BaseResponse response = client.execute(request);
//调用成功,则处理业务逻辑
if (response.isSuccess()) {
//.....
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

