获取所有部门
请求方式:GET
请求地址:/api/jediopenplatformopenapi/organization/department/getAllDepartment
请求参数:无
返回参数:List
| 参数名 | 描述 | 数据类型 | 必填 | 字节长度 |
|---|---|---|---|---|
| deptNo | 部门编号 | String | 是 | 50 |
| deptUuid | 部门uuid | String | 是 | 50 |
| deptName | 部门名称 | String | 是 | 0 |
| layer | 部门层级 | Integer | 是 | |
| deptType | 部门类型 | String | 是 | 20 |
| shopType | 部门属性 | String | 是 | 20 |
| businessType | 部门级别 { BUSINESS_DEPT: 事业部, REGION_DEPT: 大区, AREA_DEPT: 区域, PIECE_DEPT: 片区, SHOP_DEPT: ⻔店, GROUP_DEPT: 店组 } |
String | 否 | |
| deptTel | 部门电话 | String | 否 | |
| deptAddress | 部门地址 | String | 否 | 50 |
| lat | 维度 | String | 否 | 50 |
| lng | 经度 | String | 否 | 50 |
| phoneExtScope | 分机号范围 | String | 否 | 20 |
| createdTime | 创建时间(时间戳精确到毫秒) | Date | 否 | |
| closeStatus | 是否已关闭 true 已删除 false 未删除 |
Boolean | 是 | |
| closeTime | 关闭时间(时间戳精确到毫秒) | Date | ||
| deleted | 是否已删除 true 已删除 false 未删除 |
Boolean | 是 | |
| deptUuid1 | 1级部门uuid | String | 否 | 50 |
| deptUuid2 | 2级部门uuid | String | 否 | 50 |
| deptUuid3 | 3级部门uuid | String | 否 | 50 |
| deptUuid4 | 4级部门uuid | String | 否 | 50 |
| deptUuid5 | 5级部门uuid | String | 否 | 50 |
| deptUuid6 | 6级部门uuid | String | 否 | 50 |
| deptUuid7 | 7级部门uuid | String | 否 | 50 |
| deptUuid8 | 8级部门uuid | String | 否 | 50 |
| deptName1 | 1级部门名称 | String | 否 | 20 |
| deptName2 | 2级部门名称 | String | 否 | 20 |
| deptName3 | 3级部门名称 | String | 否 | 20 |
| deptName4 | 4级部门名称 | String | 否 | 20 |
| deptName5 | 5级部门名称 | String | 否 | 20 |
| deptName6 | 6级部门名称 | String | 否 | 20 |
| deptName7 | 7级部门名称 | String | 否 | 20 |
| deptName8 | 8级部门名称 | String | 否 | 20 |
| statusCode | 门店状态 { TO_BE_OPEN: 待开业, OPEN: 开业中, CLOSE: 歇业, SHUTDOWN: 闭店 } |
String | 否 | 10 |
| deptManagerEmpUuid | 部门负责人uuid | String | 否 | 50 |
返回示例:
{
"responseCode": "1",
"responseMessage": "success",
"responseType": null,
"data": [
{
"deptNo": "0000000000000000000000",
"deptUuid": "0b6bba424ad34e238a4e515ca7dcc4c8",
"deptName": "系统管理组",
"layer": 2,
"deptType": "业务",
"shopType": "直营",
"businessType": "REGION_DEPT",
"deptTel": "021-4878219",
"deptAddress": "上海市郭守敬路",
"lat": "31.205989",
"lng": "121.455855",
"phoneExtScope": "801-810",
"createdTime": 1598953411887,
"closeStatus": false,
"closeTime": null,
"deleted": false,
"deptUuid1": "0b6bba424ad34e238a4e515ca7dcc4c8",
"deptUuid2": null,
"deptUuid3": null,
"deptUuid4": null,
"deptUuid5": null,
"deptUuid6": null,
"deptUuid7": null,
"deptUuid8": null,
"deptName1": "系统管理组",
"deptName2": null,
"deptName3": null,
"deptName4": null,
"deptName5": null,
"deptName6": null,
"deptName7": null,
"deptName8": null,
"statusCode": "open",
"deptManagerEmpUuid": "8f4816f9-98d2-435a-87ba-90b1831c3443"
}
]
}
部门详情查询
请求方式:POST
请求地址:/api/jediopenplatformopenapi/organization/department/searchDepartment
请求参数:必填任意一个入参
| 参数名 | 描述 | 数据类型 | 必填 | 字节长度 |
|---|---|---|---|---|
| deptUuid | 部门UUID | String | 否 | 50 |
| deptName | 部门名称 | String | 否 | 20 |
| businessType | 部门级别 { BUSINESS_DEPT: 事业部, REGION_DEPT: 大区, AREA_DEPT: 区域, PIECE_DEPT: 片区, SHOP_DEPT: ⻔店, GROUP_DEPT: 店组 } |
String | 否 | 10 |
| showClose | 显示关闭部门 true 显示 false 不显示 |
Boolean | 否 |
请求示例:
{
"param": {
"deptUuid": "99",
"deptName": "系统管理组",
"businessType": "REGION_DEPT",
"showClose": false
}
}
返回参数:List
| 参数名 | 描述 | 数据类型 | 必填 | 字节长度 |
|---|---|---|---|---|
| deptNo | 部门编号 | String | 是 | 50 |
| deptUuid | 部门uuid | String | 是 | 50 |
| deptName | 部门名称 | String | 是 | 0 |
| layer | 部门层级 | Integer | 是 | |
| deptType | 部门类型 | String | 是 | 20 |
| shopType | 部门属性 | String | 是 | 20 |
| businessType | 部门级别 { BUSINESS_DEPT: 事业部, REGION_DEPT: 大区, AREA_DEPT: 区域, PIECE_DEPT: 片区, SHOP_DEPT: ⻔店, GROUP_DEPT: 店组 } |
String | 否 | |
| deptTel | 部门电话 | String | 否 | 50 |
| deptAddress | 部门地址 | String | 否 | 50 |
| lat | 维度 | String | 否 | 50 |
| lng | 经度 | String | 否 | 50 |
| phoneExtScope | 分机号范围 | String | 否 | 20 |
| createdTime | 创建时间(时间戳精确到毫秒) | Date | 否 | |
| closeStatus | 是否已关闭 true 已删除 false 未删除 |
Boolean | 是 | |
| closeTime | 关闭时间(时间戳精确到毫秒) | Date | ||
| deleted | 是否已删除 true 已删除 false 未删除 |
Boolean | 是 | |
| deptUuid1 | 1级部门uuid | String | 否 | 50 |
| deptUuid2 | 2级部门uuid | String | 否 | 50 |
| deptUuid3 | 3级部门uuid | String | 否 | 50 |
| deptUuid4 | 4级部门uuid | String | 否 | 50 |
| deptUuid5 | 5级部门uuid | String | 否 | 50 |
| deptUuid6 | 6级部门uuid | String | 否 | 50 |
| deptUuid7 | 7级部门uuid | String | 否 | 50 |
| deptUuid8 | 8级部门uuid | String | 否 | 50 |
| deptName1 | 1级部门名称 | String | 否 | 20 |
| deptName2 | 2级部门名称 | String | 否 | 20 |
| deptName3 | 3级部门名称 | String | 否 | 20 |
| deptName4 | 4级部门名称 | String | 否 | 20 |
| deptName5 | 5级部门名称 | String | 否 | 20 |
| deptName6 | 6级部门名称 | String | 否 | 20 |
| deptName7 | 7级部门名称 | String | 否 | 20 |
| deptName8 | 8级部门名称 | String | 否 | 20 |
| statusCode | 门店状态 { TO_BE_OPEN: 待开业, OPEN: 开业中, CLOSE: 歇业, SHUTDOWN: 闭店 } |
String | 否 | 10 |
| deptManagerEmpUuid | 部门负责人uuid | String | 否 | 50 |
返回示例:
{
"responseCode": "1",
"responseMessage": "success",
"responseType": null,
"data": [
{
"deptNo": "0000000000000000000000",
"deptUuid": "0b6bba424ad34e238a4e515ca7dcc4c8",
"deptName": "系统管理组",
"layer": 2,
"deptType": "业务",
"shopType": "直营",
"businessType": "REGION_DEPT",
"deptTel": ”021-4878219“,
"deptAddress": "上海市郭守敬路",
"lat": "31.205989",
"lng": "121.455855",
"phoneExtScope": "801-810",
"createdTime": 1598953411887,
"closeStatus": false,
"closeTime": null,
"deleted": false,
"deptUuid1": "0b6bba424ad34e238a4e515ca7dcc4c8",
"deptUuid2": null,
"deptUuid3": null,
"deptUuid4": null,
"deptUuid5": null,
"deptUuid6": null,
"deptUuid7": null,
"deptUuid8": null,
"deptName1": "系统管理组",
"deptName2": null,
"deptName3": null,
"deptName4": null,
"deptName5": null,
"deptName6": null,
"deptName7": null,
"deptName8": null,
"statusCode": "open",
"deptManagerEmpUuid": "8f4816f9-98d2-435a-87ba-90b1831c3443"
}
]
}
新增部门
请求方式:POST
请求地址:/api/jediopenplatformopenapi/organization/department/addDepartment
请求参数:
| 参数名 | 描述 | 数据类型 | 必填 | 字节长度 |
|---|---|---|---|---|
| deptName | 部门名称 | String | 是 | 20 |
| parentDeptUuid | 上级部门UUID | String | 否 | 50 |
| businessType | 部门级别 { BUSINESS_DEPT: 事业部, REGION_DEPT: 大区, AREA_DEPT: 区域, PIECE_DEPT: 片区, SHOP_DEPT: ⻔店, GROUP_DEPT: 店组 } |
String | 否 | 10 |
| shopType | 部门属性 | String | 是 | 20 |
| closeStatus | 是否已关闭 true 关闭 false 未关闭 |
Boolean | 是 | |
| statusCode | 门店状态 { TO_BE_OPEN: 待开业, OPEN: 开业中, CLOSE: 歇业, SHUTDOWN: 闭店 } |
String | 否 | 10 |
| deptTel | 部门电话 | String | 否 | 50 |
| deptAddress | 部门地址 | String | 否 | 50 |
| lat | 维度 | String | 是 | 50 |
| lng | 经度 | String | 是 | 50 |
| phoneExtScope | 分机号范围 | String | 否 | 20 |
| standardCity | 所属城市 | String | 否 | 50 |
| standardDistrictUuid | 所属区域uuid | String | 否 | 50 |
| deptAddress | 部门地址 | String | 否 | 50 |
| storeNo | 门店编号 | String | 否 | 10 |
| deptManagerEmpUuid | 部门负责人uuid | String | 否 | 50 |
请求示例:
{
"param": {
"businessType": "BUSINESS_DEPT",
"closeStatus": false,
"deptAddress": "上海市郭守敬路",
"deptName": "系统管理组下级部门",
"deptTel": "021-4878219",
"establishTime": 1598953411887,
"lat": "31.205989",
"lng": "121.455855",
"parentDeptUuid": "0b6bba424ad34e238a4e515ca7dcc4c8",
"phoneExtScope": "801-810",
"shopType": "直营",
"standardCity": "上海",
"standardDistrictUuid": "60BC67EA-13AA-4A3E-9587-FA992BDF10FE",
"statusCode": "TO_BE_OPEN",
"deptManagerEmpUuid": "8f4816f9-98d2-435a-87ba-90b1831c3443"
}
}
返回参数
| 参数名 | 描述 | 数据类型 | 必填 | 字节长度 |
|---|---|---|---|---|
| data | 部门uuid | String | 是 | 50 |
返回示例:
{
"responseCode": "1",
"responseMessage": "success",
"responseType": null,
"data": "b281cf18636e4612b46bd973407b1dd0"
}
更新部门
请求方式:POST
请求地址:/api/jediopenplatformopenapi/organization/department/updateDepartment
请求参数:
| 参数名 | 描述 | 数据类型 | 必填 | 字节长度 |
|---|---|---|---|---|
| deptName | 部门名称 | String | 是 | 20 |
| deptUuid | 部门Uuid | String | 是 | 50 |
| setFirstLayer | 是否设置为顶级 true 是 false 否 |
Boolean | 否 | |
| parentDeptUuid | 上级部门UUID | String | 否 | 50 |
| businessType | 部门级别 { BUSINESS_DEPT: 事业部, REGION_DEPT: 大区, AREA_DEPT: 区域, PIECE_DEPT: 片区, SHOP_DEPT: ⻔店, GROUP_DEPT: 店组 } |
String | 否 | 10 |
| shopType | 部门属性 | String | 是 | 20 |
| closeStatus | 是否已关闭 true 关闭 false 未关闭 |
Boolean | 否 | |
| statusCode(已经废弃) | 若需更新门店状态请使用/organization/department/updateStoreStatus | String | 否 | 10 |
| deptTel | 部门电话 | String | 否 | 50 |
| deptAddress | 部门地址 | String | 否 | 50 |
| lat | 维度 | String | 否 | 50 |
| lng | 经度 | String | 否 | 50 |
| phoneExtScope | 分机号范围 | String | 否 | 20 |
| standardCity | 所属城市 | String | 否 | 50 |
| standardDistrictUuid | 所属区域uuid | String | 否 | 50 |
| deptAddress | 部门地址 | String | 否 | 50 |
| storeNo | 门店编号 | String | 否 | 10 |
| deptManagerEmpUuid | 部门负责人uuid 字段为空表示删除部门负责人 |
String | 否 | 50 |
请求示例:
{
"param": {
"businessType": "BUSINESS_DEPT",
"closeStatus": false,
"deptAddress": "上海市郭守敬路",
"deptName": "系统管理组下级部门",
"deptUuid": "0b6bba424ad34e238a4e515ca7dcc123",
"setFirstLayer": false,
"deptTel": "021-4878219",
"establishTime": 1598953411887,
"lat": "31.205989",
"lng": "121.455855",
"parentDeptUuid": "0b6bba424ad34e238a4e515ca7dcc4c8",
"phoneExtScope": "801-810",
"standardCity": "上海",
"standardDistrictUuid": "60BC67EA-13AA-4A3E-9587-FA992BDF10FE",
"statusCode": "toBeOpen",
"deptManagerEmpUuid": "8f4816f9-98d2-435a-87ba-90b1831c3443"
}
}
返回参数:无
返回示例:
{
"responseCode": "1",
"responseMessage": "success",
"responseType": null,
"data": null
}
更新门店状态
请求方式:POST
请求地址:/api/jediopenplatformopenapi/organization/department/updateStoreStatus
请求参数:
| 参数名 | 描述 | 数据类型 | 必填 | 字节长度 |
|---|---|---|---|---|
| deptUuid | 部门uuid | String | 是 | 50 |
| needFreezeFlag | 是否冻结 | Boolean | 否 | |
| storeStatus | 门店状态 { open: 开业中, close: 歇业, shutDown: 闭店 } |
String | 是 | 10 |
请求示例:
{
"param": {
"deptUuid": "13c35e65660d48b5af9a5b4dd0654ca7",
"needFreezeFlag": false,
"storeStatus": "open"
}
}
返回参数:
| 参数名 | 描述 | 数据类型 | 必填 | 字节长度 |
|---|---|---|---|---|
| deptUuid | 部门uuid | String | 是 | 50 |
| code | 返回码: { departmentServer111:本部门有员工,不可以关闭 departmentServer112:本部门下有启用的子部门,不可以关闭 1:success } |
String | 是 |
返回示例:
{
"responseCode": "1",
"responseMessage": "success",
"responseType": null,
"data": {
"code":"1",
"deptUuid":"13c35e65660d48b5af9a5b4dd0654ca7"
}
}