部门创建
接口说明: 创建部门信息。此接口不支持虚拟部门的创建。
请求方式: POST(HTTPS)
请求地址:https://api.xinrenxinshi.com/v5/department/create
请求Header:
key | value |
---|---|
access_token | 获取的access_token的实际值 |
Query参数:
key | value |
---|---|
sign | 签名值 |
Body参数:
参数 | 类型 | 必传(Y/N) | 说明 |
---|---|---|---|
name | String | Y | 部门名称 |
code | String | Y | 部门编码 |
isVirtual | String | N | 是否是虚拟部门,0否1是.不传默认为0 |
parentId | String | N | 上级部门ID |
type | Integer | N | 部门类型,默认0,固定部门类型有 0-部门,1-事业部,2-事业群,3-组,4-中心,5-子公司 其他部门自定义类型 详见部门类型列表接口中的departType字段 |
adminId | String | N | 管理员ID |
hrbpId | String | N | hrbp的员工id |
city | String | N | 所属城市 |
remark | String | N | 备注 |
fields | Map<String,String> | N | 部门自定义字段,参考部门列表接口中的fields字段 |
timestamp | Long | Y | 请求时间戳(精确到毫秒) |
部门创建注意事项:
- 对于文本类型以及数值类型的部门自定义字段,key为字段名称,value为调整后的值;
- 对于日期类型的部门自定义字段。value的值的格式为 "yyyy-MM-dd";
- 对于选项类型的部门自定义字段。value的值为选项类型的datasource中的选项。例如:datasource为{A,B,C},则value只能为A或B或C;
- 对于地区(精确到县级地区)类型的部门自定义字段。value的值为城市列表接口中type为4(即区域类型为区级)的区域编码。
- 对于地区(精确到地级市)类型的部门自定义字段。value的值为城市列表接口中type为3(即区域类型为城市)的区域编码。
返回结果:
参数 | 类型 | 必传(Y/N) | 说明 |
---|---|---|---|
errcode | Integer | Y | 0成功,其他失败 |
errmsg | String | Y | 结果描述 |
data | DepartmentCreateResponse | Y | 返回值 |
DepartmentCreateResponse
参数 | 类型 | 必传(Y/N) | 说明 |
---|---|---|---|
id | String | Y | 部门id |
请求示例(HTTPS):
https://api.xinrenxinshi.com/v5/department/create?sign=cwyzXRxvXDiGetbidkMvHYJ7TVI%3D
请求Body示例:
{
"code":"测试部门",
"city":"河北省石家庄市",
"name":"测试部门",
"isVirtual":0,
"remark":"备注:这是一个openapi测试部门",
"type":4,
"fields":{
"数值":"1111.00",
"单行文本":"我是单行文本",
"选项":"C",
"地区精确到地级市":"2",
"日期":"2021-10-12",
"地区精确到县级":"",
"多行文本":"我是多行文本"
},
"timestamp":1625826941760
}
SDK请求示例(java):
DepartmentCreateRequest request = new DepartmentCreateRequest(access_token());
request.setName("测试部门");
request.setCode("测试部门");
request.setType(DepartTypeEnum.CENTER);
request.setCity("河北省石家庄市");
request.setRemark("备注:这是一个openapi测试部门");
request.setParentId("");
request.setIsVirtual(0);
HashMap<String, String> fields = new HashMap<>();
fields.put("数值", "1111.00");
fields.put("单行文本", "我是单行文本");
fields.put("多行文本", "我是多行文本");
fields.put("选项", "C");
fields.put("地区精确到地级市", "2");
fields.put("日期", "2021-10-12");
fields.put("地区精确到县级", "");
request.setFields(fields);
OpenapiResponse<DepartmentCreateResponse> department = XrxsDepartmentService.createDepartment(request);
响应示例:
{
"errcode": 0,
"errmsg": "成功",
"data": {
"id": "f2c2531f42ea41f98a5d0db1d2127325"//部门id
}
}