创建学段

POST

http://127.0.0.1/topapi/edu/period/create

服务端API/新教育/家校通讯录2.0/通讯录信息写入

最后修改时间：2022-08-30 09:19:24

责任人：未设置

说明

调用本接口在指定校区下创建学段。
服务地址：https://oapi.dingtalk.com

权限

服务端API是以应用维度授权的，在调用接口前，确保已经为应用添加了接口权限。详情请参考调用说明（家校通讯录2.0）。

应用类型	是否支持调用	权限申请方式	API Explorer调试
企业内部应用	是	开发者后台申请	调试
第三方企业应用	是	开发者后台申请	调试
第三方个人应用	否	—	—

请求参数

Query 参数

access_token

string

必需

调用服务端API授权凭证，可通过获取企业内部应用的access_token接口获取。

示例值:

6d1bxxxx

Body 参数application/json

super_id

number

校区ID。

必需

operator

string

钉钉管理员。

必需

open_period

object

学段信息。

必需

step

string

必需

学段名称：幼儿园小学初中高中

grades

array [object {4}]

必需

年级列表，最大列表长度为999。

period_code

string

必需

学段编码：kindergarten ：幼儿园primary_school：小学middle_school：初中high_school：高中

name_mode

string

必需

学段名称类型：text：文本型，如初中为七年级，八年级，九年级。number：数字型，如初中一年级1班，二年级1班等。

示例

{
    "super_id": 4240018,
    "operator": "user01",
    "open_period": {
        "step": "小学",
        "period_code": "primary_school",
        "name_mode": "number",
        "grades": [
            {
                "grade": "2",
                "classes": 0,
                "name": "二年级2019级",
                "start_year": "2019"
            }
        ]
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://127.0.0.1/topapi/edu/period/create?access_token=6d1bxxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "super_id": 4240018,
    "operator": "user01",
    "open_period": {
        "step": "小学",
        "period_code": "primary_school",
        "name_mode": "number",
        "grades": [
            {
                "grade": "2",
                "classes": 0,
                "name": "二年级2019级",
                "start_year": "2019"
            }
        ]
    }
}'

返回响应

🟢200成功

application/json

Body

result

object

调用结果。

可选

deptId

number

学段ID。

可选

grades

array [object {5}]

年级列表。

可选

success

boolean

请求是否成功。

可选

errcode

number

返回码。

可选

errmsg

string

返回码描述。

可选

request_id

string

请求ID。

可选

示例

{
    "result": {
        "deptId": 0,
        "grades": [
            {
                "campus_id": 0,
                "dept_id": 0,
                "grade": 0,
                "name": "string",
                "super_id": 0
            }
        ]
    },
    "success": true,
    "errcode": 0,
    "errmsg": "string",
    "request_id": "string"
}

修改于 2022-08-30 09:19:24

添加学生

初始化家校架构

创建学段

说明#

权限#

请求参数

示例代码

返回响应

说明

权限