校宝智慧校园API

# 考勤

# 获取日常考勤记录列表

# 接口名称 :

GetDailyAttendanceRecordList

# 接口说明 :

通过时间范围，获取日常考勤记录列表

请求地址：

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

请求参数：

参数名 是否必填 参数类型 参数描述
beginDate 是 datetime 开始日期，必填，时间格式示例：2020-01-01 00:00:00
endDate 是 datetime 结束日期，必填，时间格式示例：2020-01-01 00:00:00
classIds 否 array 班级Ids，选填，如果不填，返回全部
pageIndex 否 integer 页码，选填，如果不填，默认为1
pageSize 否 integer 页容量，选填，如果不填，默认为1000，最大为1000

返回参数：

参数名 类型 说明
data object 返回数据信息
totalCount integer └ 总记录数
currentIndex integer └ 当前页码
itemCount integer └ 返回的记录数
list array └ 返回数据列表
attendanceRecordId integer └└ 考勤记录Id
classId integer └└ 班级Id
className string └└ 班级中文名
classEName string └└ 班级英文名
classType integer └└ 班级类型，1表示行政班，2表示选修班
gradeCode integer └└ 班级年级，选修班时年级为-2
attendanceDate datetime └└ 考勤日期。时间格式示例：2020-01-01 00:00:00
attendanceCount integer └└ 考勤次数
attendanceTeacherId integer └└ 考勤老师Id
attendanceTeacherName string └└ 考勤老师中文名
attendanceTeacherEName string └└ 考勤老师英文名
createAt datetime └└ 创建时间。时间格式示例：2020-01-01 00:00:00
totalCount integer └└ 总记录数
normalCount integer └└ 出勤人数
absenceFromDutyCount integer └└ 缺勤人数
comeLateCount integer └└ 迟到人数
leaveEarlyCount integer └└ 早退人数
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);

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

返回示例：

{
  "data": {
    "totalCount": "@integer(60, 100)",
    "currentIndex": "@integer(60, 100)",
    "itemCount": "@integer(60, 100)",
    "list": [
      {
        "attendanceRecordId": "@integer(60, 100)",
        "classId": "@integer(60, 100)",
        "className": "@string",
        "classEName": "@string",
        "classType": 0,
        "gradeCode": 0,
        "attendanceDate": "@datetime",
        "attendanceCount": "@integer(60, 100)",
        "attendanceTeacherId": "@integer(60, 100)",
        "attendanceTeacherName": "@string",
        "attendanceTeacherEName": "@string",
        "createAt": "@datetime",
        "totalCount": "@integer(60, 100)",
        "normalCount": "@integer(60, 100)",
        "absenceFromDutyCount": "@integer(60, 100)",
        "comeLateCount": "@integer(60, 100)",
        "leaveEarlyCount": "@integer(60, 100)"
      }
    ]
  },
  "msgCN": "@string",
  "msgEN": "@string",
  "state": 0,
  "msg": "@string"
}

# 获取日常考勤记录详情

# 接口名称 :

GetDailyAttendanceRecordDetail

# 接口说明 :

通过日常考勤记录Id，获取日常考勤记录详情信息

请求地址：

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

请求参数：

参数名 是否必填 参数类型 参数描述
id 是 integer 日常考勤记录Id，必填

返回参数：

参数名 类型 说明
data array 返回数据信息
studentInfoId integer └ 学生Id
studentCName string └ 学生中文名
studentEName string └ 学生英文名
attendanceState integer └ 考勤状态，0表示出勤，1表示迟到，2表示早退，3表示缺勤，6表示用餐，7表示不用餐，8表示离校，9表示未离校
isExcused boolean └ 是否请假
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);

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

返回示例：

{
  "data": [
    {
      "studentInfoId": "@integer(60, 100)",
      "studentCName": "@string",
      "studentEName": "@string",
      "attendanceState": 0,
      "isExcused": "@boolean",
      "remark": "@string"
    }
  ],
  "msgCN": "@string",
  "msgEN": "@string",
  "state": 0,
  "msg": "@string"
}

# 获取上课考勤记录列表

# 接口名称 :

GetClassAttendanceRecordList

# 接口说明 :

通过时间范围，获取上课考勤记录列表

请求地址：

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

请求参数：

参数名 是否必填 参数类型 参数描述
beginDate 是 datetime 开始日期，必填，时间格式示例：2020-01-01 00:00:00
endDate 是 datetime 结束日期，必填，时间格式示例：2020-01-01 00:00:00
classIds 否 array 班级Ids，选填，如果不填，返回全部
pageIndex 否 integer 页码，选填，如果不填，默认为1
pageSize 否 integer 页容量，选填，如果不填，默认为1000，最大为1000

返回参数：

参数名 类型 说明
data object 返回数据信息
totalCount integer └ 总记录数
currentIndex integer └ 当前页码
itemCount integer └ 返回的记录数
list array └ 返回数据列表
attendanceRecordId integer └└ 考勤记录Id
classId integer └└ 班级Id
className string └└ 班级中文名
classEName string └└ 班级英文名
classType integer └└ 班级类型，1表示行政班，2表示选修班
gradeCode integer └└ 班级年级，选修班时年级为-2
subjectId integer └└ 课程Id
subjectName string └└ 课程中文名
subjectEName string └└ 课程英文名
lessonBeginTime datetime └└ 上课开始时间。时间格式示例：2020-01-01 00:00:00
lessonEndTime datetime └└ 上课结束时间。时间格式示例：2020-01-01 00:00:00
attendanceTeacherId integer └└ 考勤老师Id
attendanceTeacherName string └└ 考勤老师中文名
attendanceTeacherEName string └└ 考勤老师英文名
createAt datetime └└ 创建时间。时间格式示例：2020-01-01 00:00:00
totalCount integer └└ 总记录数
normalCount integer └└ 出勤人数
absenceFromDutyCount integer └└ 缺勤人数
comeLateCount integer └└ 迟到人数
leaveEarlyCount integer └└ 早退人数
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);

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

返回示例：

{
  "data": {
    "totalCount": "@integer(60, 100)",
    "currentIndex": "@integer(60, 100)",
    "itemCount": "@integer(60, 100)",
    "list": [
      {
        "attendanceRecordId": "@integer(60, 100)",
        "classId": "@integer(60, 100)",
        "className": "@string",
        "classEName": "@string",
        "classType": 0,
        "gradeCode": 0,
        "subjectId": "@integer(60, 100)",
        "subjectName": "@string",
        "subjectEName": "@string",
        "lessonBeginTime": "@datetime",
        "lessonEndTime": "@datetime",
        "attendanceTeacherId": "@integer(60, 100)",
        "attendanceTeacherName": "@string",
        "attendanceTeacherEName": "@string",
        "createAt": "@datetime",
        "totalCount": "@integer(60, 100)",
        "normalCount": "@integer(60, 100)",
        "absenceFromDutyCount": "@integer(60, 100)",
        "comeLateCount": "@integer(60, 100)",
        "leaveEarlyCount": "@integer(60, 100)"
      }
    ]
  },
  "msgCN": "@string",
  "msgEN": "@string",
  "state": 0,
  "msg": "@string"
}

# 获取上课考勤记录详情

# 接口名称 :

GetClassAttendanceRecordDetail

# 接口说明 :

通过上课考勤记录Id，获取上课考勤记录详情信息

请求地址：

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

请求参数：

参数名 是否必填 参数类型 参数描述
id 是 integer 上课考勤记录Id，必填

返回参数：

参数名 类型 说明
data array 返回数据信息
studentInfoId integer └ 学生Id
studentCName string └ 学生中文名
studentEName string └ 学生英文名
attendanceState integer └ 考勤状态，0表示出勤，1表示迟到，2表示早退，3表示缺勤，6表示用餐，7表示不用餐，8表示离校，9表示未离校
isExcused boolean └ 是否请假
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);

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

返回示例：

{
  "data": [
    {
      "studentInfoId": "@integer(60, 100)",
      "studentCName": "@string",
      "studentEName": "@string",
      "attendanceState": 0,
      "isExcused": "@boolean",
      "remark": "@string"
    }
  ],
  "msgCN": "@string",
  "msgEN": "@string",
  "state": 0,
  "msg": "@string"
}

# 获取活动考勤记录列表

# 接口名称 :

GetActivityAttendanceRecordList

# 接口说明 :

通过时间范围，获取活动考勤记录列表

请求地址：

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

请求参数：

参数名 是否必填 参数类型 参数描述
beginDate 是 datetime 开始日期，必填，时间格式示例：2020-01-01 00:00:00
endDate 是 datetime 结束日期，必填，时间格式示例：2020-01-01 00:00:00
classIds 否 array 班级Ids，选填，如果不填，返回全部
pageIndex 否 integer 页码，选填，如果不填，默认为1
pageSize 否 integer 页容量，选填，如果不填，默认为1000，最大为1000

返回参数：

参数名 类型 说明
data object 返回数据信息
totalCount integer └ 总记录数
currentIndex integer └ 当前页码
itemCount integer └ 返回的记录数
list array └ 返回数据列表
attendanceRecordId integer └└ 考勤记录Id
classId integer └└ 班级Id
className string └└ 班级中文名
classEName string └└ 班级英文名
classType integer └└ 班级类型，1表示行政班，2表示选修班
gradeCode integer └└ 班级年级，选修班时年级为-2
activityId integer └└ 活动Id
activityName string └└ 活动中文名
activityEName string └└ 活动英文文名
activityBeginTime datetime └└ 活动开始时间。时间格式示例：2020-01-01 00:00:00
activityEndTime datetime └└ 活动结束时间。时间格式示例：2020-01-01 00:00:00
isAllDay boolean └└ 是否整天
attendanceTeacherId integer └└ 考勤老师Id
attendanceTeacherName string └└ 考勤老师中文名
attendanceTeacherEName string └└ 考勤老师英文名
createAt datetime └└ 创建时间。时间格式示例：2020-01-01 00:00:00
totalCount integer └└ 总记录数
normalCount integer └└ 出勤人数
absenceFromDutyCount integer └└ 缺勤人数
comeLateCount integer └└ 迟到人数
leaveEarlyCount integer └└ 早退人数
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);

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

返回示例：

{
  "data": {
    "totalCount": "@integer(60, 100)",
    "currentIndex": "@integer(60, 100)",
    "itemCount": "@integer(60, 100)",
    "list": [
      {
        "attendanceRecordId": "@integer(60, 100)",
        "classId": "@integer(60, 100)",
        "className": "@string",
        "classEName": "@string",
        "classType": 0,
        "gradeCode": 0,
        "activityId": "@integer(60, 100)",
        "activityName": "@string",
        "activityEName": "@string",
        "activityBeginTime": "@datetime",
        "activityEndTime": "@datetime",
        "isAllDay": "@boolean",
        "attendanceTeacherId": "@integer(60, 100)",
        "attendanceTeacherName": "@string",
        "attendanceTeacherEName": "@string",
        "createAt": "@datetime",
        "totalCount": "@integer(60, 100)",
        "normalCount": "@integer(60, 100)",
        "absenceFromDutyCount": "@integer(60, 100)",
        "comeLateCount": "@integer(60, 100)",
        "leaveEarlyCount": "@integer(60, 100)"
      }
    ]
  },
  "msgCN": "@string",
  "msgEN": "@string",
  "state": 0,
  "msg": "@string"
}

# 获取活动考勤记录详情

# 接口名称 :

GetActivityAttendanceRecordDetail

# 接口说明 :

通过活动考勤记录Id，获取活动考勤记录详情信息

请求地址：

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

请求参数：

参数名 是否必填 参数类型 参数描述
id 是 integer 活动考勤记录Id，必填

返回参数：

参数名 类型 说明
data array 返回数据信息
studentInfoId integer └ 学生Id
studentCName string └ 学生中文名
studentEName string └ 学生英文名
attendanceState integer └ 考勤状态，0表示出勤，1表示迟到，2表示早退，3表示缺勤，6表示用餐，7表示不用餐，8表示离校，9表示未离校
isExcused boolean └ 是否请假
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);

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

返回示例：

{
  "data": [
    {
      "studentInfoId": "@integer(60, 100)",
      "studentCName": "@string",
      "studentEName": "@string",
      "attendanceState": 0,
      "isExcused": "@boolean",
      "remark": "@string"
    }
  ],
  "msgCN": "@string",
  "msgEN": "@string",
  "state": 0,
  "msg": "@string"
}

# 获取用餐考勤记录列表

# 接口名称 :

GetMealAttendanceRecordList

# 接口说明 :

通过时间范围，获取用餐考勤记录列表

请求地址：

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

请求参数：

参数名 是否必填 参数类型 参数描述
beginDate 是 datetime 开始日期，必填，时间格式示例：2020-01-01 00:00:00
endDate 是 datetime 结束日期，必填，时间格式示例：2020-01-01 00:00:00
classIds 否 array 班级Ids，选填，如果不填，返回全部
pageIndex 否 integer 页码，选填，如果不填，默认为1
pageSize 否 integer 页容量，选填，如果不填，默认为1000，最大为1000

返回参数：

参数名 类型 说明
data object 返回数据信息
totalCount integer └ 总记录数
currentIndex integer └ 当前页码
itemCount integer └ 返回的记录数
list array └ 返回数据列表
attendanceRecordId integer └└ 考勤记录id
classId integer └└ 班级id
className string └└ 班级中文名
classEName string └└ 班级英文名
classType integer └└ 班级类型，1表示行政班，2表示选修班
gradeCode integer └└ 班级年级，选修班时年级为-2
attendanceDate datetime └└ 考勤日期。时间格式示例：2020-01-01 00:00:00
attendanceTeacherId integer └└ 考勤老师Id
attendanceTeacherName string └└ 考勤老师中文名
attendanceTeacherEName string └└ 考勤老师英文名
createAt datetime └└ 创建时间。时间格式示例：2020-01-01 00:00:00
totalCount integer └└ 总记录数
haveBeenDinedCount integer └└ 用餐人数
notHaveDinnerCount integer └└ 不用餐人数
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);

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

返回示例：

{
  "data": {
    "totalCount": "@integer(60, 100)",
    "currentIndex": "@integer(60, 100)",
    "itemCount": "@integer(60, 100)",
    "list": [
      {
        "attendanceRecordId": "@integer(60, 100)",
        "classId": "@integer(60, 100)",
        "className": "@string",
        "classEName": "@string",
        "classType": 0,
        "gradeCode": 0,
        "attendanceDate": "@datetime",
        "attendanceTeacherId": "@integer(60, 100)",
        "attendanceTeacherName": "@string",
        "attendanceTeacherEName": "@string",
        "createAt": "@datetime",
        "totalCount": "@integer(60, 100)",
        "haveBeenDinedCount": "@integer(60, 100)",
        "notHaveDinnerCount": "@integer(60, 100)"
      }
    ]
  },
  "msgCN": "@string",
  "msgEN": "@string",
  "state": 0,
  "msg": "@string"
}

# 获取用餐考勤记录详情

# 接口名称 :

GetMealAttendanceRecordDetail

# 接口说明 :

通过用餐考勤记录Id，获取用餐考勤记录详情信息

请求地址：

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

请求参数：

参数名 是否必填 参数类型 参数描述
id 是 integer 用餐考勤记录Id，必填

返回参数：

参数名 类型 说明
data array 返回数据信息
studentInfoId integer └ 学生Id
studentCName string └ 学生中文名
studentEName string └ 学生英文名
attendanceState integer └ 考勤状态，0表示出勤，1表示迟到，2表示早退，3表示缺勤，6表示用餐，7表示不用餐，8表示离校，9表示未离校
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);

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

返回示例：

{
  "data": [
    {
      "studentInfoId": "@integer(60, 100)",
      "studentCName": "@string",
      "studentEName": "@string",
      "attendanceState": 0,
      "remark": "@string"
    }
  ],
  "msgCN": "@string",
  "msgEN": "@string",
  "state": 0,
  "msg": "@string"
}

← 请假 →