API docs by Redocly

SEIUE Open APIs (3.0)

Download OpenAPI specification:Download

接口调用约定同旧版文档 。 希悦统一采用 OAuth 授权协议，授权所需 ClientId 和 ClientSecret 以及 SchoolID 可以向希悦的工作人员索要，并请稳妥保管。 除了授权相关 API，所有的接口都必须指定学校，需要通过 X-School-Id HTTP 头来传递当前学校 ID。

Calendar

空间日程

Authorizations:
日程
path Parameters
id
required
integer

此处 ID 为 place_id

query Parameters
start_time
required
string <timestamp> ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$

日程开始时间

end_time
required
string <timestamp> ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$

日程结束时间

expand
string

扩展：address - 日程地址 | initiators - 日程事件发起人

Responses

Response samples

Content type
application/json
[
  • {
    }
]

用户日程

Authorizations:
日程
path Parameters
id
required
integer

此处 ID 为 place_id

query Parameters
start_time
required
string <timestamp> ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$

日程开始时间

end_time
required
string <timestamp> ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$

日程结束时间

expand
string

扩展：address - 日程地址 | initiators - 日程事件发起人

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Card

用户绑定校园卡接口

该接口需要 card.bind 或 card.write 的权限

Authorizations:
电子班牌电子班牌
Request Body schema: application/json
username
required
string (用户账号)
password
required
string (用户密码)
card_id
required
string (校园卡号)
rid
integer (用户身份 ID，即 reflection_id)

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string",
  • "card_id": "string",
  • "rid": 0
}

Response samples

Content type
application/json
{
  • "school_id": 0,
  • "reflection_id": 0,
  • "card_id": "string",
  • "status": "string",
  • "created_at": "string",
  • "updated_at": "string",
  • "reflection": {
    },
  • "id": 0
}

读取卡片显示学生资料

该接口需要 card.read 的权限

Authorizations:
电子班牌
path Parameters
id
required
string

此处 ID，是 card_id

Responses

Response samples

Content type
application/json
{
  • "school_id": 0,
  • "reflection_id": 0,
  • "card_id": "string",
  • "status": "string",
  • "created_at": "string",
  • "updated_at": "string",
  • "reflection": {
    },
  • "id": 0
}

CustomGroup

获取群组列表

该接口需要 custom_group.read 的 Scope 权限。

Authorizations:
自定义群组
query Parameters
id_in
string
type
string

群组类型, 对应 CustomGroupType.machine_name

member_id
integer
member_id_in
string
status
string (GroupStatusEnum)
Enum: "normal" "archived" "leaved" "draft"
name
string
with_trashed
boolean

是否包含软删除的群组

updated_at_elt
string <timestamp> ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$

格式：yyyy-mm-dd hh:mm:ss

updated_at_egt
string <timestamp> ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
expand
string

支持:

  • members: 群组成员
paginated
integer

是否分页，默认 1

page
integer

显示的数据页，默认 1

per_page
integer

每页显示数量，默认 20

Responses

Response samples

Content type
application/json
[
  • {
    }
]

获取群组类型

该接口需要 custom_group.read 的 Scope 权限。

Authorizations:
自定义群组
query Parameters
id_in
string
is_custom
boolean
machine_name
string

群组类型的标志

expand
string

支持

  • roles: 改类型群组的角色定义

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Place

根据学校获取物联设备列表

该接口需要 place.read 的权限。

Authorizations:
场地
query Parameters
name_like
string

名称检索

place_id_in
string

空间ID检索

paginated
integer

是否分页，默认 1

page
integer

显示的数据页，默认 1

per_page
integer

每页显示数量，默认 20

Responses

Response samples

Content type
application/json
[
  • {
    }
]

根据学校获取空间列表

该接口需要 place.read 的权限。

Authorizations:
场地
query Parameters
expand
string

获取关联数据，支持 building 和 category

paginated
integer

是否分页，默认 1

page
integer

显示的数据页，默认 1

per_page
integer

每页显示数量，默认 20

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Message

对外开放的写消息接口

该接口需要 message.send 的权限。

Class SendMessageApi

Authorizations:
消息
Request Body schema: application/json
title
required
string (消息标题)
content
required
string (消息内容)
receiver_ids
required
Array of integers (接受人ID)
type
required
string (事件类型)
url
string (跳转url)

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "content": "string",
  • "receiver_ids": [
    ],
  • "type": "string",
  • "url": "string"
}

Response samples

Content type
application/json
"string"

Netdisk

创建文件 meta 信息

scope: netdisk.write

Authorizations:
网盘
Request Body schema: application/json
netdisk_owner_id
required
integer (如果是附件上传（非网盘业务），该值传 0)
parent_id
integer (父节点 id ，如为根节点或附件上传，为 0 ，默认为 0)
is_dir
boolean
name
required
string
path
string (默认为 / （根目录）)
type
string (NetdiskFileTypeEnum)
Enum: "doc" "photo" "audio" "video" "slide" "sheet" "other"
mime
required
string
size
required
integer
hash
string (文件哈希（md5），由前端根据文件内容计算给出)
status
string (NetdiskFileStatusEnum)
Enum: "uploading" "normal" "trashed"

Responses

Request samples

Content type
application/json
{
  • "netdisk_owner_id": 0,
  • "parent_id": 0,
  • "is_dir": true,
  • "name": "string",
  • "path": "string",
  • "type": "doc",
  • "mime": "string",
  • "size": 0,
  • "hash": "string",
  • "status": "uploading"
}

Response samples

Content type
application/json
{
  • "netdisk_owner_id": 0,
  • "parent_id": 0,
  • "is_dir": true,
  • "name": "string",
  • "path": "string",
  • "type": "doc",
  • "mime": "string",
  • "size": 0,
  • "hash": "string",
  • "creator_rid": 0,
  • "creator_uid": 0,
  • "share_sum": 0,
  • "download_sum": 0,
  • "status": "uploading",
  • "id": 0,
  • "school_id": 0,
  • "created_at": "string",
  • "updated_at": "string"
}

获取指定文件的上传 policy

scope: netdisk.write

Authorizations:
网盘
path Parameters
id
required
integer

文件 ID

Responses

Response samples

Content type
application/json
{
  • "access_key_id": "string",
  • "expire": "string",
  • "callback_url": "string",
  • "callback": "string",
  • "host": "string",
  • "object_key": "string",
  • "policy": "string",
  • "signature": "string"
}

获取文件下载地址或直接下载文件

scope:

  • 当获取网盘文件时为 netdisk.write
  • 当获取附件时不需要权限
Authorizations:
网盘
path Parameters
id
required
string

如果是网盘文件，该值为 NetdiskFile.id ；如果为附件文件（如任务附件），该值为 NetdiskFile.hash

query Parameters
redirect
boolean

重定向，自动下载文件，默认为是。否为获取下载地址

download
boolean

下载模式，默认为否（表示在线预览）

processor
string

文件处理器，目前仅支持图片处理。使用 - 连接处理器与相关参数，使用 _ 连接多个处理器。 quality-Q-80 zoom-fill-h-200-w-100 avatar-100-100 quality-Q-80_zoom-fill-h-200-w-100

Responses

Response samples

Content type
application/json
"string"

OAuth

根据 OAuth AccessToken 获取用户 ClassIn 关联关系。

对于多身份用户, 需要通过 X-Reflection-Id 传递用户 ID 以便能够获取正确的用户信息，其值可以通过 passport 跳转的回调地址中的 active_reflection_id 参数取到。

Responses

Response samples

Content type
application/json
{ }

根据 OAuth AccessToken 获取用户信息

对于多身份用户, 需要通过 X-Reflection-Id 传递用户 ID 以便能够获取正确的用户信息，其值可以通过 passport 跳转的回调地址中的 active_reflection_id 参数取到。

query Parameters
expand
string

expand 扩展字段，请按需加载资源；graduates_in 代表届别，grade 代表年级。

?expand=graduates_in,grade

Responses

Response samples

Content type
application/json
{
  • "school_id": 0,
  • "name": "string",
  • "role": "teacher",
  • "department_names": [
    ],
  • "pinyin": "string",
  • "gender": { },
  • "user_id": 0,
  • "usin": "string",
  • "ename": "string",
  • "email": "string",
  • "phone": "string",
  • "idcard": "string",
  • "photo": "string",
  • "status": "normal",
  • "archived_type_id": 0,
  • "archived_type": { },
  • "outer_id": "string",
  • "deleted_at": "string",
  • "id": 0
}

根据 OAuth AccessToken 获取用户角色信息

query Parameters
expand
string

expand 扩展字段，请按需加载资源；permissions 代表角色授权信息；relations 代表角色可管理的各组特定资源。

?expand=relations,permissions

Responses

Response samples

Content type
application/json
[
  • {
    }
]

申请 OAuth AccessToken

请求时 需添加请求头（Header） Content-Type:application/json。

申请 Token 成功后，需要在调用具体的 API 接口时，传递如下 Header:

  • Authorization: Bearer {access_token}，其中 {access_token} 为申请 Token 时返回的 access_token。
  • X-School-Id: {school_id}，其中 {school_id} 为学校 ID。
Request Body schema: application/json
grant_type
required
string (授权类型，目前支持 password, client_credentials, refresh_token, seiue:phone_code, seiue:auth_ticket)
client_id
required
string (OAuth 应用 client_id)
client_secret
required
string (OAuth 应用 client_id 对应的密钥)
username
string (password 授权类型时使用的用户名)
password
string (password 授权类型时使用的用户密码)
refresh_token
string (refresh_token 授权类型时使用的 token)
scope
string (指定 access token 需要的权限 scope，多个空格分隔。)

为了访问特定学校的数据，需要指定 school.<school_id> 的 scope，以获得访问该学校数据的权限。

其他具体 scope 的值见具体 API 的说明。

Responses

Request samples

Content type
application/json
{
  • "grant_type": "string",
  • "client_id": "string",
  • "client_secret": "string",
  • "username": "string",
  • "password": "string",
  • "refresh_token": "string",
  • "scope": "string"
}

Response samples

Content type
application/json
{
  • "token_type": "string",
  • "expires_in": 0,
  • "access_token": "string",
  • "refresh_token": "string"
}

Permission

列出用户拥有的所有权限组和权限

权限组可关联资源类型和资源 id

Authorizations:
权限
path Parameters
rid
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

获取有指定权限用户 ids

Authorizations:
权限
path Parameters
perm
required
string
query Parameters
resource_type
string (PermissionGroupResourceTypeEnum)
Enum: "reflection" "admin_class" "class"

指定资源类型

resource_id_in
string

指定资源的 ids ，多个用逗号分隔，且关系。如多个用户 id ，3001,3002

Responses

Response samples

Content type
application/json
[
  • 0
]

Reflection

验证用户密码

该接口需要 reflection.password 的 Scope 权限访问，每个账号 10 分钟内，只有三次失败机会。

Authorizations:
用户
Request Body schema: application/json
identity
required
string (账号或绑定的手机号)
password
required
string (待验证的密码)

Responses

Request samples

Content type
application/json
{
  • "identity": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "school_id": 0,
  • "name": "string",
  • "role": "teacher",
  • "department_names": [
    ],
  • "pinyin": "string",
  • "gender": { },
  • "user_id": 0,
  • "usin": "string",
  • "ename": "string",
  • "email": "string",
  • "phone": "string",
  • "idcard": "string",
  • "photo": "string",
  • "status": "normal",
  • "archived_type_id": 0,
  • "archived_type": { },
  • "outer_id": "string",
  • "deleted_at": "string",
  • "id": 0
}

创建单个用户 - 本接口需要 `reflection.write_all` 的 Scope 权限访问 - 如果 account 账户已存在 将报 422 错误

Authorizations:
用户
Request Body schema: application/json
school_id
integer (学校 ID)
name
required
string (姓名)
account
required
string (账号)
role
required
string (RoleEnum)
Enum: "teacher" "guardian" "staff" "student" "shadow"
pinyin
string (姓名拼音)
性别：男 - m | 女 - f (null) or GenderEnum (string) (性别：男 - m | 女 - f)
user_id
integer or null (所属用户 ID)
usin
string or null (学工号)
ename
string or null (英文名称)
email
string or null (电子邮箱)
phone
string or null (手机号码)
idcard
string or null (身份证号)
photo
string or null (头像)
状态：正常 - normal | 归档 - archived (null) or StatusEnum (string) (状态：正常 - normal | 归档 - archived)
archived_type_id
integer or null (归档类型 ID)
归档类型 (null) or Term (object) (归档类型)
outer_id
required
string (关联的外部系统数据的 ID)
password
string or null (用户密码)

Responses

Request samples

Content type
application/json
{
  • "school_id": 0,
  • "name": "string",
  • "account": "string",
  • "role": "teacher",
  • "pinyin": "string",
  • "gender": { },
  • "user_id": 0,
  • "usin": "string",
  • "ename": "string",
  • "email": "string",
  • "phone": "string",
  • "idcard": "string",
  • "photo": "string",
  • "status": { },
  • "archived_type_id": 0,
  • "archived_type": { },
  • "outer_id": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "school_id": 0,
  • "name": "string",
  • "role": "teacher",
  • "department_names": [
    ],
  • "pinyin": "string",
  • "gender": { },
  • "user_id": 0,
  • "usin": "string",
  • "ename": "string",
  • "email": "string",
  • "phone": "string",
  • "idcard": "string",
  • "photo": "string",
  • "status": "normal",
  • "archived_type_id": 0,
  • "archived_type": { },
  • "outer_id": "string",
  • "deleted_at": "string",
  • "id": 0
}

用户身份 - 获取用户数据

该接口需要 reflection.read_basic 或 reflection.read_all 的 Scope 权限访问。前者能够访问基础字段，后者能够访问所有字段。

Authorizations:
用户用户
query Parameters
expand
string

扩展信息，多个用逗号隔开， 支持： archived_type:归档信息

paginated
integer

是否分页，默认 1

page
integer

显示的数据页，默认 1

per_page
integer

每页显示数量，默认 20

sort
string

排序字段， 如果想降序排序，需要在字段前加-， 例如 按id升序 id, id降序降序-id

updated_at_egt
string <timestamp> ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$

仅查询某个时间段之后更新人员身份信息, 可用于实现增量更新。 格式：yyyy-mm-dd hh:mm:ss

with_trashed
boolean

是否包含软删除的记录

Responses

Response samples

Content type
application/json
[
  • {
    }
]

修改单个用户 - 本接口需要 `reflection.write_all` 的 Scope 权限访问

Authorizations:
用户
path Parameters
id
required
integer
Request Body schema: application/json
school_id
integer (学校 ID)
name
string (姓名)
account
string (账号)
pinyin
string (姓名拼音)
性别：男 - m | 女 - f (null) or GenderEnum (string) (性别：男 - m | 女 - f)
user_id
integer or null (所属用户 ID)
usin
string or null (学工号)
ename
string or null (英文名称)
email
string or null (电子邮箱)
phone
string or null (手机号码)
idcard
string or null (身份证号)
photo
string or null (头像)
状态：正常 - normal | 归档 - archived (null) or StatusEnum (string) (状态：正常 - normal | 归档 - archived)
archived_type_id
integer or null (归档类型 ID)
归档类型 (null) or Term (object) (归档类型)
outer_id
string (关联的外部系统数据的 ID)
password
string or null (用户密码)

Responses

Request samples

Content type
application/json
{
  • "school_id": 0,
  • "name": "string",
  • "account": "string",
  • "pinyin": "string",
  • "gender": { },
  • "user_id": 0,
  • "usin": "string",
  • "ename": "string",
  • "email": "string",
  • "phone": "string",
  • "idcard": "string",
  • "photo": "string",
  • "status": { },
  • "archived_type_id": 0,
  • "archived_type": { },
  • "outer_id": "string",
  • "password": "string"
}

删除单个用户 - 本接口需要 `reflection.write_all` 的 Scope 权限访问

Authorizations:
用户
path Parameters
id
required
integer

Responses

用户身份 - 获取校外人员信息

该接口需要 staff.read_basic 或 staff.read_all 的 Scope 权限访问。前者能够访问基础字段，后者能够访问所有字段。

Authorizations:
用户用户
query Parameters
expand
string

扩展信息，多个用逗号隔开， 支持： archived_type:归档信息

paginated
integer

是否分页，默认 1

page
integer

显示的数据页，默认 1

per_page
integer

每页显示数量，默认 20

sort
string

排序字段， 如果想降序排序，需要在字段前加-， 例如 按id升序 id, id降序降序-id

updated_at_egt
string <timestamp> ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$

仅查询某个时间段之后更新人员身份信息, 可用于实现增量更新。 格式：yyyy-mm-dd hh:mm:ss

with_trashed
boolean

是否包含软删除的记录

Responses

Response samples

Content type
application/json
[
  • {
    }
]

用户身份 - 获取学生数据

该接口需要 student.read_basic 或 student.read_all 的 Scope 权限访问。前者能够访问基础字段，后者能够访问所有字段。

Authorizations:
用户用户
query Parameters
id_in
string
name_in
string

根据学生姓名检索，多个检索用逗号隔，

name_like
string
keyword_identity
string

学科检索

expand
string

扩展信息，多个用逗号隔开， 支持： graduates_in:界别信息， grade:年级信息， archived_type:归档信息

paginated
integer

是否分页，默认 1

page
integer

显示的数据页，默认 1

per_page
integer

每页显示数量，默认 20

sort
string

排序字段， 如果想降序排序，需要在字段前加-， 例如 按id升序 id, id降序降序-id

updated_at_egt
string <timestamp> ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$

仅查询某个时间段之后更新人员身份信息, 可用于实现增量更新。 格式：yyyy-mm-dd hh:mm:ss

with_trashed
boolean

是否包含软删除的记录

Responses

Response samples

Content type
application/json
[
  • {
    }
]

用户身份 - 获取教师数据

该接口需要 teacher.read_basic 或 teacher.read_all 的 Scope 权限访问。前者能够访问基础字段，后者能够访问所有字段。

Authorizations:
用户用户
query Parameters
id_in
string
discipline_id_in
string

根据学科ID检索

name_in
string
name_like
string
keyword_identity
string

教师学工号、学科 检索

expand
string

扩展信息，多个用逗号隔开， 支持: discipline:学科， archived_type:归档信息 department_names:部门名称

paginated
integer

是否分页，默认 1

page
integer

显示的数据页，默认 1

per_page
integer

每页显示数量，默认 20

sort
string

排序字段， 如果想降序排序，需要在字段前加-， 例如 按id升序 id, id降序降序-id

updated_at_egt
string <timestamp> ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$

仅查询某个时间段之后更新人员身份信息, 可用于实现增量更新。 格式：yyyy-mm-dd hh:mm:ss

with_trashed
boolean

是否包含软删除的记录

Responses

Response samples

Content type
application/json
[
  • {
    }
]

批量归档用户

如果归档的是学生，则家长也会自动被归档

Authorizations:
用户
path Parameters
role
required
string (RoleEnum)
Enum: "teacher" "guardian" "staff" "student" "shadow"

仅 student, teacher, staff 可用

Request Body schema: application/json
Array
id
required
integer (被归档的 reflection id)
archived_type_id
required
integer (归档类型 ID ，由 term 提供 根据不同的用户类型，选择不同类型的归档 term - student.archived_type - teacher.archived_type - staff.archived_type)
archived_remark
string
Array of objects (Attachment)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

System

获取学校列表

当前接口无需验证。

Responses

Response samples

Content type
application/json
[
  • {
    }
]

获取学期列表

该接口需要 semester.read 的权限。

Authorizations:
学期
query Parameters
id_in
string

学期Id

paginated
integer

是否分页，默认 1

page
integer

显示的数据页，默认 1

per_page
integer

每页显示数量，默认 20

expand
string

支持 expand:

1 . academic_year 学年 2 . category 分类 3 . is_current 是否当前学期

Responses

Response samples

Content type
application/json
[
  • {
    }
]

获取一些基础的 terms，比如 学期分类，属性，科目，领域

该接口需要 term.read 的权限。

Authorizations:
词汇
path Parameters
type
required
string (TermTypeEnum)
Enum: "course.attribute" "course.subject" "class.tag" "course.domain" "system.school_structure" "guardian.role" "system.graduates_in" "system.academic_year" "system.graduates_in" "system.school_structure" "system.semester_category" "teacher.discipline" "reporting.report_category" "place.building"
query Parameters
name
string

按名称筛选

parent_id
integer

父节点

archived_at_is_empty
boolean

筛选未归档的

archived_at_is_not_empty
boolean

筛选已归档的

sort
string

排序字段，多个字段逗号分隔 -created_at,updated_at

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Task

批改作业

scope: task.write

Authorizations:
任务
path Parameters
assignee_id
required
integer

学生 ID

task_id
required
integer

任务 ID

query Parameters
school_id
required
integer

学校 ID

Request Body schema: application/json
result
required
string (TaskReviewResultEnum)
Enum: "approved" "rejected"
reason
required
string (理由)
content
string (评论内容)
Array of objects (附件)
do_evaluation
boolean (参与评价/暂不评价)
is_submission_changed
boolean (是否批改了作业成果)
receiver_id
integer (接收者id（学生rid）)
reviewer_id
integer (批阅人 id ，默认为任务创建人)
is_excellent_submission
boolean (是否设为优秀作业)

Responses

Request samples

Content type
application/json
{
  • "result": "approved",
  • "reason": "string",
  • "content": "string",
  • "attachments": [
    ],
  • "do_evaluation": true,
  • "is_submission_changed": true,
  • "receiver_id": 0,
  • "reviewer_id": 0,
  • "is_excellent_submission": true
}

Response samples

Content type
application/json
{
  • "receiver_id": 0,
  • "reviewer_id": 0,
  • "submission_id": 0,
  • "submission": { },
  • "content_text": "string",
  • "result": "approved",
  • "reason": "string",
  • "content": "string",
  • "attachments": [
    ],
  • "do_evaluation": true,
  • "is_submission_changed": true,
  • "is_excellent_submission": true,
  • "id": 0,
  • "created_at": "string",
  • "updated_at": "string"
}

提交任务

scope: task.write

Authorizations:
任务
path Parameters
assignee_id
required
string

学生 rid 或 学工号 usin 如果学工号格式是纯数字，需要加 usin: 前缀区分

task_id
required
integer

任务 ID

query Parameters
school_id
required
integer

学校 ID

Request Body schema: application/json
content
required
string (内容)
Array of objects (附件)
状态 (null) or SubmissionStatusEnum (string) (状态)
附件批阅 - 教师创建附件批阅后才有数据 (null) or Array of 附件批阅 - 教师创建附件批阅后才有数据 (objects) (附件批阅 - 教师创建附件批阅后才有数据)

Responses

Request samples

Content type
application/json
{
  • "content": "string",
  • "attachments": [
    ],
  • "status": { },
  • "reviewed_attachments": { }
}

Response samples

Content type
application/json
{
  • "submitter_id": 0,
  • "content_text": "string",
  • "content": "string",
  • "attachments": [
    ],
  • "status": { },
  • "id": 0,
  • "created_at": "string",
  • "updated_at": "string"
}

创建任务

scope: task.write

Authorizations:
任务
query Parameters
school_id
required
integer

学校 ID

Request Body schema: application/json
enhancer
string (TaskEnhancerEnum)
Enum: "seiue.personal_task" "seiue.class_activity_task" "seiue.class_homework_task" "seiue.class_document_task" "seiue.class_website_task" "seiue.class_questionnaire_task" "seiue.class_quiz_task" "seiue.class_live_task" "seiue.class_discuz_task" "seiue.chat_task"
class_id
integer (课程班 ID)
all_joined
boolean (业务内的全员参与)
domain
string or null (业务域)
domain_biz_id
integer or null (业务ID（如：group.id）)
title
string (任务标题)
content
string (任务内容)
allow_overdue_submit
boolean (允许逾期提交，默认为不允许（false）)
submit_enabled
boolean (开启成果提交，默认为开启（true）)
expired_at
string or null <timestamp> (过期时间) ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
is_team_work
boolean (是否为团队任务，默认为否（false）)
Array of objects (Attachment)
Array of objects (任务执行人，与 all_joined 互斥。all_joined 优先)
is_force_publish
boolean (是否强制发布)
prev_id
integer (前序任务ID)
biz_id
integer or null (关联业务ID（过评等))
expected_take_minites
integer or null (预计用时(以分为单位))
任务状态 (null) or TaskStatusEnum (string) (任务状态)
published_at
string or null <timestamp> (发布时间) ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
outline_id
integer (分类（大纲）ID)
weight
integer (权重)
is_public_submission
boolean (是否公开成果)
类型，用于标志业务类型，比如: seiue.personal_task, seiue.personal_group, seiue.mentor_role (null) or EnhancerEnum (string) (类型，用于标志业务类型，比如: seiue.personal_task, seiue.personal_group, seiue.mentor_role)
admin
string (AdminLabelEnum)
Enum: "yes" "no"
module_admin
string (AdminLabelEnum)
Enum: "yes" "no"
task_id
integer (常用Id)
talk_id
integer
review_id
integer
exam_id
integer

Responses

Request samples

Content type
application/json
{
  • "enhancer": "seiue.personal_task",
  • "class_id": 0,
  • "all_joined": true,
  • "domain": "string",
  • "domain_biz_id": 0,
  • "title": "string",
  • "content": "string",
  • "allow_overdue_submit": true,
  • "submit_enabled": true,
  • "expired_at": "string",
  • "is_team_work": true,
  • "attachments": [
    ],
  • "assignments": [
    ],
  • "is_force_publish": true,
  • "prev_id": 0,
  • "biz_id": 0,
  • "expected_take_minites": 0,
  • "general_status": { },
  • "published_at": "string",
  • "outline_id": 0,
  • "weight": 0,
  • "is_public_submission": true,
  • "type": { },
  • "admin": "yes",
  • "module_admin": "yes",
  • "task_id": 0,
  • "talk_id": 0,
  • "review_id": 0,
  • "exam_id": 0
}

Response samples

Content type
application/json
{
  • "title": "string",
  • "content": "string",
  • "expired_at": "string",
  • "attachments": [
    ],
  • "allow_overdue_submit": true,
  • "is_team_work": true,
  • "creator_id": 0,
  • "role_id": 0,
  • "overall_task_status": { },
  • "domain": "string",
  • "domain_biz_id": 0,
  • "biz_id": 0,
  • "expected_take_minites": 0,
  • "assessment_type": { },
  • "custom_fields": { },
  • "general_status": { },
  • "published_at": "string",
  • "display_time": "string",
  • "labels": {
    },
  • "creator": {
    },
  • "related": { },
  • "assignments": [
    ],
  • "id": 0,
  • "school_id": 0,
  • "created_at": "string",
  • "updated_at": "string"
}

更新提交内容

scope: task.write

Authorizations:
任务
path Parameters
task_id
required
integer

任务 ID

submission_id
required
integer

提交内容 ID

query Parameters
school_id
required
integer

学校 ID

Request Body schema: application/json
content
required
string (内容)
Array of objects (附件)
状态 (null) or SubmissionStatusEnum (string) (状态)
附件批阅 - 教师创建附件批阅后才有数据 (null) or Array of 附件批阅 - 教师创建附件批阅后才有数据 (objects) (附件批阅 - 教师创建附件批阅后才有数据)

Responses

Request samples

Content type
application/json
{
  • "content": "string",
  • "attachments": [
    ],
  • "status": { },
  • "reviewed_attachments": { }
}

Response samples

Content type
application/json
{
  • "submitter_id": 0,
  • "content_text": "string",
  • "content": "string",
  • "attachments": [
    ],
  • "status": { },
  • "id": 0,
  • "created_at": "string",
  • "updated_at": "string"
}

编辑任务

scope: task.write

Authorizations:
任务
path Parameters
id
required
integer
query Parameters
school_id
required
integer

学校 ID

Request Body schema: application/json
enhancer
string (TaskEnhancerEnum)
Enum: "seiue.personal_task" "seiue.class_activity_task" "seiue.class_homework_task" "seiue.class_document_task" "seiue.class_website_task" "seiue.class_questionnaire_task" "seiue.class_quiz_task" "seiue.class_live_task" "seiue.class_discuz_task" "seiue.chat_task"
class_id
integer (课程班 ID)
all_joined
boolean (业务内的全员参与)
domain
string or null (业务域)
domain_biz_id
integer or null (业务ID（如：group.id）)
title
string (任务标题)
content
string (任务内容)
allow_overdue_submit
boolean (允许逾期提交，默认为不允许（false）)
submit_enabled
boolean (开启成果提交，默认为开启（true）)
expired_at
string or null <timestamp> (过期时间) ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
is_team_work
boolean (是否为团队任务，默认为否（false）)
Array of objects (Attachment)
Array of objects (任务执行人，与 all_joined 互斥。all_joined 优先)
is_force_publish
boolean (是否强制发布)
prev_id
integer (前序任务ID)
biz_id
integer or null (关联业务ID（过评等))
expected_take_minites
integer or null (预计用时(以分为单位))
任务状态 (null) or TaskStatusEnum (string) (任务状态)
published_at
string or null <timestamp> (发布时间) ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
outline_id
integer (分类（大纲）ID)
weight
integer (权重)
is_public_submission
boolean (是否公开成果)
类型，用于标志业务类型，比如: seiue.personal_task, seiue.personal_group, seiue.mentor_role (null) or EnhancerEnum (string) (类型，用于标志业务类型，比如: seiue.personal_task, seiue.personal_group, seiue.mentor_role)
admin
string (AdminLabelEnum)
Enum: "yes" "no"
module_admin
string (AdminLabelEnum)
Enum: "yes" "no"
task_id
integer (常用Id)
talk_id
integer
review_id
integer
exam_id
integer

Responses

Request samples

Content type
application/json
{
  • "enhancer": "seiue.personal_task",
  • "class_id": 0,
  • "all_joined": true,
  • "domain": "string",
  • "domain_biz_id": 0,
  • "title": "string",
  • "content": "string",
  • "allow_overdue_submit": true,
  • "submit_enabled": true,
  • "expired_at": "string",
  • "is_team_work": true,
  • "attachments": [
    ],
  • "assignments": [
    ],
  • "is_force_publish": true,
  • "prev_id": 0,
  • "biz_id": 0,
  • "expected_take_minites": 0,
  • "general_status": { },
  • "published_at": "string",
  • "outline_id": 0,
  • "weight": 0,
  • "is_public_submission": true,
  • "type": { },
  • "admin": "yes",
  • "module_admin": "yes",
  • "task_id": 0,
  • "talk_id": 0,
  • "review_id": 0,
  • "exam_id": 0
}

Response samples

Content type
application/json
{
  • "title": "string",
  • "content": "string",
  • "expired_at": "string",
  • "attachments": [
    ],
  • "allow_overdue_submit": true,
  • "is_team_work": true,
  • "creator_id": 0,
  • "role_id": 0,
  • "overall_task_status": { },
  • "domain": "string",
  • "domain_biz_id": 0,
  • "biz_id": 0,
  • "expected_take_minites": 0,
  • "assessment_type": { },
  • "custom_fields": { },
  • "general_status": { },
  • "published_at": "string",
  • "display_time": "string",
  • "labels": {
    },
  • "creator": {
    },
  • "related": { },
  • "assignments": [
    ],
  • "id": 0,
  • "school_id": 0,
  • "created_at": "string",
  • "updated_at": "string"
}

获取任务

scope: task.read

Authorizations:
任务
path Parameters
id
required
integer
query Parameters
expand
string

expand

1 . labels 2 . creator: 创建人信息 3 . activities: 任务动态 4 . related: 卡片关联资源 5 . assignments: 分配 6 . assignments.submissions: 任务分配，执行人提交记录 7 . assignments.assignee: 任务分配，参与人信息 8 . assignments.reviews: 任务评审记录 9. overall_task_status 总状态 10. discussion 所关联的讨论区 11. role 角色信息 12. assignments.team: 任务执行人所在小组 13. assignments.submission: 执行人最新的提交成果 14. assignments.review: 执行人最新的一次任务评审 15. group: 群组 16. outline: 分类（大纲） 17. prev: 前序任务

Responses

Response samples

Content type
application/json
{
  • "title": "string",
  • "content": "string",
  • "expired_at": "string",
  • "attachments": [
    ],
  • "allow_overdue_submit": true,
  • "is_team_work": true,
  • "creator_id": 0,
  • "role_id": 0,
  • "overall_task_status": { },
  • "domain": "string",
  • "domain_biz_id": 0,
  • "biz_id": 0,
  • "expected_take_minites": 0,
  • "assessment_type": { },
  • "custom_fields": { },
  • "general_status": { },
  • "published_at": "string",
  • "display_time": "string",
  • "labels": {
    },
  • "creator": {
    },
  • "related": { },
  • "assignments": [
    ],
  • "id": 0,
  • "school_id": 0,
  • "created_at": "string",
  • "updated_at": "string"
}

删除任务

scope: task.write

Authorizations:
任务
path Parameters
id
required
integer
query Parameters
expand
string

expand

1 . labels 2 . creator: 创建人信息 3 . activities: 任务动态 4 . related: 卡片关联资源 5 . assignments: 分配 6 . assignments.submissions: 任务分配，执行人提交记录 7 . assignments.assignee: 任务分配，参与人信息 8 . assignments.reviews: 任务评审记录 9. overall_task_status 总状态 10. discussion 所关联的讨论区 11. role 角色信息 12. assignments.team: 任务执行人所在小组 13. assignments.submission: 执行人最新的提交成果 14. assignments.review: 执行人最新的一次任务评审 15. group: 群组 16. outline: 分类（大纲） 17. prev: 前序任务

Responses

AdminClass

获取行政班接口

该接口需要 admin_class.read 权限

Authorizations:
行政班
query Parameters
id
integer

行政班 ID

id_in
string

行政班 IDs，多个 ID 以逗号分隔

name_like
string

行政班名称模糊搜索

name_in
string

行政班名称精确搜索，多个名称以逗号分隔

place_id
integer

空间 ID

teacher_id
integer

教师 ID，即 reflection_id

status
string (AdminClassStatusEnum)
Enum: "normal" "archived"

行政班状态

outer_id
string

外部ID

outer_id_in
string

外部IDs, 逗号分隔

expand
string
paginated
integer

是否分页，默认 1

page
integer

显示的数据页，默认 1

per_page
integer

每页显示数量，默认 20

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Dorm

获取宿舍列表

该接口需要 dorm.read 的权限

Authorizations:
宿舍
query Parameters
expand
string
sort
string
id_in
string
name_like
string
name_in
string
gender_limit
string
capacity_egt
integer
capacity_elt
integer
place_id_in
integer
description_like
string
object (DormMemberQuery)
object (ReflectionQuery)
object (PlaceQuery)
status
string (DormStatusEnum)
Enum: "normal" "archived" "leaved"
paginated
integer

是否分页，默认 1

page
integer

显示的数据页，默认 1

per_page
integer

每页显示数量，默认 20

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Klass

获取课程班成员

目前仅返回课程班下的学生数据，该接口需要 class.read 的权限。

Authorizations:
课程班
query Parameters
semester_id
required
integer

指定学期ID

class_id_in
string

指定课程班 IDs

updated_at_egt
string <timestamp> ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$

仅查询某个时间段之后更新过或新建的成员, 可用于实现课程班成员增量更新。

with_trashed
integer

是否包含已删除数据，一般与 updated_at_egt 配合使用。

paginated
integer

是否分页，默认 1

page
integer

显示的数据页，默认 1

per_page
integer

每页显示数量，默认 20

Responses

Response samples

Content type
application/json
[
  • {
    }
]

获取课程班列表

该接口需要 class.read 的权限。

Authorizations:
课程班
query Parameters
id_in
string

指定 ID 查询, 多个 ID 逗号分隔

semester_id
integer

学期 ID

updated_at_egt
string <timestamp> ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$

仅查询某个时间段之后更新过或新建的课程班, 可用于实现课程班增量更新。

with_trashed
integer

是否包含已删除数据，一般与 updated_at_egt 配合使用。

admin_class_id
integer

行政班ID

expand
string

指定 expand 关联资源，支持:

  • teachers
  • students
  • class_lessons
  • places
  • grades
  • domain
  • subject
  • en_subject
  • attribute
  • admin_class_ids
paginated
integer

是否分页，默认 1

page
integer

显示的数据页，默认 1

per_page
integer

每页显示数量，默认 20

Responses

Response samples

Content type
application/json
[
  • {
    }
]

获取课节数据

Authorizations:
课程班
query Parameters
semester_id
integer

学期ID，不传默认获取当前学期

date_egt
required
string <date> ^\d{4}-\d{2}-\d{2}$

开始时间

date_elt
required
string <date> ^\d{4}-\d{2}-\d{2}$

结束时间

place_id
integer

place_id 和 student_id 二选一

student_id
integer

place_id 和 student_id 二选一

class_id_in
string

教学班ID，多个ID以逗号分隔

Responses

Response samples

Content type
application/json
[
  • {
    }
]

获取矩形课表结构

将系统多个课表结构转为矩形课表结构

该接口需要 class.read 的权限。

Authorizations:
课程班
query Parameters
date
required
string <date> ^\d{4}-\d{2}-\d{2}$

指定当前日志

timetable_ids
string

指定多个课表结构的 IDs，缺省使用当前学期的默认课表结构

Responses

Response samples

Content type
application/json
[
  • {
    }
]

获取课表结构

该接口需要 class.read 的权限。

Authorizations:
课程班
query Parameters
id
integer
id_in
string
semester_id
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

查询课程班学生总成绩

scope: class.read

Authorizations:
课程班
query Parameters
class_ids
required
string
updated_at_egt
string <timestamp> ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$

仅查询某个时间段之后更新过或新建的总成绩, 可用于增量更新

paginated
integer

是否分页，默认 1

page
integer

显示的数据页，默认 1

per_page
integer

每页显示数量，默认 20

Responses

Response samples

Content type
application/json
[
  • {
    }
]

根据课程班 ID 获取评价主体

scope: class.read

Authorizations:
课程班
path Parameters
id
required
integer
query Parameters
expand
string
school_id
required
integer

学校 ID

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "semester_id": 0,
  • "type": "class",
  • "name": "string",
  • "description": "string",
  • "is_template": true,
  • "individuation": true,
  • "plan_id": 0,
  • "scope_id": 0,
  • "scope_type": "class",
  • "scope": {
    },
  • "status": "pending",
  • "setting_lock_status": "all",
  • "score_lock_status": "all",
  • "full_score": "string",
  • "rejected_reason": "string",
  • "published_at": "string",
  • "published_by": 0,
  • "item_num": 0,
  • "total_item_score": "string",
  • "klass": {