cn.felord.api

Interface DepartmentApi

public interface DepartmentApi

通讯录管理-部门管理

Since:

2021 /6/17 14:58

Author:

n1

Method Summary

Modifier and Type	Method and Description
GenericResponse<Long>	createDept(DeptInfo request) 创建部门
WeComResponse	deleteDept(long departmentId) 删除部门,不能删除根部门；不能删除含有子部门、成员的部门
GenericResponse<List<DeptInfo>>	deptList() 获取全部部门列表（自建）
GenericResponse<List<DeptInfo>>	deptList(long departmentId) 获取部门列表（自建）
GenericResponse<DeptInfo>	get(long departmentId) 获取单部门详情（自建）
GenericResponse<List<DeptSimpleInfo>>	getSimpleList() 获取全部子部门ID列表
GenericResponse<List<DeptSimpleInfo>>	getSimpleList(long departmentId) 获取子部门ID列表
WeComResponse	updateDept(DeptInfo request) 创建部门

Method Detail

createDept

@POST(value="department/create")
GenericResponse<Long> createDept(@Body
                                                                  DeptInfo request)

创建部门

Parameters:

request - the request

Returns:

CreateDeptResponse generic response

updateDept

@POST(value="department/update")
WeComResponse updateDept(@Body
                                                          DeptInfo request)

创建部门

Parameters:

request - the request

Returns:

the we com response

deleteDept

@GET(value="department/delete")
WeComResponse deleteDept(@Query(value="id")
                                                         long departmentId)

删除部门,不能删除根部门；不能删除含有子部门、成员的部门

第三方仅通讯录应用可以调用。

Parameters:

departmentId - departmentId

Returns:

WeComResponse we com response

deptList

@GET(value="department/list")
GenericResponse<List<DeptInfo>> deptList(@Query(value="id")
                                                                       long departmentId)

获取部门列表（自建）

Parameters:

departmentId - departmentId

Returns:

DeptResponse generic response

deptList

@GET(value="department/list")
GenericResponse<List<DeptInfo>> deptList()

获取全部部门列表（自建）

Returns:

DeptResponse generic response

getSimpleList

@GET(value="department/simplelist")
GenericResponse<List<DeptSimpleInfo>> getSimpleList()

获取全部子部门ID列表

Returns:

the simple list

getSimpleList

@GET(value="department/simplelist")
GenericResponse<List<DeptSimpleInfo>> getSimpleList(@Query(value="id")
                                                                                        long departmentId)

获取子部门ID列表

Parameters:

departmentId - the department id

Returns:

the generic response

get

@GET(value="department/get")
GenericResponse<DeptInfo> get(@Query(value="id")
                                                           long departmentId)

获取单部门详情（自建）

Parameters:

departmentId - the department id

Returns:

the generic response