Lấy danh sách vai trò của người dùng
Ngày cập nhật: 18 tháng 08, 2026
Người cập nhật: VNPT eContract's team
Mục đích
Hàm thực hiện lấy danh sách vai trò của người dùng ở công ty hiện tại
- Request URL:
/api/roles - HTTP method:
GET - Authorize:
Bearer token - Parameter: Không yêu cầu, tuy nhiên có thể thêm các tùy chọn bên dưới để thực hiện lọc hoặc tìm kiếm danh sách vai trò của người dùng.
| Key | Type | Description |
|---|---|---|
search | string | Thông tin tìm kiếm theo mã vai trò hoặc tên vai trò |
page | int | Số trang cần lấy dữ liệu (Mặc định hệ thống đang là 1) |
pagesize | int | Số record dữ liệu mà hệ thống sẽ trả về sau mỗi request (Mặc định hệ thống đang là 10 record) |
Mẫu request
Query param:
page: 1
pageSize: 10
search: Default
Request: /api/roles?page=1&pageSize=10&search=Default
Mẫu response body
{
"data": {
"items": [
{
"id": "2b999cd0-32ec-4e4a-16b8-08da6df5fc5a",
"code": "Default",
"name": "Mặc định",
"description": "Vai trò mặc định với những quyền cơ bản"
}
],
"totalCount": 1,
"pageCount": 1,
"page": 1,
"pageSize": 10,
"hasNextPage": false,
"hasPreviousPage": false
},
"success": true,
"code": 0,
"messages": []
}
Mô tả Response Body
| Key | Type | Description |
|---|---|---|
success | boolean | Trạng thái phản hồi của yêu cầu (true: Thành công, false: Thất bại) |
code | int | Mã phản hồi từ hệ thống |
messages | array | Danh sách thông báo trả về từ hệ thống |
data | object | Đối tượng chứa danh sách vai trò và dữ liệu phân trang (xem chi tiết bên dưới) |
Chi tiết dữ liệu trong data:
| Key | Type | Description |
|---|---|---|
items | array | Danh sách thông tin chi tiết các vai trò (xem chi tiết bên dưới) |
totalCount | int | Tổng số lượng vai trò thỏa mãn điều kiện lọc |
pageCount | int | Tổng số trang |
page | int | Trang hiện tại |
pageSize | int | Số lượng bản ghi trên một trang |
hasNextPage | boolean | Có trang kế tiếp hay không (true: Có, false: Không) |
hasPreviousPage | boolean | Có trang trước đó hay không (true: Có, false: Không) |
Chi tiết đối tượng trong mảng items:
| Key | Type | Description |
|---|---|---|
id | string | ID vai trò (định dạng GUID) |
code | string | Mã vai trò (ví dụ: Default) |
name | string | Tên vai trò (ví dụ: Mặc định) |
description | string | Mô tả chi tiết về quyền hạn hoặc phạm vi của vai trò |