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

متد Get Fare List

Download Markdown for LLM

این متد برای دریافت لیست Fareهای موجود در سیستم استفاده می‌گردد.


API Endpoint

POST https://{SupplierWebsiteUrl}/api/B2M/Bot/Flight/Charter/FlightManagement/Fare/GetList/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/Charter/FlightManagement/Fare/GetList/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

  • fareList

    Array of fares

    لیست فیرها

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

    • fareList.id

      number

      شناسه منحصر به فرد یک fare

    • fareList.name

      string

      نام این fare

    • fareList.cabin

      string

      کابین این fare. مانند Economy ، Business و…

    • fareList.bookingCode

      string

      booking code این fare

    • fareList.price_Adult_OneWay

      string

      مبلغ یک بزرگسال برای رزرو یکطرفه

    • fareList.price_Child_OneWay

      string

      مبلغ یک کودک برای رزرو یکطرفه

    • fareList.price_Infant_OneWay

      string

      مبلغ یک نوزاد برای رزرو یکطرفه

    • fareList.price_Adult_RoundTrip_FromOrigin

      string

      مبلغ پرواز رفت برای یک بزرگسال در یک رزرو رفت و برگشتی (درصورتی مقدار این فیلد روی یک رزرو رفت و برگشتی اعمال می‌شود که این fare پیشرفته باشد)

    • fareList.price_Child_RoundTrip_FromOrigin

      string

      مبلغ پرواز رفت برای یک کودک در یک رزرو رفت و برگشتی (درصورتی مقدار این فیلد روی یک رزرو رفت و برگشتی اعمال می‌شود که این fare پیشرفته باشد)

    • fareList.price_Infant_RoundTrip_FromOrigin

      string

      مبلغ پرواز رفت برای یک نوزاد در یک رزرو رفت و برگشتی (درصورتی مقدار این فیلد روی یک رزرو رفت و برگشتی اعمال می‌شود که این fare پیشرفته باشد)

    • fareList.price_Adult_RoundTrip_FromDestination

      string

      مبلغ پرواز برگشت برای یک بزرگسال در یک رزرو رفت و برگشتی (درصورتی مقدار این فیلد روی یک رزرو رفت و برگشتی اعمال می‌شود که این fare پیشرفته باشد)

    • fareList.price_Child_RoundTrip_FromDestination

      string

      مبلغ پرواز برگشت برای یک کودک در یک رزرو رفت و برگشتی (درصورتی مقدار این فیلد روی یک رزرو رفت و برگشتی اعمال می‌شود که این fare پیشرفته باشد)

    • fareList.price_Infant_RoundTrip_FromDestination

      string

      مبلغ پرواز برگشت برای یک نوزاد در یک رزرو رفت و برگشتی (درصورتی مقدار این فیلد روی یک رزرو رفت و برگشتی اعمال می‌شود که این fare پیشرفته باشد)

    • fareList.currencyCode

      string

      کد سه حرفی ارز این fare. مانند IRR ، USD و…

    • fareList.minimumStayInDays

      number

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

    • fareList.maximumStayInDays

      number

      حداکثر مدت اقامت. یعنی در رزروهای رفت و برگشتی این فیلد مشخص می‌کند که بین پرواز رفت با برگشت حداکثر چند روز باید فاصله باشد (درصورتی مقدار این فیلد روی یک رزرو رفت و برگشتی اعمال می‌شود که این fare پیشرفته باشد)

    • fareList.isAdvancedFare

      bool

      در صورت true بودن یعنی این fare پیشرفته است و در غیر این صورت fare ساده است.


Sample Response

{
    "fareList": [
        {
            "id": 21,
            "name": "YYYY3",
            "cabin": "Economy",
            "bookingCode": "YD",
            "price_Adult_OneWay": "2,000,000",
            "price_Child_OneWay": "1,800,000",
            "price_Infant_OneWay": "200,000",
            "price_Adult_RoundTrip_FromOrigin": "0",
            "price_Child_RoundTrip_FromOrigin": "0",
            "price_Infant_RoundTrip_FromOrigin": "0",
            "price_Adult_RoundTrip_FromDestination": "0",
            "price_Child_RoundTrip_FromDestination": "0",
            "price_Infant_RoundTrip_FromDestination": "0",
            "currencyCode": "IRR",
            "minimumStayInDays": null,
            "maximumStayInDays": null,
            "isAdvancedFare": false
        }
    ]
}