Để tạo một Khóa học (Course), bạn cần truyền các tham số như SID, safeKey, timeStamp, tên khóa học, ID thư mục, ảnh bìa khóa học, thời gian hết hạn, mô tả khóa học, ID cài đặt lớp học (chủ yếu dùng để thiết lập giao diện lớp học và các tùy chọn khác), ID khóa học, UID giáo viên chủ nhiệm, v.v. Các tham số SID, safeKey, timeStamp và tên khóa học là bắt buộc. Lệnh gọi sẽ trả về ID khóa học và hướng dẫn để bạn tham khảo. Nếu bạn truyền ID của khóa học, hệ thống sẽ kiểm tra xem ID đó đã tồn tại chưa. Nếu có, nó sẽ trả về ID khóa học đã được tạo trước đó; nếu không, một khóa học mới sẽ được tạo.
Khi bạn tạo một khóa học mới, khung chat của khóa học sẽ tự động được tạo trong app ClassIn. Biệt danh của người dùng sẽ được đặt làm biệt danh trong nhóm khóa học theo mặc định. Nếu bạn muốn đồng bộ tên người dùng trong Trang quản lý Trường với giao diện khóa học trên app, vui lòng gọi API Modify group member nickname để thay đổi.
Ghi chú:
- Bạn có thể thiết lập một Giáo viên chủ nhiệm (Headteacher) trong Trang quản lý Trường khi tạo Khóa học. Giáo viên chủ nhiệm có thể chỉnh sửa khóa học ngay tại app ClassIn như tạo/chỉnh sửa/xóa các lớp học và học sinh của khóa học. Các thao tác được thực hiện bởi giáo viên chủ nhiệm trên app ClassIn sẽ gây bất đồng bộ với hệ thống dữ liệu của bạn. Ví dụ, giáo viên chủ nhiệm tạo một lớp học mới trên app ClassIn thì dữ liệu của lớp mới thêm sẽ không được đồng bộ với hệ thống của bạn.
- Nếu bạn truyền giá trị trống cho tham số mainTeacherUid, điều này có nghĩa là bạn không truyền giá trị cho trường thông tin giáo viên chủ nhiệm, vì vậy hệ thống sẽ không thiết lập giáo viên chủ nhiệm cho khóa học.
To create a course, you need to pass the parameter of SID, safeKey, timeStamp, course name, folder ID, course cover picture (binary stream), expiration time, course description, classroom setting ID (mainly used to set classroom skin and other options), a course unique ID, headteacher UID, etc. SID, safeKey, timeStamp, and the course name are required. The call returns the course ID and instructions for you to refer to. If you pass the course unique ID, the interface will verify whether the unique ID already exists. If so, it returns the course ID previously created; if not, a new course will be created.
When you create a new course, an IM chat will be created in the ClassIn app automatically. The user’s nickname is set as his/her course nickname in the course group chat by default. If you want to synchronize the user name in the School Dashboard to the IM grout chat, please call Modify group member nickname to edit.
Notes:
- You can set a headteacher, also named Course Advisor/Main Teacher in the School Dashboard, when creating the course. The headteacher can edit the course in the ClassIn app, such as create/edit/delete lessons and course students in the IM group. The operation in the ClassIn app by headteachers will not be synchronized to your school’s system. For example, the headteacher created a new lesson in the IM group. The data of the newly added lesson will not be synchronized to your system.
- If you pass an empty value in the parameter of mainTeacherUid, it means you did not pass a value for the headteacher, then you did not set a headteacher for the course.
URL
https://api.eeo.cn/partner/api/course.api.php?action=addCourse
HTTP Request Methods
- POST
Coding format
- UTF-8
Request data
| Key | Bắt buộc | Yêu cầu thêm | Mô tả | Hướng dẫn |
|---|---|---|---|---|
| SID | Bắt buộc | — | ID của trường | Xem dữ liệu này tại Trang quản lý classin.com trong mục API |
| safeKey | Bắt buộc | Fixed 32-bit all lowercase characters | Khóa bảo mật xác thực trường học | safeKey=MD5(SECRET+timeStamp) |
| timeStamp | Bắt buộc | — | Theo Unix Epoch timestamp & có hiệu lực trong vòng 20 phút | Thời gian UNIX Epoch là số giây đã trôi qua kể từ 00:00:00 (giờ chuẩn quốc tế) vào ngày 1 tháng 1 năm 1970 |
| courseName | Bắt buộc | — | Tên của khóa học | — |
| folderId | Không bắt buộc | Nếu không truyền tham số này thì đồng nghĩa là không có folder nào được cấp quyền cho khóa học | ID của folder được cấp quyền truy cập cho Khóa học | — |
| Filedata | Không bắt buộc | Binary stream | Ảnh bìa của khóa học, hiển thị trên app | — |
| expiryTime | Không bắt buộc | Nếu không truyền tham số này, dữ liệu được truyền là 0 hoặc bỏ trống thì hệ thống sẽ hiểu chung là 0 và thời gian kết thúc khóa học sẽ được thiết lập thành không kết thúc. Nếu có dữ liệu thời hạn kết thúc thì thời hạn này không được vượt quá 1 năm tính từ thời điểm hiện tại | Thời hạn kết thúc khóa học | Thời gian hết hạn sẽ được gia hạn thêm 3 tháng khi một lớp học mới được tạo và thời gian hết hạn hiện tại là trong vòng 3 tháng |
| courseIntroduce | Không bắt buộc | Phần giới thiệu/ mô tả khóa học có thể để trống, độ dài của phần này cho phép tối đa 400 ký tự | — | — |
| classroomSettingId | Không bắt buộc | Mặc định là 0 | ID cài đặt lớp học | Tại giao diện Trang quản lý của ClassIn classin.com, trong phần Cài đặt — > Cài đặt lớp học, bạn sẽ thấy các bộ Cài đặt lớp học đã được thiết lập sẵn kèm với ID. Bộ “Cài đặt lớp học” được chọn sẽ áp dụng cho tất cả các lớp thuộc khóa học. “Cài đặt lớp học” bao gồm: nền lớp học, bật/tắt các tính năng trong lớp học (Drive, Danh sách lớp, Valy công cụ,…), các thiết lập lớp học (đếm ngược thời gian ghi hình tự động, bật/tắt phần chat lớp,…) |
| courseUniqueIdentity | Không bắt buộc | Ví dụ: 45s8d5a6asaa1ssf (1-32 bit characters, non-conforming value interface will return 100 errors) | Mã định danh | Trường có thể truyền mã định danh, và khi giá trị này được truyền vào, chúng tôi sẽ xác minh rằng nó có tồn tại trong khóa học đã được tạo hay không. |
| mainTeacherUid | Không bắt buộc | Nếu tham số này không được truyền hoặc để trống thì đồng nghĩa với việc Khóa học không có GVCN | UID của GVCN | UID hệ thống trả về khi đăng ký tài khoản thành công |
| subjectId | Không bắt buộc | Nếu tham số này không được truyền hoặc để trống thì hệ thống sẽ hiểu là 0 | course subject | 1: Chinese; 2: Math; 3: English; 4: Physic; 5: Chemistry; 6: Biology; 7: Politics; 8: History; 9: Geography; 10: Ideological and Moral Education; 11: Music; 12: PE; 13: Arts; 14: General Technology; 15: IT; 16: Science; 99: Others |
| allowAddFriend | Không bắt buộc | tinyint，Maximum length 1 | — | Thiết lập cho phép các thành viên trong khóa học kết bạn với nhau, 0=không cho phép, 1=cho phép. Báo lỗi sẽ trả về nếu như tham số được truyền không phải 0 hay 1 Nếu tham số không được truyền, hệ thống sẽ dùng thiết lập mặc định tại Trang quản lý classin.com Cài đặt –> Cài đặt lớp học (Mặc định cho phép thành viên của khóa học kết bạn với nhau) |
| allowStudentModifyNickname | Không bắt buộc | tinyint，maximum length 1 | — | Thiết lập cho phép học sinh điều chỉnh Biệt danh hiển thị trong khóa học, 0=không cho phép, 1=cho phép. Báo lỗi sẽ trả về nếu như tham số được truyền không phải 0 hay 1 Nếu tham số không được truyền, hệ thống sẽ mặc định thiết lập là 0 |
Response data
| Key | Định dạng | Phản hồi | Ý nghĩa |
|---|---|---|---|
| data | number | 352861 | Create success returned course ID |
| error_info | object | Return message object | |
| └ errno | number | 1 | Mã lỗi |
| └ error | string | “Program normal execution” | Thông tin lỗi |
Sample
- HTTP request
POST /partner/api/course.api.php?action=addCourse HTTP/1.1
Host: www.eeo.cn
Content-Type: application/x-www-form-urlencoded
Cache-Control: no-cache
SID=2339736&safeKey=f834fff59eb3bc8a2ff26a3cb59155f0&timeStamp=1492792399&courseName=Good+Day&folderId=22419&Filedata=@~/photo.jpg&expiryTime=1492795000&mainTeacherUid=1001001&courseIntroduce=ClassIn，真正专业的在线教室&classroomSettingId=235&courseUniqueIdentity=532512
- Shell cURL analog request instruction
curl -X "POST" \
-d "SID=1234567" \
-d "safeKey=0f7781b3033527a8cc2b1abbf45a5fd2" \
-d "timeStamp=1484719085" \
-d "courseName=Good Day" \
-d "folderId=22419" \
-d "Filedata=@~/photo.jpg" \
-d "expiryTime=1523428688" \
-d "mainTeacherUid=1001001" \
-d "courseIntroduce=ClassIn，真正专业的在线教室" \
-d "classroomSettingId=235" \
-d "courseUniqueIdentity=24545" \
"https://api.eeo.cn/partner/api/course.api.php?action=addCourse"
Response sample（The normal return json packet example）
{
"data": 352861,
"error_info": {
"errno": 1,
"error": "程序正常执行"
}
}
Error Code Description
| Error code | Description |
|---|---|
| 1 | Thành công |
| 100 | Parameters sai định dạng hoặc không hoàn chỉnh |
| 102 | Không có quyền thao tác (Xác thực bảo mật thất bại) |
| 103 | Tải lên hình ảnh thất bại |
| 104 | Thao tác thất bại |
| 114 | Lỗi server |
| 151 | Thời gian kết thúc khóa học tối thiểu là 1 ngày sau |
| 154 | Thời gian kết thúc khóa học tối đa là 1 năm |
| 160 | Không có tệp/thư mục này trong Drive trường |
| 260 | Thêm GVCN không thành công |
| 331 | Định dạng tài khoản của GVCN không hợp lệ |
| 334 | GVCN không tồn tại |
| 371 | “Cài đặt lớp học” không tồn tại |
| 373 | “Cài đặt lớp học” không thuộc trường này |
| 389 | GVCN này đã bị vô hiệu hóa |
| 398 | Dữ liệu courseUniqueIdentity đã tồn tại |
| 400 | Dữ liệu yêu cầu không hợp lệ |
| 460 | Khóa học (course) hoặc lớp học (lesson) đang được tạo bởi một lệnh khác với cùng courseUniqueIdentity |
| 805 | Tài khoản của GVCN này đã bị cấm |
| 883 | GVCN này đã xóa tài khoản |
