班级学员列表

POST

/roadmap/hsk-class/student/page-info

请求参数

Header 参数

payload

string

可选

默认值:

{'mid':{{mid}},'username':{{username}}}

Authorization

string

可选

默认值:

bearer {{access_token}}

Body 参数application/json

page

integer

当前页

可选

默认值:

size

integer

每页记录数

可选

默认值:

classId

integer <int64>

班级ID

必需

query

string

可选

用户短ID或者用户名

labelId

integer <int64>

标签ID

可选

示例

{
    "page": 1,
    "size": 20,
    "classId": 0,
    "query": "string",
    "labelId": 0
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://test-apisix.taolihanyu.net/roadmap/hsk-class/student/page-info' \
--header 'payload: {'\''mid'\'':{{mid}},'\''username'\'':{{username}}}' \
--header 'Authorization: bearer {{access_token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "page": 1,
    "size": 20,
    "classId": 0,
    "query": "string",
    "labelId": 0
}'

返回响应

🟢200成功

application/json

Body

code

string

可选

data

array[object (HskClassStudent) {13}]

可选

remark

string

备注

可选

createBy

string

创建人

可选

createTime

string

可选

updateBy

string

更新人

可选

updateTime

string

可选

integer <int64>

学生ID

可选

username

string

用户名

可选

uid

integer <int64>

用户短ID

可选

mid

integer <int64>

用户长ID

可选

hskClassId

integer <int64>

关联的班级ID

可选

status

integer

可选

学员状态:0在学;1停课

deleted

integer

可选

是否删除:0未删除;1删除

labelUses

string

可选

标签列表多个用,分隔

msg

string

可选

total

integer

可选

示例

{
  "code": "",
  "data": [
    {
      "remark": "",
      "createBy": "",
      "createTime": "",
      "updateBy": "",
      "updateTime": "",
      "id": 0,
      "username": "",
      "uid": 0,
      "mid": 0,
      "hskClassId": 0,
      "status": 0,
      "deleted": 0,
      "labelUses": ""
    }
  ],
  "msg": "",
  "total": 0
}

修改于 2025-06-21 07:16:38

解散班级

获取班级学员人数