dingtalk.oapi.edu.student.get (学生信息查询)

学生信息查询,通过orgid,学生id,班级id,查询学生的名称、所在校区id、年级id、学段id、学生的staffid

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
class_id Number 必须 654321 班级ID
student_userid String 必须 654321 学生ID

响应参数

名称 类型 示例值 描述
result StudentRespone result
  • └ name
  • String
  • name
  • 名称
  • └ class_id
  • Number
  • 123
  • 班级ID
  • └ grade_id
  • Number
  • 123
  • 年级ID
  • └ period_id
  • Number
  • 123
  • 学段ID
  • └ campus_id
  • Number
  • 123
  • 校区ID
  • guardians
  • GuardianRespone []
  • guardians
  • └ guardian_userid
  • String
  • 123
  • 家长ID
  • └ relation
  • String
  • M
  • 关系
  • └ nick
  • String
  • mather
  • 别名
  • └ student_no
  • String
  • 123
  • 学号
success Boolean true 成功状态
errcode Number 0 错误码
errmsg String msg 错误信息

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/edu/student/get");
OapiEduStudentGetRequest req = new OapiEduStudentGetRequest();
req.setClassId(654321L);
req.setStudentUserid("654321");
OapiEduStudentGetResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

响应示例

  • JSON示例
{
    "result":{
        "name":"name",
        "class_id":123,
        "grade_id":123,
        "period_id":123,
        "campus_id":123,
        "guardians":[
            {
                    "guardian_userid":"123",
                    "relation":"M",
                    "nick":"mather"
            }
        ],
        "student_no":"123"
    },
    "success":true,
    "errcode":0,
    "errmsg":"msg"
}

异常示例

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

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部