لیست گروه‌ها (Get Role)

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

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

آدرس: /api/v2/wallet-restriction/role?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/role?page=1&size=20' \
--header 'Authorization:  <your_authorization_token>' \
--header 'Accept: application/json'

پاسخ موفق

{
    "message": "Success",
    "data": [
        {
            "role": {
                "id": 37716,
                "title": "تعداد 3",
                "created_at": "2023-07-22T13:22:35+03:30",
                "updated_at": "2023-07-22T13:22:35+03:30"
            },
            "restrictions": [
                {
                    "id": 34797,
                    "user_id": 1443,
                    "type": 3,
                    "description": "تعداد 3",
                    "created_at": "2023-07-22T13:23:16+03:30",
                    "updated_at": "2023-07-22T13:23:16+03:30",
                    "time": {
                        "id": 19,
                        "corporate_restriction_id": 34797,
                        "start_date": "1402/04/31",
                        "start_date_enabled": true,
                        "end_date": "1402/05/20",
                        "end_date_enabled": true,
                        "ride_limit": 1,
                        "created_at": "2023-07-22T13:23:16+03:30",
                        "updated_at": "2023-07-22T13:23:16+03:30"
                    }
                },
                {
                    "id": 34793,
                    "user_id": 1443,
                    "type": 2,
                    "description": "بودجه 2",
                    "created_at": "2023-07-22T13:15:45+03:30",
                    "updated_at": "2023-07-22T14:29:28+03:30",
                    "budget": {
                        "id": 30391,
                        "corporate_restriction_id": 34793,
                        "type": 4,
                        "amount": 10000000,
                        "created_at": "2023-07-22T13:15:45+03:30",
                        "updated_at": "2024-07-02T13:27:51+03:30"
                    }
                },
                {
                    "id": 34816,
                    "user_id": 1443,
                    "type": 1,
                    "description": "تستی من ",
                    "created_at": "2023-07-18T12:49:59+03:30",
                    "updated_at": "2023-07-18T12:49:59+03:30",
                    "locations": [
                        {
                            "id": 14313,
                            "corporate_restriction_id": 34816,
                            "type": 2,
                            "location_geohash": "",
                            "location_title": "کرج",
                            "city_id": 2,
                            "created_at": "2023-07-29T13:29:45+03:30",
                            "updated_at": "2023-07-29T13:29:45+03:30"
                        }
                    ]
                },
                {
                    "id": 35019,
                    "user_id": 1443,
                    "type": 4,
                    "description": "من همیشه عجله دارم",
                    "created_at": "2024-11-04T11:44:13+03:30",
                    "updated_at": "2024-11-04T11:44:13+03:30"
                }
            ]
        }
    ],
    "status": "int",
    "meta": {
        "next_page": "boolean"
    }
}

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

ساختار محدودیت‌ها (restrictions)

فیلد	نوع داده	توضیحات
id	number	شناسه محدودیت
user_id	number	شناسه کاربر مرتبط با محدودیت
type	number	نوع محدودیت
description	string	توضیحات محدودیت
created_at	string	تاریخ ایجاد محدودیت (فرمت ISO 8601)
updated_at	string	تاریخ آخرین به‌روزرسانی محدودیت
budget	object	اطلاعات مربوط به محدودیت بودجه (اختیاری)

ساختار بودجه (budget)

فیلد	نوع داده	توضیحات
id	number	شناسه بودجه
corporate_restriction_id	number	شناسه محدودیت مرتبط با این بودجه
type	number	نوع بودجه
amount	number	مقدار بودجه (به ریال)
created_at	string	تاریخ ایجاد بودجه (فرمت ISO 8601)
updated_at	string	تاریخ آخرین به‌روزرسانی بودجه

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

مقدار	نوع محدودیت
`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 داشته باشد که به معنای عدم به‌روزرسانی داده است.

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

احراز هویت​

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

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

پاسخ موفق​

ساختار محدودیت‌ها (restrictions)​

ساختار بودجه (budget)​

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

خطاها​

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

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

احراز هویت

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

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

پاسخ موفق

ساختار محدودیت‌ها (restrictions)

ساختار بودجه (budget)

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

خطاها

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