物業(yè)員工管理
1.1 創(chuàng)建員工信息
Path路徑 | /solution/community/org/employee/create |
請求方式 | post |
接口版本 | 1.0.0 |
請求參數(shù)
參數(shù) | 類型 | 必填 | 描述 |
mobile | String | 是 | 手機號,最大長度20 |
name | String | 是 | 名稱,最大長度12 |
faceImgUploadId | String | 否 | 智能識別圖片上傳文件ID 上傳bizCode=HOUSEHOLD_FACE |
返回參數(shù)
參數(shù) | 類型 | 描述 |
identityId | String | 員工ID |
1.2 修改員工信息
Path路徑 | /solution/community/org/employee/modify |
請求方式 | post |
接口版本 | 1.0.0 |
請求參數(shù)
參數(shù) | 類型 | 必填 | 描述 |
identityId | String | 是 | 用戶ID |
mobile | String | 否 | 手機號,為空時表示不修改字段,最大長度20 |
name | String | 否 | 姓名,為空時表示修改字段,最大長度12 |
faceImgUploadId | String | 否 | 智能識別圖片上傳文件ID 上傳bizCode=HOUSEHOLD_FACE |
返回參數(shù)
參數(shù) | 類型 | 描述 |
無 |
1.3 刪除員工信息
Path路徑 | /solution/community/org/employee/delete |
請求方式 | post |
接口版本 | 1.0.0 |
請求參數(shù)
參數(shù) | 類型 | 必填 | 描述 |
identityId | String | 是 | 員工ID |
返回參數(shù)
參數(shù) | 類型 | 描述 |
無 |
1.4 分頁查詢員工
Path路徑 | /solution/community/org/employee/query |
請求方式 | post |
接口版本 | 1.0.0 |
請求參數(shù)
參數(shù) | 類型 | 必填 | 描述 |
pageNo | Integer | 是 | 頁碼,不小于0 |
pageSize | Integer | 是 | 頁記錄大小,范圍[1, 100] |
name | String | 否 | 非空時匹配名稱 |
nameLike | String | 否 | 非空時模糊查詢 |
mobile | String | 否 | 非空時匹配手機號 |
orderBy | JSONArray | 否 | 排序策略,默認按創(chuàng)建時間倒序 |
column | String | 是 | 排序列 |
order | String | 否 | DESC 倒序,ASC正序 |
返回參數(shù)
參數(shù) | 類型 | 描述 |
total | Integer | 消息總數(shù) |
pageNo | Integer | 頁碼 |
pageSize | Integer | 頁面條數(shù) |
data | JSONArray | 數(shù)據(jù)列表 |
identityId | String | 員工的用戶ID |
name | String | 姓名 |
mobile | String | 手機號 |
faceImgUrl | String | 智能識別圖片URL |
faceId | String | 智能識別ID,這個字段會在上傳智能識別圖片后自動填充 |
請求示例:
{
"pageNo": 1,
"pageSize": 20,
"nameLike": "張"
"orderBy": {
"column": "NAME",
"order": "DESC"
}
}
1.5 獲取員工信息
Path路徑 | /solution/community/org/employee/get |
請求方式 | post |
接口版本 | 1.0.0 |
請求參數(shù)
參數(shù) | 類型 | 必填 | 描述 |
identityId | String | 是 | 用戶ID |
返回參數(shù)
參數(shù) | 類型 | 描述 |
identityId | String | 用戶ID |
name | String | 姓名 |
mobile | String | 手機號 |
faceImgUrl | String | 智能識別圖片URL |
faceId | String | 智能識別ID,這個字段會在上傳智能識別圖片后自動填充 |
1.6 添加員工到部門
Path路徑 | /solution/community/department/employee/add |
請求方式 | post |
接口版本 | 1.0.0 |
請求參數(shù)
參數(shù) | 類型 | 必填 | 描述 |
identityId | String | 是 | 手機號 |
depId | String | 是 | 部門ID |
返回參數(shù)
參數(shù) | 類型 | 描述 |
無 |
1.7 從部門移除員工
Path路徑 | /solution/community/department/employee/remove |
請求方式 | post |
接口版本 | 1.0.0 |
請求參數(shù)
參數(shù) | 類型 | 必填 | 描述 |
identityId | String | 是 | 手機號 |
depId | String | 是 | 組織節(jié)點 |
返回參數(shù)
參數(shù) | 類型 | 描述 |
無 |
1.8 分頁查詢部門的員工
Path路徑 | /solution/community/department/employee/query |
請求方式 | post |
接口版本 | 1.0.0 |
請求參數(shù)
參數(shù) | 類型 | 必填 | 描述 |
depId | String | 是 | 部門ID |
pageNo | Integer | 是 | 從返回結(jié)果中的第幾頁開始顯示,不小于1 |
pageSize | Integer | 是 | 返回結(jié)果中每頁顯示的記錄數(shù)量,范圍[1, 100] |
返回參數(shù)
參數(shù) | 類型 | 描述 |
total | Integer | 總數(shù)量 |
pageNo | Integer | 同請求參數(shù) |
pageSize | Integer | 同請求參數(shù) |
data | JSONArray<Object> | 列表 |
identityId | String | 用戶ID |
mobile | String | 手機號 |
name | String | 名稱 |
faceImgUrl | String | 智能識別圖片地址 |
faceId | String | 智能識別ID |
1.9 查詢員工的部門
Path路徑 | /solution/community/employee/department/list |
請求方式 | post |
接口版本 | 1.0.0 |
請求參數(shù)
參數(shù) | 類型 | 必填 | 描述 |
identityId | String | 是 | 員工ID |
返回參數(shù)
數(shù)據(jù)部data是JSONArray類型
參數(shù) | 類型 | 描述 |
data | JSONArray<Object> | 列表 |
depId | String | 部門ID |
name | String | 部門名稱 |
desc | String | 說明 |
parentId | String | 父部門ID |
pathIds | JSONArray<String> | 路徑ID列表(包含當前部門) |
pathNames | JSONArray<String> | 路徑名稱列表(包含當前部門) |