قالب لینک جستجو

برای لینک‌های جستجو، شرکا یک URL پایه مخصوص جستجو ارائه می‌دهند (به پیکربندی شرکا مراجعه کنید). ما از پارامترهای پرس‌وجوی زیر پشتیبانی می‌کنیم:

نام فیلد جزئیات
from_stop_id

(قابل تکرار) شناسه‌ی ایستگاه‌هایی که سفر ممکن است از آنها شروع شود.

مقادیر stop_id های ایستگاه‌های مبدا.

to_stop_id

(قابل تکرار) شناسه‌ی ایستگاه‌هایی که سفر ممکن است در آنها پایان یابد.

مقادیر stop_id های ایستگاه‌های مقصد.

search_date

(تاریخ) روز سرویس سفر.

این فیلد شامل تاریخ با رشته‌ی قالب‌بندی زیر است:

YYYYMMDD

lang

(IETF BCP 47، اختیاری) فیلدی که برای نشان دادن زبان انتخاب شده برای سایت رزرو استفاده می‌شود.

مقدار این فیلد با IETF BCP 47 مطابقت دارد، مثلاً en-US .

اگر زبان انتخاب شده در دسترس نباشد یا فیلد ارسال نشود، سایت رزرو باید از یک زبان جایگزین استفاده کند.

cur

(ISO 4217، اختیاری) فیلدی که برای نشان دادن واحد پولی که قیمت‌ها باید با آن نمایش داده شوند، استفاده می‌شود.

مقدار این فیلد مطابق با استاندارد ISO 4217 است، مثلاً USD .

اگر ارز انتخاب شده نمایش داده نشود یا فیلد ارسال نشود، سایت رزرو باید از یک ارز جایگزین استفاده کند.

utm_source

(رشته‌ای، اختیاری) فیلدی که برای نشان دادن سایت سطح بالایی که ترافیک را ارسال کرده است، استفاده می‌شود.

مقادیر ممکن عبارتند از google_search و google_maps .

تمام پارامترهای تکرارپذیر به صورت یک آرایه JSON مشخص می‌شوند. برای from_stop_id و to_stop_id ، مقادیر چندگانه نشان‌دهنده چندین ایستگاه در محل‌های مبدا و مقصد هستند.

مثال‌ها

در این مثال، کاربر درخواست قطار از locality1 به locality2 را می‌دهد:

  • locality1 به ایستگاه‌هایی با stop_id f1 و f2 نگاشت می‌شود.
  • locality2 به ایستگاه‌هایی با stop_id های t1 و t2 نگاشت می‌شود.
  • تاریخ سرویس 20190716 است.

برای این مثال، آدرس پایه https://example.com است.

با توجه به تمام این اطلاعات، از مقادیر زیر برای پارامترها استفاده کنید:

نام فیلد جزئیات
from_stop_id ["f1" ، "f2"]
to_stop_id ["t1" ، "t2"]
service_date 20190716

در زیر URI نهایی پس از کدگذاری آمده است:

https://example.com?from_stop_id=%5B%22f1%22,%22f2%22%5D&to_stop_id=%5B%22t1%22,%22t2%22%5D&search_date=20190716

در صفحه فرود، کاربر قادر خواهد بود برنامه‌های سفری را که از ایستگاه‌های f1 و f2 در 20190716 حرکت می‌کنند و به t1 و t2 می‌رسند، مشاهده کند. همه ترکیب‌های ایستگاه پشتیبانی می‌شوند:

  • از f1 تا t1
  • از f1 تا t2
  • از f2 تا t1
  • از f2 تا t2