Synchronize Student Class Nicknames

This interface supports synchronizing the "Student Management - Name" from the backend to the class of the student.

Interface Description:

  • Supports batch synchronization, with a limit of 100 studentUids per request.
  • Only synchronizes class nicknames for courses that have not yet concluded.

URL

https://root_url/schooluser/modifyCourseStudentNickName

HTTP Request Methods

  • POST

Encoding Format

  • UTF-8

Request Parameters

Header Parameters

Key Required Type Description
X-EEO-SIGN Yes string Signature; see here for generation rules
X-EEO-UID Yes string Institution SID
X-EEO-TS Yes string Timestamp

Body Parameters

Key Required Type Description Rules Description
studentUids Yes array Refresh only class nicknames for classes not yet concluded Maximum 100 studentUids

Response Parameters

Parameter Name Type Example Value Meaning
code integer 1 Error code
msg string "Execution successful" Error message
data array [] Array of return information
└ studentUid integer 1445886 Student UID
└ code integer 1 Error code
└ msg string "Execution successful" Error message

Example

  • HTTP Request
POST /schooluser/modifyCourseStudentNickName HTTP/1.1 
Host: root_url
X-EEO-SIGN: 365456d0454e9b0dd793c47e65727e84
X-EEO-UID: 2669800
X-EEO-TS: 1732268163
Content-Type: application/json
Content-Length: 26

{
    "studentUids": [
        1445886
    ]
}
  • Shell cURL Simulation Request Command
curl -X POST \
     -H 'Host: root_url' \
     -H 'X-EEO-SIGN: 365456d0454e9b0dd793c47e65727e84' \
     -H 'X-EEO-UID: 2669800' \
     -H 'X-EEO-TS: 1732268163' \
     -H 'Content-Type: application/json' \
     -d '{"studentUids": [1445886]}' \
     'https://root_url/schooluser/modifyCourseStudentNickName'

Response Example (Example of json data packet returned when successful)

{
    "code": 1,
    "msg": "程序正常执行",
    "data": [
        {
            "studentUid": 1445886,
            "code": 1,
            "msg": "程序正常执行"
        }
    ]
}

Error Code Description

Error Code Description
101001001 Business parameter error
101002005 Signature exception
101002006 Timestamp expired
101002008 Timestamp does not exist
101004005 Internal service call failed
110100067 Failed to synchronize class nickname
121601058 Institution does not exist
121601059 No such student under the institution
121601060 Student count exceeds limit of 100

results matching ""

    No results matching ""