消息事件定义
# 变更部门信息
应用接入后，部门变更事件会以数据推送形式通知应用。
{
"requestId": "XXX",
"eventCode": "event.basic.changeDept",
"encryptData": "..."
}
1
2
3
4
5
2
3
4
5
encryptData解密后原始数据
{
"unitId": "9c601040e1a0494698d1f6467e34490a",
"event": "addDept",
"data": {
"departmentId": "aaff452c3fdd49538afab9556f580eda",
"departmentName": "保安室",
"departmentFullName": "新亭小学/保安室",
"departmentParentId": "1"
}
}
1
2
3
4
5
6
7
8
9
10
2
3
4
5
6
7
8
9
10
encryptData字段说明
| 字段 | 必填 | 说明 |
|---|---|---|
| unitId | 是 | 主体ID（32位的uuid） |
| event | 是 | 事件类型： addDept-新增部门； deleteDept-删除部门； updateDept-更新部门 |
| data | 是 | 变更数据 |
data字段说明
| 字段 | 必填 | 说明 |
|---|---|---|
| departmentId | 是 | 部门ID（32位的uuid） |
| departmentName | 否 | 部门名称（需授权） |
| departmentFullName | 否 | 部门父级到该级的全部名称（需授权） |
| departmentParentId | 是 | 部门父级ID（32位的uuid） |
# 变更教职工信息
应用接入后，教职工变更事件会以数据推送形式通知应用。
{
"requestId": "XXX",
"eventCode": "event.basic.changeFaculty",
"encryptData": "..."
}
1
2
3
4
5
2
3
4
5
encryptData解密后原始数据
{
"unitId": "9c601040e1a0494698d1f6467e34490a",
"event": "addFaculty",
"data": {
"facultyId": "e0c78e4030494e758924a1e01e33d329",
"facultyCardNumber": "723871",
"facultyName": "张小明",
"facultyGender": 0,
"facultyMobilePhone": "15767891234",
"facultyCardNo": "",
"facultyIdCard": "",
"facultyEmail": "",
"departmentId": "1"
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
2
3
4
5
6
7
8
9
10
11
12
13
14
15
encryptData字段说明
| 字段 | 必填 | 说明 |
|---|---|---|
| unitId | 是 | 主体ID（32位的uuid） |
| event | 是 | 事件类型： addFaculty-新增教职工； deleteFaculty-删除教职工； updateFaculty-更新教职工 |
| data | 是 | 变更数据 |
data字段说明
| 字段 | 必填 | 说明 |
|---|---|---|
| facultyId | 是 | 教职工ID（32位的uuid） |
| facultyCardNumber | 是 | 教职工学工号（需授权） |
| facultyName | 否 | 教职工姓名（需授权） |
| facultyGender | 是 | 教职工性别（需授权），0-未知；1-男；2-女 |
| facultyMobilePhone | 否 | 教职工手机号（需授权） |
| facultyCardNo | 否 | 教职工卡号（需授权） |
| facultyIdCard | 否 | 教职工身份证（需授权） |
| facultyEmail | 否 | 教职工邮箱（需授权） |
| departmentId | 是 | 部门ID（32位的uuid） |
# 变更校区信息
应用接入后，校区变更事件会以数据推送形式通知应用。
{
"requestId": "XXX",
"eventCode": "event.basic.changeCampus",
"encryptData": "..."
}
1
2
3
4
5
2
3
4
5
encryptData解密后原始数据
{
"unitId": "9c601040e1a0494698d1f6467e34490a",
"event": "addCampus",
"data": {
"campusId": "4a1d0125afa54e88b75abc60c39d3eec",
"campusNum": 0,
"campusName": "默认校区"
}
}
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
encryptData字段说明
| 字段 | 必填 | 说明 |
|---|---|---|
| unitId | 是 | 主体ID（32位的uuid） |
| event | 是 | 事件类型： addCampus-新增校区； deleteCampus-删除校区； updateCampus-更新校区 |
| data | 是 | 变更数据 |
data字段说明
| 字段 | 必填 | 说明 |
|---|---|---|
| campusId | 是 | 校区ID（32位的uuid） |
| campusNum | 是 | 校区序号，从0开始 |
| campusName | 是 | 校区名称 |
# 变更学段信息
应用接入后，学段变更事件会以数据推送形式通知应用。
{
"requestId": "XXX",
"eventCode": "event.basic.changePeriod",
"encryptData": "..."
}
1
2
3
4
5
2
3
4
5
encryptData解密后原始数据
{
"unitId": "9c601040e1a0494698d1f6467e34490a",
"event": "addPeriod",
"data": {
"periodId": "e4d35280afc847999a57437eea226683",
"periodNum": 2,
"periodName": "小学",
"periodStatus": 1,
"campusId": "4a1d0125afa54e88b75abc60c39d3eec"
}
}
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
encryptData字段说明
| 字段 | 必填 | 说明 |
|---|---|---|
| unitId | 是 | 主体ID（32位的uuid） |
| event | 是 | 事件类型： addPeriod-新增学段； deletePeriod-删除学段； updatePeriod-更新学段 |
| data | 是 | 变更数据 |
data字段说明
| 字段 | 必填 | 说明 |
|---|---|---|
| periodId | 是 | 学段ID（32位的uuid） |
| periodNum | 是 | 学段序号，从1开始 |
| periodName | 是 | 学段名称 |
| periodStatus | 是 | 学段状态，0-禁用；1-启用 |
| campusId | 是 | 校区ID（32位的uuid） |
# 变更年级信息
应用接入后，年级变更事件会以数据推送形式通知应用。
{
"requestId": "XXX",
"eventCode": "event.basic.changeGrade",
"encryptData": "..."
}
1
2
3
4
5
2
3
4
5
encryptData解密后原始数据
{
"unitId": "9c601040e1a0494698d1f6467e34490a",
"event": "addGrade",
"data": {
"gradeId": "7cf4a71c372b4b0d960ce27253442d7e",
"gradeNum": 1,
"gradeName": "一年级",
"periodId": "e4d35280afc847999a57437eea226683",
"campusId": "4a1d0125afa54e88b75abc60c39d3eec"
}
}
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
encryptData字段说明
| 字段 | 必填 | 说明 |
|---|---|---|
| unitId | 是 | 主体ID（32位的uuid） |
| event | 是 | 事件类型： addGrade-新增年级； deleteGrade-删除年级； updateGrade-更新年级 |
| data | 是 | 变更数据 |
data字段说明
| 字段 | 必填 | 说明 |
|---|---|---|
| gradeId | 是 | 年级ID（32位的uuid） |
| gradeNum | 是 | 年级序号，从1开始 |
| gradeName | 是 | 年级名称 |
| periodId | 是 | 学段ID（32位的uuid） |
| campusId | 是 | 校区ID（32位的uuid） |
# 变更班级信息
应用接入后，班级变更事件会以数据推送形式通知应用。
{
"requestId": "XXX",
"eventCode": "event.basic.changeClass",
"encryptData": "..."
}
1
2
3
4
5
2
3
4
5
encryptData解密后原始数据
{
"unitId": "9c601040e1a0494698d1f6467e34490a",
"event": "addClass",
"data": {
"classId": "dbc5e40bbd894a12ba886ffb1bcb38e5",
"classNum": 1,
"className": "二年级(1)班",
"registerYear": 2023,
"nomenclature": 0,
"gradeId": "3f1327f60d324780abe1caccbe0ee5b8",
"periodId": "e4d35280afc847999a57437eea226683",
"campusId": "4a1d0125afa54e88b75abc60c39d3eec"
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
2
3
4
5
6
7
8
9
10
11
12
13
14
encryptData字段说明
| 字段 | 必填 | 说明 |
|---|---|---|
| unitId | 是 | 主体ID（32位的uuid） |
| event | 是 | 事件类型： addClass-新增班级； deleteClass-删除班级； updateClass-更新班级 |
| data | 是 | 变更数据 |
data字段说明
| 字段 | 必填 | 说明 |
|---|---|---|
| classId | 是 | 班级ID（32位的uuid） |
| classNum | 是 | 班级序号，从1开始 |
| className | 是 | 班级名称（需授权） |
| registerYear | 是 | 入学年份 |
| nomenclature | 是 | 命名方式，0-自动；1-自定义 |
| gradeId | 是 | 年级ID（32位的uuid） |
| periodId | 是 | 学段ID（32位的uuid） |
| campusId | 是 | 校区ID（32位的uuid） |
# 变更学生信息
应用接入后，学生变更事件会以数据推送形式通知应用。
{
"requestId": "XXX",
"eventCode": "event.basic.changeStudent",
"encryptData": "..."
}
1
2
3
4
5
2
3
4
5
encryptData解密后原始数据
{
"unitId": "9c601040e1a0494698d1f6467e34490a",
"event": "addStudent",
"data": {
"studentId": "e0c78e4030494e758924a1e01e33d329",
"studentCardNumber": "723871",
"studentName": "张小明",
"studentGender": 0,
"studentMobilePhone": "15767891234",
"studentCardNo": "",
"studentIdCard": "",
"studentEmail": "",
"classId": "dbc5e40bbd894a12ba886ffb1bcb38e5",
"gradeId": "3f1327f60d324780abe1caccbe0ee5b8",
"periodId": "e4d35280afc847999a57437eea226683",
"campusId": "4a1d0125afa54e88b75abc60c39d3eec"
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
encryptData字段说明
| 字段 | 必填 | 说明 |
|---|---|---|
| unitId | 是 | 主体ID（32位的uuid） |
| event | 是 | 事件类型： addStudent-新增学生； deleteStudent-删除学生； updateStudent-更新学生 |
| data | 是 | 变更数据 |
data字段说明
| 字段 | 必填 | 说明 |
|---|---|---|
| studentId | 是 | 学生ID（32位的uuid） |
| studentCardNumber | 是 | 学生学工号（需授权） |
| studentName | 否 | 学生姓名（需授权） |
| studentGender | 否 | 学生性别（需授权），0-未知；1-男；2-女 |
| studentMobilePhone | 否 | 学生手机号（需授权） |
| studentCardNo | 否 | 学生卡号（需授权） |
| studentIdCard | 否 | 学生身份证（需授权） |
| studentEmail | 否 | 学生邮箱（需授权） |
| classId | 是 | 班级ID（32位的uuid） |
| gradeId | 是 | 年级ID（32位的uuid） |
| periodId | 是 | 学段ID（32位的uuid） |
| campusId | 是 | 校区ID（32位的uuid） |
# 变更人脸照片信息
应用接入后，人脸照片变更事件会以数据推送形式通知应用。
{
"requestId": "XXX",
"eventCode": "event.basic.changeFacePhoto",
"encryptData": "..."
}
1
2
3
4
5
2
3
4
5
encryptData解密后原始数据
{
"unitId": "9c601040e1a0494698d1f6467e34490a",
"event": "addFacePhoto",
"data": {
"id": "03cd37b614c04f23835a04a6dd358505",
"no": "XT002",
"facePhotoUrl": "https://zk-ddopen-bucket-dev-1257511866.cos.ap-guangzhou.myqcloud.com/image/9c601040e1a0494698d1f6467e34490a/52c50eeadceadf2d2d147d5d50a619f8.jpg"
}
}
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
encryptData字段说明
| 字段 | 必填 | 说明 |
|---|---|---|
| unitId | 是 | 主体ID（32位的uuid） |
| event | 是 | 事件类型： addFacePhoto-新增人脸照片； deleteFacePhoto-删除人脸照片； updateFacePhoto-更新人脸照片 |
| data | 是 | 变更数据 |
data字段说明
| 字段 | 必填 | 说明 |
|---|---|---|
| id | 是 | 人员ID（32位的uuid） |
| no | 是 | 人员工号（需授权） |
| facePhotoUrl | 是 | 人脸照片网址（需授权） |