查询组织机构下的终端 学员 员工。
默认接口请求频率限制:20次/秒。
REST URL
GET https://sdkapi.xylink.com/api/rest/external/{version}/edu/adapter/memberList?enterprise=分配的企业id
请求参数说明
参数 | 参数类型 | 参数位置 | 必须 | 默认值 | 说明 |
version | String | Path | 是 | 无 | v1 |
enterpriseId | String | Query | 是 | 无 | 企业ID,通过管理平台-云视讯API获得 |
departmentId | 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",//设备型号
"deviceId":4009180,//设备id,用于获取设备状态
"deviceSn":"7D201022601883",//设备sn
"callUri":"4009180@HARD"//callUri
}
]
}
返回参数说明
参数名称 | 说明 |
total | 总人数 |
pageIndex | 页码 |
pageSize | 查询数量 |
studentTotal | 机构下学员总人数 |
deviceTotal | 机构下设备总数量 |
teacherTotal | 机构下员工总人数 |
memberList | 成员列表 |
id | 设备id |
name | 设备名称 |
number | 设备number号码 |
deviceType | 设备类型 |
deviceCategory | 设备型号 |
deviceId | 设备id,用于获取设备状态 |
deviceSn | 设备sn |
callUri | callUri |