Skip to main content

Nhóm quyền (Roles)

Mô tả​

Quản trị role / quyền. Các API hỗ trợ:

API​


GET /api/roles​

Danh sách nhóm quyền:

Tham số query:

Tên trườngKiểu dữ liệuMô tảBắt buộc
namestringTên roleKhông
codestringMã roleKhông
descriptionstringMô tảKhông
statusinteger0 hoặc 1Không
pageintegerTrangKhông
sizeintegerSố bản ghi trên trangKhông
sortstringTên trường sắp xếpKhông
orderstringasc / descKhô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ườngKiểu dữ liệuMô tảBắt buộc
role_idsstring[]Danh sách id roleKhô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ườngKiểu dữ liệuMô tảBắt buộc
namestringTên role (tối đa 255)Có
descriptionstringMô tả (tối đa 500)Không
statusinteger0 inactive1 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ườngKiểu dữ liệuMô tảBắt buộc
namestringTên role (tối đa 255)Có
descriptionstringMô tả (tối đa 500)Không
statusinteger01

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ườngKiểu dữ liệuMô tảBắt buộc
func_idsstring[]Danh sách id functionCó

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ườngKiểu dữ liệuMô tảBắt buộc
permission_codesstring[]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
}