# 班级

类实例化：

ClassApi api = new ClassApi(String apiUrl, String accesskeyId, String publicKey);

# 获取行政班列表

# 接口名称 :

getAdministrativeClassList

# 接口说明 :

获取行政班列表

参数：

参数名	是否必填	参数类型	参数描述
schoolId	是	integer	校区Id，必填
gradeCode	否	integer	年级枚举，选填，如果不填，默认为全部年级
isOver	是	boolean	是否结班，必填
pageIndex	否	integer	页码，选填，如果不填，默认为1
pageSize	否	integer	页容量，选填，如果不填，默认为100
v	是	string	接口版本号

请求示例：

api.getAdministrativeClassList(parameter [, parameter1, parameter2...])

返回示例：

{
  "data": {
    "totalCount": "@integer(60, 100)",
    "currentIndex": "@integer(60, 100)",
    "itemCount": "@integer(60, 100)",
    "list": [
      {
        "classId": "@integer(60, 100)",
        "name": "@string",
        "eName": "@string"
      }
    ]
  },
  "state": 0,
  "msg": "@string"
}

返回参数说明：

参数名	类型	说明
data	object	返回数据信息
totalCount	integer	└ 总记录数
currentIndex	integer	└ 当前页码
itemCount	integer	└ 返回的记录数
list	array	└ 返回数据列表
classId	integer	班级Id
name	string	班级中文名
eName	string	班级英文名
state	integer	返回码
msg	string	描述信息

# 获取选修班列表

# 接口名称 :

getElectiveClassList

# 接口说明 :

获取选修班列表

参数：

参数名	是否必填	参数类型	参数描述
schoolId	是	integer	校区Id，必填
gradeCode	否	integer	年级枚举，选填，如果不填，默认为全部年级
isOver	是	boolean	是否结班，必填
pageIndex	否	integer	页码，选填，如果不填，默认为1
pageSize	否	integer	页容量，选填，如果不填，默认为100
v	是	string	接口版本号

请求示例：

api.getElectiveClassList(parameter [, parameter1, parameter2...])

返回示例：

{
  "data": {
    "totalCount": "@integer(60, 100)",
    "currentIndex": "@integer(60, 100)",
    "itemCount": "@integer(60, 100)",
    "list": [
      {
        "classId": "@integer(60, 100)",
        "name": "@string",
        "eName": "@string",
        "isOpenEnroll": "@boolean"
      }
    ]
  },
  "state": 0,
  "msg": "@string"
}

返回参数说明：

参数名	类型	说明
data	object	返回数据信息
totalCount	integer	└ 总记录数
currentIndex	integer	└ 当前页码
itemCount	integer	└ 返回的记录数
list	array	└ 返回数据列表
classId	integer	班级Id
name	string	班级中文名
eName	string	班级英文名
isOpenEnroll	boolean	是否开放报名，true表示开放，false表示不开放
state	integer	返回码
msg	string	描述信息

# 获取行政班详情

# 接口名称 :

getAdministrativeClassDetail

# 接口说明 :

获取行政班详情

参数：

参数名	是否必填	参数类型	参数描述
classId	是	integer	班级Id，必填
v	是	string	接口版本号

请求示例：

api.getAdministrativeClassDetail(parameter [, parameter1, parameter2...])

返回示例：

{
  "data": {
    "name": "@string",
    "eName": "@string",
    "classCode": "@string",
    "gradeCode": 0,
    "entranceYear": "@integer(60, 100)",
    "studySection": 1,
    "schoolId": "@integer(60, 100)",
    "isOver": "@boolean",
    "classRoomId": "@integer(60, 100)",
    "classTeacherId": [
      "@integer(60, 100)"
    ]
  },
  "state": 0,
  "msg": "@string"
}

返回参数说明：

参数名	类型	说明
data	object	返回数据信息
name	string	班级中文名
eName	string	班级英文名
classCode	string	班级编号
gradeCode	integer	年级枚举，行政班的所属年级
entranceYear	integer	入学年份
studySection	integer	学段Id
schoolId	integer	归属校区Id
isOver	boolean	是否结班，true表示已结班，false表示未结班
classRoomId	integer	教室场地Id
classTeacherId	array	班主任Ids
state	integer	返回码
msg	string	描述信息

# 获取选修班详情

# 接口名称 :

getElectiveClassDetail

# 接口说明 :

获取选修班详情

参数：

参数名	是否必填	参数类型	参数描述
classId	是	integer	班级Id，必填
v	是	string	接口版本号

请求示例：

api.getElectiveClassDetail(parameter [, parameter1, parameter2...])

返回示例：

{
  "data": {
    "name": "@string",
    "eName": "@string",
    "classCode": "@string",
    "gradeCode": [
      0
    ],
    "studySection": 1,
    "schoolId": "@integer(60, 100)",
    "isOver": "@boolean",
    "classRoomId": "@integer(60, 100)",
    "classTeacherId": [
      "@integer(60, 100)"
    ],
    "isOpenEnroll": "@boolean",
    "genderLimit": 1,
    "availableNumber": "@integer(60, 100)",
    "charge": "@integer(60, 100)",
    "remark": "@string"
  },
  "state": 0,
  "msg": "@string"
}

返回参数说明：

参数名	类型	说明
data	object	返回数据信息
name	string	班级中文名
eName	string	班级英文名
classCode	string	班级编号
gradeCode	array	年级枚举，选修班的可用年级
studySection	integer	学段Id
schoolId	integer	归属校区Id
isOver	boolean	是否结班，true表示已结班，false表示未结班
classRoomId	integer	教室场地Id
classTeacherId	array	指导老师Ids
isOpenEnroll	boolean	是否开放报名，true表示开放，false表示不开放
genderLimit	integer	性别限制，只有开放报名后才会出现限制男/女，1表示不限，2表示男，3表示女
availableNumber	integer	计划人数
charge	number	收费金额，为0时表示不收费
remark	string	备注信息
state	integer	返回码
msg	string	描述信息

# 获取班级的教学计划信息

# 接口名称 :

getClassTeachingPlanList

# 接口说明 :

获取班级的教学计划信息

参数：

参数名	是否必填	参数类型	参数描述
classId	是	integer	班级Id，必填
schoolSemesterId	是	integer	学期Id，必填
v	是	string	接口版本号

请求示例：

api.getClassTeachingPlanList(parameter [, parameter1, parameter2...])

返回示例：

{
  "data": [
    {
      "subjectId": "@integer(60, 100)",
      "subjectName": "@string",
      "subjectEName": "@string",
      "isCheck": "@boolean",
      "teacherInfos": [
        {
          "teacherId": "@integer(60, 100)",
          "semesterPlannedClassHours": "@integer(60, 100)"
        }
      ]
    }
  ],
  "state": 0,
  "msg": "@string"
}

返回参数说明：

参数名	类型	说明
data	array	返回数据信息
subjectId	integer	课程Id
subjectName	string	课程中文名
subjectEName	string	课程英文名
isCheck	boolean	是否考核，true表示考核，false表示不考核
teacherInfos	array	课程任课老师信息列表
teacherId	integer	任课老师Id，即OrgUserId
semesterPlannedClassHours	integer	学期计划课时
state	integer	返回码
msg	string	描述信息

# 获取班级当前学期在班的学生信息

# 接口名称 :

getClassStudentList

# 接口说明 :

获取班级当前学期在班的学生信息

参数：

参数名	是否必填	参数类型	参数描述
classId	是	integer	班级Id，必填
pageIndex	否	integer	页码，选填，如果不填，默认为1
pageSize	否	integer	页容量，选填，如果不填，默认为100
v	是	string	接口版本号

请求示例：

api.getClassStudentList(parameter [, parameter1, parameter2...])

返回示例：

{
  "data": {
    "totalCount": "@integer(60, 100)",
    "currentIndex": "@integer(60, 100)",
    "itemCount": "@integer(60, 100)",
    "list": [
      {
        "studentId": "@integer(60, 100)",
        "name": "@string",
        "eName": "@string",
        "enterTime": "@datetime"
      }
    ]
  },
  "state": 0,
  "msg": "@string"
}

返回参数说明：

参数名	类型	说明
data	object	返回数据信息
totalCount	integer	└ 总记录数
currentIndex	integer	└ 当前页码
itemCount	integer	└ 返回的记录数
list	array	└ 返回数据列表
studentId	integer	学生Id
name	string	学生中文名
eName	string	学生英文名
enterTime	string	加入时间
state	integer	返回码
msg	string	描述信息

← 考勤通用 →