# 请假

# 获取学生请假记录列表

# 接口名称 :

GetSchoolStudentLeaveRecordList

# 接口说明 :

通过时间范围，获取学生请假记录列表

请求地址：

HTTP：https://openplatform-api.xiaobao100.com/open-platform/Attendance/v2/GetSchoolStudentLeaveRecordList (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	└ 返回数据列表
leaveType	integer	└└ 请假类型，1表示事假，2表示病假
studentCName	string	└└ 学生中文名
studentEName	string	└└ 学生英文名
leaveRecordId	integer	└└ 请假记录Id
studentInfoId	integer	└└ 学生Id
beginTime	datetime	└└ 请假开始时间。时间格式示例：2020-01-01 00:00:00
endTime	datetime	└└ 请假结束时间。时间格式示例：2020-01-01 00:00:00
reason	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.getSchoolStudentLeaveRecordList(parameter [, parameter1, parameter2...])

返回示例：

{
  "data": {
    "totalCount": "@integer(60, 100)",
    "currentIndex": "@integer(60, 100)",
    "itemCount": "@integer(60, 100)",
    "list": [
      {
        "leaveType": 1,
        "studentCName": "@string",
        "studentEName": "@string",
        "leaveRecordId": "@integer(60, 100)",
        "studentInfoId": "@integer(60, 100)",
        "beginTime": "@datetime",
        "endTime": "@datetime",
        "reason": "@string"
      }
    ]
  },
  "msgCN": "@string",
  "msgEN": "@string",
  "state": 0,
  "msg": "@string"
}

# 获取学生销假记录列表

# 接口名称 :

GetSchoolStudentCancelLeaveRecordList

# 接口说明 :

通过时间范围，获取学生销假记录列表

请求地址：

HTTP：https://openplatform-api.xiaobao100.com/open-platform/Attendance/v2/GetSchoolStudentCancelLeaveRecordList (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	└ 返回数据列表
leaveRecordId	integer	└└ 请假记录Id
studentInfoId	integer	└└ 学生Id
reason	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.getSchoolStudentCancelLeaveRecordList(parameter [, parameter1, parameter2...])

返回示例：

{
  "data": {
    "totalCount": "@integer(60, 100)",
    "currentIndex": "@integer(60, 100)",
    "itemCount": "@integer(60, 100)",
    "list": [
      {
        "leaveRecordId": "@integer(60, 100)",
        "studentInfoId": "@integer(60, 100)",
        "reason": "@string"
      }
    ]
  },
  "msgCN": "@string",
  "msgEN": "@string",
  "state": 0,
  "msg": "@string"
}

# 获取学生请假详情

# 接口名称 :

GetLeaveRecord

# 接口说明 :

通过请假记录Id，获取学生请假详情

请求地址：

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

请求参数：

参数名	是否必填	参数类型	参数描述
leaveRecordId	是	integer	请假记录Id，必填

返回参数：

参数名	类型	说明
data	object	返回数据信息
leaveRecordId	integer	└ 请假记录Id
studentInfoId	integer	└ 学生Id
studentCName	string	└ 学生中文名
studentEName	string	└ 学生英文名
beginTime	datetime	└ 请假开始时间。时间格式示例：2020-01-01 00:00:00
endTime	datetime	└ 请假结束时间。时间格式示例：2020-01-01 00:00:00
leaveType	integer	└ 请假类型，1表示事假，2表示病假
reason	string	└ 请假理由
isNeedInOrOutOfSchool	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);

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

返回示例：

{
  "data": {
    "leaveRecordId": "@integer(60, 100)",
    "studentInfoId": "@integer(60, 100)",
    "studentCName": "@string",
    "studentEName": "@string",
    "beginTime": "@datetime",
    "endTime": "@datetime",
    "leaveType": 1,
    "reason": "@string",
    "isNeedInOrOutOfSchool": "@boolean"
  },
  "msgCN": "@string",
  "msgEN": "@string",
  "state": 0,
  "msg": "@string"
}

# 获取学生销假详情

# 接口名称 :

GetCancelLeaveRecord

# 接口说明 :

通过请假记录Id，获取学生销假详情

请求地址：

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

请求参数：

参数名	是否必填	参数类型	参数描述
leaveRecordId	是	integer	请假记录Id，必填

返回参数：

参数名	类型	说明
data	object	返回数据信息
leaveRecordId	integer	└ 请假记录Id
studentInfoId	integer	└ 学生Id
reason	string	└ 销假理由
isNeedInOrOutOfSchool	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);

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

返回示例：

{
  "data": {
    "leaveRecordId": "@integer(60, 100)",
    "studentInfoId": "@integer(60, 100)",
    "reason": "@string",
    "isNeedInOrOutOfSchool": "@boolean"
  },
  "msgCN": "@string",
  "msgEN": "@string",
  "state": 0,
  "msg": "@string"
}

← 考勤公告通知 →