مشاهده لیست کارمندان (Get: User Whitelist)
لیست کارمندان مجاز به استفاده از یک کد تخفیف را به صورت فایل ارائه می‌دهد.
اطلاعات عمومی
- آدرس:
/api/v2/purchased-voucher/{id}/user-whitelist/export - متد:
GET - نوع محتوا:
application/json - احراز هویت: نیازمند token
احراز هویت
- این درخواست نیاز به یک Authorization token دارد که باید در هدر ارسال شود.
پارامترهای درخواست
| نام | نوع | محل | الزامی | توضیحات |
|---|---|---|---|---|
id | int | path | ✅ بله | شناسه ووچر خریداری‌شده |
format | string | query | ✅ بله | فرمت فایل خروجی (مقدار قابل قبول: csv یا excel) |
نمونه درخواست cURL
curl -X GET "https://corporate.snapp.site/api/v2/purchased-voucher/5142/user-whitelist/export?format=csv" \
--header 'Authorization: <your_authorization_token>' \
-H "Accept: text/csv"
پاسخ‌ها
پاسخ موفق (200)
✅ فایل خروجی در قالب CSV یا Excel بازگردانده می‌شود.
| نام | نوع | توضیحات |
|---|---|---|
Content-Type | text/csv یا application/octet-stream | فرمت فایل خروجی مطابق با مقدار format |
خطاها
| کد وضعیت | نوع پاسخ | توضیحات |
|---|---|---|
400 | {object} | خطای درخواست نامعتبر |
500 | {object} | خطای داخلی سرور |