Danh sách truy vấn thành viên (Vai trò) là gì?
API Danh sách truy vấn thành viên (Vai trò) cho phép bạn liệt kê các thành viên thuộc một vai trò.
Note:
Nó sẽ chỉ trả lại các thành viên có trạng thái được mời hoặc đã được kích hoạt.
Phiên bản API
Phiên bản API |
Thời gian cập nhật |
Mô tả |
V1 |
2023.10.11 |
1. Thêm một tham số yêu cầu mới.
- Cho biết có bao gồm thông tin các phòng ban được phân công hay không: has_manage_range 2. Thêm một tham số phản hồi mới.
- ID phòng ban được phân công: departments_range - Có bao gồm phòng ban con hay không: has_child |
Gọi API
API cho phép bạn liệt kê các thành viên theo vai trò.
URL Yêu cầu: https://api.jodoo.com/api/v5/corp/role/user/list
Tần suất yêu cầu: 30 lần/giây
Phương thức yêu cầu: POST
Tham số yêu cầu:
Tham số |
Kiểu |
Bắt buộc |
Mô tả |
skip |
Số |
Không |
Phân trang theo offset |
limit |
Số |
Không |
Kích thước phân trang |
role_no |
Số |
Có |
Số vai trò |
has_manage_range |
Boolean |
Không |
Cho biết có bao gồm thông tin các phòng ban được phân công hay không. Mặc định là False. |
Ví dụ Yêu cầu:
{ "skip": 0, "limit": 3, "role_no": 3, "has_manage_range": True }
Phản hồi:
Tham số |
Kiểu |
Bắt buộc |
Mô tả |
username |
Chuỗi |
Có |
Mã số thành viên, duy nhất trong công ty. |
name |
Chuỗi |
Có |
Tên người dùng thành viên |
departments |
Mảng số |
Có |
Danh sách ID phòng ban mà thành viên thuộc về |
type |
Số |
Có |
Loại thành viên
- 0: thành viên thường |
status |
Số |
Có |
Trạng thái
- 0: thành viên chưa xác nhận - 1: đã tham gia |
departments_range |
Mảng số |
Không |
ID phòng ban được phân công
Lưu ý: Tham số chỉ có cho thành viên được cấu hình phòng ban được phân công. |
has_child |
Boolean |
Không |
Cho biết có bao gồm phòng ban con hay không
Lưu ý: Tham số chỉ có cho thành viên được cấu hình phòng ban được phân công. |
Ví dụ Phản hồi:
{ "users": [ { "username": "jodoo-xulalikdbj82", "name": "frank", "departments": [212], "type": 0, "status": 1, "deptarments_range": [378,1157], "has_child": true }, { "username": "R-E9rRNbwL", "name": "Member deletion", "departments": [338,226], "type": 0, "status": 1, "deptarments_range": [1157], "has_child": false }, { "username": "UPDATE", "name": "testadmin", "departments": [1], "type": 0, "status": 1 } ] }