成员管理
成员管理
新增员工信息
接口URL
/adduserinfo
请求参数定义
参数名 | 参数说明 | 必填 | 参数类型 | 长度 | 值举例 | 备注 |
---|---|---|---|---|---|---|
Version | 版本号 | Y | String | 3.0 | 固定为3.0。 | |
MsgID | 唯一标识 | Y | String | 1000120150511190411000001 | 企业账号+消息方向+YYYYMMDDHHMMSS+NNNNNN | |
CorpCode | 操作企业账号 | Y | String | 企业账号 | ||
TenantUserId | 操作人帐号 | Y | String | HW_000001 | 1、如果是系统维护,写"sysadmin" 2、如果是普通员工维护,写员工id | |
Employee | 员工信息 | Y | Employee |
响应参数定义
参数名 | 参数说明 | 必填 | 参数类型 | 长度 | 值举例 | 备注 |
---|---|---|---|---|---|---|
ResultCode | 返回码 | Y | String | 0 | 0表示成功,其他值为失败。注意重复创建的处理逻辑:系统直接返回,不做处理 | |
Description | 描述 | Y | String | Success | 描述信息,出错时为错误信息即错误原因。 |
样例
请求
{
"Version": "3.0",
"MsgID": "0008120220929071248283828",
"CorpCode": "0008",
"TenantUserId": "sysadmin",
"Employee": {
"TenantUserId":"26215236521",
"Name": "颜敏",
"Surname": "YAN",
"GivenName": "MIN",
"Gender": "M",
"Type": "0",
"Nationality": "156",
"Birthday": "19881111",
"Mailbox": "yanmin@**.com",
"Cellphone": "18500000001",
"MobileCountryCode": "86",
"Telephone": null,
"CertificateInfoList": [{
"CertificateType": "1",
"CertificateNum": "110101********1018"
}],
"DeptList": [{
"DeptNum": "1",
"DeptName": "产品与解决方案"
}],
"EmployeeNum": "10234118",
"EmployeeUID": "1011118",
"Role": 2,
"RoleGroupList": [{
"Name": "职级",
"RoleList": [{
"Name": "领导"
}]
}],
"EmployeeLevel": "1",
"EmployeeVIPLevel": null,
"Remark": null,
"ExtInfo": "{\"settlementUnitCode\":\"112233\",\"settlementUnitName\":\"结算单位\"}",
"BaseLocation": null
}
}
返回
{
"ResultCode": "0",
"Description": "成功"
}
修改员工信息
接口URL
/modiuserinfo
请求参数定义
参数名 | 参数说明 | 必填 | 参数类型 | 长度 | 值举例 | 备注 |
---|---|---|---|---|---|---|
Version | 版本号 | Y | String | 3.0 | 固定为3.0。 | |
MsgID | 唯一标识 | Y | String | 1000120150511190411000001 | 企业账号+消息方向+YYYYMMDDHHMMSS+NNNNNN | |
CorpCode | 操作企业账号 | Y | String | 企业账号 | ||
TenantUserId | 操作人帐号 | Y | String | HW_000001 | 1、如果是系统维护,写"sysadmin" 2、如果是普通员工维护,写员工id | |
Employee | 员工信息 | Y | Employee |
响应参数定义
参数名 | 参数说明 | 必填 | 参数类型 | 长度 | 值举例 | 备注 |
---|---|---|---|---|---|---|
ResultCode | 返回码 | Y | String | 0 | 0表示成功,其他值为失败。 | |
Description | 描述 | Y | String | Success | 描述信息,出错时为错误信息即错误原因。 |
样例
请求
{
"Version": "3.0",
"MsgID": "0008120220929071248283828",
"CorpCode": "0008",
"TenantUserId": "sysadmin",
"Employee": {
"TenantUserId":"26215236521",
"Name": "颜敏",
"Surname": "YAN",
"GivenName": "MIN",
"Gender": "M",
"Type": "0",
"Nationality": "156",
"Birthday": "19881111",
"Mailbox": "yanmin@**.com",
"Cellphone": "18500000001",
"MobileCountryCode": "86",
"Telephone": null,
"CertificateInfoList": [{
"CertificateType": "1",
"CertificateNum": "110101********1018"
}],
"DeptList": [{
"DeptNum": "1",
"DeptName": "产品与解决方案"
}],
"EmployeeNum": "10234118",
"EmployeeUID": "1011118",
"Status": "2",
"Role": 2,
"RoleGroupList": [{
"Name": "职级",
"RoleList": [{
"Name": "领导"
}]
}],
"EmployeeLevel": "1",
"EmployeeVIPLevel": null,
"Remark": null,
"ExtInfo": "{\"settlementUnitCode\":\"112233\",\"settlementUnitName\":\"结算单位\"}",
"BaseLocation": null
}
}
返回
{
"ResultCode": "0",
"Description": "成功"
}
删除员工信息
调用该接口后,员工信息会被软删除。
接口URL
/deluserinfo
请求参数定义
参数名 | 参数说明 | 必填 | 参数类型 | 长度 | 值举例 | 备注 |
---|---|---|---|---|---|---|
Version | 版本号 | Y | String | 3.0 | 固定为3.0。 | |
MsgID | 唯一标识 | Y | String | 1000120150511190411000001 | 企业账号+消息方向+YYYYMMDDHHMMSS+NNNNNN | |
CorpCode | 操作企业账号 | Y | String | 企业账号 | ||
TenantUserId | 操作人帐号 | Y | String | HW_000001 | 1、如果是系统维护,写"sysadmin" 2、如果是普通员工维护,写员工id | |
EmployeeTenantUserId | 租户用户id | N | String |
响应参数定义
参数名 | 参数说明 | 必填 | 参数类型 | 长度 | 值举例 | 备注 |
---|---|---|---|---|---|---|
ResultCode | 返回码 | Y | String | 0 | 0表示成功,其他值为失败。 | |
Description | 描述 | Y | String | Success | 描述信息,出错时为错误信息即错误原因。 |
样例
请求
{
"Version": "3.0",
"MsgID": "0008120220929071248283828",
"CorpCode": "0008",
"TenantUserId": "sysadmin",
"EmployeeTenantUserId": "10215118"
}
返回
{
"ResultCode": "0",
"Description": "成功"
}
查询员工信息
通过该接口查询用户详情。
接口URL
/employee/detail/query
请求参数定义
参数名 | 参数说明 | 必填 | 参数类型 | 长度 | 值举例 | 备注 |
---|---|---|---|---|---|---|
Version | 版本号 | Y | String | 3.0 | 固定为3.0。 | |
MsgID | 唯一标识 | Y | String | 1000120150511190411000001 | 企业账号+消息方向+YYYYMMDDHHMMSS+NNNNNN | |
CorpCode | 操作企业账号 | Y | String | 企业账号 | ||
TenantUserId | 操作人帐号 | Y | String | HW_000001 | 1、如果是系统维护,写"sysadmin" 2、如果是普通员工维护,写员工id | |
EmployeeNum | 企业内部工号 | N | String | 12345 | ||
Mobile | 企业员工手机号 | N | String | 13055051111 |
响应参数定义
参数名 | 参数说明 | 必填 | 参数类型 | 长度 | 值举例 | 备注 |
---|---|---|---|---|---|---|
ResultCode | 返回码 | Y | String | 0 | 0表示成功 | |
Description | 描述 | Y | String | Success | 描述信息,出错时为错误信息即错误原因。 | |
EmployeeDetailList | 员工详情 | Y | List<EmployeeDetail> | 包含LoginName /Name/EmployeeNum/EmployeeUID等字段 |
样例
请求
{
"Version": "3.0",
"MsgID": "0008120220929071248283828",
"CorpCode": "0008",
"TenantUserId": "sysadmin",
"EmployeeNum": "10234118",
"Mobile": "18500000001"
}
返回
{
"ResultCode": "0",
"Description": "成功",
"EmployeeDetailList": [
{
"CorpCode": "0008",
"EmployeelList": [
{
"TenantUserId": "10215118",
"Name": "颜敏",
"Surname": "YAN",
"GivenName": "MIN",
"Gender": "M",
"Type": "0",
"Nationality": "156",
"Birthday": "19881111",
"Mailbox": "yanmin@**.com",
"Cellphone": "18500000001",
"MobileCountryCode": "86",
"Telephone": null,
"CertificateInfoList": [
{
"CertificateType": "1",
"CertificateNum": "110101********1018"
}
],
"DeptList": [
{
"DeptNum": "1",
"DeptName": "产品与解决方案"
}
],
"EmployeeNum": "10234118",
"EmployeeUID": "1011118",
"Role": 2,
"RoleGroupList": [
{
"Name": "职级",
"RoleList": [
{
"Name": "领导"
}
]
}
],
"EmployeeLevel": "1",
"EmployeeVIPLevel": null,
"Remark": null,
"ExtInfo": "{\"settlementUnitCode\":\"112233\",\"settlementUnitName\":\"结算单位\"}",
"BaseLocation": null
}
]
}
]
}
变更员工归属子公司
此接口专用于集团公司中员工切换不同子公司使用,此集团中的不同子公司在系统中可能有不同企业账号、企业密码和证书。
如果是同一个公司内的员工信息变更,必须使用“修改员工信息接口”,不能使用本接口进行变更。
接口URL
/changesubcompany
请求参数定义
参数名 | 参数说明 | 必填 | 参数类型 | 长度 | 值举例 | 备注 |
---|---|---|---|---|---|---|
Version | 版本号 | Y | String | 3.0 | 固定为3.0。 | |
MsgID | 唯一标识 | Y | String | 1000120150511190411000001 | 企业账号+消息方向+YYYYMMDDHHMMSS+NNNNNN | |
CorpCode | 操作企业账号 | Y | String | 企业账号 | ||
TenantUserId | 操作人帐号 | Y | String | HW_000001 | 1、如果是系统维护,写"sysadmin" 2、如果是普通员工维护,写员工id | |
OldTenantUserId | 旧员工账号 | Y | String | 50 | 原子公司的员工租户id | |
OldCorpCode | 旧企业账号 | Y | String | 1000 | 变更前的企业账号 | |
Employee | 新员工信息 | Y | Employee | 在新子公司的员工信息,包括LoginName、部门、工号、vip信息等。1、员工的新老LoginName取值可以相同也可以不同,根据企业自身要求提供,保证全局唯一即可。如果企业是使用工号去拼装LoginName,切换子公司导致员工工号改变,LoginName取值可能也要发生变更。2、该信息将完全覆盖系统系统中的员工信息。如果级别、工号等变更,需要重新提供,否则员工此部分数据将缺失,可能影响对账。3、部门信息必要要传入新部门的信息,不传信息也会清空原有部门信息4、员工证件信息列表为空,则保持员工证件信息不变,如需要更新则传递指定证件类型的证件信息。 | ||
NewCorpCode | 新企业账号 | Y | String | 1000 | 变更后的企业账号 |
响应参数定义
参数名 | 参数说明 | 必填 | 参数类型 | 长度 | 值举例 | 备注 |
---|---|---|---|---|---|---|
ResultCode | 返回码 | Y | String | 0 | 0表示成功,其他值为失败。 | |
Description | 描述 | Y | String | Success | 描述信息,出错时为错误信息即错误原因。 |
样例
请求
{
"Version": "3.0",
"MsgID": "0008120220929071248283828",
"CorpCode": "0008",
"TenantUserId": "sysadmin",
"OldTenantUserId": "10215118",
"OldCorpCode": "0007",
"Employee": {
"TenantUserId":"26215236521",
"Name": "颜敏",
"Surname": "YAN",
"GivenName": "MIN",
"Gender": "M",
"Type": "0",
"Nationality": "156",
"Birthday": "19881111",
"Mailbox": "yanmin@**.com",
"Cellphone": "18500000001",
"MobileCountryCode": "86",
"Telephone": null,
"CertificateInfoList": [{
"CertificateType": "1",
"CertificateNum": "110101********1018"
}],
"DeptList": [{
"DeptNum": "1",
"DeptName": "产品与解决方案"
}],
"EmployeeNum": "10234118",
"EmployeeUID": "1011118",
"Role": 2,
"RoleGroupList": [{
"Name": "职级",
"RoleList": [{
"Name": "领导"
}]
}],
"EmployeeLevel": "1",
"EmployeeVIPLevel": null,
"Remark": null
},
"NewCorpCode": "0008"
}
返回
{
"ResultCode": "0",
"Description": "成功"
}