Retrieve Booking
متد GetStatus
کاربرد این متد برای زمانی است که شما متد Book را فراخوانی نموده اید، ولی به هر دلیلی – مانند مشکلات شبکه و قطعی اینترنتی یا ریست شدن سرور – جوابی از سپهر دریافت نکرده اید، با استفاده از این متد می توانید وضعیت درخواست رزرو و اینکه آیا رزرو صادر شده است یا خیر را بررسی نمایید.
پیشنهاد می گردد اگر بعد از فراخوانی متد Book هیچ جوابی دریافت نکردید، حداقل 15 ثانیه صبر نموده و سپس از متد GetStatus استفاده نمایید. در صورتی که فاصله بین فراخوانی متد Book و متد GetStatus کمتر از 15 ثانیه باشد، احتمال اینکه متد GetStatus جواب اشتباهی را خروجی دهد زیاد است. و ممکن است رزرو شما در حال صادر شدن باشد ولی متد GetStatus در جواب پاسخ دهد که هیچ رزروی صادر نشده است. به بیان فنی تر می توان اینطور گفت که وقتی متد Book را فراخوانی می نمایید یک Timeout به میزان 15 ثانیه برای آن تنظیم نمایید و در صورتی که خطای timeout دریافت کردید آنگاه متد GetStatus را فراخوانی نمایید تا از نتیجه صادر شدن یا نشدن رزرو خود مطلع شوید.
این متد اطلاعات مربوط به رزرو اولیه را نمایش میدهد و در صورتی که بعدا روی رزرو اصلاحیه ای صورت گرفته باشد – مانند استرداد یا تغییر پرواز – آن اصلاحیه ها را خروجی نمی دهد.
API Endpoint
https://{SupplierWebsiteUrl}/api/Partners/Flight/RetrieveBooking/V2/GetStatus post
Request Parameters
نمونه کلاس Request به زبان سی شارپ در پروژه Partners.Contracts (دانلود) در پوشه زیر موجود است:
\Flight\RetrieveBooking\V2\GetStatus\RequestModel
Credential
Complex type
اطلاعات مربوط به نام کاربری و رمز عبور
Username
string
نام کاربری
Password
string
رمز عبور به صورت MD5 شده
YourLocalInventoryPnr
string
رفرنس سیستم شما که در زمان رزرو به متد Book ارسال نموده اید.
{
"Credential": {
"Username": "testdev1",
"Password": "25f9e794323b453885f5181f1b624d0b"
},
"YourLocalInventoryPnr": "dab0bd0d-22e9-4f59-90ec-e1eec9199bed"
}
Response Data
نمونه کلاس Response به زبان سی شارپ در پروژه Partners.Contracts (دانلود) در پوشه زیر موجود است:
\Flight\RetrieveBooking\V2\GetStatus\ResponseModel
StatusId
number
وضعیت رزرو که شامل یکی از موارد زیر می گردد
عدد 1 بدین معناست که رزرو صادر شده است و اطلاعات آن در فیلد PassengerList قابل مشاهده می باشد.
عدد 2 بدین معناست که رزروی با رفرنس شما (YourLocalInventoryPnr) پیدا و صادر نشده است.
عدد 3 بدین معناست که درخواست رزرو شما توسط سپهر دریافت شده است و رزرو در حال پردازش می باشد. ولی وضعیت آن هنوز تایید نهایی نشده است.
عدد 4 بدین معناست که رزرو شما به خطا خورده و صادر نشده است. علت خطا در فیلد FailReason خروجی داده می شود.
StatusDesc
string
مقدار این فیلد توضیحی برای فیلد StatusId می باشد. و بنابراین شامل یکی از موارد زیر می گردد:
مقدار OK بدین معناست که رزرو صادر شده است و اطلاعات آن در فیلد PassengerList قابل مشاهده می باشد.
مقدار NotFound بدین معناست که رزروی با رفرنس شما (YourLocalInventoryPnr) پیدا و صادر نشده است.
مقدار IssueInProgress بدین معناست که درخواست رزرو شما توسط سپهر دریافت شده است و رزرو در حال پردازش می باشد. ولی وضعیت آن هنوز تایید نهایی نشده است.
مقدار Failed بدین معناست که رزرو شما به خطا خورده و صادر نشده است. علت خطا در فیلد FailReason خروجی داده می شود.
LocalPnr
string
در صورتی که رزرو شما با موفقیت صادر شده باشد، رفرنس سیستم سپهر در این فیلد خروجی داده می شود
رفرنس شامل 6 کاراکتر و ترکیبی از حروف و اعداد می باشد.
این رفرنس مربوط به سیستم داخلی تامین کننده بوده و جهت استرداد یا ارتباطات بعدی شما با تامین کننده کاربرد دارد.
پذیرش مسافر در فرودگاه بر اساس رفرنس OriginalPnr انجام می گردد.
بنابراین پیشنهاد می کنیم LocalPnr را روی بلیط مسافر نمایش ندهید و صرفا جهت استرداد یا پیگیری های بعدی آن را در دیتابیس خود ذخیره نمایید.
FailReason
string
در صورتی که رزرو شما به خطا خورده باشد، علت خطا در این فیلد خروجی داده می شود.
PassengerList
List(Passenger)
در صورتی که رزرو شما با موفقیت صادر شده باشد، لیست مسافران در این فیلد خروجی داده می شود.
FirstName
string
نام مسافر
LastName
string
نام خانوادگی مسافر
AgeType
string
گروه سنی مسافر که شامل یکی از مقادیر ADL یا CHD یا INF می باشد
Gender
string
جنسیت مسافر که شامل یکی از مقادر M به معنی مذکر یا F به معنی مونث می باشد.
Birthdate
string
تاریخ تولد مسافر به صورت میلادی و با فرمت yyyy-MM-dd
NationalityCountry
string
کد دوحرفی کشور مربوط به ملیت مسافر
IranianCartMelli
complex type
کد ملی مسافر برای مسافران ایرانی
CodeMelli
string
کد ملی
Passport
complex type
اطلاعات مربوط به گذرنامه مسافر
Number
string
شماره گذرنامه
ExpiryDate
string
تاریخ انقضا گذرنامه به صورت میلادی و با فرمت yyyy-MM-dd
PlaceOfIssueCountry
string
کد دو حرفی محل صدور گذرنامه
SegmentList
List(Segment)
لیست سگمنت های مسافر
FlightNumber
string
شماره پرواز
FlightDate
string
تاریخ پرواز به صورت میلادی و به ناحیه زمانی فرودگاه مبدا و با فرمت yyyy-MM-dd HH:mm
OriginIataCode
string
کد یاتا فرودگاه مبدا
DestinationIataCode
string
کد یاتا فرودگاه مقصد
CabinType
string
نوع کابین کلاس پروازی که می تواند یکی از موارد زیر را داشته باشد:
- Economy
- EconomyPlus
- PremiumEconomy
- Business
- BusinessComfort
- BusinessPremium
- First
BookingCode
string
معمولا ترکیب یک یا دو حرف بوده و مشخص کننده نوع BookingCode می باشد. مانند Y یا M.
FareName
string
اسم Fare
AirlineIataCode
string
کد یاتا ایرلاین
OriginalPnr
string
رفرنس مرجع که پذیرش مسافر در فرودگاه بر اساس آن انجام می شود.
پیشنهاد می گردد این رفرنس را به همراه رفرنس خود روی بلیط مسافر نمایش دهید.
کاربرد این رفرنس صرفا جهت نمایش روی بلیط می باشد و برای انجام مواردی مانند استرداد بلیط، شما از طریق رفرنس LocalPnr با تامین کننده ارتباط برقرار می نمایید.
مقدار این فیلد می تواند تا 20 کاراکتر طول داشته باشد.
جهت تست این فیلد می توانید از تست سناریوهای زیر استفاده نمایید:
LocalTicketNumber
string
شماره بلیط سیستم داخلی تامین کننده.
این شماره بلیط مربوط به سیستم داخلی تامین کننده بوده و جهت استرداد یا ارتباطات بعدی شما با تامین کننده کاربرد دارد.
پذیرش مسافر در فرودگاه بر اساس شماره بلیط OriginalTicketNumber انجام می گردد.
بنابراین پیشنهاد می کنیم این شماره بلیط را روی بلیط مسافر نمایش ندهید و صرفا جهت استرداد یا پیگیری های بعدی آن را در دیتابیس خود ذخیره نمایید.
در صورت رفت و برگشت بودن رزرو، سیستم دو شماره بلیط متفاوت برای پرواز رفت و برگشت تولید خواهد کرد.
به دلیل اینکه شماره بلیط ممکن است با عدد صفر شروع شود، لطفا دقت نمایید که مقدار این فیلد را به صورت string ذخیره نمایید و نه integer.
مقدار این فیلد می تواند تا 13 کاراکتر طول داشته باشد.
OriginalTicketNumber
string
شماره بلیط مرجع
با توجه با اینکه در سال های اخیر پذیرش مسافر در فرودگاه بر اساس رفرنس انجام می پذیرد، این فیلد عملا بدون کاربرد می باشد و نیازی به نمایش آن روی بلیط مسافر وجود ندارد.
با توجه به بدون کاربرد بودن این فیلد، به دلیل شرایط احتمالی فرودگاهای قدیمی تر، این فیلد حذف نگردیده است.
در صورت رفت و برگشت بودن رزرو، سیستم دو شماره بلیط متفاوت برای پرواز رفت و برگشت تولید خواهد کرد.
به دلیل اینکه شماره بلیط ممکن است با عدد صفر شروع شود، لطفا دقت نمایید که مقدار این فیلد را به صورت string ذخیره نمایید و نه integer.
مقدار این فیلد می تواند تا 13 کاراکتر طول داشته باشد.
OriginalSupplierName
string
در صورتی که تامین کننده خود از طریق وب سرویس روی یک تامین کننده دیگر اقدام به رزرو نموده باشد، نام تامین کننده اصلی در این فیلد خروجی داده خواهد شد
SaleInfo
Complex type
اطلاعات مربوط به نرخ فروش
BaseFare
decimal
نرخ پایه بلیط
Tax
decimal
مجموع مالیات
TotalFare
decimal
مجموع نرخ پایه به علاوه مالیات
CommissionPercent
decimal
کمیسیون درصدی
CalculatedAmountOfCommissionPercent
decimal
مقدار مبلغی معادل کمیسیون درصدی
CommissionValue
decimal
کمیسیون مبلغی
در برخی پروازها، کمیسیون به جای درصدی به صورت مبلغی ارائه می گردد. که البته این مورد بسیار نادر اتفاق می افتد.
در صورت تعریف شدن کمیسیون به صورت مبلغ، مقدار این فیلد مشخص کننده مقدار آن خواهد بود
Payable
decimal
مبلغ نهایی
مبلغ این فیلد در حساب بدهکاری خریدار منظور می گردد و مبنای پرداخت های پولی می باشد.
FreeBaggage
Complex type
اطلاعات مربوط به بار مجاز رایگان
CheckedBaggage_Quantity
number
تعداد چمدان
CheckedBaggage_TotalWeight
number
مجموع وزن چمدان ها
HandBaggage_Quantity
number
تعداد کیف بار دستی
HandBaggage_TotalWeight
number
مجموع وزن کیف و بار دستی
JarimeCanceliTextFa
string
جدول جریمه های استرداد به زبان فارسی
JarimeCanceliTextEn
string
جدول جریمه های استرداد به زبان انگلیسی
{
"StatusId": 1,
"StatusDesc": "OK",
"LocalPnr": "OID7QK",
"FailReason": null,
"PassengerList": [
{
"FirstName": "SAKHAVAT",
"LastName": "RAHMATI KHAH",
"AgeType": "ADL",
"Gender": "M",
"Birthdate": "1994-09-16",
"NationalityCountry": "IR",
"IranianCartMelli": {
"CodeMelli": "0012117862"
},
"Passport": null,
"SegmentList": [
{
"FlightNumber": "413",
"FlightDate": "2024-09-17 10:00",
"OriginIataCode": "KIH",
"DestinationIataCode": "THR",
"CabinType": "Economy",
"BookingCode": "Y",
"FareName": "MHD",
"AirlineIataCode": "HH",
"OriginalPnr": "OID7QK",
"LocalTicketNumber": "1417221",
"OriginalTicketNumber": "1417221",
"OriginalSupplierName": "",
"SaleInfo": {
"BaseFare": 4800000,
"Tax": 0,
"TotalFare": 4800000,
"CommissionPercent": 0,
"CalculatedAmountOfCommissionPercent": 0,
"CommissionValue": 0,
"Payable": 4800000
},
"FreeBaggage": {
"CheckedBaggage_Quantity": 2,
"CheckedBaggage_TotalWeight": 20,
"HandBaggage_Quantity": 1,
"HandBaggage_TotalWeight": 5
},
"JarimeCanceliTextFa": "جريمه استرداد تا 15 دقيقه بعد از رزرو (فقط تا 12 ساعت قبل از پرواز) 0 درصد مي باشد.\r\nجريمه استرداد از زمان صدور بليت تا ساعت 12 ظهر 3 روز قبل از پرواز 30 درصد مي باشد.\r\nجريمه استرداد از ساعت 12 ظهر 3 روز قبل از پرواز تا ساعت 12 ظهر 2 روز قبل از پرواز 50 درصد مي باشد.\r\nجريمه استرداد از ساعت 12 ظهر 2 روز قبل از پرواز تا ساعت 12 ظهر 1 روز قبل از پرواز 70 درصد مي باشد.\r\nجريمه استرداد از ساعت 12 ظهر 1 روز قبل از پرواز تا 20 ساعت قبل از پرواز 90 درصد مي باشد.\r\nجريمه استرداد از 20 ساعت قبل از پرواز به بعد 100 درصد مي باشد (NoShow).",
"JarimeCanceliTextEn": "The cancellation penalty until 15 minutes after reservation(only 12 hours before flight): 0%\r\nThe cancellation penalty from the time of ticket issuance until (12:00 noon), 3 days before the flight: 30%\r\nThe cancellation penalty from (12:00 noon), 3 days before the flight until (12:00 noon), 2 days before the flight: 50%\r\nThe cancellation penalty from (12:00 noon), 2 days before the flight until (12:00 noon), 1 days before the flight: 70%\r\nThe cancellation penalty from (12:00 noon), 1 days before the flight until 20 hours before the flight: 90%\r\nThe cancellation penalty from 20 hours before the flight onwards: 100% (No-Show)"
}
]
}
]
}
Response common exceptions
در جدول زیر لیستی از خطاهایی که ممکن است بعد از فراخوانی این متد برگشت داده شود، فهرست شده است.
| ExceptionType | توضیح خطا |
|---|---|
|
Exception |
خطای نامشخص. جهت دریافت اطلاعات بیشتر باید به ErrorMessage داخل json برگشتی مراجعه نمود. |