# 日程


类实例化:

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

# 获取日程列表

# 接口名称 :

getScheduleList

# 接口说明 :

获取日程列表

参数:

参数名 是否必填 参数类型 参数描述
schoolId integer 校区Id,必填
beginTime string 编辑开始时间,选填,如果不填,默认为最小时间
endTime string 编辑结束时间,选填,如果不填,默认为最大时间
pageIndex integer 页码,选填,如果不填,默认为1
pageSize integer 页容量,选填,如果不填,默认为1000
scheduleType integer 日程类别:【1:活动 3:课表排课 4:临时排课】,必填
v string 接口版本号

请求示例:

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

返回示例:

{
  "data": {
    "totalCount": "@integer(60, 100)",
    "currentIndex": "@integer(60, 100)",
    "itemCount": "@integer(60, 100)",
    "list": [
      {
        "id": "@integer(60, 100)",
        "name": "@string",
        "eName": "@string",
        "color": "@string",
        "beginTime": "@datetime",
        "endTime": "@datetime",
        "scheduleType": 1,
        "outsidePlayground": "@string",
        "playgroundId": "@integer(60, 100)",
        "courseId": "@integer(60, 100)",
        "scope": [
          {
            "key": 1,
            "value": [
              "@integer(60, 100)"
            ]
          }
        ],
        "creatorId": "@integer(60, 100)",
        "lastEditorId": "@integer(60, 100)",
        "createAt": "@datetime",
        "lastEditAt": "@datetime",
        "isAllDay": "@boolean"
      }
    ]
  },
  "state": 0,
  "msg": "@string"
}

返回参数说明:

参数名 类型 说明
data object 返回数据信息
totalCount integer └ 总记录数
currentIndex integer └ 当前页码
itemCount integer └ 返回的记录数
list array └ 返回数据列表
id integer Id
name string 日程名
eName string 英文名
color string 颜色
beginTime string 开始时间
endTime string 结束时间
scheduleType integer 日程类别:【1:活动 2:校历 3:课表排课 4:临时排课】
outsidePlayground string 校外场地
playgroundId integer 场地Id
courseId integer 课程Id
scope array 作用范围
key integer 日程关联类型【1:老师 2:学生 3:部门 4:班级】
value array
creatorId integer 创建用户Id
lastEditorId integer 修改用户Id
createAt string 创建时间
lastEditAt string 修改时间
isAllDay boolean 是否全天
state integer 返回码
msg string 描述信息

# 获取日程删除记录列表

# 接口名称 :

getScheduleDeleteRecordList

# 接口说明 :

获取日程删除记录列表

参数:

参数名 是否必填 参数类型 参数描述
schoolId integer 校区Id,必填
beginTime string 创建开始时间,选填,如果不填,默认为最小时间
endTime string 创建结束时间,选填,如果不填,默认为最大时间
pageIndex integer 页码,选填,如果不填,默认为1
pageSize integer 页容量,选填,如果不填,默认为1000
v string 接口版本号

请求示例:

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

返回示例:

{
  "data": {
    "totalCount": "@integer(60, 100)",
    "currentIndex": "@integer(60, 100)",
    "itemCount": "@integer(60, 100)",
    "list": [
      {
        "scheduleId": "@integer(60, 100)",
        "orgUserId": "@integer(60, 100)",
        "operateAt": "@datetime"
      }
    ]
  },
  "state": 0,
  "msg": "@string"
}

返回参数说明:

参数名 类型 说明
data object 返回数据信息
totalCount integer └ 总记录数
currentIndex integer └ 当前页码
itemCount integer └ 返回的记录数
list array └ 返回数据列表
scheduleId integer 日程Id
orgUserId integer 操作人Id
operateAt string 操作时间
state integer 返回码
msg string 描述信息