Update Agency F10
# 1. Tổng quan
- Action URL:
/api/vi/agencies - Đặc tả chi tiết: Swagger Link (opens new window)
- Mô tả:
- Cho phép F1 cập nhật agency của mình và các agency F10 con.
- F10 chỉ được cập nhật chính mình.
# 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 từ hệ thống.
# 3. Parameters
# Bảng mô tả Parameters
| Thuộc tính | Bắt buộc | Kiểu dữ liệu | Mô tả |
|---|---|---|---|
ID | Có | String | ID của agency cần cập nhật |
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. Request Body
# 4.1 Ví dụ Request Body
{
"companyName": "String",
"contactEmail": "String",
"contactPhone": "String",
"address": "String",
"notes": "String",
"firstName": "String",
"lastName": "String"
}
# 4.2 Bảng mô tả Request Body
| Thuộc tính | Bắt buộc | Kiểu dữ liệu | Mô tả | Ví dụ |
|---|---|---|---|---|
companyName | Có | String | Tên công ty | Agency XYZ Updated |
contactEmail | Có | String | Email liên hệ | contact@agencyxyz.com |
contactPhone | Có | String | Số điện thoại liên hệ (+84 nếu áp dụng) | 0987654321 |
address | Có | String | Địa chỉ | 123 Đường ABC, Quận XYZ, TP.HCM |
notes | Có | String | Ghi chú | Agency đã cập nhật |
firstName | Có | String | Họ | Nguyễn |
lastName | Có | String | Tên | Văn A |
# 5. Responses
# 5.1 Ví dụ Responses
{
"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": "Nzc3ZjdkOTZlYWE1MmVkZTE0MjdiYmRmOWM4MjhlODg6OTJiOTc0NTVkZTI0M2E2MTY1Yzk3NzA1YzdhYjYyNTQ=",
"apiPassword": "YTk4Y2EyNzdjOGY0ODBlODI0YzZjZWIyYjcxM2YyNTM6ZjNiYWVmNTI0OWY1ZDc4Y2Q2NmNhMjgwNTk4MWMzMTM0NGJjOGIyNmM4MmRkNmNiMmMyZGJkYTMyZDdmZTNkNw==",
"apiToken": "NTUxMGQwZjAzMzVmNjA5YTVlYTRjZjYyYTc3YmM3ZjY6NjFlMTE5Y2I3OTBlYjUyYTU1YThhMDEwNDAxYmQ4NTgyNDgxNTMyMzJkM2NiYjZkMjNiZjllMzAwMjAyNWNhZTAxMDcwYmY1ZWFlZWRiMGI3ZmU2ZDc2NTc3Zjc4MzAwOTZmZWZjYWRkNjI0OTNhNTdhYzY5ZTI2YjA1YTgxYzQ3NzExYmViY2EwZTYyYTg1ZGYzNmFlYmRhM2ZhMjdhYQ==",
"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": "Nzc3ZjdkOTZlYWE1MmVkZTE0MjdiYmRmOWM4MjhlODg6OTJiOTc0NTVkZTI0M2E2MTY1Yzk3NzA1YzdhYjYyNTQ=",
"apiPassword": "YTk4Y2EyNzdjOGY0ODBlODI0YzZjZWIyYjcxM2YyNTM6ZjNiYWVmNTI0OWY1ZDc4Y2Q2NmNhMjgwNTk4MWMzMTM0NGJjOGIyNmM4MmRkNmNiMmMyZGJkYTMyZDdmZTNkNw==",
"apiToken": "NTUxMGQwZjAzMzVmNjA5YTVlYTRjZjYyYTc3YmM3ZjY6NjFlMTE5Y2I3OTBlYjUyYTU1YThhMDEwNDAxYmQ4NTgyNDgxNTMyMzJkM2NiYjZkMjNiZjllMzAwMjAyNWNhZTAxMDcwYmY1ZWFlZWRiMGI3ZmU2ZDc2NTc3Zjc4MzAwOTZmZWZjYWRkNjI0OTNhNTdhYzY5ZTI2YjA1YTgxYzQ3NzExYmViY2EwZTYyYTg1ZGYzNmFlYmRhM2ZhMjdhYQ=="
}
},
"Errors": null,
"RequestId": "req_1760581747622_uyg66pbvv",
"TotalDuration": 1017
}
# 5.2 Bảng mô tả Responses
| Thuộc tính | Kiểu dữ liệu | Mô tả | Ví dụ |
|---|---|---|---|
id* | string | ID của agency | 12345 |
companyName* | string | Tên công ty | Agency XYZ |
contactEmail* | string | Email liên hệ | contact@agencyxyz.com |
contactPhone* | string | Số điện thoại liên hệ (+84) | +84987654321 |
apiAccount* | string | Tài khoản API | api_account |
apiPassword* | string | Mật khẩu API | api_password |
apiToken* | string | Token API | api_token |
address* | string | Địa chỉ | 123 Đường ABC, Quận XYZ, TP.HCM |
notes* | string | Ghi chú | Agency mới tạo |
contactId* | string | ID liên hệ | 12345 |
agencyType* | string | Loại agency (F1, F10) | F1 |
firstName* | string | Họ | Nguyễn |
lastName* | string | Tên | Văn A |
isActive* | boolean | Trạng thái hoạt động | true |
tier* | string | Cấp độ agency (basic, standard, premium, enterprise) | basic |
defaultLanguage* | string | Ngôn ngữ mặc định | VI |
defaultCurrency* | string | Tiền tệ mặc định | VND |
subscriptionId | string | ID của subscription đang sử dụng | uuid-string |
balenceAmount | number | Số dư agency | 10000 |
balenceLimit | number | Giới hạn số dư | 0 |
industry | string | Ngành nghề | Travel |
agencyCredit | string | Tín dụng agency | limit |
parentAgencyId | string | ID của agency cha | 12345 |
subscription | object | Thông tin subscription đang dùng | { description: ... } |
avatarUrl | string | Ảnh đại diện agency | https://example.com/avatar.jpg |
coverUrl | string | Ảnh bìa agency | https://example.com/cover.jpg |
createdAt* | string (date-time) | Ngày tạo | 2023-01-01T00:00:00.000Z |
updatedAt* | string (date-time) | Ngày cập nhật | 2023-01-02T00:00:00.000Z |
# 5.3 Ví dụ Responses
{
"StatusCode": "String",
"Timestamp": "String",
"Path": "String",
"Message": "String",
"Data": {
"message": "String"
},
"Errors": "String",
"RequestId": "String",
"TotalDuration": "number"
}
# 5.4 Bảng mô tả Responses
| Thuộc tính | Kiểu dữ liệu | Mô tả | Ví dụ |
|---|---|---|---|
StatusCode | String | Mã trạng thái | 200: Cập nhật thành công400: Dữ liệu không hợp lệ403: Không có quyền cập nhật404: Không tìm thấy agency |
Timestamp | String | Thời gian xử lý | "2025-10-16T02:29:08Z" |
Path | String | Đường dẫn API | /api/v1/agencies |
Message | String | Thông báo phản hồi | "Cập nhật agency thành công" |
Errors | String | Mô tả lỗi nếu có | "Invalid token" |
RequestId | String | Mã định danh request | "req_1760581747622_uyg66pbvv" |
TotalDuration | Number | Thời gian xử lý (ms) | 1017 |