编辑课程
编辑课程,需要提供 SID,safekey,timeStamp,课程 ID,新的文件夹 ID,新的课程名称,过期时间,班主任账号,是否加入教师列表,课程封面图片,课程简介,教室设置 ID(主要用来设置教室皮肤等其他选项),禁言,班主任 UID,allowAddFriend;其中 SID,safekey,timeStamp,courseId 是必填项,其他参数需要修改那个就传递那个。返回执行后的说明。
注:编辑课程资源后,所有未开课的课节资源都会修改为编辑后的课程资源。
URL
https://root_url/partner/api/course.api.php?action=editCourse
HTTP Request Methods
- POST
编码格式
- UTF-8
请求参数
key | 必填 | 更多限制 | 说明 | 规则说明 |
---|---|---|---|---|
SID | 是 | 无 | 机构认证 ID | 通过 sdk管理后台 申请机构认证可获得 |
safeKey | 是 | 固定 32 位全小写字符 | 机构认证安全密钥 | safeKey=MD5(SECRET+timeStamp) |
timeStamp | 是 | 无 | 当前调用接口20分钟以内的 Unix Epoch 时间戳 | Unix Epoch 时间戳是 1970年1月1日 00:00:00 (世界标准时间) 起经过的秒数 |
courseId | 是 | 无 | 课程 ID | 无 |
folderId | 否 | 无 | 新的资源文件夹 ID | 无 |
courseName | 否 | 1-40位字符,不区分中英文,超过40个字符会自动截取为40个 | 新的课程名称 | 无 |
expiryTime | 否 | 过期时间传空,不修改;传0,修改成永不过期;传非0的时间戳,则修有效期为传过来的时间;如果设置有效期,则有效期只能传当前时间1年之内的时间戳 | 过期时间 | Unix Epoch 时间戳(秒单位) |
mainTeacherUid | 否 | 无 | 班主任 UID | 注册用户接口返回的用户 UID |
stamp | 否 | 1加入,2不加入,默认为1 | 原班主任是否加入教师列表 | 无 |
Filedata | 否 | 二进制流 | 上传的课程封面图片 | 无 |
courseIntroduce | 否 | 0-400个字符,超过400会自动截取为400字 | 课程简介 | 无 |
classroomSettingId | 否 | 不传默认为0 | 教室设置 ID | 教室设置 ID 查找方式:登录到 sdk管理后台,找到机构设置,教室设置,每套教室设置上会显示教室设置 ID;选择此套设置后,该课程下所有教室内会依照此设置展示。 教室设置包含:A. 教室皮肤,B. 开关设置(头像下方工具栏、聊天窗口、学生端花名册,课后评价,教室工具箱,云盘等),C. 参数设置(录课倒计时,教室聊天时间间隔等) |
allowAddFriend | 否 | tinyint,最大长度1 | 无 | 是否允许班级成员在群里互相添加好友,0=不允许,1=允许,传非0或1报参数错误,不传则不设置 |
响应参数
key | 类型 | 示例值 | 含义 |
---|---|---|---|
error_info | object | 返回信息对象 | |
└ errno | number | 1 | 错误代码 |
└ error | string | "程序正常执行" | 错误详情 |
示例
- HTTP 请求
POST /partner/api/course.api.php?action=editCourse HTTP/1.1
Host: www.classin-sdk.com
Content-Type: application/x-www-form-urlencoded
Cache-Control: no-cache
SID=2339736&safeKey=f834fff59eb3bc8a2ff26a3cb59155f0&timeStamp=1492792399&courseId=352861&folderId=22419&courseName=Today+is+a+good+day&expiryTime=&mainTeacherUid=1001001&Filedata=@~/photo.jpg&courseIntroduce=ClassIn,真正专业的在线教室&classroomSettingId=235
- Shell cURL 模拟请求指令
curl -H "Content-Type: application/x-www-form-urlencoded" -X "POST" \
-d "SID=1234567" \
-d "safeKey=0f7781b3033527a8cc2b1abbf45a5fd2" \
-d "timeStamp=1484719085" \
-d "courseId=352861" \
-d "folderId=22419" \
-d "courseName=Today is a good day" \
-d "expiryTime=1484811085" \
-d "mainTeacherUid=1001001" \
-d "stamp=2" \
-d "Filedata=@~/photo.jpg" \
-d "courseIntroduce=ClassIn,真正专业的在线教室" \
-d "classroomSettingId=235" \
"https://root_url/partner/api/course.api.php?action=editCourse"
响应示例(正常时返回的 json
数据包示例)
{
"error_info": {
"errno": 1,
"error": "程序正常执行"
}
}
错误码说明
错误码 | 说明 |
---|---|
1 | 表示成功执行 |
100 | 表示参数不全或错误 |
102 | 表示无权限(安全验证没通过) |
103 | 表示图片放入服务器失败 |
104 | 表示操作失败(未知错误) |
114 | 表示服务器异常 |
139 | 表示该课程有正在上课的课节(不能编辑课程信息) |
144 | 表示机构下无此课程 |
147 | 表示无此课程信息 |
149 | 表示该课程已删除 |
151 | 表示过期时间至少要1天以后 |
152 | 过期时间不能小于最后一节课的结束时间 |
153 | 表示课程已过期 |
154 | 表示过期时间只能是1年以内的时间 |
160 | 表示机构下无此云盘目录 |
260 | 表示添加班主任失败 |
310 | 表示新班主任不存在 |
311 | 表示课程下的学生不能添加为班主任 |
312 | 表示课程下的旁听不能添加为班主任 |
314 | 表示原班主任有未上完的课节,不能更换 |
331 | 表示班主任账号格式不正确 |
334 | 表示班主任不是本机构的老师 |
369 | 该课程/课节类型暂不支持该操作 |
371 | 表示教室设置不存在 |
373 | 表示教室设置不属于本机构 |
389 | 表示班主任已被停用 |
400 | 表示请求数据不合法 |
805 | 表示班主任被停用中 |