查询学员信息

功能说明

查询学员信息。

默认接口请求频率限制：20次/秒。

实现方法

REST URL

GET https://sdkapi.xylink.com/api/rest/external/{version}/edu/adapter/student/get?id=学员id&enterpriseId=分配的企业id

请求参数说明

参数	参数类型	参数位置	必须	默认值	说明
version	String	Path	是	无	v1
enterpriseId	String	Query	是	无	企业ID，通过管理平台-云视讯API获得
id	long	Query	是	无	学员ID

示例代码

返回结果示例：

成功时返回结果数据，失败时返回小鱼RESTAPI错误码

{
    "id": "473819938063122432",//学员主键id
    "name": "test",//学员名称
    "idNo": "15202848796",//手机号
    "frontPicture": "http://testqacdn.xylink.com/page/edumanmage/images/user/edu-manage-688efcb2-055f-4e15-86e4-ace8612676f4-1596167474372.png",//正视照片地址
    "leftPicture": "",//左视照片地址
    "rightPicture": "",右视照片地址
    "holdUpPicture": "",俯视照片地址
    "holdDownPicture": "",仰视照片地址
    "classIds": [100000096],//班级id
    "classNames": "testqa教育演示",//班级名称
    "account": "account234",//账号
    "studentPicture": null,//学员头像地址
}

返回参数说明

参数名称	说明
id	学员主键id
name	学员名称
idNo	手机号
frontPicture	正视照片地址
leftPicture	左视照片地址
rightPicture	右视照片地址
holdUpPicture	俯视照片地址
holdDownPicture	仰视照片地址
classIds	班级id
classNames	班级名称
account	账号
studentPicture	学员头像地址

2023-04-24 15:55:20

导出PDF文档