简要描述：

  • 获取学生监护人详情

接口版本：

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

请求URL:

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

请求方式：

  • POST

认证方式：

  • HMAC

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

请求头：

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

请求参数:

参数名 是否必须 类型 默认值 说明
from_userid 是 string 监护人userid
class_id 是 long 班级ID

请求示例:

{
    "from_userid": "string",
    "class_id": 0
}

返回示例:

正确时返回:

{
    "request_id": "string",
    "success": true,
    "errcode": 0,
    "result": {
        "relations": [
            {
                "class_id": 0,
                "relation_name": "string",
                "relation_code": "string",
                "from_userid": "string",
                "to_userid": "string"
            }
        ]
    }
}

错误时返回:

返回参数说明:

参数名 类型 说明
request_id string 请求ID
success boolean 是否成功
errcode int 返回码
result.relations array 关系列表
result.relations.class_id long 班级ID 不一定准确，获取的是当前用户所有的关系
result.relations.relation_name string 关系名
result.relations.relation_code string 关系code： F：爸爸 M：妈妈 GF：爷爷 GM：奶奶 GFA：外公 GMA：外婆 U：叔叔 A：阿姨 B：哥哥 S：姐姐 O：家长
result.relations.from_userid string 监护人userid
result.relations.to_userid string 学生userid
作者：wangtc  创建时间：2023-10-08 10:41
最后编辑：wangtc  更新时间：2023-11-14 11:11