Nhảy tới nội dung
Phiên bản: 2.3.0

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.
KeyTypeDescription
searchstringThông tin tìm kiếm theo mã vai trò hoặc tên vai trò
pageintSố trang cần lấy dữ liệu (Mặc định hệ thống đang là 1)
pagesizeintSố 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​

KeyTypeDescription
successbooleanTrạng thái phản hồi của yêu cầu (true: Thành công, false: Thất bại)
codeintMã phản hồi từ hệ thống
messagesarrayDanh sách thông báo trả về từ hệ thống
dataobjectĐố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:​

KeyTypeDescription
itemsarrayDanh sách thông tin chi tiết các vai trò (xem chi tiết bên dưới)
totalCountintTổng số lượng vai trò thỏa mãn điều kiện lọc
pageCountintTổng số trang
pageintTrang hiện tại
pageSizeintSố lượng bản ghi trên một trang
hasNextPagebooleanCó trang kế tiếp hay không (true: Có, false: Không)
hasPreviousPagebooleanCó trang trước đó hay không (true: Có, false: Không)

Chi tiết đối tượng trong mảng items:​

KeyTypeDescription
idstringID vai trò (định dạng GUID)
codestringMã vai trò (ví dụ: Default)
namestringTên vai trò (ví dụ: Mặc định)
descriptionstringMô tả chi tiết về quyền hạn hoặc phạm vi của vai trò