通讯录是指上级单位(教育局)的职工组织架构和成员,以及学校的教职工的组织架构和成员,但不包括学生相关的组织架构和成员。
部门管理
创建部门(department/create)
使用场景: 在教职工,退休老师,临时组,教育局下创建一个行政部门,用于学校数据同步。创建成功后会返回部门Id,用于继续创建子部门。
是否需额外授权: 是
请求方式: POST(HTTPS)
请求地址: https://test-oapi.epaas.qq.com/department/create?access_token=ACCESS_TOKEN
请求包体:
{
"name": "教务处",
"department_type": 2,
"parentid": 1,
"order": 1,
"code": "1010931_1_838386",
}
参数说明 :
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证,使用corp_access_token,由/service/get_corp_token获得 |
department_type | 否 | 部门类型,对于学校可以传入2(教职工),5(退休老师),6(临时组),默认值为教职工。对于上级单位可以传入9(教育局员工) ,默认值为教育局员工 |
name | 是 | 部门名字 |
parentid | 是 | 父部门的Id,32位整数,根部门为1 |
order | 是 | 在父部门中的次序值,32位整数,越小排序越前 |
code | 否 | 部门唯一Code |
返回结果:
{
"errcode": 0,
"errmsg": "ok",
"id": 2
}
参数说明:
参数 | 说明 |
---|---|
errcode | 返回码 |
errmsg | 对返回码的文本描述内容 |
id | 创建的部门id |
修改部门(department/update)
使用场景: 更新行政部门的名字、排序和父节点,用于学校数据同步。更新父部门则是将整个部门平移到新的父部门下边。可以更新的部门类型包括教职工,退休老师,临时组,教育局员工,更新的节点与父节点需要在同一个部门类型下面。
是否需额外授权: 是
请求方式: POST(HTTPS)
请求地址: https://test-oapi.epaas.qq.com/department/update?access_token=ACCESS_TOKEN
请求包体:
{
"id": 2,
"name": "教务处",
"parentid": 1,
"order": 1,
"code": "1010931_1_838386",
}
参数说明 :
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证,使用corp_access_token,由/service/get_corp_token获得 |
id | 是 | 要修改的部门Id |
name | 是 | 部门名字 |
parentid | 是 | 父部门的Id,32位整数 |
order | 是 | 在父部门中的次序值,32位整数,越小排序越前 |
code | 否 | 部门唯一Code |
返回结果:
{
"errcode": 0,
"errmsg": "ok"
}
参数说明:
参数 | 说明 |
---|---|
errcode | 返回码 |
errmsg | 对返回码的文本描述内容 |
删除部门(department/delete)
使用场景: 删除指定的学校行政部门,用于学校数据同步。可以删除的部门类型包括教职工,退休老师,临时组,教育局员工。
是否需额外授权: 是
请求方式: GET(HTTPS)
请求地址: https://test-oapi.epaas.qq.com/department/delete?access_token=ACCESS_TOKEN&id=ID
参数说明 :
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证,使用corp_access_token,由/service/get_corp_token获得 |
id | 是 | 部门ID, 不能删除根部门,含有子部门、教职工的部门 |
返回结果:
{
"errcode": 0,
"errmsg": "ok"
}
参数说明:
参数 | 说明 |
---|---|
errcode | 返回码 |
errmsg | 对返回码的文本描述内容 |
获取部门列表(department/list)
使用场景: 获取学校行政部门列表,用于学校授权后的组织架构数据初始化,需缓存起来使用。
是否需额外授权: 否
请求方式: GET(HTTPS)
请求地址: https://test-oapi.epaas.qq.com/department/list?access_token=ACCESS_TOKEN&id=ID
参数说明 :
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证,使用corp_access_token,由/service/get_corp_token获得 |
id | 否 | 部门id。获取指定部门及其下的子部门。 如果不填,默认获取全量组织架构 |
next_level_only | 否 | 0:所有节点;1:只获取下一层节点 |
need_role_node | 否 | 是否需要角色根节点 |
获取老师组织架构根节点示例: https://test-oapi.epaas.qq.com/department/list?access_token=ACCESS_TOKEN&next_level_only=1&need_role_node=true
返回结果:(下面就是获取教师组织架构根节点的返回示例,后续学生相关部门节点,可以逐层挂到“教师”节点下面)
{
"errcode": 0,
"errmsg": "ok",
"department": [
{
"id": 222,
"name": "xx学校",
"parentid": 1,
"level":1,
"order": 0,
"code":""
},
{
"id": 223,
"name": "教师",
"parentid": 222,
"level":2,
"order":2,
"code": ""
}
]
}
参数说明:
参数 | 说明 |
---|---|
errcode | 返回码 |
errmsg | 对返回码的文本描述内容 |
department | 部门列表数据 |
department.id | 部门id,机构内唯一 |
department.name | 部门名称 |
department.parentid | 父部门id |
department.order | 在父部门中的次序值。order值越小排序越前。值范围是[0, 2^32) |
成员管理
特别说明 成员管理接口默认只对教职工(含教育局员工)有效,若要对学校退休员工或学校临时成员进行管理,必须传入department_type字段
创建教职工(user/create)
使用场景: 创建一个教职工,临时成员,退休老师或教育局员工,用于学校数据同步。
是否需额外授权: 是
请求方式: POST(HTTPS)
请求地址: https://test-oapi.epaas.qq.com/user/create?access_token=ACCESS_TOKEN
请求包体:
{
"name": "张三",
"mobile": "13800000000",
"gender": "1",
"user_number": "teacher001",
"department_infos":[
{"department_id":3032773,"title_id":25342},
{"department_id":3032772,"title_id":25342}
],
"department_type":2,
"basic_profile": "{\"user_number\": \"test116\",\"join_date\": \"2010-01-02\"}",
"extend_profile": " {\"FieldA\": 111,\"FieldB\": 222,\"FieldE\": \"aaa\"} "
}
参数说明 :
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证,使用corp_access_token,由/service/get_corp_token获得 |
name | 是 | 人员名字 |
mobile | 是 | 手机号码 |
gender | 是 | 性别。1表示男性,2表示女性 |
user_number | 是 | 教职工工号;学校老师必填,教育局员工非必填 |
department_infos | 是 | 用户所在部门和职位信息列表,一个用户允许存在多个部门 |
department_infos.department_id | 是 | 用户所在部门 |
department_infos.title_id | 否 | 用户所在部门对应的职位,不填,默认为“普通老师”和"普通员工" |
department_type | 否 | 部门类型,对于学校可以传入2(教职工),5(退休老师),6(临时组),默认值为教职工。对于上级单位可以传入9(教育局员工) ,默认值为教育局员工,传入的department_type应与传入的部门id类型保持一致 |
basic_profile | 否 | 教职工基础资料,json字符串,学校参考教职工资料字段。行政单位参考行政单位职工资料字段。 |
extend_profile | 否 | 教职工扩展资料,json字符串 |
返回结果:
{
"errcode": 0,
"errmsg": "ok",
"userid": "76234"
}
参数说明:
参数 | 说明 |
---|---|
errcode | 返回码,0为正常 |
errmsg | 对返回码的文本描述内容 |
userid | 创建的教职工用户id |
更新教职工资料(user/update_info)
使用场景: 更新教职工资料
是否需额外授权: 是
请求方式: POST(HTTPS)
请求地址: https://test-oapi.epaas.qq.com/user/update_info?access_token=ACCESS_TOKEN
请求包体:
{
"userid": "3724396827",
"basic_profile": "{\"position\":\"\",\"teach_section\":null,\"training_info\":null,\"user_number\":\"test116\"}",
"extend_profile": "{\"FieldA\":111,\"FieldB\":222,\"FieldE\":\"aaa\",\"_id\":\"3724396827\"}"
}
请求说明:
basic_profile和extend_profile,不能同时为空
参数说明:
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证,使用corp_access_token,由/service/get_corp_token获得 |
userid | 是 | 用户id |
basic_profile | 否 | 教职工基础平台资料,学校参考教职工资料字段。行政单位参考行政单位职工资料字段。 |
extend_profile | 否 | 教职工扩展资料,json字符串 |
返回结果:
{
"errmsg": "ok",
"errcode": 0
}
参数说明:
参数 | 说明 |
---|---|
errcode | 返回码 |
errmsg | 对返回码的文本描述内容 |
教职工调部门(/user/move_department)
使用场景: 教职工调部门
是否需额外授权: 否
请求方式: POST(HTTPS)
请求地址: https://test-oapi.epaas.qq.com/user/move_department?access_token=ACCESS_TOKEN
请求包体:
{
"userids":["3724804326","3758412570"],
"department_ids":[5670337,5671220],
"department_type":2
}
参数说明:
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证 |
userids | 是 | 用户id列表 |
department_ids | 是 | 部门id列表 |
department_type | 是 | 部门类型 2:教职工 5:退休教师 6:临时成员 9:教育局教职工 |
返回结果:
{
"errcode": 0,
"errmsg": "ok"
}
参数说明:
参数 | 说明 |
---|---|
errcode | 返回码 |
errmsg | 对返回码的文本描述内容 |
删除教职工(user/delete)
使用场景: 删除指定教职工,临时成员,退休老师或教育局员工,用于学校数据同步。
是否需额外授权: 是
请求方式: GET(HTTPS)
请求地址: https://test-oapi.epaas.qq.com/user/delete?access_token=ACCESS_TOKEN&userid=ID
参数说明 :
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证,使用corp_access_token,由/service/get_corp_token获得 |
userid | 是 | 人员ID |
返回结果:
{
"errcode": 0,
"errmsg": "ok"
}
参数说明:
参数 | 说明 |
---|---|
errcode | 返回码 |
errmsg | 对返回码的文本描述内容 |
退休教职工(user/retire)
使用场景: 退休教职工,退休操作是不可逆的。
是否需额外授权: 是
请求方式: POST(HTTPS)
请求地址: https://test-oapi.epaas.qq.com/user/retire?access_token=ACCESS_TOKEN
请求包体:
{
"userids": ["30046307", "30046308"],
"reason": "停职"
}
参数说明 :
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证,使用corp_access_token,由/service/get_corp_token获得 |
userids | 是 | 退休人员ID,退休人员必须是普通教职工或教育局普通员工 |
reason | 否 | 退休原因 |
返回结果:
{
"errcode": 0,
"errmsg": "ok"
}
参数说明:
参数 | 说明 |
---|---|
errcode | 返回码 |
errmsg | 对返回码的文本描述内容 |
教职工变动(user/move)
使用场景: 教职工离岗,停职,变动等。
是否需额外授权: 是
请求方式: POST(HTTPS)
请求地址: https://test-oapi.epaas.qq.com/user/move?access_token=ACCESS_TOKEN
请求包体:
{
"userids":["3724361204","3724348975"],
"reason":"测试学校退休老师",
"move_type":2
}
参数说明 :
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证,使用corp_access_token,由/service/get_corp_token获得 |
userids | 是 | 变动人员ID列表,变动人员必须是普通教职工或教育局普通员工 |
reason | 是 | 退休原因 |
move_type | 是 | 变动类型 2:离岗 3:停职 4:其他变动 |
返回结果:
{
"errcode": 0,
"errmsg": "ok"
}
参数说明:
参数 | 说明 |
---|---|
errcode | 返回码 |
errmsg | 对返回码的文本描述内容 |
教职工回迁(user/move_back)
使用场景: 教职工迁回(变动后迁回)。
是否需额外授权: 是
请求方式: POST(HTTPS)
请求地址: https://test-oapi.epaas.qq.com/user/move_back?access_token=ACCESS_TOKEN
请求包体:
{
"userid":"3724361204",
"department_ids":[5383525]
}
参数说明 :
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证,使用corp_access_token,由/service/get_corp_token获得 |
userid | 是 | 迁回人员ID,迁回人员必须是已变动的教职工 |
department_ids | 是 | 接收部门id列表 |
返回结果:
{
"errcode": 0,
"errmsg": "ok"
}
参数说明:
参数 | 说明 |
---|---|
errcode | 返回码 |
errmsg | 对返回码的文本描述内容 |