#P1597
POST /v2/accounting/connections/list
Route Info
| Method | Endpoint | Controller |
| POST | /v2/accounting/connections/list | AccountingController@listConnection |
شرح عملکرد (Functionality)
این مسیر برای دریافت لیست Connections فعال استفاده میشود. امکان اعمال دو نوع فیلتر ورودی وجود دارد:
- فیلتر بر اساس مقدار
serial(فیلدsearch) - فیلتر بر اساس شناسه
object(فیلدid)
پس از اعمال فیلترها، فقط رکوردهایی با status = 1 بازگردانده میشوند. در مرحله بعد، برای هر Connection یک ساختار خروجی شامل id، شماره سریال محاسبهشده و عنوان تولید میشود.
شماره سریال نهایی با افزودن 1000 به مقدار اصلی تولید میشود.
پارامترهای ورودی (JSON Body)
همه پارامترها اختیاری هستند.
{
"search": "123", // اختیاری - جستجو بر اساس serial
"id": "45" // اختیاری - فیلتر بر اساس object id
}
خروجی (Response)
موفق (Success)
{
"status": true,
"time": 1718450000,
"data": [
{
"id": 12,
"serial": 1123,
"title": "ارتباط 1123"
},
...
]
}
خطاها (Errors)
این مسیر مدیریت خطای اختصاصی ندارد.
- در صورت عدم وجود هیچ Connection، مقدار
dataآرایه خالی خواهد بود. - در صورت بروز خطای دیتابیس، پاسخ خطای عمومی سرور (5xx) برگردانده میشود.