dingtalk.oapi.edu.homework.user.role.query (查询用户角色)

查询用户角色

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
userid String 必须 23434 用户ID
biz_code String 必须 SONGSHU 业务编码
class_id Number 可选 23434324 班级ID

响应参数

名称 类型 示例值 描述
result Result 返回结果
  • └ teacher
  • Boolean
  • false
  • 是否老师
  • └ student
  • Boolean
  • true
  • 是否学生
  • └ headmaster
  • Boolean
  • false
  • 是否班主任
  • └ students
  • String []
  • 学生列表
  • └ guardian
  • Boolean
  • false
  • 是否家长
  • └ user_role
  • String
  • student
  • 用户角色
success Boolean true 是否成功
errcode Number 0 错误编码
errmsg String demo 错误信息

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/edu/homework/user/role/query");
OapiEduHomeworkUserRoleQueryRequest req = new OapiEduHomeworkUserRoleQueryRequest();
req.setUserid("23434");
req.setBizCode("SONGSHU");
req.setClassId(23434324L);
OapiEduHomeworkUserRoleQueryResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

响应示例

  • JSON示例
{
    "result":{
        "teacher":false,
        "student":true,
        "headmaster":false,
        "students":{
            "string":[
                ""
            ]
        },
        "guardian":false,
        "user_role":"student"
    },
    "success":true,
    "errcode":0,
    "errmsg":"demo"
}

异常示例

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

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部