Delete Agency F10
# 1. Tổng quan
- Action URL:
/api/vi/agencies - Đặc tả chi tiết: Swagger Link (opens new window)
- Mô tả: Tính năng này cho phép xóa một agency theo ID.
# 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ả |
|---|---|---|---|
| ID | Có | String | ID của agency cần xóa |
| 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": "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
}
# 4.2 Bảng mô tả Response
| 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 (+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 |
| 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 | premium |
| defaultLanguage* | string | Ngôn ngữ mặc định | VI |
| defaultCurrency* | string | Tiền tệ mặc định | VND |
| subscriptionId | string | ID subscription đang 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 agency cha | 12345 |
| subscription | object | Thông tin subscription | { description: ... } |
| avatarUrl | string | URL ảnh đại diện | https://example.com/avatar.jpg (opens new window) |
| coverUrl | string | URL ảnh bìa | https://example.com/cover.jpg (opens new window) |
| createdAt* | string | Ngày tạo | 2023-01-01T00:00:00.000Z |
| updatedAt* | string | Ngày cập nhật | 2023-01-02T00:00:00.000Z |
{
"StatusCode": "String",
"Timestamp": "String",
"Path": "String",
"Message": "String",
"Data": {
"message": "String"
},
"Errors": "String",
"RequestId": "String",
"TotalDuration": 0
}
| Thuộc tính | Kiểu dữ liệu | Mô tả | Ví dụ |
|---|---|---|---|
| StatusCode | String | Tình trạng xóa agency | 200: thành công, 401: không có quyền, 404: không tìm thấy |
| Timestamp | String | Thời gian thực hiện request | 2025-10-16T02:29:08.320Z |
| Path | String | Đường dẫn API | /api/v1/agencies |
| Message | String | Tin nhắn thông báo | "Xóa agency thành công" |
| Data | Object | Thông tin phản hồi chi tiết | { "message": "Agency đã được xóa" } |
| Errors | String | Lỗi khi thực hiện xóa agency | null |
| RequestId | String | Mã định danh duy nhất của request | req_1760581747622_uyg66pbvv |
| TotalDuration | number | Thời gian xử lý request (ms) | 1017 |