Edit Classroom

This interface is used to modify the settings of an LMS classroom activity, including the name, schedule(start/end time), teacher, co-teacher, number of students on-stage, and settings for cloud recording, web live streaming/playback.

Note:

• This interface only supports editing standard classrooms and does not support modifying settings for dual-teacher sub-classrooms。
• You may only pass the parameters that need to be modified; you can provide one or more parameters. If no parameters are provided, an error Incomplete Parameters will be returned.
• The parameters of screenMode (screen mode) and teachMode (teaching mode) are not needed. They will be assigned appropriate values based on the value of cameraHide (whether to hide the seat area).
  • If cameraHide=0 (seat area shown), then teachMode=1 (online classroom) and screenMode=1 (standard mode).
  • If cameraHide=1 (seat area hidden), then teachMode=2 (smart classroom), and screenMode=2 (large-screen mode).
• This interface does not support modifying the publication status. To publish the classroom activity, please call the Release Activity Interface.
• If cloud recording is enabled but web live streaming is not activated, the data will return the classroom web-live player address live_url, while the pulling stream address live_info will be empty.
• If both cloud recording and web live streaming are enabled, three pulling stream addresses (RTMP, HLS, FLV) will be generated and bound to the classroom. The data will return the classroom web-live player address live_url and the pulling stream addresses live_info. If the web-live streaming is later canceled, the three pulling stream addresses will still exist and remain bound to the classroom.
• If the classroom does not enable cloud recording, both the web-live player address live_url and the pulling stream addresses liveInfo in the data will be empty.
• recordType, recordState, liveState, and openState constitute a complete set of parameters and cannot be partially passed; otherwise, an error will occur.
• This interface does not support editing classrooms in draft status.

URL

https://root_url/lms/activity/updateClass

HTTP Request Methods

• POST

coding Format

• UTF-8

Request Data

Header Parameters

Body Parameters

Response Data

Sample

• HTTP request

POST /lms/activity/updateClass HTTP/1.1
Host: root_url
X-EEO-SIGN: a972505b54568015e9ecdc65d1dfbe4e
X-EEO-UID: 409864
X-EEO-TS: 1722938191
Content-Type: application/json
Content-Length: 298

{
    "courseId": 414193,
    "unitId": 26020897,
    "activityId": 25096094,
    "name": "API Edited Classroom",
    "teacherUid": 409864,
    "startTime": 1723010791,
    "endTime": 1723016791,
    "publishFlag": 2,
    "liveState": 1,
    "openState": 1,
    "recordState": 1,
    "recordType": 0
}

• Shell cURL analog request instruction

curl -X POST \
     -H 'Host: root_url' \
     -H 'X-EEO-SIGN: a972505b54568015e9ecdc65d1dfbe4e' \
     -H 'X-EEO-UID: 409864' \
     -H 'X-EEO-TS: 1722938191' \
     -H 'Content-Type: application/json' \
     -d '{"courseId": 414193, "unitId": 26020897, "activityId": 25096094, "name": "API Edited Classroom", "teacherUid": 409864, "startTime": 1723010791, "endTime": 1723016791, "publishFlag": 2, "liveState": 1, "openState": 1, "recordState": 1, "recordType": 0}' \
     'https://root_url/lms/activity/updateClass'

Response Sample（The normal return json packet example）

{
    "code": 1,
    "msg": "Execution successful",
    "data": {
        "activityId": 25096094,
        "name": "API Edited Classroom"
    }
}

Error Code Descriptions