文档

物业员工管理

更新时间:
一键部署

1.1 创建员工信息

Path路径

/solution/community/org/employee/create

请求方式

post

接口版本

1.0.0

请求参数

参数

类型

必填

描述

mobile

String

手机号,最大长度20

name

String

名称,最大长度12

faceImgUploadId

String

智能识别图片上传文件ID

上传bizCode=HOUSEHOLD_FACE

返回参数

参数

类型

描述

identityId

String

员工ID

1.2 修改员工信息

Path路径

/solution/community/org/employee/modify

请求方式

post

接口版本

1.0.0

请求参数

参数

类型

必填

描述

identityId

String

用户ID

mobile

String

手机号,为空时表示不修改字段,最大长度20

name

String

姓名,为空时表示修改字段,最大长度12

faceImgUploadId

String

智能识别图片上传文件ID

上传bizCode=HOUSEHOLD_FACE

返回参数

参数

类型

描述

1.3 删除员工信息

Path路径

/solution/community/org/employee/delete

请求方式

post

接口版本

1.0.0

请求参数

参数

类型

必填

描述

identityId

String

员工ID

返回参数

参数

类型

描述

1.4 分页查询员工

Path路径

/solution/community/org/employee/query

请求方式

post

接口版本

1.0.0

请求参数

参数

类型

必填

描述

pageNo

Integer

页码,不小于0

pageSize

Integer

页记录大小,范围[1, 100]

name

String

非空时匹配名称

nameLike

String

非空时模糊查询

mobile

String

非空时匹配手机号

orderBy

JSONArray

排序策略,默认按创建时间倒序

column

String

排序列

order

String

DESC 倒序,ASC正序

返回参数

参数

类型

描述

total

Integer

消息总数

pageNo

Integer

页码

pageSize

Integer

页面条数

data

JSONArray

数据列表

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

请求参数

参数

类型

必填

描述

identityId

String

用户ID

返回参数

参数

类型

描述

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

请求参数

参数

类型

必填

描述

identityId

String

手机号

depId

String

部门ID

返回参数

参数

类型

描述

1.7 从部门移除员工

Path路径

/solution/community/department/employee/remove

请求方式

post

接口版本

1.0.0

请求参数

参数

类型

必填

描述

identityId

String

手机号

depId

String

组织节点

返回参数

参数

类型

描述

1.8 分页查询部门的员工

Path路径

/solution/community/department/employee/query

请求方式

post

接口版本

1.0.0

请求参数

参数

类型

必填

描述

depId

String

部门ID

pageNo

Integer

从返回结果中的第几页开始显示,不小于1

pageSize

Integer

返回结果中每页显示的记录数量,范围[1, 100]

返回参数

参数

类型

描述

total

Integer

总数量

pageNo

Integer

同请求参数

pageSize

Integer

同请求参数

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

请求参数

参数

类型

必填

描述

identityId

String

员工ID

返回参数

数据部data是JSONArray类型

参数

类型

描述

data

JSONArray<Object>

列表

depId

String

部门ID

name

String

部门名称

desc

String

说明

parentId

String

父部门ID

pathIds

JSONArray<String>

路径ID列表(包含当前部门)

pathNames

JSONArray<String>

路径名称列表(包含当前部门)

  • 本页导读 (0)
文档反馈