Thêm người tham gia hoạt động (Add Student to Activity)

Mục lục

English below

Đây là API sử dụng chung để thêm học sinh cho các loại hoạt động LMS

Lưu ý

  • Theo mặc định, mỗi hoạt động khi được tạo sẽ bao gồm tất cả các học sinh trong danh sách thành viên lớp, nên không cần phải gọi API này.
  • Giao diện này hiện không được hỗ trợ cho hoạt động Bài kiểm tra (Test) & Bài tập về nhà (Assignment).
  • Hiện tại, thành viên có thể tham gia các hoạt động học tập LMS chỉ có các tài khoản giữ vai trò học sinh chính thức trong lớp. Tương lai dự tính mở rộng thêm nhóm đối tượng học sinh học thử, người dự thính.
  • Khi thêm nhiều thành viên vào hoạt động; mỗi thành viên sẽ có một mã phản hồi tương ứng.
  • Nếu thành viên đã tồn tại trong hoạt động, không có mã lỗi nào được trả về; thay vào đó, sẽ trả về mã 1 – hoạt động sẽ diễn ra bình thường.

This is a general interface used to add members to an LMS activity.

Note

  • By default, all class members can participate the activities when created, so there is no need to call this interface separately.
  • For activities other than classroom activities, the selectable participants include students and auditors from the same class.
  • The participants for classroom activities are currently limited to students from the class. Future plans will support transfer students (those not in the class), and this interface can also be used to add the transfer students.
  • Each member added will have a separate return code, which will be included in the data.
  • If a member already exists in the activity, no error code will be returned; instead, it will return 1, indicating normal execution.

URL

https://api.eeo.cn/lms/activity/addStudent

HTTP Request Methods

  • POST

coding Format

  • UTF-8

Request Data

Header Parameters

KeyBắt buộcĐịnh dạngMô tả
X-EEO-SIGNBắt buộcstringSignature; tham khảo cách tạo tại đây
X-EEO-UIDBắt buộcstringSID (Xem dữ liệu này tại Trang quản lý classin.com trong mục API)
X-EEO-TSBắt buộcstringTimestamp (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

KeyBắt buộcĐịnh dạngMô tảHướng dẫn
courseIdBắt buộcintegerID của lớp học 
activityIdBắt buộcintegerID của hoạt động cần thao tác 
studentUidsBắt buộcarray[string]Danh sách UID của học sinh

Response Data

KeyĐịnh dạngPhản hồiÝ nghĩa
codeinteger1Mã lỗi
msgstring“Execution successful”Nội dung
dataarray[integer]null 
└ studentUidinteger  
└ codeinteger1 
└ msgstring“Execution successful” 

Example

  • HTTP Request
POST /lms/activity/addStudent HTTP/1.1
Host: root_url
X-EEO-SIGN: ceb7a2c0534999960c02c191d409c41e
X-EEO-UID: 409864
X-EEO-TS: 1722938382
Content-Type: application/json
Content-Length: 117

{
    "courseId": 414193,
    "activityId": 25096097,
    "studentUids": [
        504026,
        504028
    ]
}
  • Shell cURL analog request instruction
curl -X POST \
     -H 'Host: root_url' \
     -H 'X-EEO-SIGN: ceb7a2c0534999960c02c191d409c41e' \
     -H 'X-EEO-UID: 409864' \
     -H 'X-EEO-TS: 1722938382' \
     -H 'Content-Type: application/json' \
     -d '{"courseId": 414193, "activityId": 25096097, "studentUids": [504026, 504028]}' \
     'https://root_url/lms/activity/addStudent'

Response sample（The normal return json packet example）

{
    "code": 1,
    "msg": "Execution successful",
    "data": [
        {
            "studentUid": 504026,
            "code": 40030,
            "msg": "Student not in the class"
        }, 
        {
            "studentUid": 504028,
            "code": 1,
            "msg": "Execution successful"
        }
    ]
}

Error Code Descriptions

Mã lỗiMô tả
147Không có thông tin của hoạt động này
29149Hoạt động đã bị xóa
30002Hoạt động không tồn tại
40030Học sinh không có thông tin trong danh sách lớp
101002005Lỗi signature
101002006Timestamp hết hạn
101002008Lỗi timestamp
110100069Hoạt động đã kết thúc
110100070Hoạt động không hỗ trợ thao tác này (Bài tập – Assignment, Bài kiểm tra – Test)
121601020Lỗi tham số
121601021Lớp này không thuộc quản lý của trường
121601022Lớp học này không phải lớp học tiêu chuẩn
121601023Lớp học này đã kết thúc và không thể thao tác được
121601030Thiếu tham số bắt buộc