部门列表
接口说明: 查询公司部门信息,不包含虚拟部门信息
共三种情况:
departmentId为空时,获取公司所有部门信息
departmentId不为空时
- fetchChild为0时,获取指定部门信息
- fetchChild为1是,获取指定部门下的所有部门信息。返回结果包含指定部门的信息。
请求方式:POST(HTTPS)
请求地址:https://api.xinrenxinshi.com/v5/department/list
请求Header:
key | value |
---|---|
access_token | 获取的access_token的实际值 |
Query参数:
key | value |
---|---|
sign | 签名值 |
Body参数:
参数 | 类型 | 必传(Y/N) | 说明 |
---|---|---|---|
departmentId | string | N | 部门ID |
fetchChild | Integer | N | 是否获取子部门,默认0,0-不包含、1-包含 |
status | Integer | N | 部门状态,默认为0,0-正常, 1-禁用, 2-删除 |
modtime | Integer | N | 更新时间(精确到秒),部门列表的增量查询。如果传了该参数,则只返回更新时间在查询时间之后的部门数据,只支持全部查询 |
timestamp | Long | Y | 请求时间戳(精确到毫秒) |
返回结果:
参数 | 类型 | 必传(Y/N) | 说明 |
---|---|---|---|
errcode | Integer | Y | 0成功,其他失败 |
errmsg | String | Y | 结果描述 |
data | List<DepartmentModel> | Y | 部门列表 |
DepartmentModel
参数 | 类型 | 必传(Y/N) | 说明 |
---|---|---|---|
adminId | String | Y | 部门负责人员工id |
city | String | Y | 所属城市 |
code | String | Y | 部门编码 |
departmentId | String | Y | 部门ID |
name | String | Y | 部门名称 |
parentId | String | N | 上级部门ID,上级部门为根部门时为空 |
remark | String | Y | 备注 |
order | Integer | Y | 排序值,同一个父部门下,按排序值从小到大排序 |
hrbpId | String | Y | hrbp的员工id |
type | Integer | Y | 部门类型,默认0,固定部门类型有 0-部门,1-事业部,2-事业群,3-组,4-中心,5-子公司 其他部门自定义类型 详见部门类型列表接口中的departType字段 |
regularHeaderCount | Integer | N | 正式编制人数 |
nonRegularHeaderCount | Integer | N | 非正式编制人数 |
fields | Map<String,String> | N | 部门的自定义字段,key为字段的名称,value为字段的值 |
addtime | Integer | Y | 添加时间 |
modtime | Integer | Y | 更新时间 |
status | Integer | Y | 状态,0-正常, 1-禁用, 2-删除 |
请求示例(HTTPS):
https://api.xinrenxinshi.com/v5/department/list?sign=o0BvsXtuFqrXtt%2FzVvAYHIB9u6o%3D
请求Body示例:
{
"departmentId": "f2c2531f42ea41f98a5d0db1d2127325",
"fetchChild": 1,
"timestamp": 1606208919623
}
SDK请求示例(java):
DepartmentListRequest request = new DepartmentListRequest(access_token);
request.setDepartmentId("f2c2531f42ea41f98a5d0db1d2127325");
request.setFetchChild(FetchChildEnum.CONTAINS_DEPARTMENT);
OpenapiResponse<List<DepartmentModel>> list = XrxsDepartmentService.getDepartmentList(request);
响应示例:
{
"errcode":0,
"errmsg":"成功",
"data":[
{
"departmentId":"13a7658889594f18a3c9e8d8dc54aec0",
"name":"开发测试部1",
"parentId":"d1e332f117dc4ec8b9b1dcf47c6b5490",
"code":"kaifa",
"type":0,
"adminId":"",
"hrbpId":"",
"regularHeaderCount":5,
"nonRegularHeaderCount":5,
"city":"",
"order": 1,
"remark":"",
"addtime":1639451329,
"modtime":1650963045,
"fields":{
"数值":"11.01",
"单行文本":"测试单行文本",
"选项":"A",
"地区精确到地级市":"132",
"日期":"2021-07-06",
"地区精确到县级":"747",
"多行文本":"测试多行文本"
},
"status": 0
}
]
}