List Agency F10
# 1. Tổng quan
- Action URL:
/api/vi/agencies - Đặc tả chi tiết: Swagger Link (opens new window)
- Mô tả: Lấy tất cả các agency F10 được quản lý bởi agency F1.
# 2. Hướng dẫn
- Bước 1: Thực hiện xây dựng request và POST tới API action URL.
- Bước 2: Nhận về response.
# 3. Parameters
# Bảng mô tả Parameters
| Thuộc tính | Bắt buộc | Kiểu dữ liệu | Mô tả |
|---|---|---|---|
| Page | Có | Number | Số trang |
| Limit | Có | Number | Số lượng phần tử trên mỗi trang |
| x-api-token | Có | String | Token API (F1) |
| x-api-password | Có | String | Mật khẩu API (F1) |
| x-api-account | Có | String | Tài khoản API (F1) |
# 4. Response
# 4.1 Ví dụ Response
{
"StatusCode": 201,
"Timestamp": "2:29:08 AM",
"Path": "/api/v1/agencies",
"Message": "Tạo mới agency F10 thành công",
"Data": {
"Agency": {
"id": "094051d1-21bd-45c4-826f-0b5d0546bf84",
"companyName": "Agency 001",
"contactEmail": "agency01@gmail.com",
"contactPhone": "+84987600001",
"apiAccount": "...",
"apiPassword": "...",
"apiToken": "...",
"address": "123 Đường ABC, Quận XYZ, TP.HCM",
"notes": "Agency mới tạo",
"agencyType": "F10",
"firstName": "Nguyễn",
"lastName": "Văn A",
"isActive": true,
"tier": "premium",
"defaultLanguage": "VI",
"defaultCurrency": "VND",
"subscriptionId": null,
"balenceAmount": "10000.00",
"balenceLimit": "0.00",
"industry": "Travel",
"agencyCredit": "limit",
"parentAgencyId": "ca5b18b8-fa5d-485f-a615-984ee0d4df89",
"createdAt": "2025-10-16T02:29:08.320Z",
"updatedAt": "2025-10-16T02:29:08.322Z"
},
"Credentials": {
"apiAccount": "...",
"apiPassword": "...",
"apiToken": "..."
}
},
"Errors": null,
"RequestId": "req_1760581747622_uyg66pbvv",
"TotalDuration": 1017
}
# 4.2 Bảng mô tả Response
| Thuộc tính | Kiểu dữ liệu | Mô tả | Ví dụ |
|---|---|---|---|
| StatusCode | String | Tình trạng request | 200: Danh sách agency trả về thành công 401: Không có quyền truy cập 403: Chỉ F1 Agency mới có quyền xem danh sách agency F10 |
| Timestamp | String | Thời gian trả về | "2:29:08 AM" |
| Path | String | Đường dẫn API | "/api/v1/agencies" |
| Message | String | Tin nhắn thông báo | "Tạo mới agency F10 thành công" |
| Errors | String | Lỗi khi thực hiện request | null |
| RequestId | String | Mã định danh duy nhất cho request | "req_1760581747622_uyg66pbvv" |
| TotalDuration | string | Thời gian xử lý của request | "1017" |
| Agency.id | string | ID của agency | "094051d1-21bd-45c4-826f-0b5d0546bf84" |
| Agency.companyName | string | Tên công ty | "Agency 001" |
| Agency.contactEmail | string | Email liên hệ | "agency01@gmail.com" |
| Agency.contactPhone | string | Số điện thoại liên hệ (Định dạng: +84) | "+84987600001" |
| Agency.apiAccount | string | Tài khoản API | "..." |
| Agency.apiPassword | string | Mật khẩu API | "..." |
| Agency.apiToken | string | Token API | "..." |
| Agency.address | string | Địa chỉ | "123 Đường ABC, Quận XYZ, TP.HCM" |
| Agency.notes | string | Ghi chú | "Agency mới tạo" |
| Agency.agencyType | string | Loại agency. Giá trị hợp lệ: F1, F10 | "F10" |
| Agency.firstName | string | Họ | "Nguyễn" |
| Agency.lastName | string | Tên | "Văn A" |
| Agency.isActive | boolean | Trạng thái hoạt động | true |
| Agency.tier | string | Cấp độ agency. Giá trị hợp lệ: basic, standard, premium, enterprise | "premium" |
| Agency.defaultLanguage | string | Ngôn ngữ mặc định | "VI" |
| Agency.defaultCurrency | string | Tiền tệ mặc định | "VND" |
| Agency.subscriptionId | string | ID subscription hiện tại | null |
| Agency.balenceAmount | number | Số dư agency | 10000 |
| Agency.balenceLimit | number | Giới hạn số dư agency | 0 |
| Agency.industry | string | Ngành nghề | "Travel" |
| Agency.agencyCredit | string | Tín dụng agency | "limit" |
| Agency.parentAgencyId | string | ID của agency cha | "ca5b18b8-fa5d-485f-a615-984ee0d4df89" |
| Agency.createdAt | string | Ngày tạo | "2025-10-16T02:29:08.320Z" |
| Agency.updatedAt | string | Ngày cập nhật | "2025-10-16T02:29:08.322Z" |
| Credentials.apiAccount | string | API Account | "..." |
| Credentials.apiPassword | string | API Password | "..." |
| Credentials.apiToken | string | API Token | "..." |