添加用户
POST
/user/add修改时间: 1 个月前
通过该接口可以向伯索云学堂系统中添加老师或学生用户。添加成功后,使用返回的loginFullName可以正常登录伯索客户端,完成业务功能。
请求参数
Body 参数application/json
loginName
string
用户登录账号名称
password
string
用户登录账号密码
userRole
string
用户类型角色
目前支持老师/学生/助教(teacher/student/assistant)
userName
string
用户姓名
mobile
number
手机号
email
string
邮箱地址
grade
number
年级
常量值定义,见数据字典定义
sex
number
性别
常量值定义,见数据字典定义
school
string
所在学校信息
note
string
备注信息
serviceFlag
number
服务学生类型标识
1:服务学生 2:普通学生 不传默认服务学生
activeUntilTimestamp
number
学生账号过期时间
格式为13位时间戳;以北京时区为准,不可早于北京时间当天。
studentCustomFields
array [object {2}]
学生的自定义字段信息
当创建学生时,根据机构设置的学生自定义字段“管理选项”(必填、选填、关闭)进行校验
key
string
字段的键
自定义字段是具有“编辑”功能的字段,它们的key从上往下依次是"s0"、"s1"和"s2"等等
value
string
字段的值
1、如果字段类型是单选框,则填写对应value时需要满足单选框中的可选项;2、如果字段类型是文本类型,则填写的内容长度限定为0至256个字符
示例
{
"loginName": "add03_zy",
"password": "666666",
"userRole": "student",
"userName": "add03_zy",
"activeUntilTimestamp": 4865327999000,
"studentCustomFields": []
}
示例代码
返回响应
请求成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
msg
string
必需
param
string
可选
code
integer
必需
obj
object
可选
userId
string
伯索侧分配的用户ID(已确保不重复)
loginName
string
伯索侧分配的用户名
loginFullName
string
伯索侧分配的登录用户名
reqId
string
必需
reqTime
integer
必需
execTime
integer
必需
示例
成功示例
{
"msg": "remote call success",
"code": 0,
"obj": {
"userId": "302_1703183",
"loginName": "Lisa",
"loginFullName": "wLisa"
},
"reqId": "1699511314767_0.70503221230209",
"reqTime": 1699511314767,
"execTime": 98
}
修改于 1 个月前