服务端API



获取部门列表

请求方式:GET(HTTPS)
请求地址:https://oapi.soke.cn/oa/department/list
Query参数说明:

参数 类型 必须 说明
access_token String 是 应用access_token,2小时有效期
parent_id String 是 部门上级ID,一级部门该值为1
page Int 否 页码,默认从1开始
page_size Int 否 每页条数,最大100,默认100

返回结果:

{
    "code": "200",
    "status": "ok",
    "message": "success",
    "data": {
        "list": [
            {
                "dept_id": "xxxx",
                "parent_id": "xxxx",
                "dept_name": "xxxx",
                "company_id": "xxxx"
            },
            {
                "dept_id": "xxxx",
                "parent_id": "xxxx",
                "dept_name": "xxxx",
                "company_id": "xxxx"
            }
        ],
        "has_more": 0
    }
}

参数说明:

参数 类型 说明
data Array 返回的数据包
list Array 返回的数据部门列表
dept_id String 部门ID,同company_id组织内唯一,最大长度36字符
parent_id String 部门上级ID,一级部门该值为1,最大长度36字符
dept_name String 部门名称,最大长度64字符
company_id String 所属企业ID,最大长度64字符
has_more Int 是否还有数据没返回:
1 还有
0 没有



获取部门详情

请求方式:GET(HTTPS)
请求地址:https://oapi.soke.cn/oa/department/info
Query参数说明:

参数 类型 必须 说明
access_token String 是 应用access_token,2小时有效期
dept_id String 是 部门ID

返回结果:

{
    "code": "200",
    "status": "ok",
    "message": "success",
    "data": {
        "dept_id": "XXXX",
        "parent_id": "XXXX",
        "dept_name": "XXXX",
        "company_id": "XXXX"
    }
}

参数说明:

参数 类型 说明
data> Array 返回的数据包
dept_id String 部门ID,同company_id组织内唯一,最大长度36字符
parent_id String 部门上级ID,一级部门该值为1,最大长度36字符
dept_name String 部门名称,最大长度64字符
company_id String 所属企业ID,最大长度64字符



获取用户列表

请求方式:GET(HTTPS)
请求地址:https://oapi.soke.cn/oa/departmentUser/list
Query参数说明:

参数 类型 必须 说明
access_token String 是 应用access_token,2小时有效期
dept_id String 是 需要获取用户的部门ID
page Int 否 页码,默认从1开始
page_size Int 否 每页条数,最大100,默认100

返回结果:

{
    "code": "200",
    "status": "ok",
    "message": "success",
    "data": {
        "list": [
            {
                "dept_user_id": "xxxx",
                "dept_user_name": "xxxx",
                "company_id": "xxxx",
                "email": "",
                "mobile": "1xx00000000",
            },
            {
                "dept_user_id": "xxxx",
                "dept_user_name": "xxxx",
                "company_id": "xxxx",
                "email": "",
                "mobile": "1xx00000000",
            }
        ],
        "has_more": 1
    }
}

参数说明:

参数 类型 说明
data Array 返回的数据包
list Array 返回的用户列表
dept_user_id String 用户ID,同company_id组织内唯一,最大长度64字符
dept_user_name String 用姓名,最大长度100字符
company_id String 所属企业ID,最大长度64字符
email String 邮箱
mobile String 手机号
has_more Int 是否还有数据没返回:
1 还有
0 没有



获取用户详情

请求方式:GET(HTTPS)
请求地址:https://oapi.soke.cn/oa/departmentUser/info
Query参数说明:

参数 类型 必须 说明
access_token String 是 应用access_token,2小时有效期
dept_user_id String 是 工号,用户在企业内唯一标识

返回结果:

{
    "code": "200",
    "status": "ok",
    "message": "success",
    "data": {
        "dept_user_id": "XXXX",
        "dept_user_name": "XXXX",
        "avatar": "XXXX",
        "position": "XXXX",
        "dept_ids": [
            "XXXX"
        ],
        "company_id": "XXXX"
    }
}

参数说明:

参数 类型 说明
data> Array 返回的数据包
dept_user_id String 用户ID,同company_id组织内唯一,最大长度64字符
dept_user_name String 姓名,最大长度100字符
avatar String 头像,可为空字符串,最大长度255字符
position String 职位,最大长度50字符
dept_ids Array 该用户所属部门ID列表
company_id String 所属企业ID



获取讲师列表

请求方式:GET(HTTPS)
请求地址:https://oapi.soke.cn/lector/lector/list
Query参数说明:

参数 类型 必须 说明
access_token String 是 应用access_token,2小时有效期
page Int 否 页码,默认从1开始
page_size Int 否 每页条数,最大100,最大100

返回结果:

{
    "code": "200",
    "status": "ok",
    "message": "success",
    "data": {
        "list": [
            
        ],
        "has_more": 1
    }
}

参数说明:

参数 类型 说明
data Array 返回的数据包
list Array 返回的用户列表
lector_id String 讲师ID,最大长度36字符
title String 讲师姓名,最大长度100字符
contact_information String 讲师联系方式,最大长度200字符
is_in Int 讲师来源:
0 外部
1 内部
employer String 讲师所在单位,最大长度200字符
grade_title String 讲师级别,最大长度100字符
area Array 讲师擅长领域,最大长度300字符
experience Array 讲师授课经历,最大长度65535字符
lector_score Decimal(3,2) 讲师评分
course_total_score Decimal(10,2) 线上课总评分
course_learn_num Int 线上课学习人数,最大位数10
course_score Decimal(3,2) 线上课平均分
training_total_score Decimal(10,2) 线下培训课总评分
training_learn_num Int 线下培训课学习人数,最大位数10
training_score Decimal(3,2) 线下培训课平均分,最大位数10
course_num Int 线上课数量,最大位数10
training_num Int 线下课数量,最大位数10
exam_num Int 考试数量,最大位数10
live_num Int 直播课数量,最大位数10
has_more Int 是否还有数据没返回:
1 还有
0 没有



创建部门

请求方式:POST(HTTPS)
请求地址:https://oapi.soke.cn/oa/department/create
Query参数说明:

参数 类型 必须 说明
access_token String 是 应用access_token,2小时有效期
dept_id String 否 部门ID,1-36位字符串,同一组织内dept_id不能重复,不传则系统自动生成,创建成功后不能修改
dept_name String 是 部门名称,长度限制为1~64个字符,不允许包含字符‘-’‘,’以及‘,’
parent_id String 是 父部门ID,跟部门ID为1
weight Int 否 排序值(正序)


成功返回结果:

{
    "code": "200",
    "status": "ok",
    "message": "success",
    "data": {
        "dept_id":"376053D7-73B6-44FE-8EF2-4A27E5CC81C6" //创建成功的部门ID
    }
}



更新部门

请求方式:POST(HTTPS)
请求地址:https://oapi.soke.cn/oa/department/update
Query参数说明:

参数 类型 必须 说明
access_token String 是 应用access_token,2小时有效期
dept_id String 是 要更新的部门ID
dept_name String 否 部门名称,长度限制为1~64个字符,不允许包含字符‘-’‘,’以及‘,’
parent_id String 否 父部门ID,跟部门ID为1
weight Int 否 排序值(正序)


成功返回结果:

{
    "code": "200",
    "status": "ok",
    "message": "success",
    "data": []
}



删除部门

请求方式:POST(HTTPS)
请求地址:https://oapi.soke.cn/oa/department/delete
Query参数说明:

参数 类型 必须 说明
access_token String 是 应用access_token,2小时有效期
dept_id String 是 要删除的部门ID


成功返回结果:

{
    "code": "200",
    "status": "ok",
    "message": "success",
    "data": []
}



创建用户

请求方式:POST(HTTPS)
请求地址:https://oapi.soke.cn/oa/departmentUser/create
Query参数说明:

参数 类型 必须 说明
access_token String 是 应用access_token,2小时有效期
dept_user_id String 否 学员唯一标识ID,1-64位字符串,同一组织内dept_user_id不能重复,不传则系统自动生成
union_id String 否 全平台内学员唯一标识ID,1-64位字符串,不传则系统自动生成
dept_user_name String 是 用户名称,长度限制为1~64个字符,不允许包含字符‘-’‘,’以及‘,’
avatar String 否 用户头像,传入一个可以在线浏览的url地址
position String 否 职位
position_rank String 否 职级
mobile Int 否 手机号
country_code String 否 国际区码,00开头,如0086
email String 否 邮箱
job_number String 否 工号
hired_date String 否 入职时间,格式:YYYY-mm-dd
is_new Int 否 是否标记为新员工,默认:0
0 否
1 是
dept_ids String 否 用户所在部门ID英文逗号隔开的字符串,不传则
默认:1
leader_dept_ids String 否 用户是部门主管的部门ID英文逗号隔开的字符串
is_leave Int 否 是否创建离职人员 默认:0
0 否
1 是
<!-- is_in Int 否


成功返回结果:

{
    "code": "200",
    "status": "ok",
    "message": "success",
    "data": {
        "dept_user_id":"376053D7-73B6-44FE-8EF2-4A27E5CC81C6" //创建成功的用ID
    }
}



编辑用户

请求方式:POST(HTTPS)
请求地址:https://oapi.soke.cn/oa/departmentUser/update
Query参数说明:

参数 类型 必须 说明
access_token String 是 应用access_token,2小时有效期
dept_user_id String 是 要更新的学员ID
dept_user_name String 否 用户名称,长度限制为1~64个字符,不允许包含字符‘-’‘,’以及‘,’
avatar String 否 用户头像,传入一个可以在线浏览的url地址
position String 否 职位
position_rank String 否 职级
mobile Int 否 手机号
country_code String 否 国际区码,00开头,如0086
email String 否 邮箱
job_number String 否 工号
hired_date String 否 入职时间,格式:YYYY-mm-dd
is_new Int 否 是否标记为新员工,默认:0
0 否
1 是
dept_ids String 否 用户所在部门ID英文逗号隔开的字符串,跟部门ID为1
leader_dept_ids String 否 用户是部门主管的部门ID英文逗号隔开的字符串


成功返回结果:

{
    "code": "200",
    "status": "ok",
    "message": "success",
    "data": []
}



删除用户

请求方式:POST(HTTPS)
请求地址:https://oapi.soke.cn/oa/departmentUser/delete
Query参数说明:

参数 类型 必须 说明
access_token String 是 应用access_token,2小时有效期
dept_user_id String 是 要删除的学员ID


成功返回结果:

{
    "code": "200",
    "status": "ok",
    "message": "success",
    "data": []
}



根据名称搜索部门

请求方式:POST(HTTPS)
请求地址:https://oapi.soke.cn/oa/department/searchDepartmentByName
Query参数说明:

参数 类型 必须 说明
access_token String 是 应用access_token,2小时有效期
name String 是 部门名称(支持模糊搜索)
page Int 否 页码,默认从1开始
page_size Int 否 每页条数,最大100,默认100

返回结果:

{
    "code": "200",
    "status": "ok",
    "message": "success",
    "data": {
        "list": [
            {
                "dept_id": "355746834",
                "parent_id": "1",
                "dept_name": "北京人社华北测试"
            },
            {
                "dept_id": "619807495",
                "parent_id": "619810519",
                "dept_name": "测试1"
            }
        ],
        "count": {
            "value": 9,
            "relation": "eq"
        }
    },
    "request_id": "36fa3575-f814-4ef5-a1f3-4a7a3a69d7cb"
}

参数说明:

参数 类型 说明
data Object 返回的数据包
list Array 返回的部门列表
dept_id String 部门ID,同company_id组织内唯一
parent_id String 部门上级ID,一级部门该值为1
dept_name String 部门名称
count Object 符合条件的总记录数对象
value Int 总记录数
relation String 关系类型,eq表示精确计数
request_id String 请求唯一标识



根据名称搜索用户

请求方式:POST(HTTPS)
请求地址:https://oapi.soke.cn/oa/departmentUser/searchDepartmentUserByName
Query参数说明:

参数 类型 必须 说明
access_token String 是 应用access_token,2小时有效期
name String 是 用户名称(支持模糊搜索)
page Int 否 页码,默认从1开始
page_size Int 否 每页条数,最大100,默认100

返回结果:

{
    "code": "200",
    "status": "ok",
    "message": "success",
    "data": {
        "list": [
            {
                "dept_user_id": "xxxx",
                "dept_user_name": "xxxxxx",
                "avatar": "xxxxxxxx",
                "position": "xxxxxx",
                "dept_ids": [],
                "company_id": "xxxxxxxx"
            }
        ],
        "count": {
            "value": 1,
            "relation": "eq"
        }
    },
    "request_id": "xxxxxxx"
}

参数说明:

参数 类型 说明
data Object 返回的数据包
list Array 返回的用户列表
dept_user_id String 用户ID,同company_id组织内唯一
dept_user_name String 用户姓名
avatar String 头像URL
position String 职位
dept_ids Array 该用户所属部门ID列表
company_id String 所属企业ID
count Object 符合条件的总记录数对象
value Int 总记录数
relation String 关系类型,eq表示精确计数
request_id String 请求唯一标识