添加学员。
默认接口请求频率限制:20次/秒。
REST URL
POST https://sdkapi.xylink.com/api/rest/external/{version}/edu/adapter/student?enterpriseId=分配的企业id
请求参数说明
参数 | 参数类型 | 参数位置 | 必须 | 默认值 | 说明 |
version | String | Path | 是 | 无 | v1 |
enterpriseId | String | Query | 是 | 无 | 企业ID,通过管理平台-云视讯API获得 |
name | String | Body | 是 | 无 | 学员姓名,支持汉字、字母、数字和下划线(长度要求20位以内) |
idNo | Sting | Body | 是 | 无 | 手机号 |
account | Sting | Body | 是 | 无 | 账号 |
classIds | 数组 | Body | 是 | 无 | 所属部门ID(数组类型) |
frontPicture | Sting | Body | 否 | 无 | 正视照片地址 |
leftPicture | Sting | Body | 否 | 无 | 左视照片地址 |
rightPicture | Sting | Body | 否 | 无 | 右视照片地址 |
holdDownPicture | Sting | Body | 否 | 无 | 俯视照片地址 |
holdUpPicture | Sting | Body | 否 | 无 | 正视照片地址 |
请求消息体示例(Json)
{
"name": "test",//姓名
"idNo": "15202848696",
"frontPicture": "http://testqacdn.xylink.com/page/edumanmage/images/user/edu-manage-688efcb2-055f-4e15-86e4-ace8612676f4-1596167474372.png",//
正视照片地址
"leftPicture": "",//左视照片地址
"rightPicture": "",右视照片地址
"holdUpPicture": "",俯视照片地址
"holdDownPicture": "",仰视照片地址
"account": "account234",//登录账号
"studentPicture": null,//头像地址
"classIds": [12342,23451]
}
返回结果示例:
成功时返回结果数据,失败时返回小鱼RESTAPI错误码
485141430675701760//学员ID