Modify group member nickname
To change the class nickname of group members, you need to pass SID, safekey, timeStamp, course ID.
Each time a standard course is created, the system automatically creates a class group (you can view this group in ClassIn IM). When creating a class group, the system uses User Nickname by default to set the names of the group members, which we call Class Nickname.
This interface modifies the class nicknames of students and auditors in a group using the names of all students and auditors in the course and in the institution. Once modified, the name displayed by the student in the client's IM group and in the classroom under the course will be the student's name, not the user's nickname.
This interface solves the problem that after students change their user nicknames in the ClassIn client, teachers often can't match them in groups and classrooms.
Recommended Scenarios: After creating a course and adding students/observers to the course, call this interface to modify the class nicknames of all students and observers in the course.
URL
https://root_url/partner/api/course.api.php?action=modifyGroupMemberNickname
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 | Timestamp 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 |
Response data
key | Type | Sample value | meaning |
---|---|---|---|
error_info | object | Return message object | |
└ errno | number | 1 | Error code |
└ error | string | "Program normal execution" | Error list |
Sample
- HTTP request
POST /partner/api/course.api.php?action=modifyGroupMemberNickname HTTP/1.1
Host: www.eeo.cn
Content-Type: application/x-www-form-urlencoded
Cache-Control: no-cache
SID=2339736&safeKey=f834fff59eb3bc8a2ff26a3cb59155f0&timeStamp=1492792399&courseId=35286
- 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=561294" \
"https://root_url/partner/api/course.api.php?action=modifyGroupMemberNickname"
Response sample(The normal return json
packet example)
{
"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.). |
104 | Operation failed (unknown error). |
144 | There is no such course in your institution. |
147 | No information about this course |
149 | This course has been deleted |
153 | This course has expired |
842 | Failed to modify partial members' class nicknames. |
843 | Failed to modify the nicknames of all members of the lesson. |