dingtalk.oapi.edu.guardian.get (家长信息查询)

家长信息查询,查询家长信息,通过orgid,班级id查询家长的nick(如:小A的爸爸),非真实姓名,关系类别(妈妈、爸爸、其他亲属),学生staffid

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
class_id Number 必须 123 班级ID
guardian_userid String 必须 123 家长ID

响应参数

名称 类型 示例值 描述
result GuardianRespone result
  • └ nick
  • String
  • 妈妈
  • 关系名称
  • └ student_userid
  • String
  • 123
  • 学生ID
  • └ guardian_userid
  • String
  • 123
  • 家长ID
  • └ relation
  • String
  • M
  • 关系类型(M妈妈,D爸爸,O其他)
  • relations
  • Relations []
  • fafa\\
  • fdaf
  • └ student_userid
  • String
  • fafa\\
  • fafa\\
  • └ nick
  • String
  • fafa\\
  • fafa\\
  • └ relation
  • String
  • fafa\\
  • fafa\\
errcode Number 0 错误码
errmsg String msg 错误信息
success Boolean true 成功状态

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/edu/guardian/get");
OapiEduGuardianGetRequest req = new OapiEduGuardianGetRequest();
req.setClassId(123L);
req.setGuardianUserid("123");
OapiEduGuardianGetResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

响应示例

  • JSON示例
{
    "result":{
        "nick":"妈妈",
        "student_userid":"123",
        "guardian_userid":"123",
        "relation":"M",
        "relations":[
            {
                    "student_userid":"fafa\\\\",
                    "nick":"fafa\\\\",
                    "relation":"fafa\\\\"
            }
        ]
    },
    "errcode":0,
    "errmsg":"msg",
    "success":true
}

异常示例

  • JSON示例
{
	"errcode":88,
	"errmsg":"ding talk error"
}

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部