Để thêm học sinh/ người dự thính vào nhiều khóa học cùng một lúc, cần truyền các tham số SID, safekey, timeStamp, courseID, tham số xác định vai trò học sinh hay người dự thính (1=học sinh, 2=người dự thính), danh sách tài khoản học sinh hoặc người dự thính cần được thêm vào khóa học, biệt danh, student/auditorUID.
Ghi chú: The maximum number of auditors that can be added is 20 by default, and it is recommended to add no more than 30 students at a time. Số lượng người dự thính tối đa có thể thêm là 20 và khuyến nghị không thêm quá 30 học sinh trong mỗi lượt gọi API.
Nếu tại Trang quản lý classin.com đang được thiết lập để chọn hiển thị tên nhà trường đặt cho học viên khi được thêm vào trường thành biệt danh trong lớp ClassIn của học viên (Trang quản lý –> Cài đặt –> Cài đặt lớp học –> Đồng bộ thiết lập biệt danh trong lớp –> Bật), thì sau khi hoàn tất lệnh, hệ thống sẽ sử dụng tên được đặt khi gọi API để hiển thị làm biệt danh của học sinh trong lớp.
Bật chế độ này sẽ giải quyết được tình huống học sinh tự thay đổi tên khi truy cập vào ứng dụng và khi đó giáo viên không thể nhận diện được bạn.
Lưu ý: Khi chức năng này được bật thì có khả năng lỗi 841 sẽ xảy ra. Khi đó, vui lòng gọi API modify the class nickname of the group member để thay đổi
To add students/auditors (multiple) to a course, you need SID, safekey, timeStamp, the course ID, the identification of the student or auditor (1 for students, 2 for auditors), and an array of student or auditor accounts to be added, which includes the account number and account name of each account, and the student/auditor UID. Returns the details of each account after it is added. Users can pass custom fields, and the interface will return the parameters as is. If not passed, it will not be returned. Students added to this course can take all classes under this course.
Note: The maximum number of auditors that can be added is 20 by default, and it is recommended to add no more than 30 students at a time.
If your eeocn institution management backend switch sets the backend name of the newly added student to the course to his or her ClassIn class nickname (setting path: institution settings – class settings – synchronize class nickname settings) to on, after calling this interface to add students/auditors, the system will use the name of the newly added member under the institution to modify his or her class nickname in the group . After the modification, the name displayed in the client’s IM class group and in the classroom under the course is the student’s name, not the user nickname.
Turning on this switch solves the problem that after students modify their user nicknames in the ClassIn client, teachers often cannot match their nicknames in the group and in the classroom.
Please note: When this switch is turned on, there is a very small probability that the 841 error code will appear when calling this interface. At this time, it is recommended that you call the interface to modify the class nickname of the group member.
URL
https://api.eeo.cn/partner/api/course.api.php?action=addCourseStudentMultiple
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 |
| courseId | Bắt buộc | — | ID Khóa học | — |
| identity | Bắt buộc | — | Xác định vài trò của tài khoản (1=học sinh, 2=người dự thính) | — |
| studentJson | Bắt buộc | Tối đa được thêm 20 người dự thính cho một khóa học | Danh sách các tài khoản | — |
| └ Student 1 account information | Bắt buộc | — | Thêm thông tin về học sinh | — |
| └ name | Bắt buộc | — | Tên học sinh | — |
| └ customColumn | Không bắt buộc | Tối đa 50 ký tự | — | Nếu để trống thì dữ liệu sẽ trả về trống |
| └ uid | Không bắt buộc | — | UID của học sinh | Register the user UID returned by the user interface |
| └ ······ | Không bắt buộc | — | Thêm thông tin học sinh | — |
| └ name | Bắt buộc | — | Tên học sinh | — |
| └ customColumn | Không bắt buộc | Tối đa 50 ký tự | — | Nếu để trống thì dữ liệu sẽ trả về trống |
| └ uid | Không bắt buộc | — | UID của học sinh | UID hệ thống trả về khi đăng ký tài khoản thành công |
Response data #
| Key | Định dạng | Phản hồi | Ý nghĩa |
|---|---|---|---|
| data | array | [] | Returns an array of data information |
| └ data Return message 1 | object | Return information object | |
| └ customColumn | string | 123 | User – defined identity |
| └ errno | number | 1 | The error code |
| └ error | string | “程序正常执行” | 错误详Error details情 |
| └ data返回信息2 | object | Return information object | |
| └ customColumn | string | 123 | User – defined identity |
| └ errno | number | 1 | The error code |
| └ error | string | “程序正常执行” | Error details |
| └ ······ | object | Return information object | |
| └ customColumn | string | 123 | User – defined identity |
| └ errno | number | ··· | The error code |
| └ error | string | ··· | Error details |
| error_info | object | Return information object | |
| └ errno | number | 1 | The error code |
| └ error | string | “Routine execution” | Error details |
Sample #
- HTTP Request
POST /partner/api/course.api.php?action=addCourseStudentMultiple HTTP/1.1
Host: www.eeo.cn
Content-Type: application/x-www-form-urlencoded
Cache-Control: no-cache
SID=2339736&safeKey=e98b01228fca036bf2ab060f7a8a6ec3&timeStamp=1493725870&courseId=490583&identity=1&studentJson=[{"uid":"1001001","name":"Mary","customColumn":123}]
Shell cURL analog request instruction
curl -H "Content-Type: application/x-www-form-urlencoded" -X "POST" \ -d "SID=1234567" \ -d "safeKey=0f7781b3033527a8cc2b1abbf45a5fd2" \ -d "timeStamp=1484719085" \ -d "courseId=442447" \ -d "identity=1" \ -d 'studentJson=[{"uid":"1001001","name":"学生一"},{"uid":"1002001","name":"学生二"}]' \ "https://api.eeo.cn/partner/api/course.api.php?action=addCourseStudentMultiple"
Response Sample (normal return json packet sample) #
{
"data": [
{
"customColumn": "123",
"errno": 1,
"error": "程序正常执行"
}
],
"error_info": {
"errno": 1,
"error": "程序正常执行"
}
}
Error Code Description #
| Error Code | Mô tả |
|---|---|
| 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) |
| 104 | Thao tác thất bại |
| 113 | Số điện thoại chưa được đăng ký tài khoản |
| 114 | Lỗi server |
| 125 | Số điện thoại của học sinh không hợp lệ |
| 129 | Giáo viên của khóa học không thể được thiết lập làm học sinh |
| 130 | Vượt số lượng học sinh tối đa được thêm |
| 131 | Đăng ký thất bại |
| 133 | Đã tồn tại (Lỗi này sẽ hiển thị khi bạn truyền dữ liệu tài khoản bị trùng lặp) |
| 134 | Số điện thoại không hợp lệ |
| 144 | Không có khóa học trong trường này |
| 147 | Không có thông tin về khóa học |
| 149 | Khóa học đã bị xóa |
| 153 | Khóa học đã kết thúc và không thể chỉnh sửa được |
| 155 | Danh sách học sinh không thể truyền dữ liệu trống |
| 163 | Học sinh này đã tồn tại trong khóa học |
| 164 | Người dự thính này đã tồn tại trong khóa học |
| 174 | Không thể thêm giáo viên làm người dự thính |
| 228 | Không có học sinh này ở trong danh sách học sinh của trường |
| 288 | Số điện thoại không hợp lệ |
| 332 | Giáo viên của khóa học và trợ giảng không thể được thêm làm học sinh hay người dự thính của khóa học |
| 333 | GVCN của khóa học không thể được thiết lập làm học sinh của khóa học |
| 369 | Lớp học công khai không cho phép thao tác |
| 400 | Dữ liệu được yêu cầu không hợp lệ |
| 841 | Thêm học sinh vào khóa học thành công. Đồng bộ biệt danh của học sinh thất bại |
| 886 | Tài khoản của học sinh đã bị xóa |
| 887 | Tài khoản của người dự thính đã bị xóa |
