描述
通过此接口查询用户当前的课堂前台工具配置情况。
接口地址
http://api-class.e.vhall.com/api/class/configure/get-userclass-tools
请求参数
公共参数需要每次请求都附带上,详细内容请参考公共参数
参数名 | 类型 | 必选 | 说明 |
---|---|---|---|
config_type | int | 是 | 1针对用户名下所有课堂进行设置 2针对单独课堂进行设置 |
class_id | string | 否 | 课堂ID(当config_type=2时 class_id必须传入) |
响应参数
返回数据如下:
参数名 | 类型 | 说明 |
---|---|---|
code | int | 响应状态码 200 代表成功 |
msg | string | 响应失败时的描述 |
global_config | object | 用户全局配置 |
class_config | object | 课堂配置 |
tool_doc | int | 课中工具文档是否显示 1显示 0隐藏 |
tool_whiteBoard | int | 课中工具白板是否显示 1显示 0隐藏 |
tool_sharingDesktop | int | 课中工具共享桌面是否显示 1显示 0隐藏 (默认显示) |
tool_answer | int | 课中工具答题是否显示 1显示 0隐藏 (默认显示) |
tool_upload_doc | int | 用户课中上传文档功能是否显示 1显示 0隐藏 (默认显示) |
tool_mediaplayer | int | 课中工具插播是否显示 1显示 0隐藏 (默认显示) |
当config_type=1时响应示例
{
"code": 200,
"msg": "",
"data": [
'global_config':{
'tool_doc':1,
'tool_whiteBoard':1,
'tool_sharingDesktop':1,
'tool_answer':1,
'tool_upload_doc':1,
'tool_mediaplayer':1,
}
]
}
当config_type=2时响应示例
{
"code": 200,
"msg": "",
"data": [
'class_config':{
'tool_doc':1,
'tool_whiteBoard':1,
'tool_sharingDesktop':1,
'tool_answer':1,
'tool_upload_doc':1,
'tool_mediaplayer':1
}
]
}
错误码
code | 含义 |
---|---|
10005 | 课程不存在 |