批量读取成员资料详情

使用场景： 批量获取成员的详细基础平台资料和应用托管资料，需要指定需要返回的字段列表

权限说明

请求方式： POST（HTTPS）

请求地址：https://jz.hasmartedu.com/oapi/user/batch_get_info

Query参数:

Body参数：

返回参数：

请求示例：

POST https://jz.hasmartedu.com/oapi/user/batch_get_info?access_token=ACCESS_TOKEN

请求包体：

{
  "useridlist": [
    "30010757",
    "30014050"
  ],
  "basic_fields": [
    "userid",
    "name",
    "email"
  ],
  "extend_fields": [
    "FieldA",
    "FieldB",
    "FieldE"
  ],
  "all_extend_fields": true
}

返回示例：

{
  "errmsg": "ok",
  "errcode": 0,
  "result_list": [
    {
      "userid": "30010757",
      "basic_profile": "{\"email\":\"1000@qq.com\",\"name\":\"老师\",\"teach_subject\":[\"1\"],\"user_no\":\"10010\"}",
      "extend_profile": "{\"FieldA\":111,\"FieldB\":222,\"FieldE\":\"aaa\",\"_id\":\"3724396827\"}",
      "errcode": 0,
      "errmsg": "",
      "department_infos": [
        {
          "department_id": 5165437,
          "name": "教师",
          "full_id_path": "/5165435/5165437",
          "full_path": "/倩倩标准版十中/教师",
          "title_id": 74142,
          "title": "普通教师",
          "priority": 1
        }
      ]
    },
    {
      "userid": "30014097",
      "basic_profile": "",
      "extend_profile": "",
      "errcode": 9,
      "errmsg": "用户不存在"
    }
  ]
}

获取部门成员

使用场景： 分页拉取部门下的所有教职工,临时成员，退休老师或教育局员工的简要信息，可以递归拉取所有子部门的教职工。

权限说明

请求方式： GET（HTTPS）

请求地址：https://jz.hasmartedu.com/oapi/user/list_simple

Query参数:

注意：请根据实际需要拉取，为减少时延问题，一般不建议将fetch_child=1

返回参数：

请求示例：

POST https://jz.hasmartedu.com/oapi/user/list_simple?access_token=ACCESS_TOKEN&department_id=DEPARTMENT_ID&fetch_child=FETCH_CHILD&page_index=PAGE_INDEX&page_size=PAGE_SIZE

返回示例：

{
  "errcode": 0,
  "errmsg": "ok",
  "total": 21,
  "user_list": [
    {
      "userid": "10088",
      "name": "李四"
    },
    {
      "userid": "10089",
      "name": "李三"
    }
  ]
}

获取部门成员详情

使用场景： 分页拉取部门下的所有教职工,临时成员，退休老师或教育局员工，可以递归拉取所有子部门的教职工，可用于应用授权安装后的数据初始化，缓存起来使用。

权限说明

请求方式： GET（HTTPS）

请求地址：https://jz.hasmartedu.com/oapi/user/list

Query参数:

Body参数：

注意：请根据实际需要拉取，为减少时延问题，建议设置not_fetch_account=1，fetch_child=0

返回参数：

请求示例：

GET https://jz.hasmartedu.com/oapi/user/list?access_token=ACCESS_TOKEN&department_id=10001&not_fetch_account=1&fetch_child=1&page_index=1&page_size=20

返回示例：

{
  "errcode": 0,
  "errmsg": "ok",
  "total": 22,
  "userlist": [
    {
      "userid": "10228",
      "name": "李四",
      "department_infos": [
        {
          "department_id": 1,
          "name": "一班",
          "title_id": 1,
          "title": "老师"
        },
        {
          "department_id": 2,
          "name": "二班",
          "title_id": 1,
          "title": "老师",
          "priority": 1
        }
      ],
      "department": [
        1,
        2
      ],
      "position": "1",
      "gender": "1",
      "status": 1,
      "role_admin_types": [
        41
      ]
    }
  ]
}

成员检索 (指定机构)

使用场景： 搜索机构内的成员。

权限说明

请求方式： POST（HTTPS）

请求地址：https://jz.hasmartedu.com/oapi/user/search

Query参数:

Body参数：

返回参数：

请求示例：

POST https://jz.hasmartedu.com/oapi/user/search?access_token=ACCESS_TOKEN

请求包体：

{
  "name": "张",
  "is_name_fuzzy": true,
  "department_id": 100001,
  "fetch_child": 1
}

返回示例：

{
  "errcode": 0,
  "errmsg": "ok",
  "data_list": [
    {
      "userid": "30009386",
      "name": "张三",
      "status": 1
    },
    {
      "userid": "30009783",
      "name": "张九",
      "status": 1
    }
  ],
  "total": 2
}

检索成员(包括下属机构)

使用场景： 搜索本机构和下属机构内的教职工。支持虚拟机构

权限说明

请求方式： [GET, POST]（HTTPS）

请求地址： https://jz.hasmartedu.com/oapi/user/search_in_sub_orgs

Query参数:

Body参数：

返回参数：

请求示例：

POST https://jz.hasmartedu.com/oapi/user/search_in_sub_orgs?access_token=ACCESS_TOKEN

请求包体：

{
  "page_index": 1,
  "page_size": 10,
  "sub_corpid": "0",
  "search_type": 1,
  "search_value": "张",
  "hide_creator": true,
  "need_depart": 1
}

返回示例：

{
  "errcode": 0,
  "errmsg": "ok",
  "data_list": [
    {
      "userid": "3722428406",
      "name": "张三",
      "status": 1,
      "corpid": "889074",
      "corp_name": "测试学校",
      "role_id": 12,
      "department_ids": [
        6645258,
        6066987
      ]
    }
  ],
  "total": 1
}

扩展资料成员检索(本机构)

使用场景： 使用扩展资料字段搜索当前机构内员工,只支持精确匹配

权限说明

请求方式： [GET, POST]（HTTPS）

请求地址： https://jz.hasmartedu.com/oapi/user/search_profile

Query参数:

Body参数：

返回参数：

请求示例：

POST https://jz.hasmartedu.com/oapi/user/search_profile?access_token=ACCESS_TOKEN

请求包体：

{
  "search_keys": [
    {
      "key": "test_1",
      "value": "123"
    }
  ],
  "page_index": 1,
  "page_size": 10
}

返回示例：

{
  "errcode": 0,
  "errmsg": "ok",
  "data_list": [
    {
      "userid": "3722428406",
      "name": "张三",
      "status": 1
    }
  ],
  "total": 1
}

查询成员的用户组列表

使用场景：查询教职工是否有管理员身份等。

权限说明

请求方式： GET（HTTPS）

请求地址：https://jz.hasmartedu.com/oapi/common/teacher/get_group

Query参数:

返回参数：

请求示例:

GET https://jz.hasmartedu.com/oapi/common/teacher/get_group?access_token=ACCESS_TOKEN&userid=10088

返回示例：

{
  "errcode": 0,
  "errmsg": "ok",
  "group_ids": [
    1,
    3
  ]
}

查询用户数量

使用场景： 查询本机构和下属机构内的用户数量

权限说明

请求方式： [POST]（HTTPS）

请求地址： https://jz.hasmartedu.com/oapi/corp/user_stat/batch_get

Query参数:

Body参数：

返回参数：

请求示例：

POST https://jz.hasmartedu.com/oapi/corp/user_stat/batch_get?access_token=ACCESS_TOKEN

请求包体：

{
  "role_id": [
    2,
    11,
    12,
    14
  ],
  "sub_corpid": [],
  "fetch_child_corps": 1
}

返回示例：

{
  "errmsg": "ok",
  "errcode": 0,
  "data_list": [
    {
      "corpid": 888971,
      "name": "测试学校1",
      "grade_num": 6,
      "class_num": 60,
      "user_stat": [
        {
          "role_id": 11,
          "person_stat_count": 121
        },
        {
          "role_id": 12,
          "person_stat_count": 56
        },
        {
          "role_id": 13,
          "person_stat_count": 37
        },
        {
          "role_id": 14,
          "person_stat_count": 2
        }
      ]
    },
    {
      "corpid": 1004379,
      "name": "测试教育局1",
      "grade_num": 0,
      "class_num": 0,
      "user_stat": [
        {
          "role_id": 2,
          "person_stat_count": 165
        }
      ]
    }
  ]
}

根据职务查询用户列表

使用场景： 根据职务查询用户列表

权限说明

请求方式： [GET]（HTTPS）

请求地址： https://jz.hasmartedu.com/oapi/user/get_user_by_title

Query参数:

Body参数：

返回参数：

请求示例：

GET https://jz.hasmartedu.com/oapi/user/get_user_by_title?access_token=ACCESS_TOKEN&title=TITLE

返回示例：

{
  "errmsg": "ok",
  "errcode": 0,
  "list": [
    {
      "userid": "3727171349",
      "user_name": "王宗欢",
      "department_id": 6080150,
      "department_name": "测试部",
      "title": "局长"
    },
    {
      "userid": "3727171349",
      "user_name": "王宗欢",
      "department_id": 6147324,
      "department_name": "市属学校",
      "title": "局长"
    }
  ]
}

批量机构根据职务查询用户列表

使用场景： 批量机构根据职务查询用户列表

权限说明

请求方式： [GET]（HTTPS）

请求地址： https://jz.hasmartedu.com/oapi/user/batch_get_user_by_title

Query参数:

Body参数：

返回参数：

请求示例：

POST https://jz.hasmartedu.com/oapi/user/batch_get_user_by_title?access_token=ACCESS_TOKEN

{
  "title": "校长",
  "corpid_list": [
    100001,
    100002
  ],
  "page_size": 30,
  "page_index": 1
}

返回示例：

{
  "errmsg": "ok",
  "errcode": 0,
  "list": [
    {
      "userid": "123456",
      "user_name": "王new",
      "department_id": 8180,
      "department_name": "教师",
      "title": "普通教师",
      "title_id": 859,
      "corpid": 100001,
      "corp_name": "xxx小学"
    },
    {
      "userid": "123457",
      "user_name": "王爸爸",
      "department_id": 10489,
      "department_name": "教务处",
      "title": "普通教师",
      "title_id": 860,
      "corpid": 100002,
      "corp_name": "xxx小学2"
    }
  ],
  "total": 235
}

虚拟组成员

使用场景： 查询虚拟组内用户列表

权限说明

请求方式： [GET]（HTTPS）

请求地址： https://jz.hasmartedu.com/oapi/virtual_group/user/list

Query参数:

返回参数：

请求示例：

GET https://jz.hasmartedu.com/oapi/virtual_group/user/list?access_token=ACCESS_TOKEN&group_id=1&fetch_child=1

返回示例：

{
  "errmsg": "ok",
  "errcode": 0,
  "total": 3,
  "user_infos": [
    {
      "userid": "5824",
      "name": "jahe",
      "role_id": 12,
      "corp_id": 1086786,
      "group_id": 8413107,
      "group_name": "abc"
    },
    {
      "userid": "3732",
      "name": "tencent",
      "role_id": 12,
      "corp_id": 1086786,
      "group_id": 8413107,
      "group_name": "abc"
    }
  ]
}