Đây là API dùng chung cho tất cả các hoạt động LMS, được sử dụng để đăng tải hoạt động (chuyển từ trạng thái ‘bản nháp’ sang ‘công khai’).
Lưu ý :
- Mọi loại hoạt động (buổi học, bài tập, bài kiểm tra, phiếu đáp án, điểm danh, thảo luận, v.v.) đều có thể được xuất bản thông qua giao diện này.
- API này chỉ hỗ trợ đăng tải các hoạt động từ trạng thái ‘bản nháp’; không hỗ trợ thao tác ngược lại.
This is a general LMS interface for publishing any type of activity.
Note:
- All types of activities (classrooms, assignments, tests, answer sheets, recurring assignments, discussions, etc.) can be published using this interface.
- This interface only supports changing the status from draft to published; reversing the operation is not allowed.
URL
https://root_url/lms/activity/release
HTTP Request Methods
- POST
coding Format
- UTF-8
Request Data
Header Parameters
| Key | Bắt buộc | Định dạng | Mô tả |
|---|---|---|---|
| X-EEO-SIGN | Bắt buộc | string | Signature; tham khảo cách tạo tại đây |
| X-EEO-UID | Bắt buộc | string | SID (Xem dữ liệu này tại Trang quản lý classin.com trong mục API) |
| X-EEO-TS | Bắt buộc | string | Timestamp (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) |
Body Parameters
| Key | Bắt buộc | Định dạng | Mô tả | Hướng dẫn |
|---|---|---|---|---|
| courseId | Bắt buộc | integer | ID của lớp học | |
| activityIds | Bắt buộc | array[integer] | Danh sách ID của các hoạt động |
Response Data
| Key | Định dạng | Phản hồi | Ý nghĩa |
|---|---|---|---|
| code | integer | 1 | Mã lỗi |
| msg | string | “Execution successful” | Nội dung |
| data | array | [] | |
| └ | object | ||
| └ activityId | integer | 25096096 | ID của hoạt động |
| └ name | string | “API Published Activity” | Tên hoạt động |
Example
- HTTP Request
POST /lms/activity/release HTTP/1.1
Host: root_url
X-EEO-SIGN: fe19eb3a5b721c7b66194e4a29ee8ead
X-EEO-UID: 409864
X-EEO-TS: 1722938255
Content-Type: application/json
Content-Length: 84
{
"courseId": 414193,
"activityId": 25096096
}
- Shell cURL analog request instruction
curl -X POST \
-H 'Host: root_url' \
-H 'X-EEO-SIGN: fe19eb3a5b721c7b66194e4a29ee8ead' \
-H 'X-EEO-UID: 409864' \
-H 'X-EEO-TS: 1722938255' \
-H 'Content-Type: application/json' \
-d '{"courseId": 414193, "activityId": 25096096}' \
'https://root_url/lms/activity/release'
Response sample(The normal return json packet example)
{
"code": 1,
"msg": "Execution successful",
"data": {
"activityId": 25096096,
"name": "API Published Activity"
}
}
Error Code Descriptions
| Mã lỗi | Mô tả |
|---|---|
| 147 | Không có thông tin của hoạt động này |
| 29149 | Hoạt động đã bị xóa |
| 29184 | Hoạt động đã được đăng tải |
| 30002 | Hoạt động không tồn tại |
| 21601030 | Thiếu tham số bắt buộc |
| 101001001 | Lỗi tham số |
| 101002005 | Lỗi signature |
| 101002006 | Lỗi timestamp |
| 101002008 | Timestamp không tồn tại |
| 110100065 | Điều kiện mở khóa của hoạt động này vẫn đang ở trạng thái ‘Bản nháp’ |
| 121601020 | Lỗi tham số kinh doanh |
| 121601021 | Lớp này không thuộc quản lý của trường |
| 121601022 | Lớp học này không phải lớp học tiêu chuẩn |
| 121601023 | Lớp học này đã kết thúc và không thể thao tác được |