مشاهده وضعیت سفر (Status)

وضعیت هر سفر با استفاده از این API و بر اساس شناسه (ID) آن نمایش داده می‌شود.

---

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

• آدرس: /api/v3/ride/{ride_id}/status
• متد: GET
• نوع محتوا: application/json
• احراز هویت: نیازمند token

---

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

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

فیلد	نوع داده	ضروری	توضیحات
ride_id	string	بله	شناسه سفر که وضعیت آن بررسی می‌شود

---

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

curl --location 'https://corporate.snapp.site/api/v3/ride/{ride_id}/status' \
--header 'Authorization: <your_authorization_token>'

---

پاسخ موفق

{
    "message": "Success",
    "data": {
        "ride_status": 1
    },
    "status": 200
}

فیلد	نوع داده	توضیحات
message	string	پیام موفقیت‌آمیز بودن درخواست
data	object	شامل وضعیت سفر
ride_status	integer	وضعیت فعلی سفر
status	integer	کد وضعیت پاسخ (200 برای موفقیت)

---

کدهای وضعیت و خطاها

کد وضعیت	توضیحات
200	درخواست موفق بود
400	درخواست نامعتبر
401	نیاز به احراز هویت
404	سفر پیدا نشد
500	خطای داخلی سرور

---

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

• مقدار ride_status نشان‌دهنده وضعیت فعلی سفر است. مقدار عددی آن ممکن است نشان‌دهنده مراحل مختلف سفر باشد.

• مقدارهای ride_status در پاسخ API

مقدار ride_status در پاسخ API نشان‌دهنده وضعیت فعلی سفر است. در جدول زیر توضیح هر مقدار آورده شده است:

مقدار	وضعیت سفر	توضیحات
1	Started	سفر شروع شده است.
2	Accepted	سفر توسط راننده پذیرفته شده است.
3	Arrived	راننده به محل رسیدن مسافر رسیده است.
4	Boarded	مسافر سوار خودرو شده است.
5	Finished	سفر به پایان رسیده است.
6	CancelledByCustomer	سفر توسط مسافر لغو شده است.
7	CancelledByDriver	سفر توسط راننده لغو شده است.
8	CancelledByBackoffice	سفر توسط تیم پشتیبانی لغو شده است.
9	NobodyAccepted	هیچ راننده‌ای درخواست سفر را قبول نکرده است.
10	CouldNotCalculatePrice	قیمت سفر قابل محاسبه نبود.
11	CancelledByCustomerDueNewRideRequest	مسافر به دلیل درخواست سفر جدید، این سفر را لغو کرده است.
12	DriverRequestedFareReview	راننده درخواست بررسی کرایه داده است.
13	CancelFinishedRide	سفر تکمیل شده اما لغو شده است.
14	FinishCancelledRide	سفر لغو شده اما به پایان رسیده است.
15	FareReviewDone	بررسی کرایه انجام شده است.
16	ArrivedFirstDestination	راننده به اولین مقصد رسیده است.
17	ArrivedSecondDestination	راننده به دومین مقصد رسیده است.
18	UpdatingRideOptions	در حال به‌روزرسانی گزینه‌های سفر.
19	CancelledWithFee	سفر لغو شده اما شامل هزینه لغو است.
20	Finishing	سفر در حال اتمام است.
21	Settled	تسویه‌حساب انجام شده است.
22	FareReviewCancelled	بررسی کرایه لغو شده است.

این مقادیر هنگام درخواست وضعیت سفر (/api/v3/ride/{ride_id}/status) در پاسخ API دریافت خواهند شد.

---