查询组织机构下的终端 学生 教师。
默认接口请求频率限制:20次/秒。
REST URL
GET https://sdkapi.xylink.com/api/rest/external/{version}/edu/adapter/memberList?
departmentId=220023701&type=STUDENT&showSubMembers=true&pageSize=10&pageIndex=1&extId=分配的企业id
请求参数说明
参数 | 参数类型 | 参数位置 | 必须 | 默认值 | 说明 |
version | String | Path | 是 | 无 | v1 |
extId | String | Query | 是 | 无 | 企业ID,通过管理平台-云视讯API获得 |
deparmentId | long | Query | 是 | 无 | 机构id |
type | String | Query | 是 | 无 | 查询类型,TEACHER-教师, DEVICE-设备, STUDENT-学生 |
showSubMembers | boolean | Query | 是 | 无 | 是否显示下级成员,true-是 ,false-否 |
pageIndex | int | Query | 是 | 无 | 页码 |
pageSize | int | Query | 是 | 无 | 分页大小(不超过50) |
返回结果示例:
成功时返回结果数据,失败时返回小鱼RESTAPI错误码
1,type为TEACHER,返回
{
"total":10,//总人数
"pageIndex":1,//页码
"pageSize":10,//查询数量
"studentTotal":2,//机构下学生总人数
"deviceTotal":2,//机构下设备总数量
"teacherTotal":10,//机构下教师总人数
"memberList":[
{
"id":2202653,//id
"name":"张三",//教师姓名
"phone":"18800000000",//教师手机号
"subjectName":null,//教师主讲科目
"roleName":"平台管理员",//教师角色
"roleType":1,///教师角色type
"userId":222400196//教师用户id
}
]
}
返回参数说明
参数名称 | 说明 |
total | 总人数 |
pageIndex | 页码 |
pageSize | 查询数量 |
studentTotal | 机构下学生总人数 |
deviceTotal | 机构下设备总数量 |
teacherTotal | 机构下教师总人数 |
memberList | 成员列表 |
id | id |
name | 教师姓名 |
phone | 教师手机号 |
subjectName | 教师主讲科目 |
roleName | 教师角色 |
roleType | 教师角色type |
userId | 教师用户id |
2,type为STUDENT,返回
{
"total":10,//总人数
"pageIndex":1,//页码
"pageSize":10,//查询数量
"studentTotal":2,//机构下学生总人数
"deviceTotal":2,//机构下设备总数量
"teacherTotal":10,//机构下教师总人数
"memberList":[
{
"id":"452863173200969728",//id
"name":"学生1",//学生姓名
"idNo":"122222",//学生学号
"account":"q111111",//学生账号
"studentPhoto":{
"frontPicture":"",//学生正面照片
"leftPicture":"",//学生左面照片
"rightPicture":"",//学生右面照片
"holdUpPicture":"",//学生仰视照片
"holdDownPicture":""//学生俯视照片
},
"studentclassid":"468349585765433345"//学生班级id
}
]
}
返回参数说明
total | 总人数 |
pageIndex | 页码 |
pageSize | 查询数量 |
studentTotal | 机构下学生总人数 |
deviceTotal | 机构下设备总数量 |
teacherTotal | 机构下教师总人数 |
memberList | 成员列表 |
id | 学生id |
name | 学生姓名 |
idNo | 学生学号 |
account | 学生账号 |
studentPhoto | 学生 |
frontPicture | 学生正面照片 |
leftPicture | 学生左面照片 |
rightPicture | 学生右面照片 |
holdUpPicture | 学生仰视照片 |
holdDownPicture | 学生俯视照片 |
studentclassid | 学生班级id |
3,type为DEVICE,返回
{
"total":2,//总数量
"pageIndex":1,//页码
"pageSize":10,//查询数量
"studentTotal":2,//机构下学生总人数
"deviceTotal":2,//机构下设备总数量
"teacherTotal":10,//机构下教师总人数
"memberList":[
{
"id":220286347,//id
"name":"测试设备1",//设备名称
"number":"8140211",//设备number号码
"deviceType":"2",//设备类型
"deviceCategory":"NE60",//设备型号
"status":null,//状态,根据调用状态接口获取实时状态
"deviceId":4009180,//设备id,用于获取设备状态
"deviceSn":"7D201022601883",//设备sn
"callUri":"4009180@HARD"//callUri
}
]
}
返回参数说明
参数名称 | 说明 |
total | 总人数 |
pageIndex | 页码 |
pageSize | 查询数量 |
studentTotal | 机构下学生总人数 |
deviceTotal | 机构下设备总数量 |
teacherTotal | 机构下教师总人数 |
memberList | 成员列表 |
id | 设备id |
name | 设备名称 |
number | 设备number号码 |
deviceType | 设备类型 |
deviceCategory | 设备型号 |
status | 状态,根据调用状态接口获取实时状态 |
deviceId | 设备id,用于获取设备状态 |
deviceSn | 设备sn |
callUri | callUri |