简要描述:

  • 获取学生信息

接口版本:

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

请求URL:

  • http://{api-gateway-host}/ding/topapi/edu/class/studentinfo/get

请求方式:

  • POST

认证方式:

  • HMAC

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

请求头:

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

请求参数:

参数名 是否必须 类型 默认值 说明
class_id long 班级ID
app_id long 应用ID 无用
userid string 学生ID

请求示例:

{
    "class_id": 0,
    "app_id": 0,
    "userid": "string"
}

返回示例:

正确时返回:

{
    "request_id": "string",
    "success": true,
    "errcode": 0,
    "result": {
        "userid": "string",
        "student_num": "string",
        "name": "string",
        "class_id": 0,
        "avatar": "string",
        "guardians": [
            {
                "userid": "string",
                "relation": "string",
                "relation_name": "string",
                "name": "string",
                "is_active": true,
                "avatar": "string"
            }
        ]
    }
}

错误时返回:

返回参数说明:

参数名 类型 说明
request_id string 请求ID
success boolean 是否成功
errcode int 返回码
result.userid string 学生的userid
result.student_num string 学生的学号
result.name string 学生姓名
result.class_id long 班级ID
result.avatar string 学生头像id
result.guardians array 家长列表
result.guardians.userid string 家长ID
result.guardians.relation string 学生和家长关系。 F:爸爸 M:妈妈 O:其他
result.guardians.relation_name string 关系名称
result.guardians.name string 家长姓名
result.guardians.is_active boolean 是否激活 暂时无用 true:已激活 false:未激活
result.guardians.avatar string 家长头像
作者:wangtc  创建时间:2023-10-08 10:41
最后编辑:wangtc  更新时间:2023-11-14 11:11