查询教师列表

功能说明

查询教师列表。

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

实现方法

REST URL

GET https://sdkapi.xylink.com/api/rest/external/{version}/edu/adapter/teacher/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": 618,//总数
    "pageSize": 10, //每页条数
    "pageIndex": 0,//页码
    "list": [{
      "id": "473817539227418624",//主键
      "teacherId": "119346038",//教师ID
      "name": "李四",//姓名
      "phone": "18380227711",//电话号码
      "countryCode": "+86",//区号
      "profilePicture": "",//头像地址
      "subjectName": null,//学科
      "roleName": "教师",//角色名称
      "departmentNames": "testqa教育演示,testqa教育演示/测试同级机构",//部门名称
      "schoolTypeName": null,//学段
    }]
}

返回参数说明

参数名称	说明
total	总人数
pageIndex	页码
pageSize	查询数量
studentTotal	机构下学生总人数
deviceTotal	机构下设备总数量
teacherTotal	机构下教师总人数
list	教师列表
id	主键
teacherId	教师ID
name	姓名
phone	电话号码
countryCode	区号
profilePicture	头像地址
subjectName	学科
roleName	角色名称
departmentNames	部门名称
schoolTypeName	学段

2023-03-20 14:43:39

导出PDF文档