添加用户 - 伯索开放平台

请求参数

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

string

字段的键

可选

当创建学生时，根据机构设置的可进行"编辑"操作的学生自定义字段“管理选项”（必填、选填、关闭）进行校验。对象数组字符串，如"[{"key": "s0","value": "写作"},{"key": "s1","value": "阅读"}]"，

示例值:

[{"s0":"小学"},{"s1":"一班"}]

示例

{
  "loginName": "add03_zy",
  "password": "666666",
  "userRole": "student",
  "userName": "add03_zy",
  "activeUntilTimestamp": 4865327999000,
  "studentCustomFields": "[{\"key\": \"s0\",\"value\": \"写作\"},{\"key\": \"s1\",\"value\": \"阅读\"}]"
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://www.plaso.cn/dataentry/user/add' \
--header 'Content-Type: application/json' \
--data-raw '{
    "loginName": "add03_zy",
    "password": "666666",
    "userRole": "student",
    "userName": "add03_zy",
    "activeUntilTimestamp":4865327999000,
    "studentCustomFields":"[{\"key\": \"s0\",\"value\": \"写作\"},{\"key\": \"s1\",\"value\": \"阅读\"}]"
}'

返回响应

🟢200请求成功

application/json

Body

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
}