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

متد Get Refund Policy List

Download Markdown for LLM

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

کاربرد این متد صرفا جهت اطلاع از قوانین و میزان جریمه‌های کنسلی پرواز که در سیستم تعریف شده می‌باشد.

مقدار null در هر فیلدی به معنی همه‌ی موارد می‌باشد.


API Endpoint

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

  • policyList

    Array of policies

    لیست قوانین کنسلی پرواز

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

    • policyList.airline

      string

      کد یاتای ایرلاین

    • policyList.bookingCode

      string

      بوکینگ کد

    • policyList.origin

      string

      کد یاتای مبدا

    • policyList.destination

      string

      کد یاتای مقصد

    • policyList.flightFromDate

      string

      تاریخ اولین روز در بازه‌ی تاثیر با فرمت yyyy-MM-dd به صورت میلادی. تاریخ خروج پرواز با مقدار این فیلد و فیلد بعدی مطابقت داده می‌شود، به این صورت که اگر تاریخ خروج پرواز بین این دو تاریخ باشد این قانون برای پرواز مورد نظر اعمال خواهد شد

    • policyList.flightToDate

      string

      تاریخ آخرین روز در بازه‌ی تاثیر با فرمت yyyy-MM-dd به صورت میلادی. تاریخ خروج پرواز با مقدار این فیلد و فیلد قبلی مطابقت داده می‌شود، به این صورت که اگر تاریخ خروج پرواز بین این دو تاریخ باشد این قانون برای پرواز مورد نظر اعمال خواهد شد

    • policyList.penalty1_RemainingDaysUntilFlight

      number

      حداقل روزهای باقی مانده به پرواز در جریمه اول

    • policyList.penalty1_PenaltyPercentage

      number

      درصد جریمه در جریمه اول

    • policyList.penalty2_RemainingDaysUntilFlight

      number

      حداقل روزهای باقی مانده به پرواز در جریمه دوم

    • policyList.penalty2_PenaltyPercentage

      number

      درصد جریمه در جریمه دوم

    • policyList.penalty3_RemainingDaysUntilFlight

      number

      حداقل روزهای باقی مانده به پرواز در جریمه سوم

    • policyList.penalty3_PenaltyPercentage

      number

      درصد جریمه در جریمه سوم

    • policyList.nearFlight_RemainingMinutesUntilFlight

      number

      حداقل زمان باقی مانده به پرواز در جریمه نزدیک پرواز به دقیقه

    • policyList.nearFlight_PenaltyPercentage

      number

      درصد جریمه در جریمه نزدیک پرواز

    • policyList.noShow_PenaltyPercentage

      number

      درصد جریمه در جریمه no-show

    • policyList.penaltyBasedOnTimeElapsedSinceBooking_MinutesElapsedSinceBooking

      number

      حداکثر زمان گذشته از رزرو که جریمه penaltyBasedOnTimeElapsedSinceBooking_PenaltyPercentage موقع کنسلی اعمال خواهد شد به دقیقه

    • policyList.penaltyBasedOnTimeElapsedSinceBooking_RemainingHoursUntilFlight

      number

      حداقل زمان باقی به پرواز که جریمه penaltyBasedOnTimeElapsedSinceBooking_PenaltyPercentage موقع کنسلی اعمال خواهد شد به ساعت

    • policyList.penaltyBasedOnTimeElapsedSinceBooking_PenaltyPercentage

      number

      درصد جریمه penaltyBasedOnTimeElapsedSinceBooking


Sample Response

{
    "policyList": [
        {
            "airline": null,
            "bookingCode": null,
            "origin": null,
            "destination": null,
            "flightFromDate": "2025-01-11",
            "flightToDate": "2035-01-11",
            "penalty1_RemainingDaysUntilFlight": 3,
            "penalty1_PenaltyPercentage": 10,
            "penalty2_RemainingDaysUntilFlight": 2,
            "penalty2_PenaltyPercentage": 30,
            "penalty3_RemainingDaysUntilFlight": 1,
            "penalty3_PenaltyPercentage": 50,
            "nearFlight_RemainingMinutesUntilFlight": 1800,
            "nearFlight_PenaltyPercentage": 90,
            "noShow_PenaltyPercentage": 100,
            "penaltyBasedOnTimeElapsedSinceBooking_MinutesElapsedSinceBooking": 5,
            "penaltyBasedOnTimeElapsedSinceBooking_RemainingHoursUntilFlight": 10,
            "penaltyBasedOnTimeElapsedSinceBooking_PenaltyPercentage": 0
        }
    ]
}