获取部门学生

使用场景： 分页获取指定部门下的学生简要信息。接口会返回总数，用于判断分页是否可以结束。

权限说明

请求方式： GET（HTTPS）

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

Query参数:

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

返回参数：

请求示例：

GET https://jz.hasmartedu.com/oapi/school/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": 100,
  "students": [
    {
      "userid": "985295",
      "name": "张三",
      "status": 1
    },
    {
      "userid": "985280",
      "name": "李四",
      "status": 1
    }
  ]
}

获取部门成员详情

使用场景：

分页获取指定部门下的学生列表及家长信息。接口会返回总数，用于判断分页是否可以结束。此接口用于班级学生列表的展示，或者整个校区、学段或年级下的学生列表展示。一般情况下，应用在收到授权通知并应答后，需要调用此接口将数据拉回本地做缓存，以减少用户实时访问时频繁访问接口；同时，需要定时调用此接口拉回全量的数据做对比和修复，防止由于回调通知丢失导致数据不一致。

权限说明

请求方式： GET（HTTPS）

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

Query参数:

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

加解密代码

返回参数：

请求示例：

GET https://jz.hasmartedu.com/oapi/school/user/list?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": 100,
  "students": [
    {
      "student_userid": "985295",
      "name": "张三",
      "department": [
        1,
        2
      ],
      "virtual_department": [
        11,
        12
      ],
      "status": 1,
      "parents": [
        {
          "parent_userid": "985296",
          "relation": "爸爸",
          "is_subscribe": 1,
          "name": "张爸爸",
          "status": 1
        },
        {
          "parent_userid": "985297",
          "relation": "妈妈",
          "is_subscribe": 0,
          "name": "张妈妈",
          "status": 1
        }
      ]
    },
    {
      "student_userid": "985280",
      "name": "李四",
      "department": [
        4,
        5
      ],
      "virtual_department": [
        12
      ],
      "status": 1,
      "parents": [
        {
          "parent_userid": "985281",
          "relation": "爷爷",
          "is_subscribe": 1,
          "name": "李爷爷"
        }
      ]
    }
  ]
}

批量获取学生资料

使用场景： 调用本接口，获取多名学生的资料。

权限说明

请求方式： POST（HTTPS）

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

Query参数:

Body参数：

返回参数：

请求示例：：

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

请求包体：

{
  "userids": [
    "30046274",
    "30046275"
  ],
  "basic_fields": [
    "ic_card",
    "join_date"
  ],
  "extend_fields": [
    "FieldA",
    "FieldB",
    "FieldE"
  ],
  "all_extend_fields": true
}

返回示例：

{
  "errcode": 0,
  "errmsg": "ok",
  "data_list": [
    {
      "userid": "30046274",
      "basic_profile": "{\"ic_card\": \"278652\",\"join_date\": \"2010-01-02\"}",
      "extend_profile": "{\"FieldA\": 111,\"FieldB\": 222,\"FieldE\": \"aaa\"}",
      "department_infos": [
        {
          "department_id": 5617311,
          "name": "一班",
          "full_id_path": "/5165435/5165436/7608621/5617311",
          "full_path": "/测试学校/学生/2011级/一班",
          "type": 1
        }
      ]
    },
    {
      "userid": "30046275",
      "basic_profile": "{\"ic_card\": \"958284\",\"join_date\": \"2010-07-02\"}",
      "extend_profile": "{\"FieldA\": 3,\"FieldB\": 6,\"FieldE\": \"eee\"}",
      "department_infos": [
        {
          "department_id": 5617311,
          "name": "一班",
          "full_id_path": "/5165435/5165436/7608621/5617311",
          "full_path": "/测试学校/学生/2011级/一班"
          "type": 1
        }
      ]
    }
  ]
}

批量获取家长资料

使用场景： 调用本接口，获取多名家长的资料。

权限说明

请求方式： POST（HTTPS）

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

Query参数:

Body参数：

返回参数：

请求示例：：

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

请求包体：

{
  "userids": [
    "30046274",
    "30046275"
  ],
  "basic_fields": [
    "top_edu",
    "work"
  ],
  "extend_fields": [
    "FieldE"
  ],
  "all_extend_fields": true
}

返回示例：

{
  "errcode": 0,
  "errmsg": "ok",
  "user_list": [
    {
      "userid": "30046274",
      "basic_profile": "{\"top_edu\": \"6\",\"work\": \"实验中学\"}",
      "extend_profile": "{\"FieldE\": \"middle\"}"
    },
    {
      "userid": "30046275",
      "basic_profile": "{\"top_edu\": \"8\",\"work\": \"第一中学\"}",
      "extend_profile": "{\"FieldE\": \"top\"}"
    }
  ]
}

批量获取学生关联的家长信息

使用场景： 根据学生的userids批量查询关联的家长信息，用于统计学生查询到其关联的家长列表及关系。

权限说明

请求方式： POST（HTTPS）

请求地址： https://jz.hasmartedu.com/oapi/school/parent/batch_get

Query参数:

Body参数：

返回参数：

请求示例：

POST https://jz.hasmartedu.com/oapi/school/parent/batch_get?access_token=ACCESS_TOKEN

请求包体：

{
  "userids": [
    "1254",
    "1519"
  ]
}

返回示例：

{
  "errcode": 0,
  "errmsg": "ok",
  "total": 2,
  "student_parent_infos": [
    {
      "student_userid": "1254",
      "parents": [
        {
          "parent_userid": "1297",
          "relation": "爸爸",
          "name": "张爸爸",
          "status": 1
        },
        {
          "parent_userid": "1296",
          "relation": "妈妈",
          "name": "张妈妈",
          "status": 1
        }
      ]
    },
    {
      "student_userid": "1519",
      "parents": [
        {
          "parent_userid": "1520",
          "relation": "爷爷",
          "name": "李爷爷",
          "status": 1
        }
      ]
    }
  ]
}

批量获取家长关联的学生信息

使用场景： 根据家长id批量查询其关联的学生信息。

权限说明

请求方式： POST（HTTPS）

请求地址： https://jz.hasmartedu.com/oapi/school/student/batch_get_by_parent

Query参数:

Body参数：

返回参数：

请求示例：

POST https://jz.hasmartedu.com/oapi/school/student/batch_get_by_parent?access_token=ACCESS_TOKEN

请求包体：

{
  "userids": [
    "37288",
    "37278"
  ]
}

返回示例：

{
  "errmsg": "ok",
  "errcode": 0,
  "parent_students_infos": [
    {
      "errmsg": "ok",
      "parent_userid": "37288",
      "students": [
        {
          "student_userid": "37208",
          "relation": "家长",
          "name": "小明",
          "status": 1
        },
        {
          "student_userid": "37237",
          "relation": "家长",
          "name": "小花",
          "status": 1
        }
      ]
    },
    {
      "errmsg": "ok",
      "parent_userid": "37278",
      "students": [
        {
          "student_userid": "37277",
          "relation": "妈妈",
          "name": "小红",
          "status": 1
        }
      ]
    }
  ]
}

检索学生（本学校）

使用场景： 搜索当前学校内的学生。

权限说明

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

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

Query参数:

Body参数：

搜索说明：入参带有关键字的字段，不能全部为空

返回参数：

请求示例：

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

请求包体：

{
  "page_index": 1,
  "page_size": 10,
  "name": "张",
  "phone": "13000000000",
  "user_number": "10100001",
  "parent_name": "张爸爸",
  "parent_phone": "13000000001",
  "ic_card": "card1001",
  "is_name_fuzzy": true,
  "is_user_number_fuzzy": true,
  "is_ic_card_fuzzy": true,
  "student_type": 11
}

返回示例：

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

检索家长（本学校)

使用场景： 搜索学校内的家长

权限说明

请求方式： GET（HTTPS）

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

Query参数:

返回参数：

请求示例：

GET https://jz.hasmartedu.com/oapi/school/parent/search?access_token=ACCESS_TOKEN&name=NAME&is_name_fuzzy=IS_NAME_FUZZY&&page_index=PAGE_INDEX&page_size=PAGE_SIZE

返回示例：

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

检索学生(包括下属学校)

使用场景： 搜索本机构和下属学校内的学生。支持虚拟机构

权限说明

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

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

Query参数:

Body参数：

返回参数：

请求示例：

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

请求包体：

{
  "page_index": 1,
  "page_size": 10,
  "sub_corpid": "0",
  "search_type": 1,
  "search_value": "张",
  "status": 0,
  "department_id": [
    5691838,
    5691839
  ]
}

返回示例：

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

扩展资料检索学生(本学校)

使用场景： 使用扩展资料字段搜索当前学校内学生,只支持精确匹配

权限说明

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

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

Query参数:

Body参数：

返回参数：

请求示例：

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

请求包体：

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

返回示例：

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