لیست محدودیت ها (Get Restriction)

لیست محدودیت ها را نمایش میدهد.

---

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

• آدرس: /api/v2/wallet-restriction/restriction/list?page={page}&size={size}
• متد: GET
• نوع محتوا: application/json
• احراز هویت: نیازمند token

---

احراز هویت

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

---

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

درخواست باید شامل پارامترهای زیر در URL باشد:

فیلد	نوع داده	ضروری	توضیحات
page	number	خیر	شماره صفحه برای دریافت نتایج محدودیت‌ها
size	number	خیر	تعداد آیتم‌ها در هر صفحه

---

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

curl --location 'https://corporate.snapp.site/api/v2/wallet-restriction/restriction/list?page=1&size=20' \
--header 'Authorization:  <your_authorization_token>' \
--header 'Accept: application/json'

---

پاسخ موفق

{
    "message": "Success",
    "data": [
        {
            "id": 0,
            "user_id": 0,
            "type": 2,
            "description": "string",
            "created_at": "2025-02-18T23:06:07+03:30",
            "updated_at": "0001-01-01T00:00:00Z"
        }
    ],
    "status": 200,
    "meta": {
        "next_page": true
    }
}

فیلد	نوع داده	توضیحات
message	string	پیام وضعیت درخواست
data	array	آرایه‌ای از محدودیت‌های کیف پول
id	number	شناسه محدودیت کیف پول
user_id	number	شناسه کاربر
type	number	نوع محدودیت
description	string	توضیحات محدودیت
created_at	string	تاریخ ایجاد محدودیت (فرمت ISO 8601)
updated_at	string	تاریخ آخرین به‌روزرسانی (در برخی موارد مقدار پیش‌فرض است)
status	number	وضعیت درخواست
meta	object	اطلاعات صفحه‌بندی
next_page	boolean	آیا صفحه بعدی وجود دارد یا خیر

---

مقادیر نوع محدودیت

مقدار	نوع محدودیت
1	محدودیت مکانی (LocationRestriction)
2	محدودیت بودجه (BudgetRestriction)
3	محدودیت زمانی (TimeRestriction)
4	محدودیت سفر عجله‌ای (RideInHurryRestriction)
5	محدودیت شهری (CityRestriction)
6	محدودیت شیفت زمانی (TimeShiftRestriction)

---

خطاها

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

---

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

• مقدار next_page در بخش meta مشخص می‌کند که آیا صفحه بعدی برای لیست محدودیت‌ها وجود دارد یا خیر.
• فیلد updated_at ممکن است مقدار 0001-01-01T00:00:00Z داشته باشد که به معنای عدم به‌روزرسانی داده است.