Remove Students from Class(Multiple)
To remove multiple students from a lesson, you need to pass SID, safeKey, timeStamp, course ID, class ID, students' identity(1 is Student) and the array of student accounts to be deleted, including the students' UIDs. The interface returns excution result of each account.
Also support to used on dual-teacher main and sub-lessons.
URL
https://api.eeo.cn/partner/api/course.api.php?action=delClassStudentMultiple
HTTP Request Methods
- POST
Coding Format
- UTF-8
Request Data
Key | Required | More Restrictions | Instructions | Description |
---|---|---|---|---|
SID | Yes | Null | School ID | It is available through the eeo.cn application |
safeKey | Yes | Fixed 32-bit all lowercase characters | School authentication security key | safeKey=MD5(SECRET+timeStamp) |
timeStamp | Yes | Null | Imestamp used by safeKey | Unix Epoch timeStamp is the number of seconds passed by 00:00 (world standard time) on January 1, 1970 |
courseId | Yes | Null | Course ID | Null |
classId | Yes | Null | Class ID | Null |
identity | Yes | Null | Student identification(1 student) | Null |
studentUidJson | Yes | If the array is not empty, the length of at least 1, can be multiple uids.Either studentUidJson or studentJson. If studentUidJson and studentJson are sent at the same time, studentUidJson shall prevail | You need to delete the array of student uids | Null |
└ student 1 UID | Yes | Null | Student UID | Register the user UID returned by the user interface, for example: 1001001 |
└ student 2 UID | No | Null | Student UID | Register the user UID returned by the user interface, for example: 1001002 |
└ ...... | No | Null | Student UID | Register the user UID returned by the user interface, for example: 1001003 |
Response Data
Key | Type | Sample Value | Meaning |
---|---|---|---|
data | array | [] | Returns an array of Data information |
└ data return information 1 | object | Return message object | |
└ errno | number | 1 | Error code |
└ error | string | "Normal execution" | Error list |
└ data return data 2 | object | return message object | |
└ errno | number | 1 | Error code |
└ error | string | "Normal execution" | Error list |
└ ······ | object | Return message object | |
└ errno | number | ··· | Error code |
└ error | string | ··· | Error list |
error_info | object | Return message object | |
└ errno | number | 1 | Error code |
└ error | string | "Normal execution" | Error list |
Sample
- HTTP Request
POST /partner/api/course.api.php?action=delClassStudentMultiple HTTP/1.1
Host: www.eeo.cn
Content-Type: application/x-www-form-urlencoded
Cache-Control: no-cache
SID=2339736&safeKey=00ab6e63b2f13891a79a067aa4290854&timeStamp=1494410390&courseId=542163&classId=1474563&identity=1&studentUidJson=["1001001"]
- 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 "classId=2447" \
-d "identity=1" \
-d 'studentUidJson=["1001001","1001002"]' \
"https://api.eeo.cn/partner/api/course.api.php?action=delClassStudentMultiple"
Response Sample (normal return json
packet sample)
{
"data": [
{
"errno": 1,
"error": "程序正常执行"
},
{
"errno": 1,
"error": "程序正常执行"
}
],
"error_info": {
"errno": 1,
"error": "程序正常执行"
}
}
Error Code Description
Error Code | Description |
---|---|
1 | Successful execution. |
100 | Incomplete or incorrect parameters. |
102 | No permission(Security verification failed.). |
113 | The mobile phone number has not been registered yet. |
114 | Server exception. |
142 | There is no information about the lesson in the course. |
143 | There is no information about this lesson. |
144 | There is no such course in your institution. |
145 | The lesson is finished. |
155 | Array data of students cannot be null. |
159 | Only support to operate students. |
167 | The student does not exist in the lesson. |
171 | Failed to remove the student out of the lesson. |
212 | The lesson has been deleted. |
369 | Do not support to operate this type of courses and lessons(public course). |
400 | The requested data is illegal. |
466 | The lesson was created in the ClassIn LMS and cannot be edited via API. Please remove the student in the ClassIn LMS. |