# 员工 API

# 创建员工

接口地址:/api/open/v2/staffs/create

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {
    "account": "",
    "active": 0,
    "code": "EM001",
    "departmentNames": ["研发"],
    "name": "顾大卫",
    "password": ""
  }
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
staffSaveParamRequestParameter	staffSaveParamRequestParameter	body	true	RequestParameter«StaffSaveParam»	RequestParameter«StaffSaveParam»
body			false	StaffSaveParam	StaffSaveParam
account	账号		false	string
active	是否开通		false	integer
code	编码		false	string
departmentNames	部门列表		false	array	string
name	名称		false	string
password	密码		false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
message		string

响应示例:

{
	"code": 0,
	"message": ""
}

# 删除员工

接口地址:/api/open/v2/staffs/delete

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
code	code	body	true	RequestParameter«string»	RequestParameter«string»
body			false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
message		string

响应示例:

{
	"code": 0,
	"message": ""
}

# 查询员工列表

接口地址:/api/open/v2/staffs/query

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {
    "code": "",
    "codeLike": "",
    "codes": [],
    "name": "",
    "nameLike": "",
    "pagingParam": {
      "length": 0,
      "start": 0
    }
  }
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
queryParamRequestParameter	queryParamRequestParameter	body	true	RequestParameter«StaffQueryParam»	RequestParameter«StaffQueryParam»
body			false	StaffQueryParam	StaffQueryParam
code	编码完全匹配		false	string
codeLike	编码模糊匹配		false	string
codes	编码完全匹配，批量获取		false	array	string
name	名称完全匹配		false	string
nameLike	名称模糊匹配		false	string
pagingParam			false	PagingParam	PagingParam
length			false	integer
start			false	integer

响应状态:

状态码	说明	schema
200	OK	ListPagingResponse«StaffDTO»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		ListPagingResponseData«StaffDTO»	ListPagingResponseData«StaffDTO»
length		integer(int32)
list		array	StaffDTO
account	账号	string
active	账号是否开启 1开启 0关闭 2禁用	integer
bindStatus	登录手机绑定状态，0-未绑定，1-待确认，2-已绑定	integer
code	编码	string
comment	备注	string
dateOfBirth	生日	string
deleted	是否已逻辑删除(【1】：是,【0】：否)	integer
department	部门	string
directSuperiorAccount	直属上级账号	string
directSuperiorId	直属上级账号	integer
email	邮箱	string
emergencyContactNumber	紧急联系电话	string
emergencyContactPerson	紧急联系人	string
employedDate	日期	string
employeeId	工号	string
gender	性别	string
headPortrait	头像	string
homeAddress	住址	string
identityNumber	身份证号	string
inCharge	是否负责人(【1】：是,【0】：否)	integer
invitationCode	邀请码	string
mobilePhone	登录手机号[已经被 mask]	string
name	名称	string
permissionIds	权限	array	integer
phone	电话	string
position	职位	string
quitDate	离职日期	string
serviceStatus	在职状态 0-离职，1-在职	integer
shortName		string
staffDepartments	部门	array	DepartmentDTO
levelIndex	部门所在层级位置	integer
name	部门名称	string
staffRank	职级	string
tenantId	租户id	string
updateTime	更新时间	string
workingCondition	工作状态	string
recordsTotal		integer(int32)
start		integer(int32)
message		string

响应示例:

{
	"code": 0,
	"data": {
		"length": 0,
		"list": [
			{
				"account": "",
				"active": 0,
				"bindStatus": 0,
				"code": "",
				"comment": "",
				"dateOfBirth": "",
				"deleted": 0,
				"department": "",
				"directSuperiorAccount": "",
				"directSuperiorId": 0,
				"email": "",
				"emergencyContactNumber": "",
				"emergencyContactPerson": "",
				"employedDate": "",
				"employeeId": "",
				"gender": "",
				"headPortrait": "",
				"homeAddress": "",
				"identityNumber": "",
				"inCharge": 0,
				"invitationCode": "",
				"mobilePhone": "",
				"name": "",
				"permissionIds": [],
				"phone": "",
				"position": "",
				"quitDate": "",
				"serviceStatus": 0,
				"shortName": "",
				"staffDepartments": [
					{
						"levelIndex": 0,
						"name": ""
					}
				],
				"staffRank": "",
				"tenantId": "",
				"updateTime": "",
				"workingCondition": ""
			}
		],
		"recordsTotal": 0,
		"start": 0
	},
	"message": ""
}

# 修改员工详情

接口地址:/api/open/v2/staffs/update

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {
    "account": "",
    "active": 0,
    "code": "",
    "departmentNames": [],
    "name": "",
    "password": ""
  }
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
staffSaveParamRequestParameter	staffSaveParamRequestParameter	body	true	RequestParameter«StaffSaveParam»	RequestParameter«StaffSaveParam»
body			false	StaffSaveParam	StaffSaveParam
account	账号		false	string
active	是否开通		false	integer
code	编码		false	string
departmentNames	部门列表		false	array	string
name	名称		false	string
password	密码		false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
message		string

响应示例:

{
	"code": 0,
	"message": ""
}

# 创建更新员工

接口地址:/api/open/v2/staffs/upsert

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {
    "account": "",
    "active": 0,
    "code": "",
    "departmentNames": [],
    "name": "",
    "password": ""
  }
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
staffSaveParamRequestParameter	staffSaveParamRequestParameter	body	true	RequestParameter«StaffSaveParam»	RequestParameter«StaffSaveParam»
body			false	StaffSaveParam	StaffSaveParam
account	账号		false	string
active	是否开通		false	integer
code	编码		false	string
departmentNames	部门列表		false	array	string
name	名称		false	string
password	密码		false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
message		string

响应示例:

{
	"code": 0,
	"message": ""
}

# 部门API

# 创建或修改部门

接口地址:/api/open/v2/department/createOrUpdate

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {
    "departmentName": "",
    "originalDepartmentName": "",
    "parentDepartmentName": ""
  }
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
parameter	parameter	body	true	RequestParameter«DepartmentSaveParam»	RequestParameter«DepartmentSaveParam»
body			false	DepartmentSaveParam	DepartmentSaveParam
departmentName	部门编码		false	string
originalDepartmentName	原部门名称		false	string
parentDepartmentName	父级部门名称		false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
message		string

响应示例:

{
	"code": 0,
	"message": ""
}

← 认证 API 物料-分类API →