PMS账号管理
1. 角色管理
1.1 角色 - 添加
- 接口地址
POST /v1/role/create- 请求参数
| 名称 | 类型 | 是否必需 | 示例 | 描述 |
|---|---|---|---|---|
| pms_id | int | Y | 1 | pms-storeID |
| name | string | Y | "保安" | 角色名称 |
- 返回结果
无
1.2 角色 - 列表
- 接口地址
POST /v1/role/list- 请求参数
| 名称 | 类型 | 是否必需 | 示例 | 描述 |
|---|---|---|---|---|
| pms_id | int | Y | 1 | pms-storeID |
| search_str | string | N | "aa" | 模糊搜索关键字 |
- 返回示例
json
{
"error_code": 0,
"description": "success",
"error_msg": "success",
"data": [
{
"id": 2,
"pms_id": 1,
"name": "保安"
}
]
}1.3 角色 - 修改
- 接口地址
POST /v1/role/update- 请求参数
| 名称 | 类型 | 是否必需 | 示例 | 描述 |
|---|---|---|---|---|
| id | int | Y | 1 | 角色ID |
| pms_id | int | Y | 1 | pms-storeID |
| name | string | Y | "保安" | 角色名称 |
- 返回结果
无
1.4 角色 - 删除
- 接口地址
POST /v1/role/delete- 请求参数
| 名称 | 类型 | 是否必需 | 示例 | 描述 |
|---|---|---|---|---|
| id | int | Y | 1 | 角色ID |
| pms_id | int | Y | 1 | pms-storeID |
- 返回结果
无
1.5 角色 - 配置权限
- 接口地址
POST /v1/role/permissionUpdate- 请求参数
| 名称 | 类型 | 是否必需 | 示例 | 描述 |
|---|---|---|---|---|
| pms_id | int | Y | 1 | pms-storeID |
| id | int | Y | 3 | 角色ID |
| permission_ids | array | Y | [8, 9] | 权限ID集合 |
- 返回结果
无
1.6 角色 - 权限数据ID集合
- 接口地址
POST /v1/role/permission- 请求参数
| 名称 | 类型 | 是否必需 | 示例 | 描述 |
|---|---|---|---|---|
| pms_id | int | Y | 1 | pms-storeID |
| role_ids | array | Y | [1, 2, 3] | 角色ID集合 |
- 返回示例
json
{
"error_code": 0,
"description": "success",
"error_msg": "success",
"data": {
"role_permission_ids": [8, 9, 15, 16]
}
}2. 账号管理
2.1 账号 - 添加
- 接口地址
POST /v1/employee/create- 请求参数
| 名称 | 类型 | 是否必需 | 示例 | 描述 |
|---|---|---|---|---|
| pms_id | int | Y | 1 | pms-storeID |
| country_code | string | N | "+86" | 国家区号；默认 +86 |
| phone | string | Y | "13410577086" | 手机号 |
| name | string | Y | "lukui" | 姓名 |
| role_ids | array | N | [2, 3] | 选择的角色ID |
| permission_ids | array | N | [1, 2] | 选择的权限ID |
- 返回结果
无
2.2 账号 - 列表
- 接口地址
POST /v1/employee/list- 请求参数
| 名称 | 类型 | 是否必需 | 示例 | 描述 |
|---|---|---|---|---|
| page_no | int | N | 1 | 页码；默认1 |
| page_size | int | N | 25 | 每页数量；默认25 |
| pms_id | int | Y | 1 | pms-storeID |
| search_str | string | N | "aa" | 模糊搜索关键字（账号、姓名） |
| role_ids | array | N | [1] | 员工角色ID |
| bool_enable | int | N | 1 | 状态 |
- 返回结果
| 名称 | 类型 | 描述 |
|---|---|---|
| id | int | 账号ID |
| pms_id | int | pms-storeID |
| user_id | int | 用户ID |
| name | string | 姓名 |
| phone | string | 手机号 |
| bool_enable | int | 状态, 1: 启用, 2: 禁用 |
| bool_owner | int | 是否门店负责人, 1: 是, 2: 否 |
| created_at | string | 创建时间 |
| updated_at | string | 更新时间 |
| bool_limit_ip | int | 是否限制IP, 1: 是, 2: 否 |
| role_list | array | 角色列表 |
| role_list.*.id | int | 角色ID |
| role_list.*.name | string | 角色名称 |
- 返回示例
json
{
"error_code": 0,
"description": "success",
"error_msg": "success",
"data": {
"page_no": 1,
"page_size": 3,
"total": 5,
"pages": 2,
"list": [
{
"id": 1,
"pms_id": 1,
"user_id": 1,
"name": "biaobiao",
"phone": "13410577084",
"bool_enable": 1,
"bool_owner": 1,
"created_at": "2025-02-17 15:10:27",
"updated_at": "2025-02-17 15:10:27",
"bool_limit_ip": 2,
"role_list": [
{
"id": 3,
"name": "保安2"
},
{
"id": 2,
"name": "保安"
}
]
}
]
}
}2.3 账号 - 修改
- 接口地址
POST /v1/employee/update- 请求参数
| 名称 | 类型 | 是否必需 | 示例 | 描述 |
|---|---|---|---|---|
| pms_id | int | Y | 1 | pms-storeID |
| id | int | Y | 6 | 账号ID |
| name | string | Y | "lukui" | 姓名 |
| role_ids | array | N | [2, 3] | 选择的角色ID |
| permission_ids | array | N | [1, 2] | 选择的权限ID |
- 返回结果
无
2.4 账号 - 批量删除
- 接口地址
POST /v1/employee/batchDelete- 请求参数
| 名称 | 类型 | 是否必需 | 示例 | 描述 |
|---|---|---|---|---|
| pms_id | int | Y | 1 | pms-storeID |
| ids | array | Y | [3, 5, 6] | 要删除的账号ID集合 |
- 返回结果
无
2.5 账号 - 批量设置
- 接口地址
POST /v1/employee/batchSet- 请求参数
| 名称 | 类型 | 是否必需 | 示例 | 描述 |
|---|---|---|---|---|
| pms_id | int | Y | 1 | pms-storeID |
| ids | array | Y | [3, 5, 6] | 账号ID |
| bool_enable | int | N | 1 | 状态；1: 启用, 2: 禁用 |
| bool_limit_ip | int | N | 1 | 是否限制IP；1: 是, 2: 否 |
- 返回结果
无
2.6 账号 - 详情（角色、权限）
- 接口地址
POST /v1/employee/detail- 请求参数
| 名称 | 类型 | 是否必需 | 示例 | 描述 |
|---|---|---|---|---|
| pms_id | int | Y | 1 | pms-storeID |
| id | int | Y | 5 | 账号ID |
- 返回结果
| 名称 | 类型 | 描述 |
|---|---|---|
| employee | object | 账号信息 |
| employee.id | int | 账号ID |
| employee.pms_id | int | pms-storeID |
| employee.name | string | 姓名 |
| employee.country_code | int | 国家区号 |
| employee.phone | string | 账号 |
| employee.user_id | int | 用户ID |
| role_ids | array | 角色ID集合 |
| permission_ids | array | 账号的权限ID集合 |
- 返回示例
json
{
"error_code": 0,
"description": "success",
"error_msg": "success",
"data": {
"employee": {
"id": 5,
"pms_id": 1,
"name": "meimaei11",
"country_code": 86,
"phone": "13410577087",
"user_id": 8
},
"role_ids": [1, 2, 3],
"permission_ids": [11, 18]
}
}2.7 账号 - Select
- 接口地址
POST /api/v1/employee/getSelect- 请求参数
| 名称 | 类型 | 是否必需 | 示例 | 描述 |
|---|---|---|---|---|
| pms_id | int | Y | 1 | PMS门店ID |
- 返回结果
| 名称 | 类型 | 描述 |
|---|---|---|
| employee_id | int | 员工ID |
| name | string | 姓名 |
- 返回示例
json
{
"error_code": 0,
"description": "success",
"error_msg": "success",
"data": [
{
"employee_id": 5,
"name": "xie"
}
]
}3. 权限数据
3.1 权限数据 - 列表
- 接口地址
POST /v1/common/permissionAll- 请求参数
无
- 返回结果
| 名称 | 类型 | 描述 |
|---|---|---|
| id | int | 权限ID |
| name | string | 权限名称 |
| slug | string | 权限标识 |
| parent_id | int | 父级ID |
| children | array | 子权限 |
| children.*.id | int | 权限ID |
| children.*.name | string | 权限名称 |
| children.*.slug | string | 权限标识 |
| children.*.parent_id | int | 父级ID |
| children.*.children | array | 子权限 |
- 返回示例
json
{
"error_code": 0,
"description": "success",
"error_msg": "success",
"data": [
{
"id": 1,
"name": "住宿管理",
"slug": "checkin",
"parent_id": 0,
"children": [
{
"id": 8,
"name": "房态管理",
"slug": "checkin.checkin",
"parent_id": 1,
"children": [
{
"id": 9,
"name": "查看房态",
"slug": "checkin.checkin.index",
"parent_id": 8
}
]
}
]
},
{
"id": 2,
"name": "渠道直连",
"slug": "channel",
"parent_id": 0
}
]
}