组织接口总览

员工角色赋予（AuthorizeAccess）

• PKG: com.joyzl.scada.people.actions.AuthorizeAccess
• URI: /actions/AuthorizeAccess
• 权限: AUTHORIZED
• 广播: 无

为员工赋予指定角色。 员工可赋予多个角色，员工将拥有这些角色包含的功能权限。 角色赋予员工之后，员工需要重现登录才能获得最新的功能权限。 员工即便没有任何角色也可以登录系统，并能够使用无须授权的功能。

请求示例：

{
	"EmployeeId": 3565021699244033, // 必要，员工标识
	"RoleId": 3565021699244033 // 必要，角色标识
}

响应示例：

{
	"Status": 2
}

员工角色取消（AuthorizeCancel）

• PKG: com.joyzl.scada.people.actions.AuthorizeCancel
• URI: /actions/AuthorizeCancel
• 权限: AUTHORIZED
• 广播: 指定员工

取消已赋予员工的角色。 员工角色被取消后，将不能使用此角色包含的功能权限。 客户端收到广播应立即注销此员工当前登录。 员工即便没有任何角色也可以登录系统，并能够使用无须授权的功能。

请求示例：

{
	"EmployeeId": 3565021699244033, // 必要，员工标识
	"RoleId": 3565021699244033 // 必要，角色标识
}

响应示例：

{
	"Status": 2
}

员工权限获取（AuthorizeEmployee）

• PKG: com.joyzl.scada.people.actions.AuthorizeEmployee
• URI: /actions/AuthorizeEmployee
• 权限: ANY
• 广播: 无

获取员工拥有的功能权限。 如果员工拥有多个角色，将返回多个角色包含的功能权限的并集。 请求此接口之前用户必须已成功登录。

请求示例：

{
	"EmployeeId": 3565021699244033, // 任选，员工标识
	"Token": "0ok8u7hygtf" // 任选，会话令牌
}

员工标识和令牌两个参数必须至少指定一项。 如果同时指定仅采用员工标识。

响应示例：

{
	"Status": 2,
	"Functions": [
		"AreaCreate",
		"AreaDelete",
		"AreaMove"
	]
}

员工角色获取（AuthorizeSelect）

• PKG: com.joyzl.scada.people.actions.AuthorizeSelect
• URI: /actions/AuthorizeSelect
• 权限: LOGON
• 广播: 无

获取指定员工赋予的角色或指定角色被赋予的员工。

请求示例：

{
	"EmployeeId": 3565021699244033, // 任选，员工标识
	"RoleId": 3565021699244033 // 任选，角色标识
}

员工标识和角色标识必须至少指定一项。 如果同时指定仅采用员工标识。

响应示例：

{
	"Status": 2,
	"Roles":[
		{
			"CompanyId": 3565275035205635, // 所属公司标识
			"Name": "管理员", // 角色名称
			"Functions": 168 // 包含的功能数
		}
		...
	]
}

{
	"Status": 2,
	"Employees": [
		{
			"UserId": 3565303556472836, // 用户标识
			"CompanyId": 3565275035205635, // 公司标识
			"AreaId": 3565322011410437, // 区域标识
			"Number": "Z0001", // 工号
			"Phone": 023 12345678, // 固定电话
			"State": { // 状态（枚举）
				value: 1,
				name: "SERVING",
				text: "在职"
			}, 
			"Enable": true, // 可用/禁用
			"Entry": "2024-09-11", // 入职日期
			"Departure": "2024-09-11", // 离职日期
			"Insurance": "2024-09-12", // 保险日期
			"Emergency": "", // 紧急联系方式
			"Name": , // 姓名
		}
		...
	]
}

公司新建（CompanyCreate）

• PKG: com.joyzl.scada.people.actions.CompanyCreate
• URI: /actions/CompanyCreate
• 权限: AUTHORIZED
• 广播: 登录用户

创建新的公司。

请求示例：

{
	"Name": "中翌智联（重庆）科技有限公司", // 必要，名称
	"License": "1234567890123456789", // 必要，注册代码
	"Alias": "中翌智联", // 可选，简称或别名
	"Phone": "023 12345678", // 可选，固定电话
	"Country": "中国", // 可选，国家
	"Province": "重庆市", // 可选，省份或直辖市
	"City": "重庆市", // 可选，城市
	"District": "渝北区", // 可选，区
	"Town": "回兴", // 可选，镇
	"Village": "社区", // 可选，社区/村
	"Address": "小区", // 可选，地址
	"Website": "www.joyzl.com" // 可选，网址
}

请求之前应校验公司名称和注册代码进行唯一性， 请参考 CompanyUnique 接口。

响应示例：

{
	"Status": 2,
	"Id" : 3565343821791238, // 必要，公司标识
	"Created" : "2024-9-12 8:04:10" // 必要，创建时间
}

公司删除（CompanyDelete）

• PKG: com.joyzl.scada.people.actions.CompanyDelete
• URI: /actions/CompanyDelete
• 权限: AUTHORIZED
• 广播: 登录用户

删除指定公司。 同时会删除公司下属的所有关联对象（区域、员工、角色等），这将导致几乎所有数据都被删除。 通常常规客户端不建议提供删除公司功能。

请求示例：

{
	"Id": 238253447937797 // 必要，公司标识
}

响应示例：

{
	"Status": 2
}

公司获取（CompanySelect）

• PKG: com.joyzl.scada.people.actions.CompanySelect
• URI: /actions/CompanySelect
• 权限: LOGON
• 广播: 无

获取所有已创建的公司。

请求示例：

{
	// 无参数
}

响应示例：

{
	"Status": 2,
	"Companies":[
		{
			"Id" : 3565343821791238, // 必要，公司标识
			... // 字段与公司创建相同
			"Created" : "2024-9-12 8:04:10", // 必要，创建时间
			"Updated" : "2024-9-12 8:04:10" // 必要，创建时间
		}
		...
	]
}

公司获取（CompanySingle）

• PKG: com.joyzl.scada.people.actions.CompanySingle
• URI: /actions/CompanySingle
• 权限: LOGON
• 广播: 无

获取标识指定公司。

请求示例：

{
	"Id" : 3565343821791238, // 必要，公司标识
}

响应示例：

{
	"Status": 2,
	"Company": {
		"Id" : 3565343821791238, // 必要，公司标识
		... // 字段与公司创建时相同
		"Created" : "2024-9-12 8:04:10", // 必要，创建时间
		"Updated" : "2024-9-12 8:04:10" // 必要，创建时间
	}
}

公司唯一性校验（CompanyUnique）

• PKG: com.joyzl.scada.people.actions.CompanyUnique
• URI: /actions/CompanyUnique
• 权限: ANY
• 广播: 无

校验公司名称和注册代码是否可用。 系统中不允许创建名称和注册代码重复的公司。

请求示例：

{
	"Id" : 3565343821791238, // 可选，公司标识
	"Name": "中翌智联（重庆）科技有限公司", // 任选，名称
	"License": "1234567890123456789", // 任选，注册代码
}

名称和注册代码可同时指定也可单独指定，但至少应指定一项。 同时指定名称和注册代码时将同时校验两项是否都不存在。 "Id" 公司标识用于排除性校验，可在修改公司信息时使用。

响应示例：

{
	"Status": 2,
	"Available": false // 必要，是否可用
}

公司更新（CompanyUpdate）

• PKG: com.joyzl.scada.people.actions.CompanyUpdate
• URI: /actions/CompanyUpdate
• 权限: AUTHORIZED
• 广播: 登录用户

修改公司信息。

请求示例：

{
	"Id" : 3565343821791238, // 必要，公司标识
	"Name": "中翌智联（重庆）科技有限公司", // 必要，名称
	"License": "1234567890123456789", // 必要，注册代码
	"Alias": "中翌智联", // 可选，简称或别名
	"Phone": "023 12345678", // 可选，固定电话
	"Country": "中国", // 可选，国家
	"Province": "重庆市", // 可选，省份或直辖市
	"City": "重庆市", // 可选，城市
	"District": "渝北区", // 可选，区
	"Town": "回兴", // 可选，镇
	"Village": "社区", // 可选，社区/村
	"Address": "小区", // 可选，地址
	"Website": "www.joyzl.com" // 可选，网址
}

请求之前应校验公司名称和注册代码进行唯一性， 请参考 CompanyUnique 接口。

响应示例：

{
	"Status": 2,
	"Updated" : "2024-9-12 8:04:10" // 必要，更新时间
}

区域新建（AreaCreate）

• PKG: com.joyzl.scada.people.actions.AreaCreate
• URI: /actions/AreaCreate
• 权限: AUTHORIZED
• 广播: 登录用户

创建新的区域。

请求示例：

{
	"CompanyId": 3565343821791238, // 必要，公司标识，Long
	"ParentId": 3565363954450439, // 可选，父级区域标识，Long,
	"Name": "A区", // 必要，名称，String
	"Type": "1", // 可选，自定类型，String
	"Alias": "A区", // 可选，别名，String
	"Number": // 可选，自定编号，String
	"Phone": // 可选，固定电话，String
	"Address": // 可选，地址，String
	"Longitude": // 可选，经度，Double
	"Latitude": // 可选，纬度，Double
	"Altitude": // 可选，海拔高度，Float
}

请求之前应校验区域名称唯一性， 请参考 AreaUnique 接口。

"Type" 字段可为任意字符串，本系统未进行额外定义。 客户端期望对区域进行额外标识以进行区分时可使用此字段。

响应示例：

{
	"Status": 2,
	"Id": 3565382409388040, // 必要，区域标识，Long
	"Created": "2024-09-12 10:19:12" // 必要，创建时间，LocalDateTime
}

区域删除（AreaDelete）

• PKG: com.joyzl.scada.people.actions.AreaDelete
• URI: /actions/AreaDelete
• 权限: AUTHORIZED
• 广播: 登录用户

删除指定区域。 同时会删除区域下属的所有关联对象（员工、设备、定时器、伺服器等）。

请求示例：

{
	"Id": 238253447937797 // 必要，区域标识
}

响应示例：

{
	"Status": 2
}

区域移动（AreaMove）

• PKG: com.joyzl.scada.people.actions.AreaMove
• URI: /actions/AreaMove
• 权限: AUTHORIZED
• 广播: 登录用户

移动区域到另一个区域，使其成为另一个区域的下属区域。 也可以移动到公司，使其成为根级区域。

请求示例：

{
	"Id": 238253447937797, // 必要，区域标识
	"ParentId": 3565382409388040 // 可选，父级区域标识
}

如果 "ParentId" 未指定，则表示移动到当前公司下成为根级区域。

响应示例：

{
	"Status": 2
}

区域获取（AreaSelect）

• PKG: com.joyzl.scada.people.actions.AreaSelect
• URI: /actions/AreaSelect
• 权限: LOGON
• 广播: 无

获取所有区域或指定区域的下属区域。

请求示例：

{
	"AreaId": 238253447937797 // 可选，父级区域标识，Long
}

如果 "AreaId" 未指定，则返回当前用户可见的所有区域和上级衍生区域； 上级衍生区域用于完整的展示区域结构。 如果 "AreaId" 被指定，则返回指定区域的直接下属区域，不含子区域。

响应示例：

{
	"Status": 2,
	"Areas": [
		{
			"Id": 3565382409388040, // 必要，区域标识
			... // 字段与区域创建时相同
			"Created": "2024-09-12 10:19:12" // 必要，创建时间
			"Updated": "2024-09-12 10:19:12" // 必要，更新时间
		}
	]
}

区域获取（AreaSingle）

• PKG: com.joyzl.scada.people.actions.AreaSingle
• URI: /actions/AreaSingle
• 权限: LOGON
• 广播: 无

获取标识指定区域。

请求示例：

{
	"Id": 238253447937797 // 必要，区域标识，Long
}

响应示例：

{
	"Status": 2,
	"Area": {
		"Id": 238253447937797, // 必要，区域标识
		... // 字段与区域创建时相同
		"Created": "2024-09-12 10:19:12" // 必要，创建时间
		"Updated": "2024-09-12 10:19:12" // 必要，更新时间
	}
}

区域唯一性校验（AreaUnique）

• PKG: com.joyzl.scada.people.actions.AreaUnique
• URI: /actions/AreaUnique
• 权限: ANY
• 广播: 无

校验区域名称是否可用。 系统中不允许在公司范围创建名称重复的区域。

请求示例：

{
	"Id": 238253447937797, // 可选，区域标识，Long
	"Name": "A区" // 必要，名称，String
}

"Id" 区域标识用于排除性校验，可在修改区域信息时使用。

响应示例：

{
	"Status": 2,
	"Available": true // 必要，是否可用，Boolean
}

区域更新（AreaUpdate）

• PKG: com.joyzl.scada.people.actions.AreaUpdate
• URI: /actions/AreaUpdate
• 权限: AUTHORIZED
• 广播: 登录用户

修改区域信息。

请求示例：

{
	"Id": 3565363954450439, // 必要，区域标识，Long,
	"Name": "A区", // 必要，名称，String
	"Type": "1", // 可选，自定类型，String
	"Alias": "A区", // 可选，别名，String
	"Number": // 可选，自定编号，String
	"Phone": // 可选，固定电话，String
	"Address": // 可选，地址，String
	"Longitude": // 可选，经度，Double
	"Latitude": // 可选，纬度，Double
	"Altitude": // 可选，海拔高度，Float
}

请求之前应校验区域名称唯一性， 请参考 AreaUnique 接口。

响应示例：

{
	"Status": 2,
	"Updated": "2024-09-12 10:19:12" // 必要，更新时间
}

员工数量（EmployeeAmount）

• PKG: com.joyzl.scada.people.actions.EmployeeAmount
• URI: /actions/EmployeeAmount
• 权限: LOGON
• 广播: 无

获取全部或指定区域的员工数量。

请求示例：

{
	"CompanyId": 3565343821791238, // 可选，公司标识，Long
	"AreaId": 3565363954450439 // 可选，区域标识，Long
}

缺省所有参数时将返回员工可见区域的所有员工数量。 指定公司标识时将返回公司下属所有员工（含所有区域）。 指定区域标识时将返回指定区域下属所有员工（含子区域）。

响应示例：

{
	"Status": 2,
	"Employees": 10 // 必要，员工数量，Integer
}

员工状态更改（EmployeeChange）

• PKG: com.joyzl.scada.people.actions.EmployeeChange
• URI: /actions/EmployeeChange
• 权限: AUTHORIZED
• 广播: 登录用户

更改员工状态。

请求示例：

{
	"Id": 3565303556472836, // 必要，员工标识，Long
	"State": 1, // 必要，状态（枚举），EmployeeState
}

员工状态定义请参考 EmployeeState 。

响应示例：

{
	"Status": 2,
	"Updated": "2024-09-12 14:36:34" // 必要，更新时间，LocalDateTime
}

员工新建（EmployeeCreate）

• PKG: com.joyzl.scada.people.actions.EmployeeCreate
• URI: /actions/EmployeeCreate
• 权限: AUTHORIZED
• 广播: 登录用户

创建新的员工。 请求此接口时关联用户应已事先创建。

请求示例：

{
	"UserId": 3565303556472836, // 必要，用户标识，Long
	"CompanyId": 3565275035205635, // 必要，公司标识，Long
	"AreaId": 3565322011410437, // 可选，区域标识，Long
	"Number": "Z0001", // 必要，工号，String
	"Phone": 023 12345678, // 可选，固定电话，String
	"State": 1, // 必要，状态（枚举），EmployeeState
	"Enable": true // 必要，可用/禁用，Boolean
}

未指定 "AreaId" 区域标识时，创建的员工将可见公司下属所有区域范围。 有指定 "AreaId" 区域标识时，创建的员工仅可见指定区域及下属子区域范围。

请求此接口之前应校验员工工号的唯一性， 请参考 EmployeeUnique 接口。

员工状态定义请参考 EmployeeState 。

响应示例：

{
	"Status": 2,
	"Id": 3422661384339457, // 必要，员工标识，Long
	"Created": "2024-09-12 14:36:34" // 必要，创建时间，LocalDateTime
}

员工删除（EmployeeDelete）

• PKG: com.joyzl.scada.people.actions.EmployeeDelete
• URI: /actions/EmployeeDelete
• 权限: AUTHORIZED
• 广播: 登录用户

删除指定员工。 同时会删除员工所有关联对象（保养等）。 已经登录此身份的客户端应收到广播后要求用户重选员工身份， 如果没有员工身份可选择应强制注销当前登录。

请求示例：

{
	"Id": 238253447937797 // 必要，员工标识
}

响应示例：

{
	"Status": 2
}

员工启用或禁用（EmployeeEnable）

• PKG: com.joyzl.scada.people.actions.EmployeeEnable
• URI: /actions/EmployeeEnable
• 权限: AUTHORIZED
• 广播: 登录用户

启用或禁用指定员工。 被禁用的员工将不能使用此身份登录； 已经登录此身份的客户端应收到广播后要求用户重选员工身份， 如果没有员工身份可选择应强制注销当前登录。

请求示例：

{
	"Id": 238253447937797 // 必要，员工标识，Long
	"Enable": true // 必要，启用或禁用，Boolean
}

响应示例：

{
	"Status": 2
}

员工登录（EmployeeLogin）

• PKG: com.joyzl.scada.people.actions.EmployeeLogin
• URI: /actions/EmployeeLogin
• 权限: ANY
• 广播: 无

员工身份登录。

请求示例：

{
	"Number": "Z0001",// 必要，工号，String
	"Password": "XXX" // 必要，密码，MD5 String
}

响应示例：

{
	"Status": 2，
	"User": {
		... // 用户字段参考用户新建接口
	},
	"Employee": {
		... // 员工字段参考员工新建接口
	}
}

"Password" 请求参数不会在响应中原样返回。

员工移动（EmployeeMove）

• PKG: com.joyzl.scada.people.actions.EmployeeMove
• URI: /actions/EmployeeMove
• 权限: AUTHORIZED
• 广播: 登录用户

移动员工到另一个区域，使其成为另一个区域的员工。 也可以移动到公司，使其可见所有区域。

请求示例：

{
	"Id": 3565343821791238, // 必要，员工标识，Long
	"AreaId": 3565363954450439 // 可选，区域标识，Long
}

如果 "AreaId" 未指定，则表示移动到公司级，使其可见所有区域。

响应示例：

{
	"Status": 2
}

员工注册（EmployeeRegister）

• PKG: com.joyzl.scada.people.actions.EmployeeRegister
• URI: /actions/EmployeeRegister
• 权限: ANY
• 广播: 登录用户

注册新员工。 注册的员工需要审核状态后才能生效。

请求示例：

{
	"UserId": 3565303556472836, // 必要，用户标识，Long
	"CompanyId": 3565275035205635, // 必要，公司标识，Long
	"AreaId": 3565322011410437, // 可选，区域标识，Long
	"Number": "Z0001", // 必要，工号，String
	"Phone": 023 12345678, // 可选，固定电话，String
	"State": 1, // 必要，状态（枚举），EmployeeState
	"Enable": true // 必要，可用/禁用，Boolean
}

请求此接口之前应校验用户手机号码、电子邮件和身份证的唯一性， 请参考 UserUnique 接口。 请求此接口之前应校验员工工号的唯一性， 请参考 EmployeeUnique 接口。

员工状态定义请参考 EmployeeState 。

响应示例：

{
	"Status": 2,
	"UserId": 3422842578272258, // 必要，用户标识，Long
	"EmployeeId": 3422862710931459, // 必要，员工标识，Long
	"Created": "2024-09-12 15:47:12" // 必要，创建时间，LocalDateTime
}

"Password" 请求参数不会在响应中原样返回。

员工获取（EmployeeSelect）

• PKG: com.joyzl.scada.people.actions.EmployeeSelect
• URI: /actions/EmployeeSelect
• 权限: LOGON
• 广播: 无

获取所有员工或指定区域的下属员工。

注意：此接口名与 EmployerSelect 仅一个字母的差异请注意区分。

请求示例：

{
	"CompanyId": 3565275035205635 // 可选，公司标识，Long
	"AreaId": 3565322011410437 // 可选，区域标识，Long
	"State": 1, // 可选，状态（枚举），EmployeeState
	"Enable": true // 可选，启用或禁用，Boolean
	"Keywords": "Z00" // 可选，关键字，String	
}

缺省所有参数时，将返回当前登录员工可见范围的所有员工。 指定 "CompanyId" 公司标识时，将仅匹配未隶属任何区域的员工。 指定 "AreaId" 区域标识时，将仅匹配指定区域的员工（不含子区域）。 指定 "Keywords" 关键字时，将模糊匹配员工姓名和工号。

员工状态定义请参考 EmployeeState 。

响应示例：

{
	"Status": 2,
	"Employees": [
		{
			"Id": 3422862710931459, // 必要，员工标识
			... // 字段与员工创建相同
			"Created" : "2024-9-12 8:04:10", // 必要，创建时间
			"Updated" : "2024-9-12 8:04:10" // 必要，创建时间
		}
		...
	]
}

员工获取（EmployeeSingle）

• PKG: com.joyzl.scada.people.actions.EmployeeSingle
• URI: /actions/EmployeeSingle
• 权限: LOGON
• 广播: 无

获取标识指定员工。

请求示例：

{
	"Id" : 3422862710931459, // 必要，员工标识
}

响应示例：

{
	"Status": 2,
	"Employee": {
		"Id": 3422862710931459, // 必要，员工标识
		... // 字段与员工创建相同
		"Created" : "2024-9-12 8:04:10", // 必要，创建时间
		"Updated" : "2024-9-12 8:04:10" // 必要，创建时间
	}
}

员工唯一性校验（EmployeeUnique）

• PKG: com.joyzl.scada.people.actions.EmployeeUnique
• URI: /actions/EmployeeUnique
• 权限: LOGON
• 广播: 无

校验员工工号是否可用。 系统中不允许在公司范围创建工号重复的员工。

请求示例：

{
	"Id": 3422862710931459, // 可选，员工标识
	"Number": "Z0001" // 必要，工号
}

"Id" 员工标识用于排除性校验，可在修改员工信息时使用。

响应示例：

{
	"Status": 2,
	"Available": true // 必要，是否可用，Boolean
}

员工更新（EmployeeUpdate）

• PKG: com.joyzl.scada.people.actions.EmployeeUpdate
• URI: /actions/EmployeeUpdate
• 权限: AUTHORIZED
• 广播: 登录用户

修改员工信息。

请求示例：

{
	"Id": 3565303556472836, // 必要，员工标识，Long
	"Number": "Z0001", // 必要，工号，String
	"Phone": 023 12345678 // 可选，固定电话，String
}

请求此接口之前应校验员工工号的唯一性， 请参考 EmployeeUnique 接口。

响应示例：

{
	"Status": 2,
	"Updated": "2024-09-12 16:20:15" // 必要，更新时间，LocalDateTime
}

用户员工获取（EmployerSelect）

• PKG: com.joyzl.scada.people.actions.EmployerSelect
• URI: /actions/EmployerSelect
• 权限: LOGON
• 广播: 无

获取指定用户的所有可用（不含禁用）员工身份。 此接口常用于用户登录成功之后获取员工身份供用户选择。

注意：此接口名与 EmployeeSelect 仅一个字母的差异请注意区分。

请求示例：

{
	"UserId": 3565303556472836, // 必要，用户标识，Long
}

响应示例：

{
	"Status": 2,
	"Employees": [ // 必要，员工
		{
			"Id": 3422862710931459, // 必要，员工标识
			... // 字段与员工创建相同
			"Created" : "2024-9-12 8:04:10", // 必要，创建时间
			"Updated" : "2024-9-12 8:04:10" // 必要，创建时间
		}
		...
	],
	"Companies": [ // 必要，公司
		{
			"Id": 3422862710931459, // 必要，员工标识
			... // 字段与公司创建相同
			"Created" : "2024-9-12 8:04:10", // 必要，创建时间
			"Updated" : "2024-9-12 8:04:10" // 必要，创建时间
		}
		...
	],
}

返回的公司为多个员工身份所属公司的并集。

角色功能赋予（FunctionAccess）

• PKG: com.joyzl.scada.people.actions.FunctionAccess
• URI: /actions/FunctionAccess
• 权限: AUTHORIZED
• 广播: 无

角色赋予指定功能权限。

请求示例：

{
	"RoleId": 3422891232198661, // 必要，角色标识，Long
	"Action": "EmployeeUpdate" // 必要，功能名称，String
}

响应示例：

{
	"Status": 2
}

角色功能取消（FunctionCancel）

• PKG: com.joyzl.scada.people.actions.FunctionCancel
• URI: /actions/FunctionCancel
• 权限: AUTHORIZED
• 广播: 无

角色取消指定功能权限。

请求示例：

{
	"RoleId": 3422891232198661, // 必要，角色标识，Long
	"Action": "EmployeeUpdate" // 必要，功能名称，String
}

响应示例：

{
	"Status": 2
}

角色功能获取（FunctionSelect）

• PKG: com.joyzl.scada.people.actions.FunctionSelect
• URI: /actions/FunctionSelect
• 权限: LOGON
• 广播: 无

获取指定角色已赋予的所有功能。

请求示例：

{
	"RoleId": 3422891232198661, // 必要，角色标识，Long
}

响应示例：

{
	"Status": 2,
	"Functions": [
		"EmployeeCreate",
		"EmployeeChange",
		"EmployeeDelete",
		...
	]
}

角色新建（RoleCreate）

• PKG: com.joyzl.scada.people.actions.RoleCreate
• URI: /actions/RoleCreate
• 权限: AUTHORIZED
• 广播: 登录用户

创建新的角色。

请求示例：

{
	"CompanyId": 3565275035205635, // 必要，公司标识，Long
	"Name": "管理员", // 必要，角色名称，String
	"Functions": [ // 可选，功能名称，String[]
		"EmployeeCreate",
		"EmployeeChange",
		"EmployeeDelete",
		...
	]
}

"Functions" 功能名称可在创建时指定， 也可以创建之后通过 FunctionAccess 添加。 角色应仅赋予需要授权的功能，其它权限类型的功能无须赋予到角色中， 即便将无须授权的功能其赋予到角色中也不会有任何额外效果。

请求之前应校验角色名称唯一性， 请参考 RoleUnique 接口。

通过 ActionSelect 接口可获取系统已定义的所有功能。

响应示例：

{
	"Status": 2,
	"Id": 3422902976249862, // 必要，角色标识，Long
	"Created": "2024-09-12 17:45:16"
}

角色删除（RoleDelete）

• PKG: com.joyzl.scada.people.actions.RoleDelete
• URI: /actions/RoleDelete
• 权限: AUTHORIZED
• 广播: 登录用户

删除指定角色。

请求示例：

{
	"Id": 238253447937797 // 必要，角色标识
}

响应示例：

{
	"Status": 2
}

角色获取（RoleSelect）

• PKG: com.joyzl.scada.people.actions.RoleSelect
• URI: /actions/RoleSelect
• 权限: LOGON
• 广播: 无

获取当前公司的所有角色。

请求示例：

{
	// 无参数
}

响应示例：

{
	"Status": 2,
	"Roles": [
		{
			"Id": 238253447937797, // 必要，角色标识，Long
			"CompanyId": 3565275035205635, // 必要，公司标识，Long
			"Name": "管理员", // 必要，角色名称，String
			"Functions": 10 // 必要，功能数量，Integer
		}
		...
	]
}

角色获取（RoleSingle）

• PKG: com.joyzl.scada.people.actions.RoleSingle
• URI: /actions/RoleSingle
• 权限: LOGON
• 广播: 无

获取标识指定角色。

请求示例：

{
	"Id": 238253447937797, // 必要，角色标识，Long
}

响应示例：

{
	"Status": 2,
	"Role": {
		"Id": 238253447937797, // 必要，角色标识，Long
		"CompanyId": 3565275035205635, // 必要，公司标识，Long
		"Name": "管理员", // 必要，角色名称，String
		"Functions": 10 // 必要，功能数量，Integer
	}
}

角色唯一性校验（RoleUnique）

• PKG: com.joyzl.scada.people.actions.RoleUnique
• URI: /actions/RoleUnique
• 权限: ANY
• 广播: 无

校验角色名称是否可用。 系统中不允许在公司范围创建名称重复的角色。

请求示例：

{
	"Id": 238253447937797, // 必要，角色标识，Long
	"Name": "管理员", // 必要，角色名称，String
}

"Id" 角色标识用于排除性校验，可在修改角色信息时使用。

响应示例：

{
	"Status": 2,
	"Available": true // 必要，是否可用，Boolean
}

角色更新（RoleUpdate）

• PKG: com.joyzl.scada.people.actions.RoleUpdate
• URI: /actions/RoleUpdate
• 权限: AUTHORIZED
• 广播: 无

修改角色信息。

请求示例：

{
	"Id": 238253447937797, // 必要，角色标识，Long
	"Name": "管理员", // 必要，角色名称，String
}

请求之前应校验角色名称唯一性， 请参考 RoleUnique 接口。

响应示例：

{
	"Status": 2,
	"Updated": "2024-09-12 17:45:16" // 必要，更新时间，LocalDateTime
}

用户数量（UserAmount）

• PKG: com.joyzl.scada.people.actions.UserAmount
• URI: /actions/UserAmount
• 权限: LOGON
• 广播: 无

获取用户数量。

请求示例：

{
	// 无参数
}

响应示例：

{
	"Status": 2,
	"Users": 10, // 必要，用户总数，Integer
	"Females": 5, // 必要，女性总数，Integer
	"Males": 4 // 必要，男性总数，Integer
}

用户新建（UserCreate）

• PKG: com.joyzl.scada.people.actions.UserCreate
• URI: /actions/UserCreate
• 权限: AUTHORIZED
• 广播: 无

创建新的用户。

请求示例：

{
	"Mobile": "13883062895", // 必要，手机号码，String
	"Phone": "023 12345678", // 可选，固定电话，String
	"Email": "Z001@joyzl.com", // 可选，电子邮件，String
	"QQ": "931000000", // 可选，QQ号码，String
	"WX": "wx931000000", // 可选，微信号码，String
	"NRIC": "513524199010301155", // 必要，身份证号码，String
	"Name": "小陈", // 必要，姓名，String
	"Gender": true, // 必要，性别，Boolean
	"Birthday": "1990-10-30" // 可选，出生日期，LocalDate
	"Degree": "本科", // 可选，学历，String
	"Origin": "重庆市", // 可选，籍贯，String
	"Address": "渝北区...", // 可选，住址，String
	"Password": "XXX", // 必要，登陆密码，MD5 String
}

请求此接口之前应校验用户手机号码、电子邮件和身份证的唯一性， 请参考 UserUnique 接口。

响应示例：

{
	"Status": 2,
	"Id": 3422911364857863, // 必要，用户标识，Long
	"Created": "2024-09-12 18:33:12" // 必要，创建时间，LocalDateTime
}

用户删除（UserDelete）

• PKG: com.joyzl.scada.people.actions.UserDelete
• URI: /actions/UserDelete
• 权限: AUTHORIZED
• 广播: 无

删除指定用户。 同时会删除用户所有关联对象（员工）。

请求示例：

{
	"Id": 238253447937797 // 必要，用户标识
}

响应示例：

{
	"Status": 2
}

用户更改邮箱（UserEmail）

• PKG: com.joyzl.scada.people.actions.UserEmail
• URI: /actions/UserEmail
• 权限: LOGON
• 广播: 无

用户更改邮箱。

请求示例：

{
	"Id": 3422911364857863, // 必要，用户标识，Long
	"Email": "Z001@joyzl.com", // 可选，电子邮件，String
}

请求此接口之前应校验用户电子邮件的唯一性， 请参考 UserUnique 接口。

响应示例：

{
	"Status": 2,
	"Updated": "2024-09-12 18:33:12" // 必要，更新时间，LocalDateTime
}

用户启用或禁用（UserEnable）

• PKG: com.joyzl.scada.people.actions.UserEnable
• URI: /actions/UserEnable
• 权限: AUTHORIZED
• 广播: 无

启用或禁用指定用户。 被禁用的用户以及所有员工身份都将不能登录。

请求示例：

{
	"Id": 3422911364857863, // 必要，用户标识，Long
	"Enable": true // 必要，启用或禁用，Boolean
}

响应示例：

{
	"Status": 2,
	"Updated": "2024-09-12 18:33:12" // 必要，更新时间，LocalDateTime
}

用户登录（UserLogin）

• PKG: com.joyzl.scada.people.actions.UserLogin
• URI: /actions/UserLogin
• 权限: ANY
• 广播: 无

用户登录。

请求示例：

{
	"Username": "13883062895", // 必要，用户名，String
	"Password": "XXX" // 必要，密码，MD5 String
}

"Username" 用户名可以是手机号码、身份证号码、邮箱地址。

响应示例：

{
	"Status": 2,
	"User": {
		"Id": 3422911364857863, // 必要，用户标识，Long
		... // 字段与用户新建相同
		"Created": "2024-09-12 18:33:12", // 必要，创建时间，LocalDateTime
		"Updated": "2024-09-12 18:33:12" // 必要，更新时间，LocalDateTime
	},
	"Token": "0oki8uhygt5"
}

用户更改手机号（UserMobile）

• PKG: com.joyzl.scada.people.actions.UserMobile
• URI: /actions/UserMobile
• 权限: LOGON
• 广播: 无

请求示例：

{
	"Id": 3422911364857863, // 必要，用户标识，Long
	"Mobile": "13883062895" // 必要，手机号码，String
}

请求此接口之前应校验用户手机号码的唯一性， 请参考 UserUnique 接口。

响应示例：

{
	"Status": 2,
	"Updated": "2024-09-12 18:36:12" // 必要，更新时间，LocalDateTime
}

用户修改密码（UserPassword）

• PKG: com.joyzl.scada.people.actions.UserPassword
• URI: /actions/UserPassword
• 权限: LOGON
• 广播: 无

用户修改登录密码。 客户端应要求用户输入两次以确认新密码。

请求示例：

{
	"Id": 3422911364857863, // 必要，用户标识，Long
	"PasswordOld": "XXX", // 必要，原密码，MD5 String
	"PasswordNew": "XXX" // 必要，新密码，MD5 String
}

响应示例：

{
	"Status": 2,
	"Updated": "2024-09-12 18:37:12" // 必要，更新时间，LocalDateTime
}

用户注册（UserRegister）

• PKG: com.joyzl.scada.people.actions.UserRegister
• URI: /actions/UserRegister
• 权限: ANY
• 广播: 无

用户自行注册创建新用户。 如果系统具有较多用户，让其自行注册能够有效的分摊创建大量用户的工作量。 注册用户通常需要通过审核才能生效。

请求示例：

{
	"Mobile": "13883062895", // 必要，手机号码，String
	"Phone": "023 12345678", // 可选，固定电话，String
	"Email": "Z001@joyzl.com", // 可选，电子邮件，String
	"QQ": "931000000", // 可选，QQ号码，String
	"WX": "wx931000000", // 可选，微信号码，String
	"NRIC": "513524199010301155", // 必要，身份证号码，String
	"Name": "小陈", // 必要，姓名，String
	"Gender": true, // 必要，性别，Boolean
	"Birthday": "1990-10-30" // 可选，出生日期，LocalDate
	"Degree": "本科", // 可选，学历，String
	"Origin": "重庆市", // 可选，籍贯，String
	"Address": "渝北区...", // 可选，住址，String
	"Password": "XXX", // 必要，登陆密码，MD5 String
}

请求此接口之前应校验用户手机号码、电子邮件和身份证的唯一性， 请参考 UserUnique 接口。

响应示例：

{
	"Status": 2,
	"Id": 3422921431187464, // 必要，用户标识，Long
	"Created": "2024-09-12 18:38:12" // 必要，创建时间，LocalDateTime
}

用户重置密码（UserReset）

• PKG: com.joyzl.scada.people.actions.UserReset
• URI: /actions/UserReset
• 权限: AUTHORIZED
• 广播: 无

重置指定用户的登录密码。

请求示例：

{
	"Id": 3422921431187464, // 必要，用户标识，Long
	"Password": "XXX" // 必要，新密码，MD5 String
}

响应示例：

{
	"Status": 2
}

用户获取（UserSelect）

• PKG: com.joyzl.scada.people.actions.UserSelect
• URI: /actions/UserSelect
• 权限: AUTHORIZED
• 广播: 无

获取关键字匹配的用户。

请求示例：

{
	"Keywords":"" // 必要，关键字，String
}

"Keywords" 关键字将模糊匹配用户的手机号码、电子邮件、身份证号码和姓名。

响应示例：

{
	"Status": 2,
	"Users": [
		{
			"Id": 3422911364857863, // 必要，用户标识，Long
			... // 字段与用户新建相同
			"Created": "2024-09-12 18:33:12", // 必要，创建时间，LocalDateTime
			"Updated": "2024-09-12 18:33:12" // 必要，更新时间，LocalDateTime
		}
		...
	]
}

用户获取（UserSingle）

• PKG: com.joyzl.scada.people.actions.UserSingle
• URI: /actions/UserSingle
• 权限: LOGON
• 广播: 无

获取标识指定用户。

请求示例：

{
	"Id": 3422921431187464, // 必要，用户标识，Long
}

响应示例：

{
	"Status": 2,
	"User": {
		"Id": 3422911364857863, // 必要，用户标识，Long
		... // 字段与用户新建相同
		"Created": "2024-09-12 18:33:12", // 必要，创建时间，LocalDateTime
		"Updated": "2024-09-12 18:33:12" // 必要，更新时间，LocalDateTime
	}
}

用户唯一性校验（UserUnique）

• PKG: com.joyzl.scada.people.actions.UserUnique
• URI: /actions/UserUnique
• 权限: ANY
• 广播: 无

校验用户手机号码、邮箱地址和身份证号码是否可用。 系统中不允许创建手机号码、邮箱地址和身份证号码重复的用户。

请求示例：

{
	"Id": 3422921431187464, // 必要，用户标识，Long
	"Mobile": "13883062895", // 任选，手机号码，String
	"Email": "Z001@joyzl.com", // 任选，电子邮箱，String
	"NRIC": "513524199010301155" // 任选，电子邮箱，String
}

手机号码、邮箱地址和身份证号码可同时指定也可单独指定，但至少应指定一项。 同时指定手机号码、邮箱地址和身份证号码时将同时校验三项是否都不存在。 "Id" 用户标识用于排除性校验，可在修改用户信息时使用。

响应示例：

{
	"Status": 2,
	"Available": false // 必要，是否可用，Boolean
}

用户更新（UserUpdate）

• PKG: com.joyzl.scada.people.actions.UserUpdate
• URI: /actions/UserUpdate
• 权限: AUTHORIZED
• 广播: 无

修改用户信息。

请求示例：

{
	"Id": 3422921431187464, // 必要，用户标识，Long
	"Mobile": "13883062895", // 必要，手机号码，String
	"Phone": "023 12345678", // 可选，固定电话，String
	"Email": "Z001@joyzl.com", // 可选，电子邮件，String
	"QQ": "931000000", // 可选，QQ号码，String
	"WX": "wx931000000", // 可选，微信号码，String
	"NRIC": "513524199010301155", // 必要，身份证号码，String
	"Name": "小陈", // 必要，姓名，String
	"Gender": true, // 必要，性别，Boolean
	"Birthday": "1990-10-30" // 可选，出生日期，LocalDate
	"Degree": "本科", // 可选，学历，String
	"Origin": "重庆市", // 可选，籍贯，String
	"Address": "渝北区..." // 可选，住址，String
}

请求此接口之前应校验用户手机号码、电子邮件和身份证的唯一性， 请参考 UserUnique 接口。

响应示例：

{
	"Status": 2,
	"Updated": "2024-09-12 18:33:12" // 必要，更新时间，LocalDateTime
}

枚举定义（Enums）

员工状态（EmployeeState）

• PKG: com.joyzl.scada.people.entities.EmployeeState