简要描述：

  • 获取人员列表

接口版本：

版本号 制定人 制定日期 修订日期
v0.1 dev 2022-03-23 init

请求URL:

  • http://{api-gateway-host}/ding/topapi/edu/user/list

请求方式：

  • POST

认证方式：

  • HMAC

详细可参见 开放平台API的认证说明

请求头：

参数名 是否必须 类型 说明
Content-Type 是 string 请求类型： application/json
Date 是 string http协议标准头
Authorization 是 string hmac 签名
sdp-app-id 是 string 应用租户ID，具体信息获取方式参见应用的sdp-app-id参数获取方式

请求参数:

参数名 是否必须 类型 默认值 说明
page_size 是 int 最小1 最大30
page_no 是 int 从1开始
class_id 是 long 班级ID
role 是 string 家校人员角色： teacher：老师 guardian：监护人 student：学生

请求示例:

{
    "page_size": 0,
    "page_no": 0,
    "role": "string",
    "class_id": 0
}

返回示例:

正确时返回:

{
    "request_id": "string",
    "success": true,
    "errcode": 0,
    "result": {
        "has_more": true,
        "details": [
            {
                "class_id": 0,
                "role": "string",
                "feature": "string",
                "is_adviser": "string",
                "student_no": "string",
                "name": "string",
                "unionid": "string",
                "userid": "string"
            }
        ]
    }
}

错误时返回:

返回参数说明:

参数名 类型 说明
request_id string 请求ID
success boolean 是否成功
errcode int 返回码
result.has_more boolean 是否有更多数据
result.details array 关系列表
result.details.class_id long 班级ID 不一定准确，获取的是当前用户所有的关系
result.details.role string 家校人员角色： teacher: 老师 guardian: 监护人 student: 学生
result.details.feature string 不同角色的其他业务属性，可JSON反序列化。
result.details.is_adviser string 只在老师角色下意义。 1：班主任 0：表示非班主任
result.details.student_no string 学号，只有在学生角色下才有意义。
result.details.name string 人员名
result.details.unionid string 暂时无此数据
result.details.userid string 人员userid
作者：wangtc  创建时间：2023-10-08 10:41
最后编辑：wangtc  更新时间：2023-11-14 11:11