Nhóm quyền (Roles)
Mô tả
Quản trị role / quyền. Các API hỗ trợ:
- GET /roles: Danh sách
- GET /count: Đếm
- GET /selectBox: Select box
- GET /nextRoleCode: Mã role tiếp theo
- GET /requiresWarehouseScope: Cần phạm vi kho?
- POST /roles: Tạo
- PUT /{id}: Cập nhật
- DELETE /{id}: Xóa
- PUT /{id}/toggleActive: Bật/tắt
- GET /{id}/functions: Functions
- PUT /{id}/functions: Cập nhật functions
- GET /{id}/permissions: Permissions
- PUT /{id}/permissions: Cập nhật permissions
API
GET /api/roles
Danh sách nhóm quyền:
Tham số query:
| Tên trường | Kiểu dữ liệu | Mô tả | Bắt buộc |
|---|---|---|---|
name | string | Tên role | Không |
code | string | Mã role | Không |
description | string | Mô tả | Không |
status | integer | 0 hoặc 1 | Không |
page | integer | Trang | Không |
size | integer | Số bản ghi trên trang | Không |
sort | string | Tên trường sắp xếp | Không |
order | string | asc / desc | Không |
GET /api/roles?page=1&size=20
Response Body
{
"code": 200,
"message": "Success",
"result": [],
"page": 1,
"page_size": 20,
"total": 0
}
GET /api/roles/count
Đếm nhóm quyền.
GET /api/roles/count
Response Body
{
"code": 200,
"message": "Success",
"result": 5
}
GET /api/roles/selectBox
Roles cho select box.
GET /api/roles/selectBox
Response Body
{
"code": 200,
"message": "Success",
"result": {}
}
GET /api/roles/nextRoleCode
Sinh mã role tiếp theo.
GET /api/roles/nextRoleCode
Response Body
{
"code": 200,
"message": "Success",
"result": "…"
}
GET /api/roles/requiresWarehouseScope
Các role có yêu cầu phạm vi kho hay không:
Tham số query:
| Tên trường | Kiểu dữ liệu | Mô tả | Bắt buộc |
|---|---|---|---|
role_ids | string[] | Danh sách id role | Không |
GET /api/roles/requiresWarehouseScope?role_ids=…
Response Body
{
"code": 200,
"message": "Success",
"result": {}
}
POST /api/roles
Tạo nhóm quyền.
Request Body
| Tên trường | Kiểu dữ liệu | Mô tả | Bắt buộc |
|---|---|---|---|
name | string | Tên role (tối đa 255) | Có |
description | string | Mô tả (tối đa 500) | Không |
status | integer | 0 inactive | 1 active |
POST /api/roles
Request Body
{
"name": "Kho quản lý",
"description": "",
"status": 1
}
Response Body
{
"code": 200,
"message": "Success",
"result": true
}
PUT /api/roles/{id}
Cập nhật nhóm quyền.
Request Body
| Tên trường | Kiểu dữ liệu | Mô tả | Bắt buộc |
|---|---|---|---|
name | string | Tên role (tối đa 255) | Có |
description | string | Mô tả (tối đa 500) | Không |
status | integer | 0 | 1 |
PUT /api/roles/\{id\}
Request Body
{
"name": "Kho quản lý",
"status": 1
}
Response Body
{
"code": 200,
"message": "Success",
"result": true
}
DELETE /api/roles/{id}
Xóa nhóm quyền.
DELETE /api/roles/\{id\}
Response Body
{
"code": 200,
"message": "Success",
"result": true
}
PUT /api/roles/{id}/toggleActive
Bật / tắt active. Không có body.
PUT /api/roles/\{id\}/toggleActive
Response Body
{
"code": 200,
"message": "Success",
"result": true
}
GET /api/roles/{id}/functions
Danh sách function của role.
GET /api/roles/\{id\}/functions
Response Body
{
"code": 200,
"message": "Success",
"result": {}
}
PUT /api/roles/{id}/functions
Cập nhật functions của role.
Request Body
| Tên trường | Kiểu dữ liệu | Mô tả | Bắt buộc |
|---|---|---|---|
func_ids | string[] | Danh sách id function | Có |
PUT /api/roles/\{id\}/functions
Request Body
{ "func_ids": ["func-id-1", "func-id-2"] }
Response Body
{
"code": 200,
"message": "Success",
"result": true
}
GET /api/roles/{id}/permissions
Permissions của role.
GET /api/roles/\{id\}/permissions
Response Body
{
"code": 200,
"message": "Success",
"result": {}
}
PUT /api/roles/{id}/permissions
Cập nhật permissions của role.
Request Body
| Tên trường | Kiểu dữ liệu | Mô tả | Bắt buộc |
|---|---|---|---|
permission_codes | string[] | Mã quyền (vd products.read) | Không |
PUT /api/roles/\{id\}/permissions
Request Body
{ "permission_codes": ["products.read", "products.create"] }
Response Body
{
"code": 200,
"message": "Success",
"result": true
}