flight-bot-b2m
متد Get Refund Policy List
این متد برای دریافت قوانین کنسلی پرواز استفاده میگردد.
کاربرد این متد صرفا جهت اطلاع از قوانین و میزان جریمههای کنسلی پرواز که در سیستم تعریف شده میباشد.
مقدار null در هر فیلدی به معنی همهی موارد میباشد.
API Endpoint
POST https://{SupplierWebsiteUrl}/api/B2M/Bot/Flight/Charter/Refund/Policy/GetList/V1
Request Parameters
UserNamestring
[conditional-required]
نام کاربری
در صورت استفاده از روش Username/Password Authentication ارسال این فیلد الزامی است.
Passwordstring
[conditional-required]
رمز عبور به صورت MD5 شده
در صورت استفاده از روش Username/Password Authentication ارسال این فیلد الزامی است.
AccessTokenstring
[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": "testdev1",
"Password": "25f9e794323b453885f5181f1b624d0b"
}'
Response Parameters
policyListArray of policies
لیست قوانین کنسلی پرواز
policyList.airlinestring
کد یاتای ایرلاین
policyList.bookingCodestring
بوکینگ کد
policyList.originstring
کد یاتای مبدا
policyList.destinationstring
کد یاتای مقصد
policyList.flightFromDatestring
تاریخ اولین روز در بازهی تاثیر با فرمت yyyy-MM-dd به صورت میلادی. تاریخ خروج پرواز با مقدار این فیلد و فیلد بعدی مطابقت داده میشود، به این صورت که اگر تاریخ خروج پرواز بین این دو تاریخ باشد این قانون برای پرواز مورد نظر اعمال خواهد شد
policyList.flightToDatestring
تاریخ آخرین روز در بازهی تاثیر با فرمت yyyy-MM-dd به صورت میلادی. تاریخ خروج پرواز با مقدار این فیلد و فیلد قبلی مطابقت داده میشود، به این صورت که اگر تاریخ خروج پرواز بین این دو تاریخ باشد این قانون برای پرواز مورد نظر اعمال خواهد شد
policyList.penalty1_RemainingDaysUntilFlightnumber
حداقل روزهای باقی مانده به پرواز در جریمه اول
policyList.penalty1_PenaltyPercentagenumber
درصد جریمه در جریمه اول
policyList.penalty2_RemainingDaysUntilFlightnumber
حداقل روزهای باقی مانده به پرواز در جریمه دوم
policyList.penalty2_PenaltyPercentagenumber
درصد جریمه در جریمه دوم
policyList.penalty3_RemainingDaysUntilFlightnumber
حداقل روزهای باقی مانده به پرواز در جریمه سوم
policyList.penalty3_PenaltyPercentagenumber
درصد جریمه در جریمه سوم
policyList.nearFlight_RemainingMinutesUntilFlightnumber
حداقل زمان باقی مانده به پرواز در جریمه نزدیک پرواز به دقیقه
policyList.nearFlight_PenaltyPercentagenumber
درصد جریمه در جریمه نزدیک پرواز
policyList.noShow_PenaltyPercentagenumber
درصد جریمه در جریمه no-show
policyList.penaltyBasedOnTimeElapsedSinceBooking_MinutesElapsedSinceBookingnumber
حداکثر زمان گذشته از رزرو که جریمه penaltyBasedOnTimeElapsedSinceBooking_PenaltyPercentage موقع کنسلی اعمال خواهد شد به دقیقه
policyList.penaltyBasedOnTimeElapsedSinceBooking_RemainingHoursUntilFlightnumber
حداقل زمان باقی به پرواز که جریمه penaltyBasedOnTimeElapsedSinceBooking_PenaltyPercentage موقع کنسلی اعمال خواهد شد به ساعت
policyList.penaltyBasedOnTimeElapsedSinceBooking_PenaltyPercentagenumber
درصد جریمه 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
}
]
}