创建成员
使用场景: 调用本接口,创建一个学校普通教职工成员,行政单位员工成员,学校退休教职工成员,学校临时组成员。
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 需要 | 申请方式:联系项目接口人申请 |
用户凭证 | 未支持 | |
机构凭证 | 支持 | 获取不到用户凭证的后台管理场景使用 |
请求方式: POST(HTTPS)
请求地址: https://oapi.epaas.qq.com/user/create
Query参数:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 接口调用凭证 |
Body参数:
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
name | string | 是 | 人员名字。 限制规则参考字段规则说明 |
mobile | string | 是 | 手机号码 |
gender | string | 是 | 性别。1表示男性,2表示女性,3表示未知 |
string | 否 | 邮箱 | |
user_number | string | 否 | 教职工工号;限制规则参考字段规则说明 |
department_infos | 否 | 部门职位列表信息 | |
department_infos.department_id | uint32 | 是 | 部门Id |
department_infos.title_id | uint32 | 否 | 部门职位Id |
department_infos.priority | uint32 | 否 | 主副部门 1-主 0-副 限制:主部门只能有一个 |
department_type | int32 | 否 | 部门类型,对于学校可以传入2(普通教职工),5(退休教职工),6(临时组),默认值为普通教职工。对于行政单位可以传入9(行政单位员工) ,默认值为行政单位员工,传入的department_type应与传入的部门id类型保持一致 |
basic_profile | string | 否 | 基础平台资料,json字符串。 学校参考教职工资料字段 行政单位参考行政单位职工资料字段 |
extend_profile | string | 否 | 应用扩展资料,json字符串 |
is_recover | bool | 否 | 是否恢复账号 默认:false |
返回参数:
参数 | 类型 | 说明 |
---|---|---|
errcode | int32 | 返回码,0为正常 |
errmsg | string | 对返回码的文本描述内容 |
userid | string | 创建的教职工成员id |
请求示例:
POST https://oapi.epaas.qq.com/user/create?access_token=ACCESS_TOKEN
请求包体:
{
"name": "张三",
"mobile": "13800000000",
"gender": "1",
"email": "zhangsan@gzdev.com",
"enable": 1,
"user_number": "teacher001",
"department_infos":[
{"department_id":3032773,"title_id":25342, "priority":1},
{"department_id":3032772,"title_id":25342, "priority":0}
],
"department_type":2,
"basic_profile": "{\"user_number\": \"test116\",\"join_date\": \"2010-01-02\"}",
"extend_profile": " {\"FieldA\": 111,\"FieldB\": 222,\"FieldE\": \"aaa\"} "
}
返回示例:
{
"errcode": 0,
"errmsg": "ok",
"userid": "org_user_id"
}
更新成员资料
使用场景: 调用本接口,更新一个学校普通教职工,学校退休教职工,学校临时组,行政单位员工的资料。
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 需要 | 申请方式:联系项目接口人申请 |
用户凭证 | 未支持 | |
机构凭证 | 支持 | 获取不到用户凭证的后台管理场景使用 |
请求方式: POST(HTTPS)
请求地址: https://oapi.epaas.qq.com/user/update_info
Query参数:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 接口调用凭证 |
Body参数:
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
userid | string | 是 | 用户id |
basic_profile | string | 否 | 基础平台资料,json字符串 学校参考教职工资料字段。 行政单位参考行政单位职工资料字段。 |
extend_profile | string | 否 | 应用扩展资料,json字符串 |
department_infos | []object | 否 | 部门列表 空:不修改部门 |
department_infos.department_id | int32 | 否 | 部门id |
department_infos.title_id | int32 | 否 | 职位id 0:学校是普通教师 教育局是普通员工(默认) |
department_infos.priority | uint32 | 否 | 主副部门 1-主 0-副 限制:主部门只能有一个 |
basic_profile和extend_profile,不能同时为空
返回参数
参数 | 类型 | 说明 |
---|---|---|
errcode | int32 | 返回码 |
errmsg | string | 对返回码的文本描述内容 |
请求示例:
POST https://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\",\"posts\":[\"1\",\"2\"],\"duties\":[\"1\",\"3\",\"4\"]}",
"extend_profile": "{\"FieldA\":111,\"FieldB\":222,\"FieldE\":\"aaa\",\"_id\":\"3724396827\"}",
"department_infos":[{"department_id":7416489,"title_id":74142,"priority":1}]
}
返回包体:
{
"errmsg": "ok",
"errcode": 0
}
删除成员
使用场景: 调用本接口, 删除一个学校普通教职工,学校退休教职工,学校临时组,行政单位员工。
注意:一旦删除用户,用户相关数据将无法找回,所以,进行删除操作需谨慎!!!
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 需要 | 申请方式:联系项目接口人申请 |
用户凭证 | 未支持 | |
机构凭证 | 支持 | 获取不到用户凭证的后台管理场景使用 |
请求方式: GET(HTTPS)
请求地址: https://oapi.epaas.qq.com/user/delete
Query参数:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 接口调用凭证 |
userid | string | 是 | 成员id |
返回参数:
参数 | 类型 | 说明 |
---|---|---|
errcode | int32 | 返回码 |
errmsg | string | 对返回码的文本描述内容 |
请求示例:
GET https://oapi.epaas.qq.com/user/delete?access_token=ACCESS_TOKEN&userid=ID
返回示例:
{
"errcode": 0,
"errmsg": "ok"
}
调整成员所属部门
使用场景: 调用本接口, 调整一个或多个学校普通教职工,学校退休教职工,学校临时组,行政单位员工的所属部门。
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 需要 | 申请方式:联系项目接口人申请 |
用户凭证 | 未支持 | |
机构凭证 | 支持 | 获取不到用户凭证的后台管理场景使用 |
请求方式: POST(HTTPS)
请求地址: https://oapi.epaas.qq.com/user/move_department
Query参数:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 接口调用凭证 |
Body参数:
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
userids | []string | 是 | 用户id列表 |
department_ids | []uint32 | 是 | 部门id列表 |
department_type | int32 | 是 | 部门类型 2:教职工 5:退休教师 6:临时成员 9:教育局教职工 |
备注:仅支持在用户所属类型部门间进行调整; 用户迁移到新部门后,职位都为普通成员(教师),若需保持原职位或设置为其他职位,需要重新设置用户所在部门职位
返回参数:
参数 | 说明 |
---|---|
errcode | 返回码 |
errmsg | 对返回码的文本描述内容 |
请求示例:
POST https://oapi.epaas.qq.com/user/move_department?access_token=ACCESS_TOKEN
请求包体:
{
"userids":["3724804326","3758412570"],
"department_ids":[5670337,5671220],
"department_type":2
}
返回包体:
{
"errcode": 0,
"errmsg": "ok"
}
教职工停用
使用场景: 批量或单个停用教职工
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 需要 | 申请方式:联系项目接口人申请 |
用户凭证 | 支持 | |
机构凭证 | 支持 | 获取不到用户凭证的后台管理场景使用 |
请求方式: POST(HTTPS)
请求地址: https://oapi.epaas.qq.com/user/disable
Query参数:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 接口调用凭证 |
Body参数:
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
userids | []string | 是 | 教职工id列表 |
请求包体:
{
"userids":["3724804326", "3724804327"]
}
返回结果:
{
"errcode": 0,
"errmsg": "ok"
}
参数说明:
参数 | 说明 |
---|---|
errcode | 返回码 |
errmsg | 对返回码的文本描述内容 |
教职工启用
使用场景: 批量或单个启用教职工
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 需要 | 申请方式:联系项目接口人申请 |
用户凭证 | 支持 | |
机构凭证 | 支持 | 获取不到用户凭证的后台管理场景使用 |
请求方式: POST(HTTPS)
请求地址: https://oapi.epaas.qq.com/user/enable
Query参数:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 接口调用凭证 |
Body参数:
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
userids | []string | 是 | 教职工id列表 |
请求包体:
{
"userids":["3724804326", "3724804327"]
}
返回结果:
{
"errcode": 0,
"errmsg": "ok"
}
参数说明:
参数 | 说明 |
---|---|
errcode | 返回码 |
errmsg | 对返回码的文本描述内容 |