Remove Activity Members

This is a general LMS interface for removing members from an LMS activity.

Note:

  • For activities other than classroom activities, the selectable participants include students and auditors from the class.
  • For classroom activities, the selectable participants are currently limited to students from the class. Future plans will support transfer students (those not in the class), and this interface will also be used to delete the transfer students.

URL

https://root_url/lms/activity/deleteStudent

HTTP Request Methods

  • POST

coding Format

  • UTF-8

Request Data

Header Parameters

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

Body Parameters

key Required Type Description Rules Description
courseId Yes integer Class (Course) ID
activityId Yes integer Activity ID returned after creation
studentUids Yes array[string] Collection of student UIDs

Response Data

Parameter Name Type Example Value Description
code integer 1 Error code
msg string "Execution successful" Error message
data integer null Reponse data

Example

  • HTTP Request
POST /lms/activity/deleteStudent HTTP/1.1
Host: root_url
X-EEO-SIGN: d8241dd187c9e6ba20d366cfbb3741a2
X-EEO-UID: 409864
X-EEO-TS: 1722938394
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: d8241dd187c9e6ba20d366cfbb3741a2' \
     -H 'X-EEO-UID: 409864' \
     -H 'X-EEO-TS: 1722938394' \
     -H 'Content-Type: application/json' \
     -d '{"courseId": 414193, "activityId": 25096097, "studentUids": [504026, 504028]}' \
     'https://root_url/lms/activity/deleteStudent'

Response sample(The normal return json packet example)

{
    "code": 1,
    "msg": "Execution successful",
    "data": null
}

Error Code Descriptions

Error Code Description
147 No information for this class
29149 Activity has been deleted
30002 Activity does not exist
30008 Activity type error (assignments, tests not supported)
101002005 Signature exception
101002006 Timestamp expired
101002008 Timestamp does not exist
110100069 Activity has ended
121601020 Parameter error
121601021 Class does not belong to your institution
121601022 It is not a standard class
121601023 This class has been dissolved and cannot be operated
121601030 Missing required parameters

results matching ""

    No results matching ""