校宝智慧校园API

# 课表

# 获取班级课表列表

# 接口名称 :

GetClassCourseTaskList

# 接口说明 :

通过班级Id，获取当前学期已生效的班级课表列表

请求地址：

HTTP：https://openplatform-api.xiaobao100.com/open-platform/CourseTask/v2/GetClassCourseTaskList (opens new window)

Java：https://openplatform-api.xiaobao100.com (opens new window)

请求方式：

GET

请求类型：

Content-Type: application/json

请求头：

"token":"@string"
"corp-id":"@string"
"xb-timestamp":"@integer"
"xb-sign-method":"sha256"
"xb-sign":"@string"

请求参数：

参数名 是否必填 参数类型 参数描述
classId 是 integer 班级Id，必填
pageIndex 否 integer 页码，选填，如果不填，默认为1
pageSize 否 integer 页容量，选填，如果不填，默认为1000，最大为1000

返回参数：

参数名 类型 说明
data object 返回数据信息
totalCount integer └ 总记录数
currentIndex integer └ 当前页码
itemCount integer └ 返回的记录数
list array └ 返回数据列表
courseTaskId integer └└ 课表Id
cName string └└ 课表中文名
eName string └└ 课表英文名
default boolean └└ 是否默认课表
beginTime datetime └└ 课表开始时间。时间格式示例：2020-01-01 00:00:00
endTime datetime └└ 课表结束时间。时间格式示例：2020-01-01 00:00:00
workRestTableType integer └└ 作息时间表类型，1表示一周循环作息表，2表示两周循环作息表
msgCN string 中文异常信息
msgEN string 英文异常信息
state integer 返回码
msg string 描述信息

请求示例（Java SDK）：

TokenApi tokenApi = new TokenApi(String apiUrl);
TokenDTO dto = new TokenDTO();
dto.setAccessKeyId(String accessKeyId);
dto.setAccessKeySecret(String accessKeySecret);
String token = tokenApi.getToken(dto);

CourseTaskApi api = new CourseTaskApi(String apiUrl, String accesskeyId, String accessKeySecret, String token, String corpId);
api.getClassCourseTaskList(parameter [, parameter1, parameter2...])

返回示例：

{
  "data": {
    "totalCount": "@integer(60, 100)",
    "currentIndex": "@integer(60, 100)",
    "itemCount": "@integer(60, 100)",
    "list": [
      {
        "courseTaskId": "@integer(60, 100)",
        "cName": "@string",
        "eName": "@string",
        "default": "@boolean",
        "beginTime": "@datetime",
        "endTime": "@datetime",
        "workRestTableType": 1
      }
    ]
  },
  "msgCN": "@string",
  "msgEN": "@string",
  "state": 0,
  "msg": "@string"
}

# 获取班级课表详情

# 接口名称 :

GetClassCourseTaskDetail

# 接口说明 :

通过班级Id、课表Id，获取班级课表详情

请求地址：

HTTP：https://openplatform-api.xiaobao100.com/open-platform/CourseTask/v2/GetClassCourseTaskDetail (opens new window)

Java：https://openplatform-api.xiaobao100.com (opens new window)

请求方式：

GET

请求类型：

Content-Type: application/json

请求头：

"token":"@string"
"corp-id":"@string"
"xb-timestamp":"@integer"
"xb-sign-method":"sha256"
"xb-sign":"@string"

请求参数：

参数名 是否必填 参数类型 参数描述
courseTaskId 是 integer 课表Id，必填
classId 是 integer 班级Id，必填

返回参数：

参数名 类型 说明
data array 返回数据信息
coordId integer └ 课节坐标Id
cName string └ 中文名称，如果是课程，返回课程中文名称；如果是课程包，则返回课程包名称
eName string └ 英文名称，如果是课程，返回课程英文名称；如果是课程包，则返回空值
subjects array └ 课程信息
subjectId integer └└ 课程Id
subjectCName string └└ 课程中文
subjectEName string └└ 课程英文名
subjectTeachers array └└ 上课老师信息
subjectTeacherId integer └└└ 上课老师Id
subjectTeacherCName string └└└ 上课老师名称
subjectTeacherEName string └└└ 上课老师英文名称
classId integer └└ 班级Id
classCName string └└ 班级中文名
classEName string └└ 班级英文名
playgroundId integer └└ 场地Id
playgroundCName string └└ 场地中文名
playgroundEName string └└ 场地英文名
singleDoubleSet integer └└ 单双周，0表示不限，1表示单周，2表示双周
msgCN string 中文异常信息
msgEN string 英文异常信息
state integer 返回码
msg string 描述信息

请求示例（Java SDK）：

TokenApi tokenApi = new TokenApi(String apiUrl);
TokenDTO dto = new TokenDTO();
dto.setAccessKeyId(String accessKeyId);
dto.setAccessKeySecret(String accessKeySecret);
String token = tokenApi.getToken(dto);

CourseTaskApi api = new CourseTaskApi(String apiUrl, String accesskeyId, String accessKeySecret, String token, String corpId);
api.getClassCourseTaskDetail(parameter [, parameter1, parameter2...])

返回示例：

{
  "data": [
    {
      "coordId": "@integer(60, 100)",
      "cName": "@string",
      "eName": "@string",
      "subjects": [
        {
          "subjectId": "@integer(60, 100)",
          "subjectCName": "@string",
          "subjectEName": "@string",
          "subjectTeachers": [
            {
              "subjectTeacherId": "@integer(60, 100)",
              "subjectTeacherCName": "@string",
              "subjectTeacherEName": "@string"
            }
          ],
          "classId": "@integer(60, 100)",
          "classCName": "@string",
          "classEName": "@string",
          "playgroundId": "@integer(60, 100)",
          "playgroundCName": "@string",
          "playgroundEName": "@string",
          "singleDoubleSet": 0
        }
      ]
    }
  ],
  "msgCN": "@string",
  "msgEN": "@string",
  "state": 0,
  "msg": "@string"
}

# 获取学生课表列表

# 接口名称 :

GetStudentCourseTaskList

# 接口说明 :

通过学生Id，获取当前学期已生效的学生课表列表

请求地址：

HTTP：https://openplatform-api.xiaobao100.com/open-platform/CourseTask/v2/GetStudentCourseTaskList (opens new window)

Java：https://openplatform-api.xiaobao100.com (opens new window)

请求方式：

GET

请求类型：

Content-Type: application/json

请求头：

"token":"@string"
"corp-id":"@string"
"xb-timestamp":"@integer"
"xb-sign-method":"sha256"
"xb-sign":"@string"

请求参数：

参数名 是否必填 参数类型 参数描述
studentId 是 integer 学生Id，必填
pageIndex 否 integer 页码，选填，如果不填，默认为1
pageSize 否 integer 页容量，选填，如果不填，默认为1000，最大为1000

返回参数：

参数名 类型 说明
data object 返回数据信息
totalCount integer └ 总记录数
currentIndex integer └ 当前页码
itemCount integer └ 返回的记录数
list array └ 返回数据列表
courseTaskId integer └└ 课表Id
cName string └└ 课表中文名
eName string └└ 课表英文名
default boolean └└ 是否默认课表
beginTime datetime └└ 课表开始时间。时间格式示例：2020-01-01 00:00:00
endTime datetime └└ 课表结束时间。时间格式示例：2020-01-01 00:00:00
workRestTableType integer └└ 作息时间表类型，1表示一周循环作息表，2表示两周循环作息表
msgCN string 中文异常信息
msgEN string 英文异常信息
state integer 返回码
msg string 描述信息

请求示例（Java SDK）：

TokenApi tokenApi = new TokenApi(String apiUrl);
TokenDTO dto = new TokenDTO();
dto.setAccessKeyId(String accessKeyId);
dto.setAccessKeySecret(String accessKeySecret);
String token = tokenApi.getToken(dto);

CourseTaskApi api = new CourseTaskApi(String apiUrl, String accesskeyId, String accessKeySecret, String token, String corpId);
api.getStudentCourseTaskList(parameter [, parameter1, parameter2...])

返回示例：

{
  "data": {
    "totalCount": "@integer(60, 100)",
    "currentIndex": "@integer(60, 100)",
    "itemCount": "@integer(60, 100)",
    "list": [
      {
        "courseTaskId": "@integer(60, 100)",
        "cName": "@string",
        "eName": "@string",
        "default": "@boolean",
        "beginTime": "@datetime",
        "endTime": "@datetime",
        "workRestTableType": 1
      }
    ]
  },
  "msgCN": "@string",
  "msgEN": "@string",
  "state": 0,
  "msg": "@string"
}

# 获取学生课表详情

# 接口名称 :

GetStudentCourseTaskDetail

# 接口说明 :

通过学生Id、课表Id，获取学生课表详情

请求地址：

HTTP：https://openplatform-api.xiaobao100.com/open-platform/CourseTask/v2/GetStudentCourseTaskDetail (opens new window)

Java：https://openplatform-api.xiaobao100.com (opens new window)

请求方式：

GET

请求类型：

Content-Type: application/json

请求头：

"token":"@string"
"corp-id":"@string"
"xb-timestamp":"@integer"
"xb-sign-method":"sha256"
"xb-sign":"@string"

请求参数：

参数名 是否必填 参数类型 参数描述
courseTaskId 是 integer 课表Id，必填
studentId 是 integer 学生Id，必填

返回参数：

参数名 类型 说明
data array 返回数据信息
coordId integer └ 课节坐标Id
cName string └ 中文名称，如果是课程，返回课程中文名称；如果是课程包，则返回课程包名称
eName string └ 英文名称，如果是课程，返回课程英文名称；如果是课程包，则返回空值
subjects array └ 课程信息
subjectId integer └└ 课程Id
subjectCName string └└ 课程中文
subjectEName string └└ 课程英文名
subjectTeachers array └└ 上课老师信息
subjectTeacherId integer └└└ 上课老师Id
subjectTeacherCName string └└└ 上课老师名称
subjectTeacherEName string └└└ 上课老师英文名称
classId integer └└ 班级Id
classCName string └└ 班级中文名
classEName string └└ 班级英文名
playgroundId integer └└ 场地Id
playgroundCName string └└ 场地中文名
playgroundEName string └└ 场地英文名
singleDoubleSet integer └└ 单双周，0表示不限，1表示单周，2表示双周
msgCN string 中文异常信息
msgEN string 英文异常信息
state integer 返回码
msg string 描述信息

请求示例（Java SDK）：

TokenApi tokenApi = new TokenApi(String apiUrl);
TokenDTO dto = new TokenDTO();
dto.setAccessKeyId(String accessKeyId);
dto.setAccessKeySecret(String accessKeySecret);
String token = tokenApi.getToken(dto);

CourseTaskApi api = new CourseTaskApi(String apiUrl, String accesskeyId, String accessKeySecret, String token, String corpId);
api.getStudentCourseTaskDetail(parameter [, parameter1, parameter2...])

返回示例：

{
  "data": [
    {
      "coordId": "@integer(60, 100)",
      "cName": "@string",
      "eName": "@string",
      "subjects": [
        {
          "subjectId": "@integer(60, 100)",
          "subjectCName": "@string",
          "subjectEName": "@string",
          "subjectTeachers": [
            {
              "subjectTeacherId": "@integer(60, 100)",
              "subjectTeacherCName": "@string",
              "subjectTeacherEName": "@string"
            }
          ],
          "classId": "@integer(60, 100)",
          "classCName": "@string",
          "classEName": "@string",
          "playgroundId": "@integer(60, 100)",
          "playgroundCName": "@string",
          "playgroundEName": "@string",
          "singleDoubleSet": 0
        }
      ]
    }
  ],
  "msgCN": "@string",
  "msgEN": "@string",
  "state": 0,
  "msg": "@string"
}

# 获取老师课表列表

# 接口名称 :

GetTeacherCourseTaskList

# 接口说明 :

通过老师Id，获取当前学期已生效的老师课表列表

请求地址：

HTTP：https://openplatform-api.xiaobao100.com/open-platform/CourseTask/v2/GetTeacherCourseTaskList (opens new window)

Java：https://openplatform-api.xiaobao100.com (opens new window)

请求方式：

GET

请求类型：

Content-Type: application/json

请求头：

"token":"@string"
"corp-id":"@string"
"xb-timestamp":"@integer"
"xb-sign-method":"sha256"
"xb-sign":"@string"

请求参数：

参数名 是否必填 参数类型 参数描述
teacherId 是 integer 老师Id，必填
pageIndex 否 integer 页码，选填，如果不填，默认为1
pageSize 否 integer 页容量，选填，如果不填，默认为1000，最大为1000

返回参数：

参数名 类型 说明
data object 返回数据信息
totalCount integer └ 总记录数
currentIndex integer └ 当前页码
itemCount integer └ 返回的记录数
list array └ 返回数据列表
courseTaskId integer └└ 课表Id
cName string └└ 课表中文名
eName string └└ 课表英文名
default boolean └└ 是否默认课表
beginTime datetime └└ 课表开始时间。时间格式示例：2020-01-01 00:00:00
endTime datetime └└ 课表结束时间。时间格式示例：2020-01-01 00:00:00
workRestTableType integer └└ 作息时间表类型，1表示一周循环作息表，2表示两周循环作息表
msgCN string 中文异常信息
msgEN string 英文异常信息
state integer 返回码
msg string 描述信息

请求示例（Java SDK）：

TokenApi tokenApi = new TokenApi(String apiUrl);
TokenDTO dto = new TokenDTO();
dto.setAccessKeyId(String accessKeyId);
dto.setAccessKeySecret(String accessKeySecret);
String token = tokenApi.getToken(dto);

CourseTaskApi api = new CourseTaskApi(String apiUrl, String accesskeyId, String accessKeySecret, String token, String corpId);
api.getTeacherCourseTaskList(parameter [, parameter1, parameter2...])

返回示例：

{
  "data": {
    "totalCount": "@integer(60, 100)",
    "currentIndex": "@integer(60, 100)",
    "itemCount": "@integer(60, 100)",
    "list": [
      {
        "courseTaskId": "@integer(60, 100)",
        "cName": "@string",
        "eName": "@string",
        "default": "@boolean",
        "beginTime": "@datetime",
        "endTime": "@datetime",
        "workRestTableType": 1
      }
    ]
  },
  "msgCN": "@string",
  "msgEN": "@string",
  "state": 0,
  "msg": "@string"
}

# 获取老师课表详情

# 接口名称 :

GetTeacherCourseTaskDetail

# 接口说明 :

通过老师Id、课表Id，获取老师课表详情

请求地址：

HTTP：https://openplatform-api.xiaobao100.com/open-platform/CourseTask/v2/GetTeacherCourseTaskDetail (opens new window)

Java：https://openplatform-api.xiaobao100.com (opens new window)

请求方式：

GET

请求类型：

Content-Type: application/json

请求头：

"token":"@string"
"corp-id":"@string"
"xb-timestamp":"@integer"
"xb-sign-method":"sha256"
"xb-sign":"@string"

请求参数：

参数名 是否必填 参数类型 参数描述
courseTaskId 是 integer 课表Id，必填
teacherId 是 integer 老师Id，必填

返回参数：

参数名 类型 说明
data array 返回数据信息
coordId integer └ 课节坐标Id
cName string └ 中文名称，如果是课程，返回课程中文名称；如果是课程包，则返回课程包名称
eName string └ 英文名称，如果是课程，返回课程英文名称；如果是课程包，则返回空值
subjects array └ 课程信息
subjectId integer └└ 课程Id
subjectCName string └└ 课程中文
subjectEName string └└ 课程英文名
subjectTeachers array └└ 上课老师信息
subjectTeacherId integer └└└ 上课老师Id
subjectTeacherCName string └└└ 上课老师名称
subjectTeacherEName string └└└ 上课老师英文名称
classId integer └└ 班级Id
classCName string └└ 班级中文名
classEName string └└ 班级英文名
playgroundId integer └└ 场地Id
playgroundCName string └└ 场地中文名
playgroundEName string └└ 场地英文名
singleDoubleSet integer └└ 单双周，0表示不限，1表示单周，2表示双周
msgCN string 中文异常信息
msgEN string 英文异常信息
state integer 返回码
msg string 描述信息

请求示例（Java SDK）：

TokenApi tokenApi = new TokenApi(String apiUrl);
TokenDTO dto = new TokenDTO();
dto.setAccessKeyId(String accessKeyId);
dto.setAccessKeySecret(String accessKeySecret);
String token = tokenApi.getToken(dto);

CourseTaskApi api = new CourseTaskApi(String apiUrl, String accesskeyId, String accessKeySecret, String token, String corpId);
api.getTeacherCourseTaskDetail(parameter [, parameter1, parameter2...])

返回示例：

{
  "data": [
    {
      "coordId": "@integer(60, 100)",
      "cName": "@string",
      "eName": "@string",
      "subjects": [
        {
          "subjectId": "@integer(60, 100)",
          "subjectCName": "@string",
          "subjectEName": "@string",
          "subjectTeachers": [
            {
              "subjectTeacherId": "@integer(60, 100)",
              "subjectTeacherCName": "@string",
              "subjectTeacherEName": "@string"
            }
          ],
          "classId": "@integer(60, 100)",
          "classCName": "@string",
          "classEName": "@string",
          "playgroundId": "@integer(60, 100)",
          "playgroundCName": "@string",
          "playgroundEName": "@string",
          "singleDoubleSet": 0
        }
      ]
    }
  ],
  "msgCN": "@string",
  "msgEN": "@string",
  "state": 0,
  "msg": "@string"
}

# 获取场地课表列表

# 接口名称 :

GetPlaygroundCourseTaskList

# 接口说明 :

通过场地Id，获取当前学期已生效的场地课表列表

请求地址：

HTTP：https://openplatform-api.xiaobao100.com/open-platform/CourseTask/v2/GetPlaygroundCourseTaskList (opens new window)

Java：https://openplatform-api.xiaobao100.com (opens new window)

请求方式：

GET

请求类型：

Content-Type: application/json

请求头：

"token":"@string"
"corp-id":"@string"
"xb-timestamp":"@integer"
"xb-sign-method":"sha256"
"xb-sign":"@string"

请求参数：

参数名 是否必填 参数类型 参数描述
playgroundId 是 integer 场地Id，必填
pageIndex 否 integer 页码，选填，如果不填，默认为1
pageSize 否 integer 页容量，选填，如果不填，默认为1000，最大为1000

返回参数：

参数名 类型 说明
data object 返回数据信息
totalCount integer └ 总记录数
currentIndex integer └ 当前页码
itemCount integer └ 返回的记录数
list array └ 返回数据列表
courseTaskId integer └└ 课表Id
cName string └└ 课表中文名
eName string └└ 课表英文名
default boolean └└ 是否默认课表
beginTime datetime └└ 课表开始时间。时间格式示例：2020-01-01 00:00:00
endTime datetime └└ 课表结束时间。时间格式示例：2020-01-01 00:00:00
workRestTableType integer └└ 作息时间表类型，1表示一周循环作息表，2表示两周循环作息表
msgCN string 中文异常信息
msgEN string 英文异常信息
state integer 返回码
msg string 描述信息

请求示例（Java SDK）：

TokenApi tokenApi = new TokenApi(String apiUrl);
TokenDTO dto = new TokenDTO();
dto.setAccessKeyId(String accessKeyId);
dto.setAccessKeySecret(String accessKeySecret);
String token = tokenApi.getToken(dto);

CourseTaskApi api = new CourseTaskApi(String apiUrl, String accesskeyId, String accessKeySecret, String token, String corpId);
api.getPlaygroundCourseTaskList(parameter [, parameter1, parameter2...])

返回示例：

{
  "data": {
    "totalCount": "@integer(60, 100)",
    "currentIndex": "@integer(60, 100)",
    "itemCount": "@integer(60, 100)",
    "list": [
      {
        "courseTaskId": "@integer(60, 100)",
        "cName": "@string",
        "eName": "@string",
        "default": "@boolean",
        "beginTime": "@datetime",
        "endTime": "@datetime",
        "workRestTableType": 1
      }
    ]
  },
  "msgCN": "@string",
  "msgEN": "@string",
  "state": 0,
  "msg": "@string"
}

# 获取场地课表详情

# 接口名称 :

GetPlaygroundCourseTaskDetail

# 接口说明 :

通过场地Id、课表Id，获取场地课表详情

请求地址：

HTTP：https://openplatform-api.xiaobao100.com/open-platform/CourseTask/v2/GetPlaygroundCourseTaskDetail (opens new window)

Java：https://openplatform-api.xiaobao100.com (opens new window)

请求方式：

GET

请求类型：

Content-Type: application/json

请求头：

"token":"@string"
"corp-id":"@string"
"xb-timestamp":"@integer"
"xb-sign-method":"sha256"
"xb-sign":"@string"

请求参数：

参数名 是否必填 参数类型 参数描述
courseTaskId 是 integer 课表Id，必填
playgroundId 是 integer 场地Id，必填

返回参数：

参数名 类型 说明
data array 返回数据信息
coordId integer └ 课节坐标Id
cName string └ 中文名称，如果是课程，返回课程中文名称；如果是课程包，则返回课程包名称
eName string └ 英文名称，如果是课程，返回课程英文名称；如果是课程包，则返回空值
subjects array └ 课程信息
subjectId integer └└ 课程Id
subjectCName string └└ 课程中文
subjectEName string └└ 课程英文名
subjectTeachers array └└ 上课老师信息
subjectTeacherId integer └└└ 上课老师Id
subjectTeacherCName string └└└ 上课老师名称
subjectTeacherEName string └└└ 上课老师英文名称
classId integer └└ 班级Id
classCName string └└ 班级中文名
classEName string └└ 班级英文名
playgroundId integer └└ 场地Id
playgroundCName string └└ 场地中文名
playgroundEName string └└ 场地英文名
singleDoubleSet integer └└ 单双周，0表示不限，1表示单周，2表示双周
msgCN string 中文异常信息
msgEN string 英文异常信息
state integer 返回码
msg string 描述信息

请求示例（Java SDK）：

TokenApi tokenApi = new TokenApi(String apiUrl);
TokenDTO dto = new TokenDTO();
dto.setAccessKeyId(String accessKeyId);
dto.setAccessKeySecret(String accessKeySecret);
String token = tokenApi.getToken(dto);

CourseTaskApi api = new CourseTaskApi(String apiUrl, String accesskeyId, String accessKeySecret, String token, String corpId);
api.getPlaygroundCourseTaskDetail(parameter [, parameter1, parameter2...])

返回示例：

{
  "data": [
    {
      "coordId": "@integer(60, 100)",
      "cName": "@string",
      "eName": "@string",
      "subjects": [
        {
          "subjectId": "@integer(60, 100)",
          "subjectCName": "@string",
          "subjectEName": "@string",
          "subjectTeachers": [
            {
              "subjectTeacherId": "@integer(60, 100)",
              "subjectTeacherCName": "@string",
              "subjectTeacherEName": "@string"
            }
          ],
          "classId": "@integer(60, 100)",
          "classCName": "@string",
          "classEName": "@string",
          "playgroundId": "@integer(60, 100)",
          "playgroundCName": "@string",
          "playgroundEName": "@string",
          "singleDoubleSet": 0
        }
      ]
    }
  ],
  "msgCN": "@string",
  "msgEN": "@string",
  "state": 0,
  "msg": "@string"
}

# 获取作息时间表

# 接口名称 :

GetWorkrestTable

# 接口说明 :

通过课表Id，获取课表使用的作息时间表信息

请求地址：

HTTP：https://openplatform-api.xiaobao100.com/open-platform/CourseTask/v2/GetWorkrestTable (opens new window)

Java：https://openplatform-api.xiaobao100.com (opens new window)

请求方式：

GET

请求类型：

Content-Type: application/json

请求头：

"token":"@string"
"corp-id":"@string"
"xb-timestamp":"@integer"
"xb-sign-method":"sha256"
"xb-sign":"@string"

请求参数：

参数名 是否必填 参数类型 参数描述
courseTaskId 是 integer 课表Id，必填

返回参数：

参数名 类型 说明
data array 返回数据信息
coordId integer └ 课节坐标Id
cName string └ 节次中文名
eName string └ 节次英文名
dayOrder integer └ 天次，指第几天，从1开始，一周循环作息表中最大7，两周循环作息表中最大14
sectionOrder integer └ 节次，指一天内所有节次顺序，包括公共时段
subjectOrder integer └ 课程节次，指一天内所有课程的节次顺序，仅针对上课时段
beginTime string └ 开始时间，返回时分格式，如20:00
endTime string └ 结束时间，返回时分格式，如20:00
timeType integer └ 节次时段类型，1表示上课时段，2表示公共时段
msgCN string 中文异常信息
msgEN string 英文异常信息
state integer 返回码
msg string 描述信息

请求示例（Java SDK）：

TokenApi tokenApi = new TokenApi(String apiUrl);
TokenDTO dto = new TokenDTO();
dto.setAccessKeyId(String accessKeyId);
dto.setAccessKeySecret(String accessKeySecret);
String token = tokenApi.getToken(dto);

CourseTaskApi api = new CourseTaskApi(String apiUrl, String accesskeyId, String accessKeySecret, String token, String corpId);
api.getWorkrestTable(parameter [, parameter1, parameter2...])

返回示例：

{
  "data": [
    {
      "coordId": "@integer(60, 100)",
      "cName": "@string",
      "eName": "@string",
      "dayOrder": "@integer(60, 100)",
      "sectionOrder": "@integer(60, 100)",
      "subjectOrder": "@integer(60, 100)",
      "beginTime": "@string",
      "endTime": "@string",
      "timeType": 1
    }
  ],
  "msgCN": "@string",
  "msgEN": "@string",
  "state": 0,
  "msg": "@string"
}

# 获取课表详情

# 接口名称 :

GetCourseTask

# 接口说明 :

通过课表Id，获取课表详情

请求地址：

HTTP：https://openplatform-api.xiaobao100.com/open-platform/CourseTask/v2/GetCourseTask (opens new window)

Java：https://openplatform-api.xiaobao100.com (opens new window)

请求方式：

GET

请求类型：

Content-Type: application/json

请求头：

"token":"@string"
"corp-id":"@string"
"xb-timestamp":"@integer"
"xb-sign-method":"sha256"
"xb-sign":"@string"

请求参数：

参数名 是否必填 参数类型 参数描述
courseTaskId 是 integer 课表Id，必填

返回参数：

参数名 类型 说明
data object 返回数据信息
courseTaskId integer └ 课表Id
cName string └ 课表中文名
eName string └ 课表英文名
default boolean └ 是否默认课表
beginTime datetime └ 课表开始时间。时间格式示例：2020-01-01 00:00:00
endTime datetime └ 课表结束时间。时间格式示例：2020-01-01 00:00:00
workRestTableType integer └ 作息时间表类型，1表示一周循环作息表，2表示两周循环作息表
subjectSections array └ 课节列表
coordId integer └└ 课节坐标Id
cName string └└ 中文名称，如果是课程，返回课程中文名称；如果是课程包，则返回课程包名称
eName string └└ 英文名称，如果是课程，返回课程英文名称；如果是课程包，则返回空值
subjects array └└ 课程信息
subjectId integer └└└ 课程Id
subjectCName string └└└ 课程中文
subjectEName string └└└ 课程英文名
subjectTeachers array └└└ 上课老师信息
subjectTeacherId integer └└└└ 上课老师Id
subjectTeacherCName string └└└└ 上课老师名称
subjectTeacherEName string └└└└ 上课老师英文名称
classId integer └└└ 班级Id
classCName string └└└ 班级中文名
classEName string └└└ 班级英文名
playgroundId integer └└└ 场地Id
playgroundCName string └└└ 场地中文名
playgroundEName string └└└ 场地英文名
singleDoubleSet integer └└└ 单双周，0表示不限，1表示单周，2表示双周
msgCN string 中文异常信息
msgEN string 英文异常信息
state integer 返回码
msg string 描述信息

请求示例（Java SDK）：

TokenApi tokenApi = new TokenApi(String apiUrl);
TokenDTO dto = new TokenDTO();
dto.setAccessKeyId(String accessKeyId);
dto.setAccessKeySecret(String accessKeySecret);
String token = tokenApi.getToken(dto);

CourseTaskApi api = new CourseTaskApi(String apiUrl, String accesskeyId, String accessKeySecret, String token, String corpId);
api.getCourseTask(parameter [, parameter1, parameter2...])

返回示例：

{
  "data": {
    "courseTaskId": "@integer(60, 100)",
    "cName": "@string",
    "eName": "@string",
    "default": "@boolean",
    "beginTime": "@datetime",
    "endTime": "@datetime",
    "workRestTableType": 1,
    "subjectSections": [
      {
        "coordId": "@integer(60, 100)",
        "cName": "@string",
        "eName": "@string",
        "subjects": [
          {
            "subjectId": "@integer(60, 100)",
            "subjectCName": "@string",
            "subjectEName": "@string",
            "subjectTeachers": [
              {
                "subjectTeacherId": "@integer(60, 100)",
                "subjectTeacherCName": "@string",
                "subjectTeacherEName": "@string"
              }
            ],
            "classId": "@integer(60, 100)",
            "classCName": "@string",
            "classEName": "@string",
            "playgroundId": "@integer(60, 100)",
            "playgroundCName": "@string",
            "playgroundEName": "@string",
            "singleDoubleSet": 0
          }
        ]
      }
    ]
  },
  "msgCN": "@string",
  "msgEN": "@string",
  "state": 0,
  "msg": "@string"
}

# 获取课程

# 接口名称 :

GetSubjectList

# 接口说明 :

通过CorpId，获取校区下的课程列表

请求地址：

HTTP：https://openplatform-api.xiaobao100.com/open-platform/Subject/v2/GetSubjectList (opens new window)

Java：https://openplatform-api.xiaobao100.com (opens new window)

请求方式：

GET

请求类型：

Content-Type: application/json

请求头：

"token":"@string"
"corp-id":"@string"
"xb-timestamp":"@integer"
"xb-sign-method":"sha256"
"xb-sign":"@string"

请求参数：

参数名 是否必填 参数类型 参数描述
pageIndex 否 integer 页码，选填，如果不填，默认为1
pageSize 否 integer 页容量，选填，如果不填，默认为1000，最大为1000

返回参数：

参数名 类型 说明
data object 返回数据信息
totalCount integer └ 总记录数
currentIndex integer └ 当前页码
itemCount integer └ 返回的记录数
list array └ 返回数据列表
id integer └└ 课程Id
cName string └└ 课程中文名
eName string └└ 课程英文名
subjectCode string └└ 课程代码
subjectGradeCodes array └└ 适用年级
msgCN string 中文异常信息
msgEN string 英文异常信息
state integer 返回码
msg string 描述信息

请求示例（Java SDK）：

TokenApi tokenApi = new TokenApi(String apiUrl);
TokenDTO dto = new TokenDTO();
dto.setAccessKeyId(String accessKeyId);
dto.setAccessKeySecret(String accessKeySecret);
String token = tokenApi.getToken(dto);

SubjectApi api = new SubjectApi(String apiUrl, String accesskeyId, String accessKeySecret, String token, String corpId);
api.getSubjectList(parameter [, parameter1, parameter2...])

返回示例：

{
  "data": {
    "totalCount": "@integer(60, 100)",
    "currentIndex": "@integer(60, 100)",
    "itemCount": "@integer(60, 100)",
    "list": [
      {
        "id": "@integer(60, 100)",
        "cName": "@string",
        "eName": "@string",
        "subjectCode": "@string",
        "subjectGradeCodes": [
          0
        ]
      }
    ]
  },
  "msgCN": "@string",
  "msgEN": "@string",
  "state": 0,
  "msg": "@string"
}

# 获取场地

# 接口名称 :

GetPlaygroundList

# 接口说明 :

通过CorpId，获取校区下的场地列表，按可用校区

请求地址：

HTTP：https://openplatform-api.xiaobao100.com/open-platform/Playground/v2/GetPlaygroundList (opens new window)

Java：https://openplatform-api.xiaobao100.com (opens new window)

请求方式：

GET

请求类型：

Content-Type: application/json

请求头：

"token":"@string"
"corp-id":"@string"
"xb-timestamp":"@integer"
"xb-sign-method":"sha256"
"xb-sign":"@string"

请求参数：

参数名 是否必填 参数类型 参数描述
pageIndex 否 integer 页码，选填，如果不填，默认为1
pageSize 否 integer 页容量，选填，如果不填，默认为1000，最大为1000

返回参数：

参数名 类型 说明
data object 返回数据信息
totalCount integer └ 总记录数
currentIndex integer └ 当前页码
itemCount integer └ 返回的记录数
list array └ 返回数据列表
id integer └└ 场地Id
cName string └└ 场地中文名
eName string └└ 场地英文名
address string └└ 地点
remark string └└ 备注
msgCN string 中文异常信息
msgEN string 英文异常信息
state integer 返回码
msg string 描述信息

请求示例（Java SDK）：

TokenApi tokenApi = new TokenApi(String apiUrl);
TokenDTO dto = new TokenDTO();
dto.setAccessKeyId(String accessKeyId);
dto.setAccessKeySecret(String accessKeySecret);
String token = tokenApi.getToken(dto);

PlaygroundApi api = new PlaygroundApi(String apiUrl, String accesskeyId, String accessKeySecret, String token, String corpId);
api.getPlaygroundList(parameter [, parameter1, parameter2...])

返回示例：

{
  "data": {
    "totalCount": "@integer(60, 100)",
    "currentIndex": "@integer(60, 100)",
    "itemCount": "@integer(60, 100)",
    "list": [
      {
        "id": "@integer(60, 100)",
        "cName": "@string",
        "eName": "@string",
        "address": "@string",
        "remark": "@string"
      }
    ]
  },
  "msgCN": "@string",
  "msgEN": "@string",
  "state": 0,
  "msg": "@string"
}

← 日程 →