پرش به مطلب اصلی

گزارش بودجه کارمندان (Budget Restriction)

این گزارش اطلاعاتی درباره بودجه کارمندان در هر پنل سازمانی ارائه می‌دهد، از جمله میزان بودجه باقی‌مانده هر کاربر. همچنین امکان جست‌وجو بر اساس نام و شماره موبایل کارمند نیز وجود دارد.


اطلاعات عمومی

  • آدرس:

    /api/v2/wallet-restriction/budget-restriction/list
  • متد: GET

  • نوع محتوا: application/json

  • احراز هویت: نیازمند توکن


احراز هویت

  • این درخواست نیاز به ارسال توکن در هدر Authorization دارد.

پارامترهای کوئری

پارامترنوع دادهضروریتوضیحات
namestringخیرنام مسافر
cellphonestringخیرشماره تلفن همراه مسافر

هدرهای درخواست

هدرمقدارتوضیحات
Authorizationtokenتوکن احراز هویت کاربر
Acceptapplication/jsonنوع داده خروجی

نمونه درخواست

curl --location --request GET '<base_url>/api/v2/wallet-restriction/budget-restriction/list?name=John&cellphone=09123456789' \
--header 'Authorization: <your_authorization_token>' \
--header 'Accept: application/json'

پاسخ موفق

{
"message": "User budget restrictions retrieved successfully",
"status": 200,
"data": [
{
"restriction_id": 1,
"passenger_id": 12345,
"amount": 500000,
"name": "John Doe",
"cellphone": "09123456789",
"type": 2
},
{
"restriction_id": 2,
"passenger_id": 67890,
"amount": 300000,
"name": "Jane Smith",
"cellphone": "09234567890",
"type": 1
}
]
}

توضیحات فیلدهای پاسخ

فیلدنوع دادهتوضیحات
messagestringپیام موفقیت‌آمیز دریافت داده‌ها
statusintegerوضعیت پاسخ
dataarrayلیست مسافرانی که محدودیت بودجه دارند
restriction_idint64شناسه محدودیت بودجه
passenger_idint64شناسه مسافر
amountint64مبلغ محدودیت بودجه (ریال)
namestringنام مسافر
cellphonestringشماره تلفن همراه مسافر
typeintنوع محدودیت بودجه

خطاها

کد وضعیتتوضیحات
400درخواست نامعتبر
401نیاز به احراز هویت
403دسترسی غیرمجاز
500خطای داخلی سرور

توضیحات تکمیلی

  • اگر مقدار name یا cellphone ارسال نشود، تمام کاربران دارای محدودیت بودجه برگردانده می‌شوند.
  • type نشان‌دهنده نوع محدودیت بودجه است.