创建学生

使用场景： 创建一名学生，用于学年开始时的数据初始化，例如新生入学。学生只能放在班级节点下。

权限说明

请求方式： POST（HTTPS）

请求地址： https://test-oapi.epaas.qq.com/school/user/create_student

Query参数:

Body参数：

返回参数：

请求示例：

POST https://test-oapi.epaas.qq.com/school/user/create_student?access_token=ACCESS_TOKEN

请求包体：

{
    "name": "张三",
    "user_number": "student001",
    "department": [1,2],
    "gender": "1",
    "initial_password": "123456ff",
    "department_type":4,
    "mobile":"13522221225",
    "basic_profile": "{\"ic_card\": \"278652\",\"join_date\": \"2010-01-02\"}",
    "extend_profile": "{\"FieldA\": 111,\"FieldB\": 222,\"FieldE\": \"aaa\"}"
}

返回示例：

{
   "errcode": 0,
   "errmsg": "ok",
   "userid": "36825158",
   "profile_msg": ""
}

更新学生资料

使用场景： 调用本接口，更新一名学生的资料。

权限说明

请求方式： POST（HTTPS）

请求地址： https://test-oapi.epaas.qq.com/school/user/update_student_info

Query参数:

Body参数：

返回参数：

请求示例：

POST https://test-oapi.epaas.qq.com/school/user/update_student_info?access_token=ACCESS_TOKEN

请求包体：

 {
    "userid":"2113660",
    "basic_profile": "{\"ic_card\": \"278652\",\"join_date\": \"2010-01-02\"}",
    "extend_profile": "{\"FieldA\": 111,\"FieldB\": 222,\"FieldE\": \"aaa\"}",
    "force_merge_account":false,
    "department_ids":[]
 }

返回示例：

{
   "errcode": 0,
   "errmsg": "ok"
}

删除学生

使用场景： 调用本接口， 删除一名学生。

权限说明

请求方式： GET（HTTPS）

请求地址： https://test-oapi.epaas.qq.com/school/user/delete_student

Query参数:

返回参数：

请求示例：

GET  https://test-oapi.epaas.qq.com/school/user/delete_student?access_token=ACCESS_TOKEN&userid=ID

返回示例：

{
   "errcode": 0,
   "errmsg": "ok"
}

创建家长

使用场景： 创建一名家长，并指定与学生的关系，一般用于新生入学，或者家长信息收集好后录入。需要先创建学生，使用学生id来指定关系。

权限说明

请求方式： POST（HTTPS）

请求地址： https://test-oapi.epaas.qq.com/school/user/create_parent

Query参数:

Body参数：

返回参数：

请求示例：

POST https://test-oapi.epaas.qq.com/school/user/create_parent?access_token=ACCESS_TOKEN

请求包体：

{
    "name": "张三",
    "mobile":"13300000000",
    "children": [
        {
            "student_userid": "30046274",
            "relation": "爸爸"
        },
        {
            "student_userid": "30046275",
            "relation": "家长"
        }
    ],
    "basic_profile": "{\"top_edu\": \"6\",\"work\": \"实验中学\"}",
    "extend_profile": "{\"FieldE\": \"k\"}"
}

返回示例：

{
   "errcode": 0,
   "errmsg": "ok",
   "userid": "98828481",
    "fail_list": [
        {
            "idx": 0,
            "errmsg": "学生不存在",
            "errcode":11
        }
    ],
   "profile_msg": ""
}

更新家长资料

使用场景： 调用本接口，更新一名家长的资料。

权限说明

请求方式： POST（HTTPS）

请求地址： https://test-oapi.epaas.qq.com/school/user/update_parent_info

Query参数:

Body参数：

返回参数：

请求示例：

POST https://test-oapi.epaas.qq.com/school/user/update_parent_info?access_token=ACCESS_TOKEN

请求包体：

 {
    "userid":"98828481",
    "basic_profile": "{\"top_edu\": \"5\",\"work\": \"实验小学\"}",
    "extend_profile": "{\"FieldE\": \"top\"}"
 }

返回示例：

{
   "errcode": 0,
   "errmsg": "ok"
}

删除家长

使用场景： 调用本接口， 删除一名家长。

权限说明

请求方式： GET（HTTPS）

请求地址： https://test-oapi.epaas.qq.com/school/user/delete_parent

Query参数:

返回参数：

请求示例：

GET  https://test-oapi.epaas.qq.com/school/user/delete_parent?access_token=ACCESS_TOKEN&userid=ID

返回示例：

{
   "errcode": 0,
   "errmsg": "ok"
}

学生调班

使用场景： 学生调班，用于将一个学生从一个班级调整到另一个班级

目前，仅支持行政班和毕业班级的调整

权限说明

请求方式： POST（HTTPS）

请求地址： https://test-oapi.epaas.qq.com/school/user/move_department

Query参数:

Body参数：

返回参数：

请求示例：：

POST https://test-oapi.epaas.qq.com/school/user/move_department?access_token=ACCESS_TOKEN

请求包体：

{
    "userids": ["3724826"],
    "department_id": 56777051,
    "department_type": 1
}

返回示例：

{   
    "errcode": 0,   
    "errmsg": "ok"
}

批量绑定学生和家长的关系

使用场景: 批量绑定学生和家长的关系

权限说明

请求方式： POST（HTTPS）

请求地址： https://test-oapi.epaas.qq.com/school/user/batch_bind_student_parent

Query参数:

Body参数：

返回参数：

请求示例：：

POST https://test-oapi.epaas.qq.com/school/user/batch_bind_student_parent?access_token=ACCESS_TOKEN

请求包体：

 {
  "access_token": "",
  "data_list": [
    {
      "child_userid": "1",
      "parent_userid": "2",
      "relation":"家长"
    }
  ]
 }

返回示例：

{
  "errcode": 0,
  "errmsg": "",
  "data_list": [
    {
      "child_userid": "1",
      "parent_userid": "2",
      "errcode": 1,
      "errmsg": "参数错误"
    }
  ]
}

批量解除学生和家长的关系

使用场景： 批量解除学生和家长的关系

权限说明

请求方式： POST（HTTPS）

请求地址： https://test-oapi.epaas.qq.com/school/user/batch_unbind_student_parent

Query参数:

Body参数：

返回参数：

请求示例：：

POST https://test-oapi.epaas.qq.com/school/user/batch_unbind_student_parent?access_token=ACCESS_TOKEN

请求包体：

{
    "access_token": "",
    "data_list": [
        {
            "child_userid": "1882879",
            "parent_userid": "1882880"
        }
    ]
}

返回示例：

{
    "errcode": 0,
    "errmsg": "",
    "data_list": [
        {
            "child_userid": "1882879",
            "parent_userid": "1882880",
            "errcode": 1,
            "errmsg": "学生不存在"
        }
    ]
}

批量添加学生到课程班

使用场景： 批量添加学生到课程班(中小学)/教学班(高校)

权限说明

请求方式： POST（HTTPS）

请求地址： https://test-oapi.epaas.qq.com/school/user/batch_add_course

Query参数:

Body参数：

返回参数：

请求示例：：

POST https://test-oapi.epaas.qq.com/school/user/batch_add_course?access_token=ACCESS_TOKEN

请求包体：

{
    "department_id": "629821",
    "userids": ["3922863","3922864"]
}

返回示例：

{
    "errmsg": "ok",
    "errcode": 0,
    "course_result": [
        {
            "errcode": 0,
            "errmsg": "ok",
            "userid": "3922863"
        },
        {
            "errcode": 0,
            "errmsg": "ok",
            "userid": "3922864"
        }
    ]
}

批量将学生从课程班中删除

使用场景： 批量将学生从课程班(中小学)/教学班(高校)中删除

权限说明

请求方式： POST（HTTPS）

请求地址： https://test-oapi.epaas.qq.com/school/user/batch_delete_course

Query参数:

Body参数：

返回参数：

请求示例：：

POST https://test-oapi.epaas.qq.com/school/user/batch_delete_course?access_token=ACCESS_TOKEN

请求包体：

{
    "department_id": "629821",
    "userids": ["3922863","3922864"]
}

返回示例：

{
    "errmsg": "ok",
    "errcode": 0,
    "course_result": [
        {
            "errcode": 0,
            "errmsg": "ok",
            "userid": "3922863"
        },
        {
            "errcode": 0,
            "errmsg": "ok",
            "userid": "3922864"
        }
    ]
}

学生停用

使用场景： 批量或单个停用学生

权限说明

请求方式： POST（HTTPS）

请求地址： https://test-oapi.epaas.qq.com/school/user/disable_student

Query参数:

Body参数：

请求包体：

{
    "userids":["3724804326", "3724804327"]
}

返回结果：

{
    "errcode": 0,
    "errmsg": "ok"
}

参数说明：

学生启用

使用场景： 批量或单个启用学生

权限说明

请求方式： POST（HTTPS）

请求地址： https://test-oapi.epaas.qq.com/school/user/enable_student

Query参数:

Body参数：

请求包体：

{
    "userids":["3724804326", "3724804327"]
}

返回结果：

{
    "errcode": 0,
    "errmsg": "ok"
}

参数说明：

家长停用

使用场景： 批量或单个停用家长

权限说明

请求方式： POST（HTTPS）

请求地址： https://test-oapi.epaas.qq.com/school/user/disable_parent

Query参数:

Body参数：

请求包体：

{
    "userids":["3724804326", "3724804327"],
}

返回结果：

{
    "errcode": 0,
    "errmsg": "ok"
}

参数说明：

家长启用

使用场景： 批量或单个启用家长

权限说明

请求方式： POST（HTTPS）

请求地址： https://test-oapi.epaas.qq.com/school/user/enable_parent

Query参数:

Body参数：

请求包体：

{
    "userids":["3724804326", "3724804327"]
}

返回结果：

{
    "errcode": 0,
    "errmsg": "ok"
}

参数说明：

家长邀请

使用场景： 邀请成为某学生家长

权限说明

请求方式： POST（HTTPS）

请求地址： https://test-oapi.epaas.qq.com/common/invite/create

Query参数:

Body参数：

请求包体：

{
    "expire_time": 1661254049
}

返回结果：

{
    "errcode": 0,
    "errmsg": "ok",
    "invite_url": "https://test-e.campus.qq.com/parents.html?id=e36f9021127d9ca4099536cc8db5aa7bc4c09d24b80fbb1aaefe343804279b38"
}

参数说明：