校宝智慧校园API

# 日程

# 获取校历

# 接口名称 :

GetCalendarList

# 接口说明 :

通过时间范围，获取校历列表

请求地址：

HTTP：https://openplatform-api.xiaobao100.com/open-platform/Schedule/v2/GetCalendarList (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"

请求参数：

参数名 是否必填 参数类型 参数描述
beginTime 是 datetime 开始时间，必填，时间格式示例：2020-01-01 00:00:00
endTime 是 datetime 结束时间，必填，时间格式示例：2020-01-01 00:00:00
pageIndex 否 integer 页码，选填，如果不填，默认为1
pageSize 否 integer 页容量，选填，如果不填，默认为1000，最大为1000

返回参数：

参数名 类型 说明
data object 返回数据信息
totalCount integer └ 总记录数
currentIndex integer └ 当前页码
itemCount integer └ 返回的记录数
list array └ 返回数据列表
scheduleId integer └└ 日程Id
cName string └└ 中文名称
eName string └└ 英文名称
beginTime datetime └└ 开始时间。时间格式示例：2020-01-01 00:00:00
endTime datetime └└ 结束时间。时间格式示例：2020-01-01 00:00:00
playgroundId integer └└ 校内场地Id
playgroundCName string └└ 校内场地中文名
playgroundEName string └└ 校内场地英文名
outsidePlayground string └└ 校外场地
participantType integer └└ 参与对象类型，0表示全体员工，1表示教职工
remark string └└ 备注
isAllDay boolean └└ 是否全天
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);

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

返回示例：

{
  "data": {
    "totalCount": "@integer(60, 100)",
    "currentIndex": "@integer(60, 100)",
    "itemCount": "@integer(60, 100)",
    "list": [
      {
        "scheduleId": "@integer(60, 100)",
        "cName": "@string",
        "eName": "@string",
        "beginTime": "@datetime",
        "endTime": "@datetime",
        "playgroundId": "@integer(60, 100)",
        "playgroundCName": "@string",
        "playgroundEName": "@string",
        "outsidePlayground": "@string",
        "participantType": 0,
        "remark": "@string",
        "isAllDay": "@boolean"
      }
    ]
  },
  "msgCN": "@string",
  "msgEN": "@string",
  "state": 0,
  "msg": "@string"
}

# 获取活动

# 接口名称 :

GetActivityList

# 接口说明 :

通过时间范围，获取活动列表

请求地址：

HTTP：https://openplatform-api.xiaobao100.com/open-platform/Schedule/v2/GetActivityList (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"

请求参数：

参数名 是否必填 参数类型 参数描述
beginTime 是 datetime 开始时间，必填，时间格式示例：2020-01-01 00:00:00
endTime 是 datetime 结束时间，必填，时间格式示例：2020-01-01 00:00:00
pageIndex 否 integer 页码，选填，如果不填，默认为1
pageSize 否 integer 页容量，选填，如果不填，默认为1000，最大为1000

返回参数：

参数名 类型 说明
data object 返回数据信息
totalCount integer └ 总记录数
currentIndex integer └ 当前页码
itemCount integer └ 返回的记录数
list array └ 返回数据列表
scheduleId integer └└ 日程Id
cName string └└ 中文名称
eName string └└ 英文名称
beginTime datetime └└ 开始时间。时间格式示例：2020-01-01 00:00:00
endTime datetime └└ 结束时间。时间格式示例：2020-01-01 00:00:00
playgroundId integer └└ 校内场地Id
playgroundCName string └└ 校内场地中文名
playgroundEName string └└ 校内场地英文名
outsidePlayground string └└ 校外场地
participantDepartmentIds array └└ 参与部门Ids，为null时表示没有
participantOrgUserIds array └└ 参与员工Ids，为null时表示没有
participantClassIds array └└ 参与班级Ids，为null时表示没有
participantStudentIds array └└ 参与学生Ids，为null时表示没有
remark string └└ 备注
isAllDay boolean └└ 是否全天
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);

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

返回示例：

{
  "data": {
    "totalCount": "@integer(60, 100)",
    "currentIndex": "@integer(60, 100)",
    "itemCount": "@integer(60, 100)",
    "list": [
      {
        "scheduleId": "@integer(60, 100)",
        "cName": "@string",
        "eName": "@string",
        "beginTime": "@datetime",
        "endTime": "@datetime",
        "playgroundId": "@integer(60, 100)",
        "playgroundCName": "@string",
        "playgroundEName": "@string",
        "outsidePlayground": "@string",
        "participantDepartmentIds": [
          "@integer(60, 100)"
        ],
        "participantOrgUserIds": [
          "@integer(60, 100)"
        ],
        "participantClassIds": [
          "@integer(60, 100)"
        ],
        "participantStudentIds": [
          "@integer(60, 100)"
        ],
        "remark": "@string",
        "isAllDay": "@boolean"
      }
    ]
  },
  "msgCN": "@string",
  "msgEN": "@string",
  "state": 0,
  "msg": "@string"
}

# 获取排课日程

# 接口名称 :

GetCourseScheduleList

# 接口说明 :

通过时间范围，获取排课日程列表

请求地址：

HTTP：https://openplatform-api.xiaobao100.com/open-platform/Schedule/v2/GetCourseScheduleList (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"

请求参数：

参数名 是否必填 参数类型 参数描述
beginTime 是 datetime 开始时间，必填，时间格式示例：2020-01-01 00:00:00
endTime 是 datetime 结束时间，必填，时间格式示例：2020-01-01 00:00:00
pageIndex 否 integer 页码，选填，如果不填，默认为1
pageSize 否 integer 页容量，选填，如果不填，默认为1000，最大为1000
playGroundId 否 integer 场地id

返回参数：

参数名 类型 说明
data object 返回数据信息
totalCount integer └ 总记录数
currentIndex integer └ 当前页码
itemCount integer └ 返回的记录数
list array └ 返回数据列表
scheduleId integer └└ 日程Id
cName string └└ 中文名称
eName string └└ 英文名称
beginTime datetime └└ 开始时间。时间格式示例：2020-01-01 00:00:00
endTime datetime └└ 结束时间。时间格式示例：2020-01-01 00:00:00
playgroundId integer └└ 校内场地Id
playgroundCName string └└ 校内场地中文名
playgroundEName string └└ 校内场地英文名
outsidePlayground string └└ 校外场地
remark string └└ 备注
isAllDay boolean └└ 是否全天
scheduleType integer └└ 日程类型 3课表排课、4临时排课
objectTypes array └└ 作用对象集合 1教师，2班级，3学生
subjectId integer └└ 课程id
subjectCName string └└ 课程中文名
subjectEName string └└ 课程英文名
classes array └└ 上课班级（作用对象为班级）
classId integer └└└ 班级Id
cName string └└└ 班级中文名
eName string └└└ 班级英文名
classType integer └└└ 选修班类型
gradeCode integer └└└ 年级
teachers array └└ 上课教师（作用对象为教师）
eName string └└└ 英文
id integer └└└ id
name string └└└ 中文
students array └└ 上课学生（作用对象为学生）
eName string └└└ 英文
id integer └└└ id
name 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);

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

返回示例：

{
  "data": {
    "totalCount": "@integer(60, 100)",
    "currentIndex": "@integer(60, 100)",
    "itemCount": "@integer(60, 100)",
    "list": [
      {
        "scheduleId": "@integer(60, 100)",
        "cName": "@string",
        "eName": "@string",
        "beginTime": "@datetime",
        "endTime": "@datetime",
        "playgroundId": "@integer(60, 100)",
        "playgroundCName": "@string",
        "playgroundEName": "@string",
        "outsidePlayground": "@string",
        "remark": "@string",
        "isAllDay": "@boolean",
        "scheduleType": 1,
        "objectTypes": [
          1
        ],
        "subjectId": "@integer(60, 100)",
        "subjectCName": "@string",
        "subjectEName": "@string",
        "classes": [
          {
            "classId": "@integer(60, 100)",
            "cName": "@string",
            "eName": "@string",
            "classType": 0,
            "gradeCode": 0
          }
        ],
        "teachers": [
          {
            "eName": "@string",
            "id": "@integer(60, 100)",
            "name": "@string"
          }
        ],
        "students": [
          {
            "eName": "@string",
            "id": "@integer(60, 100)",
            "name": "@string"
          }
        ]
      }
    ]
  },
  "msgCN": "@string",
  "msgEN": "@string",
  "state": 0,
  "msg": "@string"
}

← 考勤 →