熵基智联
2022-09-14
目录

教职工管理

# 创建教职工

创建一个教职工信息

请求方式 ：POST

请求地址 ：https://api.zkbiocloud.com/open/edu/school/basic/v1/faculty/save

请求数据

header域

入参名称 入参类型 默认值 必填 入参说明
Content-Type String application/json 是 指定请求的媒体类型
Authorization String 是 令牌，详见令牌说明

body域

{
    "payload": {
        "params": {
            "departmentId": "239399281d1b472ba663173eaeb92e3b",
            "facultyName": "张三丰",
            "facultyCardNumber": "9999",
            "facultyMobilePhone": "15999999999",
            "facultyEmail": "",
            "facultyCardNo": "",
            "facultyIdCard": "",
            "facultyGender": 0,
            "facultyAvatarUrl": ""
        }
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

入参说明

入参名称 入参类型 参数长度 默认值 必填 入参说明
departmentId String 32 是 所属部门ID（32位的uuid）
facultyName String 100 是 姓名
facultyCardNumber String 50 是 学工号，只支持数字或字母
facultyMobilePhone String 11 否 手机号，15999999999-11位
facultyEmail String 50 否 邮箱
facultyCardNo String 10 否 卡号
facultyIdCard String 18 否 身份证，中国的身份证号18位
facultyGender Integer 1 0 否 性别，0-未知；1-男；2-女
facultyAvatarUrl String 255 否 头像URL

返回结果

{
    "code": "00000000",
    "payload": {
        "results": {
            "facultyId": "239399281d1b472ba663173eaeb92e3b"
        }
    }
}
1
2
3
4
5
6
7
8

出参说明

出参名称 出参类型 出参说明
code String 响应返回码
facultyId String 教职工ID（32位的uuid）

# 删除教职工

用于删除指定一个或多个教职工信息

请求方式：POST

请求地址：https://api.zkbiocloud.com/open/edu/school/basic/v1/faculty/delete

请求数据

header域

入参名称 入参类型 默认值 必填 入参说明
Content-Type String application/json 是 指定请求的媒体类型
Authorization String 是 令牌，详见令牌说明

body域

{
    "payload": {
        "params": {
            "facultyIds": [
                "bd3ffc623e364d82a8e493382ed4a0cc"
            ]
        }
    }
}
1
2
3
4
5
6
7
8
9

入参说明

入参名称 入参类型 参数长度 默认值 是否必填 入参说明
facultyIds List 32 是 教职工ID（32位的uuid）

返回结果

{
    "code": "00000000",
    "message": "success"
}
1
2
3
4

出参说明

出参名称 出参类型 出参说明
code String 响应返回码
message String 成功响应消息内容

# 更新教职工

修改指定一个教职工基本信息

请求方式 ：POST

请求地址 ：https://api.zkbiocloud.com/open/edu/school/basic/v1/faculty/update

请求数据

header域

入参名称 入参类型 默认值 必填 入参说明
Content-Type String application/json 是 指定请求的媒体类型
Authorization String 是 令牌，详见令牌说明

body域

{
    "payload": {
        "params": {
            "facultyId": "bd3ffc623e364d82a8e493382ed4a0cc",
            "facultyName": "张三丰",
            "facultyMobilePhone": "15999999999",
            "facultyEmail": "",
            "facultyCardNo": "",
            "facultyIdCard": "",
            "facultyGender": 0,
            "facultyAvatarUrl": ""
        }
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

入参说明

入参名称 入参类型 参数长度 默认值 必填 入参说明
facultyId String 32 是 教职工ID（32位的uuid）
facultyName String 100 是 姓名
facultyMobilePhone String 11 否 手机号，15999999999-11位
facultyEmail String 50 否 邮箱
facultyCardNo String 10 否 卡号
facultyIdCard String 18 否 身份证，中国的身份证号18位
facultyGender Integer 1 0 否 性别，0-未知；1-男；2-女
facultyAvatarUrl String 255 否 头像URL

返回结果

{
    "code": "00000000",
    "message": "success"
}
1
2
3
4

出参说明

出参名称 出参类型 出参说明
code String 响应返回码
message String 成功响应消息内容

# 同步教职工

批量创建、删除和更新教职工信息

请求方式 ：POST

请求地址 ：https://api.zkbiocloud.com/open/edu/school/basic/v1/faculty/synchronize

请求数据

header域

入参名称 入参类型 默认值 必填 入参说明
Content-Type String application/json 是 指定请求的媒体类型
Authorization String 是 令牌，详见令牌说明

body域

{
    "payload": {
        "params": {
        	"faculties": [
        		{
        			"seqId": "1",
        			"event": "saveOrUpdate",
					"departmentId": "239399281d1b472ba663173eaeb92e3b",
        			"facultyId": "1",
                    "facultyName": "张三丰",
                    "facultyCardNumber": "1",
                    "facultyMobilePhone": "15999999999",
                    "facultyEmail": "",
                    "facultyCardNo": "",
                    "facultyIdCard": "",
                    "facultyGender": 0,
                    "facultyAvatarUrl": ""
        		}, {
        			"seqId": "2",
        			"event": "saveOrUpdate",
        			"facultyId": "2",
                    "facultyName": "张美团",
                    "facultyCardNumber": "2",
                    "facultyMobilePhone": "15999999999",
                    "facultyEmail": "",
                    "facultyCardNo": "",
                    "facultyIdCard": "",
                    "facultyGender": 0,
                    "facultyAvatarUrl": ""
        		}, {
        			"seqId": "3",
        			"event": "delete",
        			"facultyId": "3"
        		}
        	]
        }
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

入参说明

入参名称 入参类型 参数长度 默认值 必填 入参说明
faculties List 是 教职工集合（最大支持100）
seqId String 32 是 流水号
event String 20 是 事件（saveOrUpdate/delete）
departmentId String 32 所属部门ID（32位的uuid），保存时，所属部门必填；更新时，所属部门非必填
facultyId String 32 教职工ID（32位的uuid），保存是，非必填；更新时，必填
facultyName String 100 是 姓名
facultyCardNumber String 50 是 学工号，只支持数字或字母
facultyMobilePhone String 11 否 手机号，15999999999-11位
facultyEmail String 50 否 邮箱
facultyCardNo String 10 否 卡号
facultyIdCard String 18 否 身份证，中国的身份证号18位
facultyGender Integer 1 0 否 性别，0-未知；1-男；2-女
facultyAvatarUrl String 255 否 头像URL

返回结果

{
    "code": "00000000",
    "payload": {
        "results": [
        	{
        		"code": "00000000",
        		"mid": "1",
            	"payload": {
                    "results": {
                        "facultyId": "1"
                    }
                }
        	}, {
        		"code": "00000000",
        		"mid": "2",
        		"message": "success"
        	}, {
        		"code": "00000000",
        		"mid": "3",
        		"message": "success"
        	}
        ]
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

出参说明

出参名称 出参类型 出参说明
code String 响应返回码
facultyId String 教职工ID（32位的uuid）
message String 成功响应消息内容

# 校验教职工人脸照片

用于校验第三方系统中的人脸信息是否符合熵基系统后台教职工人脸信息（支持https/http链接 ，图片格式需为jpg或png格式）

请求方式：POST

请求地址：https://api.zkbiocloud.com/open/edu/backbone/basic/v1/person/facePhoto/check

请求数据

header域

入参名称 入参类型 默认值 必填 入参说明
Content-Type String application/json 是 指定请求的媒体类型
Authorization String 是 令牌，详见令牌说明

body域

{
    "payload": {
        "params": {
            "deleteFlag": 0,
            "facePhotoUrl": "https://....."
        }
    }
}
1
2
3
4
5
6
7
8

入参说明

入参名称 入参类型 参数长度 默认值 是否必填 入参说明
deleteFlag Integer 是 删除标记，0表示不删除，1表示删除
facePhotoUrl String 是 人脸照片Url，只支持https且图片格式为jpg或png

返回结果

{
    "code": "00000000",
    "message": "success",
    "payload": {
        "results": {
            "facePhotoUrl": "/croped/1755135915-162313.jpg"
        }
    }
}
1
2
3
4
5
6
7
8
9

出参说明

出参名称 出参类型 出参说明
code String 响应返回码
message String 成功响应消息内容

# 同步教职工人脸照片

用于将第三方系统中的人脸信息同步至熵基系统后台教职工人脸信息（支持https/http链接 ，图片格式需为jpg或png格式）

请求方式：POST

请求地址：https://api.zkbiocloud.com/open/edu/school/basic/v1/faculty/face/photo/synchronize

请求数据

header域

入参名称 入参类型 默认值 必填 入参说明
Content-Type String application/json 是 指定请求的媒体类型
Authorization String 是 令牌，详见令牌说明

body域

{
    "payload": {
        "params": {
            "cardNumber": "1",
            "facePhotoUrl": "https://....."
        }
    }
}
1
2
3
4
5
6
7
8

入参说明

入参名称 入参类型 参数长度 默认值 是否必填 入参说明
cardNumber String 50 是 学工号，只支持数字或字母
facePhotoUrl String 是 人脸照片Url，只支持https且图片格式为jpg或png

返回结果

{
    "code": "00000000",
    "message": "success"
}
1
2
3
4

出参说明

出参名称 出参类型 出参说明
code String 响应返回码
message String 成功响应消息内容

# 移除教职工人脸照片

用于删除指定教职工人脸信息

请求方式：POST

请求地址：https://api.zkbiocloud.com/open/edu/school/basic/v1/faculty/face/photo/remove

请求数据

header域

入参名称 入参类型 默认值 必填 入参说明
Content-Type String application/json 是 指定请求的媒体类型
Authorization String 是 令牌，详见令牌说明

body域

{
    "payload": {
        "params": {
            "facultyId": "1"
        }
    }
}
1
2
3
4
5
6
7

入参说明

入参名称 入参类型 参数长度 默认值 是否必填 入参说明
facultyId String 32 是 教职工ID（32位的uuid）

返回结果

{
    "code": "00000000",
    "message": "success"
}
1
2
3
4

出参说明

出参名称 出参类型 出参说明
code String 响应返回码
message String 成功响应消息内容

# 调整教职工部门

用于对教职工所属部门进行调整

请求方式：POST

请求地址：https://api.zkbiocloud.com/open/edu/school/basic/v1/faculty/adjust

请求数据

header域

入参名称 入参类型 默认值 必填 入参说明
Content-Type String application/json 是 指定请求的媒体类型
Authorization String 是 令牌，详见令牌说明

body域

{
    "payload": {
        "params": {
            "facultyIds": [
            	"bd3ffc623e364d82a8e493382ed4a0cc"    
            ],
            "departmentId": "239399281d1b472ba663173eaeb92e3b"
        }
    }
}
1
2
3
4
5
6
7
8
9
10

入参说明

入参名称 入参类型 参数长度 默认值 是否必填 入参说明
facultyIds List 是 教职工ID列表（32位的uuid），List的size最大支持100
departmentId String 32 是 部门ID（32位的uuid）

返回结果

{
    "code": "00000000",
    "message": "success"
}
1
2
3
4

出参说明

出参名称 出参类型 出参说明
code String 响应返回码
message String 成功响应消息内容

# 绑定或解绑教职工标签

用于对教职工的标签进行绑定或解绑

请求方式：POST

请求地址：https://api.zkbiocloud.com/open/edu/school/basic/v1/tag2faculty/update

请求数据

header域

入参名称 入参类型 默认值 必填 入参说明
Content-Type String application/json 是 指定请求的媒体类型
Authorization String 是 令牌，详见令牌说明

body域

{
    "payload": {
        "params": {
            "bindFacultyIds": [
                "bd3ffc623e364d82a8e493382ed4a0cc"    
            ],
            "unbindFacultyIds": [
                "239399281d1b472ba663173eaeb92e3b"    
            ],
            "tagId": "239399281d1b472ba663173eaeb92e3b"
        }
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13

入参说明

入参名称 入参类型 参数长度 默认值 是否必填 入参说明
bindFacultyIds List 否 绑定教职工ID列表（32位的uuid），List的size最大支持100
unbindFacultyIds List 否 解绑教职工ID列表（32位的uuid），List的size最大支持100
tagId String 32 是 标签ID（32位的uuid）

返回结果

{
    "code": "00000000",
    "message": "success"
}
1
2
3
4

出参说明

出参名称 出参类型 出参说明
code String 响应返回码
message String 成功响应消息内容

# 读取教职工

获取指定一个教职工基本信息

请求方式：POST

请求地址：https://api.zkbiocloud.com/open/edu/school/basic/v1/faculty/get

请求数据

header域

入参名称 入参类型 默认值 必填 入参说明
Content-Type String application/json 是 指定请求的媒体类型
Authorization String 是 令牌，详见令牌说明

body域

{
    "payload": {
        "params": {
            "facultyId": "bd3ffc623e364d82a8e493382ed4a0cc"
        }
    }
}
1
2
3
4
5
6
7

入参说明

入参名称 入参类型 参数长度 默认值 是否必填 入参说明
facultyId String 是 教职工ID（32位的uuid）

返回结果

{
    "code": "00000000",
    "payload": {
        "results": {
            "name": "丁兵娟",
            "cardNumber": "622424199312101144",
            "gender": 0,
            "mobilePhone": "15087212114",
            "email": "",
            "idCard": "622424199312101144",
            "cardNo": "",
            "departmentName": "OUR",
            "facePhotoFlag": 0
        }
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

出参说明

出参名称 出参类型 出参说明
code String 响应返回码
name String 姓名
cardNumber String 学工号
gender Integer 性别，0-未知；1-男；2-女
mobilePhone String 手机号，15999999999-11位
email String 邮箱
idCard String 身份证，中国的身份证号18位
cardNo String 卡号
departmentName String 所属部门名称
facePhotoFlag Integer 人脸照片标记，0-未录入；1-已录入

# 查询教职工分页

分页查询一批次的教职工基本信息

请求方式：POST

请求地址：https://api.zkbiocloud.com/open/edu/school/basic/v1/faculty/page

请求数据

header域

入参名称 入参类型 默认值 必填 入参说明
Content-Type String application/json 是 指定请求的媒体类型
Authorization String 是 令牌，详见令牌说明

body域

{
    "payload": {
        "curPage": 1,
        "pageSize": 10,
        "params": {}
    }
}
1
2
3
4
5
6
7

入参说明

入参名称 入参类型 参数长度 默认值 是否必填 入参说明
curPage Integer 是 当前页数，最小值1
pageSize Integer 是 分页量，最小值10，最大值100

返回结果

{
    "code": "00000000",
    "payload": {
        "results": {
            "pagination": {
                "total": 1,
                "curPage": 1,
                "pageSize": 10
            },
            "list": [
                {
                    "facultyId": "e0c78e4030494e758924a1e01e33d329",
                    "facultyCardNumber": "723871",
                    "facultyName": "张小明",
                    "facultyGender": 0,
                    "facultyMobilePhone": "15767891234",
                    "facultyCardNo": "",
                    "facultyIdCard": "",
                    "facultyEmail": "",
                    "departmentId": "1",
                    "departmentName": "测试API专用主体二"
                }
            ]
        }
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

出参说明

出参名称 出参类型 出参说明
code String 响应返回码
facultyName String 姓名
facultyCardNumber String 学工号
facultyGender Integer 性别，0-未知；1-男；2-女
facultyMobilePhone String 手机号，15999999999-11位
facultyEmail String 邮箱
facultyIdCard String 身份证，中国的身份证号18位
facultyCardNo String 卡号
departmentId String 所属部门主键
departmentName String 所属部门名称
facePhotoFlag Integer 人脸照片标记，0-未录入；1-已录入
标签管理
请假外出记录管理

← 请假外出记录管理→

最近更新
01
记录快照管理
09-28
02
请假外出记录管理
06-14
03
部门管理
09-14
更多文章>
Theme by Vdoing | Copyright © -2025 熵基智联 | Copyright © 2021 ZKTECO CO., LTD. All rights reserved.