# 员工

类实例化：

UserApi api = new UserApi(String apiUrl, String accesskeyId, String publicKey);

# 获取部门下的员工（包括该部门的所有子部门员工）

# 接口名称 :

getDepartmentUserList

# 接口说明 :

获取部门下的员工（包括该部门的所有子部门员工）

参数：

参数名	是否必填	参数类型	参数描述
departmentId	是	integer	部门Id，必填
pageIndex	否	integer	页码，选填，如果不填，默认为1
pageSize	否	integer	页容量，选填，如果不填，默认为100
v	是	string	接口版本号

请求示例：

api.getDepartmentUserList(parameter [, parameter1, parameter2...])

返回示例：

{
  "data": {
    "totalCount": "@integer(60, 100)",
    "currentIndex": "@integer(60, 100)",
    "itemCount": "@integer(60, 100)",
    "list": [
      {
        "orgUserId": "@integer(60, 100)",
        "name": "@string",
        "eName": "@string"
      }
    ]
  },
  "state": 0,
  "msg": "@string"
}

返回参数说明：

参数名	类型	说明
data	object	返回数据信息
totalCount	integer	└ 总记录数
currentIndex	integer	└ 当前页码
itemCount	integer	└ 返回的记录数
list	array	└ 返回数据列表
orgUserId	integer	员工Id
name	string	员工中文名
eName	string	员工英文名
state	integer	返回码
msg	string	描述信息

# 获取员工信息

# 接口名称 :

getUserDetail

# 接口说明 :

获取员工信息

参数：

参数名	是否必填	参数类型	参数描述
orgUserId	是	integer	员工Id，必填
v	是	string	接口版本号

请求示例：

api.getUserDetail(parameter [, parameter1, parameter2...])

返回示例：

{
  "data": {
    "name": "@string",
    "eName": "@string",
    "sex": 0,
    "phone": "@string",
    "email": "@string",
    "hireDate": "@datetime",
    "departmentIds": [
      "@integer(60, 100)"
    ]
  },
  "state": 0,
  "msg": "@string"
}

返回参数说明：

参数名	类型	说明
data	object	返回数据信息
name	string	员工中文名
eName	string	员工英文名
sex	integer	员工性别，0表示未知，1表示男，2表示女
phone	string	手机号码
email	string	邮箱
hireDate	string	入职日期，未填写时默认为最小日期
departmentIds	array	所属部门Ids
state	integer	返回码
msg	string	描述信息

# 通过用户名获取员工信息

# 接口名称 :

getUserDetailByLoginName

# 接口说明 :

通过用户名获取员工信息

参数：

参数名	是否必填	参数类型	参数描述
loginName	是	string	员工Id，必填
v	是	string	接口版本号

请求示例：

api.getUserDetailByLoginName(parameter [, parameter1, parameter2...])

返回示例：

{
  "data": {
    "name": "@string",
    "eName": "@string",
    "sex": 0,
    "phone": "@string",
    "email": "@string",
    "hireDate": "@datetime",
    "departmentIds": [
      "@integer(60, 100)"
    ]
  },
  "state": 0,
  "msg": "@string"
}

返回参数说明：

参数名	类型	说明
data	object	返回数据信息
name	string	员工中文名
eName	string	员工英文名
sex	integer	员工性别，0表示未知，1表示男，2表示女
phone	string	手机号码
email	string	邮箱
hireDate	string	入职日期，未填写时默认为最小日期
departmentIds	array	所属部门Ids
state	integer	返回码
msg	string	描述信息

# 创建员工

# 接口名称 :

createUser

# 接口说明 :

创建员工

参数：

参数名	子级	是否必填	参数类型	参数描述
employee		否	--	--
	loginName	是	string	用户名，maxLength：50
	name	是	string	姓名，maxLength：50
	phone	是	string	手机号码
	email	否	string	邮箱
	eName	是	string	英文名
	sex	是	integer	性别 1男 2女
	hireDate	否	string	入职时间
	employeeDepartment	是	array	所属部门
	state	是	integer	状态 1在职 2离职
v		是	string	接口版本号

请求示例：

api.createUser(parameter [, parameter1, parameter2...])

返回示例：

{
  "data": "@integer(60, 100)",
  "state": 0,
  "msg": "@string"
}

返回参数说明：

参数名	类型	说明
data	integer	返回数据信息
state	integer	返回码
msg	string	描述信息

# 更新员工

# 接口名称 :

updateUser

# 接口说明 :

更新员工

参数：

参数名	子级	是否必填	参数类型	参数描述
loginName		是	string	--
employee		否	--	--
	name	是	string	姓名，maxLength：50
	phone	是	string	手机号码
	email	否	string	邮箱
	eName	是	string	英文名
	sex	是	integer	性别 1男 2女
	hireDate	否	string	入职时间
	employeeDepartment	是	array	所属部门
	state	是	integer	状态 1在职 2离职
v		是	string	接口版本号

请求示例：

api.updateUser(parameter [, parameter1, parameter2...])

返回示例：

{
  "data": "@integer(60, 100)",
  "state": 0,
  "msg": "@string"
}

返回参数说明：

参数名	类型	说明
data	integer	返回数据信息
state	integer	返回码
msg	string	描述信息

← 学生全局错误码 →