查询学员列表

功能说明

查询学员列表。

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

实现方法

REST URL

GET https://sdkapi.xylink.com/api/rest/external/{version}/edu/adapter/student/list?pageSize=10
&pageIndex=1&enterpriseId=分配的企业id

请求参数说明

参数	参数类型	参数位置	必须	默认值	说明
version	String	Path	是	无	v1
enterpriseId	String	Query	是	无	企业ID，通过管理平台-云视讯API获得
pageSize	int	Query	是	无	每页数量
pageIndex	int	Query	是	无	页码（从1开始）
search	String	Query	是	无	搜索（账号）

示例代码

返回结果示例：

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

{
    "total": 2,//总条数
    "pageSize": 10,//每页条数
    "pageIndex": 1,//页码
    "list": [{
      "id": "473819938063122432",//主键
      "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,//头像地址
      "classNames": "testqa教育演示"//班级名称
    }]
}

返回参数说明

参数名称	说明
total	总人数
pageIndex	页码
pageSize	查询数量
list	学员列表
id	主键
name	姓名
idNo	手机号
frontPicture	正片地址
leftPicture	左视照片地址
rightPicture	右视照片地址
holdUpPicture	俯视照片地址
holdDownPicture	仰视照片地址
account	登录账号
studentPicture	头像地址
classNames	班级名称

2023-04-24 15:54:28

导出PDF文档