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

تغییر دادن گزینه های سفر (Upate Price)

برای بروزرسانی گزینه های سفر استفاده می‌شود.

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

  • آدرس:

    <base_url>/api/v1/ride/{hri}/update/ride

  • متد: POST

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

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

احراز هویت​

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

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

هدرمقدارتوضیحات
AuthorizationBearer <token>توکن احراز هویت کاربر
Content-Typeapplication/jsonنوع محتوا

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

فیلدنوع دادهضروریتوضیحات
extra_destination_latfloatخیرعرض جغرافیایی مقصد اضافی
extra_destination_lngfloatخیرطول جغرافیایی مقصد اضافی
round_tripbooleanخیرمشخص می‌کند که سفر رفت و برگشت است یا خیر
waitingintegerخیرمدت‌زمان انتظار (برحسب دقیقه)
by_creditbooleanخیرپرداخت از طریق اعتبار

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

curl --location --request POST '<base_url>/api/v1/ride/ABC123/update/ride' \
--header 'Authorization: Bearer your_token_here' \
--header 'Content-Type: application/json' \
--data-raw '{
    "extra_destination_lat": 35.790845919867,
    "extra_destination_lng": 52.403267927447,
    "round_trip": false,
    "waiting": null,
    "by_credit": false
}'

پاسخ موفق​

{
  "message": "Ride options updated successfully",
  "status": 200,
  "data": {
    "extra_destination_lat": 35.790845919867,
    "extra_destination_lng": 52.403267927447,
    "round_trip": false,
    "waiting": null,
    "by_credit": false,
    "updated_price": 120000
  }
}

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

فیلدنوع دادهتوضیحات
messagestringپیام موفقیت‌آمیز بروزرسانی
statusintegerوضعیت پاسخ
dataobjectاطلاعات بروزرسانی‌شده سفر
data.updated_priceintegerقیمت جدید سفر بعد از بروزرسانی

خطاها​

کد وضعیتتوضیحات
400درخواست نامعتبر (ورودی‌های اشتباه)
401نیاز به احراز هویت
403دسترسی غیرمجاز
404سفر موردنظر یافت نشد
500خطای داخلی سرور

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

  • برای استفاده از این API سفر باید حتما در وضعیت قبول توسط راننده (StateStarted = 1) باشد.
  • مقدار waiting می‌تواند null باشد اگر گزینه‌ی انتظار فعال نشود.
  • اگر گزینه‌ی round_trip true باشد، سیستم هزینه‌ی برگشت را محاسبه خواهد کرد.