مستندات وب سرویس

متد GetLocationList

Download Markdown for LLM

این متد فهرست کامل گزینه‌های مکان (Location) قابل انتخاب در فرم جستجوی پرواز را برمی‌گرداند. خروجی شامل گزینه‌های پیش‌فرض (همه‌ی موارد، داخل/خارج عراق، داخل/خارج ایران) به‌علاوه لیست کامل فرودگاه‌های فعال سیستم است.

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

نکته مهم در خصوص فیلد Type فیلد Type هر آیتم، نوع آن گزینه مکان را مشخص می‌کند:

  • all: گزینه «همه‌ی موارد» که برای جستجوی بدون محدودیت مکانی استفاده می‌شود.
  • country: گزینه‌های «داخل کشور» (مثلاً داخل عراق یا داخل ایران).
  • not_country: گزینه‌های «خارج از کشور» (مثلاً خارج از عراق یا خارج از ایران).
  • airport: گزینه‌های فرودگاه مشخص.

در صورتی که کاربر یکی از گزینه‌های country یا not_country را انتخاب کرد، باید در درخواست جستجوی پرواز، مقدار فیلد Value (کد کشور) را ارسال کنید. در صورت انتخاب airport، کد IATA فرودگاه را ارسال کنید.


API Endpoint

POST https://{SupplierWebsiteUrl}/api/B2M/Bot/Flight/Federated/Location/V1

Request Parameters

  • UserName

    string

    [conditional-required]

    نام کاربری

    در صورت استفاده از روش Username/Password Authentication ارسال این فیلد الزامی است.

  • Password

    string

    [conditional-required]

    رمز عبور به صورت MD5 شده

    در صورت استفاده از روش Username/Password Authentication ارسال این فیلد الزامی است.

  • AccessToken

    string

    [conditional-required]

    توکن احراز هویت دریافت‌شده از طریق Single Sign-On (SSO).

    در صورت استفاده از روش Token-based Authentication این فیلد را ارسال کنید. در این حالت نیازی به ارسال UserName و Password نیست.

    برای آشنایی با روش‌های احراز هویت و نحوه انتخاب و استفاده از هر روش، به مستندات Authentication مراجعه کنید.


Sample Request

curl -X POST https://SepehrApiTest.ir/api/B2M/Bot/Flight/Federated/Location/V1 \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "Accept: application/json" \
  -H "Accept-Encoding: gzip, deflate" \
  -d '{
  "UserName": "sample-head-office-user",
  "Password": "25f9e794323b453885f5181f1b624d0b"
}'

Response Parameters

  • LocationList

    List(Location)

    فهرست گزینه‌های مکان قابل انتخاب در فرم جستجوی پرواز.

    این لیست به ترتیب شامل موارد زیر است:

    1. گزینه «همه‌ی موارد» (Type = all)
    2. گزینه «فرودگاه‌های عراق» (Type = country, Value = IQ)
    3. گزینه «فرودگاه‌های خارج از عراق» (Type = not_country, Value = IQ)
    4. گزینه «فرودگاه‌های ایران» (Type = country, Value = IR)
    5. گزینه «فرودگاه‌های خارج از ایران» (Type = not_country, Value = IR)
    6. لیست کامل فرودگاه‌های فعال (Type = airport)

    + نمایش ویژگی‌های زیرمجموعه

    • LocationList.Type

      string

      نوع گزینه مکان. یکی از مقادیر زیر:

      • all: همه‌ی موارد (جستجوی بدون محدودیت مکانی)
      • country: داخل کشور مشخص‌شده در فیلد Value
      • not_country: خارج از کشور مشخص‌شده در فیلد Value
      • airport: فرودگاه مشخص

    • LocationList.Value

      string

      مقدار گزینه مکان.

      • برای Type = all: مقدار *
      • برای Type = country یا not_country: کد ISO کشور (مثلاً IQ برای عراق، IR برای ایران)
      • برای Type = airport: کد IATA فرودگاه (مثلاً BSH برای بصره، THR برای تهران)

    • LocationList.LabelList

      List(Label)

      فهرست برچسب‌های چندزبانه گزینه مکان.

      برای هر گزینه، سه برچسب به زبان‌های انگلیسی (en-US)، عربی (ar-IQ) و فارسی (fa-IR) ارسال می‌شود.

      + نمایش ویژگی‌های زیرمجموعه

      • LocationList.LabelList.Culture

        string

        زبان برچسب. یکی از مقادیر:

        • en-US (انگلیسی)
        • ar-IQ (عربی)
        • fa-IR (فارسی)

      • LocationList.LabelList.Value

        string

        متن برچسب به زبانِ مشخص‌شده در فیلد Culture.


Sample Response

{
  "LocationList": [
    {
      "Type": "all",
      "Value": "*",
      "LabelList": [
        { "Culture": "en-US", "Value": "All" },
        { "Culture": "ar-IQ", "Value": "کل الموارد" },
        { "Culture": "fa-IR", "Value": "همه‌ی موارد" }
      ]
    },
    {
      "Type": "country",
      "Value": "IQ",
      "LabelList": [
        { "Culture": "en-US", "Value": "Airports in Iraq" },
        { "Culture": "ar-IQ", "Value": "مطارات العراق" },
        { "Culture": "fa-IR", "Value": "فرودگاه های عراق" }
      ]
    },
    {
      "Type": "not_country",
      "Value": "IQ",
      "LabelList": [
        { "Culture": "en-US", "Value": "Airports outside Iraq" },
        { "Culture": "ar-IQ", "Value": "المطارات خارج العراق" },
        { "Culture": "fa-IR", "Value": "فرودگاه‌های خارج از عراق" }
      ]
    },
    {
      "Type": "country",
      "Value": "IR",
      "LabelList": [
        { "Culture": "en-US", "Value": "Airports in Iran" },
        { "Culture": "ar-IQ", "Value": "مطارات إيران" },
        { "Culture": "fa-IR", "Value": "فرودگاه‌های ایران" }
      ]
    },
    {
      "Type": "not_country",
      "Value": "IR",
      "LabelList": [
        { "Culture": "en-US", "Value": "Airports outside Iran" },
        { "Culture": "ar-IQ", "Value": "المطارات خارج إيران" },
        { "Culture": "fa-IR", "Value": "فرودگاه‌های خارج از ایران" }
      ]
    },
    {
      "Type": "airport",
      "Value": "KIH",
      "LabelList": [
        { "Culture": "en-US", "Value": "Kish" },
        { "Culture": "ar-IQ", "Value": "کيش" },
        { "Culture": "fa-IR", "Value": "کيش" }
      ]
    },
    {
      "Type": "airport",
      "Value": "MHD",
      "LabelList": [
        { "Culture": "en-US", "Value": "Mashhad" },
        { "Culture": "ar-IQ", "Value": "مشهد" },
        { "Culture": "fa-IR", "Value": "مشهد" }
      ]
    },
    {
      "Type": "airport",
      "Value": "THR",
      "LabelList": [
        { "Culture": "en-US", "Value": "Tehran Mehrabad" },
        { "Culture": "ar-IQ", "Value": "طهران مهرآباد" },
        { "Culture": "fa-IR", "Value": "تهران مهرآباد" }
      ]
    },
    {
      "Type": "airport",
      "Value": "IST",
      "LabelList": [
        { "Culture": "en-US", "Value": "Istanbul New Airport" },
        { "Culture": "ar-IQ", "Value": "اسطنبول مطار الجديد" },
        { "Culture": "fa-IR", "Value": "استانبول فرودگاه جديد" }
      ]
    },
    {
      "Type": "airport",
      "Value": "IKA",
      "LabelList": [
        { "Culture": "en-US", "Value": "Tehran Imam Khomeini" },
        { "Culture": "ar-IQ", "Value": "طهران الإمام الخميني" },
        { "Culture": "fa-IR", "Value": "تهران امام خميني" }
      ]
    },
    {
      "Type": "airport",
      "Value": "AWZ",
      "LabelList": [
        { "Culture": "en-US", "Value": "Ahvaz" },
        { "Culture": "ar-IQ", "Value": "الأهواز" },
        { "Culture": "fa-IR", "Value": "اهواز" }
      ]
    },
    {
      "Type": "airport",
      "Value": "BSR",
      "LabelList": [
        { "Culture": "en-US", "Value": "Basreh" },
        { "Culture": "ar-IQ", "Value": "البصره" },
        { "Culture": "fa-IR", "Value": "بصره" }
      ]
    },
    {
      "Type": "airport",
      "Value": "DXB",
      "LabelList": [
        { "Culture": "en-US", "Value": "Dubai" },
        { "Culture": "ar-IQ", "Value": "دبي" },
        { "Culture": "fa-IR", "Value": "دبي" }
      ]
    },
    {
      "Type": "airport",
      "Value": "EBL",
      "LabelList": [
        { "Culture": "en-US", "Value": "Erbil" },
        { "Culture": "ar-IQ", "Value": "اربيل" },
        { "Culture": "fa-IR", "Value": "اربيل" }
      ]
    },
    {
      "Type": "airport",
      "Value": "BGW",
      "LabelList": [
        { "Culture": "en-US", "Value": "Baghdad" },
        { "Culture": "ar-IQ", "Value": "بغداد" },
        { "Culture": "fa-IR", "Value": "بغداد" }
      ]
    }
    // ... بیشتر فرودگاه‌ها
  ]
}