Modify School Settings
This interface is used to modify the configuration for school settings in the classin.com.
Note
Currently, this interface only supports modifying the following two settings:
- Allow formal students and teachers to watch lesson playback video after class.
- New course students can watch the lesson videos of finished lessons
This interface supports modifying one or more school settings. If no parameters are provided, an
Incomplete Parameters
error will be returned.
URL
https://root_url/school/modifySchoolConf
HTTP Request Methods
- POST
Request Data
Header Parameters
Key | Required | Type | Description | Rules | Description |
---|---|---|---|---|---|
X-EEO-SIGN | Yes | string | Signature; see the rules here | ||
X-EEO-UID | Yes | string | Institution's SID | By apply ClassIn school account in classin.com | |
X-EEO-TS | Yes | string | Unix Epoch timestamp within 5 minutes of the current API call | Unix Epoch timestamp is the number of seconds since 00:00:00 (UTC) on January 1, 1970 |
Body Parameters
Key | Required | Type | Description | Rules Description |
---|---|---|---|---|
allowViewReplay | No | integer | Allow formal students and teachers to watch lesson playback video after class. | If not provided, no modification; if incorrect, returns Parameter Error . 0 = Not allowed, 1 = Allowed |
allowNewStudentViewReplay | No | integer | New course students can watch the lesson videos of finished lessons | If not provided, no modification; if incorrect, returns Parameter Error . 0 = Not allowed, 1 = Allowed |
Response Data
Parameter Name | Type | Example Value | Description |
---|---|---|---|
code | integer | 1 | Error code |
msg | string | "Execution successful" | Error message |
data | array | [] | Reponse data |
Example
- HTTP Request
POST /school/modifySchoolConf HTTP/1.1
Host:
X-EEO-SIGN: f11d835f8c69ec49d2d936e3eb29ace9
X-EEO-UID: 234323
X-EEO-TS: 1721095405
User-Agent: Apifox/1.0.0 (https://apifox.com)
Content-Type: application/json
Content-Length: 64
{
"allowViewReplay": 0,
"allowNewStudentViewReplay": 0
}
- Shell cURL analog request instruction
curl --location --request POST '/school/modifySchoolConf' \
--header 'X-EEO-SIGN: f11d835f8c69ec49d2d936e3eb29ace9' \
--header 'X-EEO-UID: 234323' \
--header 'X-EEO-TS: 1721095405' \
--header 'User-Agent: Apifox/1.0.0 (https://apifox.com)' \
--header 'Content-Type: application/json' \
--data-raw '{
"allowViewReplay": 0,
"allowNewStudentViewReplay": 0
}'
Response sample(The normal return json packet example)
{
"code": 1,
"msg": "Execution successful",
"data": {}
}
Error Code Descriptions
Error Code | Description |
---|---|
121601030 | Missing required parameters |
101002005 | Signature exception |
101002006 | Timestamp expired |
101002008 | Timestamp does not exist |
121601020 | Business parameter error |
101001001 | Parameter error |