熵基智联 熵基智联
首页
  • 平台介绍
  • 快速入门
  • 开发指南
  • 开通熵基智联
  • API列表
  • 附录
首页
  • 平台介绍
  • 快速入门
  • 开发指南
  • 开通熵基智联
  • API列表
  • 附录
  • 产品概述
  • 快速入门

  • 开发指南

  • 应用操作

  • API列表

    • 基础服务能力

      • 主体信息
      • 部门信息
      • 教职工信息
      • 校区学段年级班级信息
        • 查询校区信息
        • 查询学段信息
        • 查询年级信息
        • 查询班级信息
        • 查询班级树型信息
      • 学生信息
      • 人脸照片信息
      • 上报消息
    • 消息推送能力

    • 第三方登录

  • 附录

  • 文档
  • API列表
  • 基础服务能力
2023-06-14
目录

校区学段年级班级信息

# 查询校区信息

查询所有校区基本信息

请求方式 :POST

请求地址 :https://api.zkbiocloud.com/open/edu/school/basic/v1/campus/info/list

请求数据

header域

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

body域

{
    "payload": {
        "params": {}
    }
}
1
2
3
4
5

入参说明

入参名称 入参类型 参数长度 默认值 必填 入参说明

返回结果

{
    "code": "00000000",
    "payload": {
        "results": [
            {
                "campusId": "4a1d0125afa54e88b75abc60c39d3eec",
                "campusNum": 0,
                "campusName": "默认校区"
            }
        ]
    }
}
1
2
3
4
5
6
7
8
9
10
11
12

出参说明

出参名称 出参类型 出参说明
code String 响应返回码
campusId String 校区ID(32位的uuid)
campusNum Integer 校区序号,从0开始
campusName String 校区名称

# 查询学段信息

查询所有学段基本信息

请求方式 :POST

请求地址 :https://api.zkbiocloud.com/open/edu/school/basic/v1/period/info/list

请求数据

header域

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

body域

{
    "payload": {
        "params": {}
    }
}
1
2
3
4
5

入参说明

入参名称 入参类型 参数长度 默认值 必填 入参说明

返回结果

{
    "code": "00000000",
    "payload": {
        "results": [
            {
                "periodId": "e4d35280afc847999a57437eea226683",
                "periodNum": 2,
                "periodName": "小学",
                "periodStatus": 1,
                "campusId": "4a1d0125afa54e88b75abc60c39d3eec"
            }
        ]
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

出参说明

出参名称 出参类型 出参说明
code String 响应返回码
periodId String 学段ID(32位的uuid)
periodNum Integer 学段序号,从1开始
periodName String 学段名称
periodStatus String 学段状态,0-禁用;1-启用
campusId String 校区ID(32位的uuid)

# 查询年级信息

查询所有年级基本信息

请求方式 :POST

请求地址 :https://api.zkbiocloud.com/open/edu/school/basic/v1/grade/info/list

请求数据

header域

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

body域

{
    "payload": {
        "params": {}
    }
}
1
2
3
4
5

入参说明

入参名称 入参类型 参数长度 默认值 必填 入参说明

返回结果

{
    "code": "00000000",
    "payload": {
        "results": [
            {
                "gradeId": "7cf4a71c372b4b0d960ce27253442d7e",
                "gradeNum": 1,
                "gradeName": "一年级",
                "periodId": "e4d35280afc847999a57437eea226683",
                "campusId": "4a1d0125afa54e88b75abc60c39d3eec"
            }
        ]
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

出参说明

出参名称 出参类型 出参说明
code String 响应返回码
gradeId String 年级ID(32位的uuid)
gradeNum Integer 年级序号,从1开始
gradeName String 年级名称
periodId String 学段ID(32位的uuid)
campusId String 校区ID(32位的uuid)

# 查询班级信息

查询所有班级基本信息

请求方式 :POST

请求地址 :https://api.zkbiocloud.com/open/edu/school/basic/v1/class/info/list

请求数据

header域

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

body域

{
    "payload": {
        "params": {}
    }
}
1
2
3
4
5

入参说明

入参名称 入参类型 参数长度 默认值 必填 入参说明

返回结果

{
    "code": "00000000",
    "payload": {
        "results": [
            {
                "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
15
16
17

出参说明

出参名称 出参类型 出参说明
code String 响应返回码
classId String 班级ID(32位的uuid)
classNum Integer 班级序号,从1开始
className String 班级名称(需授权)
registerYear Integer 入学年份
nomenclature Integer 命名方式,0-自动;1-自定义
gradeId String 年级ID(32位的uuid)
periodId String 学段ID(32位的uuid)
campusId String 校区ID(32位的uuid)

# 查询班级树型信息

查询所有班级基本信息树型列表(包含校区、学段和年级)

请求方式 :POST

请求地址 :https://api.zkbiocloud.com/open/edu/school/basic/v1/class/info/tree/list

请求数据

header域

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

body域

{
    "payload": {
        "params": {}
    }
}
1
2
3
4
5

入参说明

入参名称 入参类型 参数长度 默认值 必填 入参说明

返回结果

{
    "code": "00000000",
    "payload": {
        "results": [
            {
                "campusId": "8313a8d6d6eb48ec91fb9e517b38692b",
                "campusNum": 0,
                "campusName": "默认校区",
                "periodList": [
                    {
                        "periodId": "1ef3852bb13a4657aea4b10b739925b2",
                        "periodNum": 2,
                        "periodName": "初中",
                        "gradeList": [
                            {
                                "gradeId": "a3b8c4fa0ea14680899e4e3df8fa48e7",
                                "gradeNum": 0,
                                "gradeName": "初一",
                                "classList": [
                                    {
                                        "classId": "0c2272ddeb734d63aa3a280eb094e46e",
                                        "classNum": 1,
                                        "className": "初一(1)班",
                                        "registerYear": 2023,
                                        "nomenclature": 0
                                    }
                                ]
                            }
                        ]
                    }
                ]
            }
        ]
    }
}
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

出参说明

出参名称 出参类型 出参说明
code String 响应返回码
campusId String 校区ID(32位的uuid)
campusNum Integer 校区序号,从0开始
campusName String 校区名称
periodId String 学段ID(32位的uuid)
periodNum Integer 学段序号,从1开始
periodName String 学段名称
gradeId String 年级ID(32位的uuid)
gradeNum Integer 年级序号,从1开始
gradeName String 年级名称
classId String 班级ID(32位的uuid)
classNum Integer 班级序号,从1开始
className String 班级名称(需授权)
registerYear Integer 入学年份
nomenclature Integer 命名方式,0-自动;1-自定义
教职工信息
学生信息

← 教职工信息 学生信息→

最近更新
01
上报消息
09-29
02
第三方平台应用单点登录
07-30
03
人脸照片信息
06-14
更多文章>
Theme by Vdoing | Copyright © -2024 熵基智联 | Copyright © 2021 ZKTECO CO., LTD. All rights reserved.
  • 跟随系统
  • 浅色模式
  • 深色模式
  • 阅读模式