huawei-cloud-api-definitions-Classroom 0.1.20250418

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"[\"application/json;charset=UTF-8\"]","definitions":{"ClassroomMember":{"properties":{"class_name":{"description":"成员所在班级的名字","type":"string"},"job_finished_count":{"description":"该成员已完成的作业数量","type":"integer"},"job_finished_rate":{"description":"该成员作业完成率","type":"number"},"job_received_count":{"description":"该成员已接收到的作业数量","type":"integer"},"join_time":{"description":"成员加入课堂时间,日期格式:yyyy-MM-dd HH:mm:ss","type":"string"},"member_id":{"description":"成员ID","type":"string"},"name":{"description":"成员名称","type":"string"},"number":{"description":"成员学号/工号","type":"string"},"user_name":{"description":"成员用户名","type":"string"}},"required":["member_id","name","number","class_name","user_name","join_time","job_received_count","job_finished_count","job_finished_rate"],"type":"object"},"ClassroomMemberResult":{"properties":{"members":{"description":"课堂成员列表","items":{"$ref":"#/definitions/ClassroomMember"},"type":"array"},"total":{"description":"课堂成员总数","type":"integer"}},"required":["members","total"],"type":"object"}},"description":null,"group_id":"efb473a373f747f48f056d82c721a6dd","host":"classroom-ext.cn-north-4.myhuaweicloud.com","id":"308e4e4341e74994b8e17b4b21f022e1","info_version":"v3","method":"get","name":"ListClassroomMembers","parameters":{},"paths":{"/v3/classrooms/{classroom_id}/members":{"get":{"description":"根据课堂ID获取指定课堂的课堂成员列表,支持分页,搜索字段默认同时匹配姓名,学号,用户名,班级。","operationId":"ListClassroomMembers","parameters":[{"description":"课堂ID","in":"path","maxLength":32,"minLength":32,"name":"classroom_id","required":true,"type":"string","x-example":"9a780fd55cd64333b668ba26132629d2"},{"description":"信息记录的起始编号","in":"query","maximum":1000,"minimum":1,"name":"offset","required":false,"type":"integer","x-example":1},{"description":"每页包含的信息记录数","in":"query","maximum":100,"minimum":1,"name":"limit","required":false,"type":"integer","x-example":1},{"description":"按照条件搜索学生,搜索字段会同时匹配姓名,学号,用户名,班级","in":"query","maxLength":200,"minLength":1,"name":"filter","required":false,"type":"string","x-example":"aa"},{"description":"用户token","in":"header","name":"x-auth-token","required":true,"type":"string","x-example":"MIIDkgYJKoZIhvIIDgzCCXXXXXX..."}],"produces":["application/json"],"responses":{"200":{"description":"OK","examples":{"application/json":{"members":[{"class_name":"Java高级编程一班","job_finished_count":0,"job_finished_rate":0,"job_received_count":4,"join_time":"2019-11-19 01:56:21","member_id":"f37ad8c959c24bd880fd20296867c1ef","name":"张三","number":"0001","user_name":"zhangsan001"}],"total":1}},"schema":{"$ref":"#/definitions/ClassroomMemberResult","type":"object"}},"400":{"description":"Bad Request","examples":{"application/json":{"error_code":"CM.0003","error_msg":"请求参数有误"}}},"403":{"description":"Forbidden","examples":{"application/json":{"error_code":"CM.0001","error_msg":"请求被拒绝访问"}}},"500":{"description":"Internal Server Error","examples":{"application/json":{"error_code":"CM.0000","error_msg":"服务内部错误"}}}},"summary":"根据课堂ID获取指定课堂的课堂成员列表","tags":["classroom"],"x-is-registered":"Y","x-request-examples-1":"GET https://{endpoint}/v3/classrooms/{classroom_id}/members","x-request-examples-text-1":"GET https://{endpoint}/v3/classrooms/{classroom_id}/members","x-support-sdk":"Y"}}},"product_short":"Classroom","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"根据课堂ID获取指定课堂的课堂成员列表","tags":"classroom","uri":null,"version":"2.0"}