داکیومنت وب سرویس اتوبوس های هالیدی

اطلاعاتی که باید قبل از استفاده از وب سرویس اتوبوس بدانید

این سرویس (وب سرویس اتوبوس) رایگان نبوده و شامل هزینه اشتراک ماهانه می باشد.برای اطلاعات بیشتر با شماره های پشتیبانی تماس بگیرید.
قیمت های ارائه شده در وب سرویس اتوبوس به صورت نت بوده و هیچ روکشی قیمتی از سوی های هالیدی انجام نمی شود.
استفاده کنندگان از وب سرویس موظف به فروش حداقل سقف تایین شده می باشند در غیر این صورت حداقل کارمزد فروش از آنها دریافت می شود.
وب سرویس اتوبوس به صورت Rest و امکان لینک شدن با هر سیستم و پلتفرمی را دارا می باشد.
برای استفاده از وب سرویس رزرو اتوبوس باید ابتدا اشتراک وب سرویس را دریافت و سپس کلید تبادل وب سرویس رزرو اتوبوس برای شما ارسال می گردد.

قیمت وب سرویس اتوبوس چند است؟

وب سرویس اتوبوس به صورت سگمنت محاسبه می شود یعنی برای هر رزرو موفق مبلغی به عنوان سگمنت دریافت می شود و یک هزینه راه اندازی اولیه دارید برای اطلاعات بیشتر در مورد هزینه های وب سرویس اتوبوس با ما تماس بگیرید office@hiholiday.ir
فرم تماس با ما

نحوه پیاده سازی وب سرویس اتوبوس چگونه است؟

وب سرویس های هالیدی به صورت APIREST و خروجی آن Json می باشد که به شما امکان می دهد بر روی هر پلتفرم و نرم افزاری چه وب یا موبایل پیاده سازی می شود. جزئیات بیشتر

چرا وب سرویس های هالیدی را انتخاب کنیم؟

وب سرویس های هالیدی بیش از 7 سال است که در حال خدمات رسانی به سایت ها و اپ های موبایل می باشد وب سرویس فوق UpTime بالایی دارد و تقریبا تمامی آژانس های و ایرلاین ها را پوشش داده نرخ های ارائه شده در این سرویس همان نرخ مستقیم ارائه شده توسط جارتر کننده ها می باشد. ارائه وب سرویس های مختلف به صورت Integrate وب سرویس پرواز - وب سرویس هتل - وب سرویس بیمه - وب سرویس اتوبوس - مستندات وب سرویس

درخواست API KEY

کالکشن PostMan وب سرویس فروش اتوبوس به صورت عموم در فضای مستندات PostMan قرار داده شده و می توانید از طریق آدرس زیر به آن دسترسی داشته باشید

Bus.postman_collection.json

Bus C# Models

در صورت بروز خطا و یا پیشنهادی در جهت بهتر شدن ارائه سرویس می توانید از طریق ایمیل یا واتس آپ با ما در تماس باشید

ارسال درخواست (POST)

api.hiholiday.ir/V4/bus/regions/{ApiKey}

معرفی فیلدهای خروجی

RegionID	آی دی منطقه در بانک های هالیدی. این کد در تمام سیستم یک پارچه شده و از طریق آن می توانید پرواز ها هتل ها و هر خدمات گردشگری ارائه شده در های هالیدی را از طریق وب سرویس صدا بزنید
RegionName	نام منطقه ترمینال شهر یا کشور (هنوز در سیستم های هالیدی تمامی مناطق انگلیسی ثبت نشده و به مرور انجام میشود)
FaRegionName	نام فارسی منطقه
Code	نام یاتای منطقه
Region.ParentRegion	Region Model
Region.Type	Type Model
Region.Type.TypeID	ایدی نوع منطقه مشخص کننده ترمینال یا شهر بودن مقدار
Region.Type.TypeTitle	نام نوع منطقه

توجه کنید مقادیر این خروجی را باید در سیستم خود نگهداری کنید و به عنوان استاتیک دیتا استفاده شود.
بروزرسانی این مناطق را می توانید یک بار در ماه انجام دهید.

مثال

api.hiholiday.ir/V4/bus/regions/{ApiKey}

{ "Result": { "Type": "Success", "Message": "", "Code": 0 }, "Regions": [ { "RegionID": 1, "RegionName": "آسیا", "FaRegionName": "", "Code": "AS", "Type": { "TypeID": 8, "TypeTitle": "Continent" }, "ParentRegion": { "RegionID": 0, "RegionName": "", "FaRegionName": "", "Code": null, "Type": null, "ParentRegion": null } }, { "RegionID": 2, "RegionName": "آمریکای شمالی", "FaRegionName": "", "Code": "NA", "Type": { "TypeID": 8, "TypeTitle": "Continent" }, "ParentRegion": { "RegionID": 0, "RegionName": "", "FaRegionName": "", "Code": null, "Type": null, "ParentRegion": null } }]}

ارسال درخواست (POST)

api.hiholiday.ir/V4/bus/search/{ApiKey}

پارامترهای ورودی

نام فیلد	نوع	توضیحات	مثال
DepartureID Or DepartureName	int or String	کد منطقه که در متد Regions تمامی مناطق با کدها وجود دارند	57
ArrivalID Or ArrivalName	int or String	کد منطقه که در متد Regions تمامی مناطق با کدها وجود دارند	107
DepartureDate	string	تاریخ ورود که هم به صورت میلادی و هم شمسی می توانید ارسال نمایید	1398-05-04 2019-10-11

می توانید یا از آیدی شهر استفاده نمایید یا نام شهر (در صورت که از ای دی شهر استفاده می کنید نیازی به نام شهر ندارید)

معرفی فیلدهای خروجی

Result	Result Model
Result.Type	string	نوع وضعیت شامل Error - Success
Result.Message	string	در صورت بروز خطا متن خطا را نمایش می دهد
Result.Code	int	کد خطا	در حال حاظر مورد استفاده نمی باشد
SearchHistory	Model SearchHistory
SearchHistory.SearchHistoryID	Guid	در مرحله رزرو این مقدار پر میشود
SearchHistory.Departure	Region Model
SearchHistory.Departure.RegionID	int	ای دی منطقه
SearchHistory.Departure.RegionName	string	نام منطقه
SearchHistory.Departure.FaRegionName	string	نام فارسی منطقه
SearchHistory.Departure.RegionType	string	نوع منطقه	ترمینال - شهر
SearchHistory.Departure.Code	string	کد یاتا در صورت موجود بودن
SearchHistory.Departure.ParentRegion	Region Model
SearchHistory.Arrival	Region Model
SearchHistory.Arrival.ParentRegion	Region Model
SearchHistory.DepartureDate	string	تاریخ میلادی رزرو
SearchHistory.PersianDepartureDate	string	تاریخ فارسی رزرو
SearchHistory.SearchType	enum	نوع جستجو	Bus
Buses	List Bus Model	مدل اتوبوس
Bus.BusID	int	ای دی رکورد
Bus.Code	string	کد شناسایی	جهت رزرو
Bus.Manufacturer	enum string	کد تامین کننده اتوبوس	PYN
Bus.Company	Company Model	مشخصات شرکت مسافربری
Bus.Company.CompanyID	int	ای دی شرکت مسافربری	1545
Bus.Company.Name	string	نام شرکت مسافربری	گیتی پیما
Bus.Company.Logo	string	آدرس لوگو	https://storage.
Bus.Vehicle	Vehicle Model	مدل وسیله نقلیه
Bus.Vehicle.VehicleID	int	ای دی وسیله	1383
Bus.Vehicle.Name	string	نام وسیله نقلیه	اسکانیا 32 نفره
Bus.Vehicle.Manufacturer	string	کد تامین کننده	Scania
Bus.DepartureDate	string	زمان حرکت	2019-10-14T21:15:00
Bus.ArrivalDate	string	زمان رسیدن به مقصد	در نسخه بعد ارائه میشود
Bus.Capacity	int	ظرفیت موجود	15
Bus.DisplayMode	string	مهم نیست	0
Bus.Price	string	مبلغ نهائی بلیط	45000
Bus.Discount	decimal	مقدار تخفیف به صورت درصد - این مقدار از مبلغ بلیط کسر شده و جهت اطلاع رسانی شماست این تخفیف مربوط به مسافر می باشد	20
Bus.Commission	decimal	مقدار کمیسیون به صورت درصد که شرکت به شما میدهد -توجه کنید اکثر شرکت ها این مقدار را زمان فروش به اعتبار شما اضافه خواهد کرد لذا ممکن است در این قسمت 0 برگشت داده شود اما در فروش نهائی شما کمیسیون لحاظ خواهد شد	20
Bus.IsForeign	Bool	سفر داخلی یا خارجی	false
Bus.Departure	Region Model	اطلاعات مبدا
Bus.Arrival	Region Model	اطلاعات مقصد
Bus.FinalArrival	string	مقصد نهائی اتوبوس	یزد
Bus.OtherArrivals	string	منطقه های که در مسیر از آن رد میشود	اردکان (یزد),میب
Bus.Description	string	توضیحات تامین کننده در صورت لزوم
Bus.UpdTime	Datetime	آخرین زمان بروزرسانی رکورد
Bus.BusDetail	Bus Detail Model	جزئیات اتوبوس شامل ظرفیت و غیره	در مرحله بعد پر می شود

مثال شماره یک

api.hiholiday.ir/v4/bus/search/{ApiKey}

مقادیر ورودی Request Body

{ "DepartureID": 107, "ArrivalID": 80, "DepartureDate": "2019-10-14" }

مقادیر خروجی Response

{ "Result": { "Type": "Success", "Message": "", "Code": 0 }, "SearchHistory": { "SearchHistoryID": "00000000-0000-0000-0000-000000000000", "Departure": { "RegionID": 107, "RegionName": "تهران", "FaRegionName": "تهران", "RegionType": "City", "Code": "THR", "ParentRegion": { "RegionID": 372, "RegionName": "تهران (استان)", "FaRegionName": "تهران (استان)", "RegionType": null, "Code": "", "ParentRegion": null } }, "Arrival": { "RegionID": 80, "RegionName": "یزد", "FaRegionName": "يزد", "RegionType": "City", "Code": "AZD", "ParentRegion": { "RegionID": 352, "RegionName": "یزد (استان)", "FaRegionName": "يزد (استان)", "RegionType": null, "Code": "", "ParentRegion": null } }, "DepartureDate": "2019-10-14", "PersianDepartureDate": "1398-07-22", "SearchType": "Bus" }, "Buses": [ { "BusID": 2256, "Code": "2256", "Manufacturer": "PYN", "Company": { "CompanyID": 992, "Name": "ماهان سفر ایرانیان", "Logo": "https://storage.hiholiday.ir/File/AirlineLogo/992.png" }, "Vehicle": { "VehicleID": 1382, "Name": "اسکانیا ۴۴ نفره", "Manufacturer": "Scania" }, "DepartureDate": "2019-10-14T10:15:00", "ArrivalDate": "", "Capacity": 38, "DisplayMode": 0, "Price": 42000, "Commission": 0, "IsForeign": false, "Departure": { "RegionID": 1189, "RegionName": "پایانه غرب تهران", "FaRegionName": "پايانه غرب تهران", "RegionType": null, "Code": "", "ParentRegion": { "RegionID": 0, "RegionName": "تهران", "FaRegionName": null, "RegionType": null, "Code": null, "ParentRegion": null } }, "Arrival": { "RegionID": 80, "RegionName": "یزد", "FaRegionName": "يزد", "RegionType": null, "Code": "AZD", "ParentRegion": { "RegionID": 0, "RegionName": "یزد (استان)", "FaRegionName": null, "RegionType": null, "Code": null, "ParentRegion": null } }, "FinalArrival": "یزد", "OtherArrivals": "اردکان (یزد),نائین,میبد,اردستان", "Description": "", "UpdTime": "2019-10-05T20:00:00", "BusDetail": null }, { "BusID": 2255, "Code": "2255", "Manufacturer": "PYN", "Company": { "CompanyID": 1014, "Name": "تک سفر ایرانیان", "Logo": "https://storage.hiholiday.ir/File/AirlineLogo/1014.jpg" }, "Vehicle": { "VehicleID": 1383, "Name": "اسکانیا 32 نفره", "Manufacturer": "Scania" }, "DepartureDate": "2019-10-14T21:15:00", "ArrivalDate": "", "Capacity": 26, "DisplayMode": 0, "Price": 46400, "Commission": 20, "IsForeign": false, "Departure": { "RegionID": 1189, "RegionName": "پایانه غرب تهران", "FaRegionName": "پايانه غرب تهران", "RegionType": null, "Code": "", "ParentRegion": { "RegionID": 0, "RegionName": "تهران", "FaRegionName": null, "RegionType": null, "Code": null, "ParentRegion": null } }, "Arrival": { "RegionID": 80, "RegionName": "یزد", "FaRegionName": "يزد", "RegionType": null, "Code": "AZD", "ParentRegion": { "RegionID": 0, "RegionName": "یزد (استان)", "FaRegionName": null, "RegionType": null, "Code": null, "ParentRegion": null } }, "FinalArrival": "یزد", "OtherArrivals": "اردکان (یزد),میبد,نائین", "Description": "", "UpdTime": "2019-10-05T20:00:00", "BusDetail": null } ] }

ارسال درخواست (POST)

api.hiholiday.ir/v4/bus/detail/{ApiKey}

پارامترهای ورودی

نام فیلد	نوع	توضیحات	مثال
Code	string	کد رکورد اتوبوس در مرحله قبل ارائه شده	2245

معرفی فیلدهای خروجی

Result	Result Model
Result.Type	string	نوع وضعیت شامل Error - Success
Result.Message	string	در صورت بروز خطا متن خطا را نمایش می دهد
Result.Code	int	کد خطا	در حال حاظر مورد استفاده نمی باشد
Bus	Bus Model	مدل اتوبوس
Bus.BusID	int	ای دی رکورد
Bus.Code	string	کد شناسایی	جهت رزرو
Bus.Manufacturer	enum string	کد تامین کننده اتوبوس	PYN
Bus.Company	Company Model	مشخصات شرکت مسافربری
Bus.Company.CompanyID	int	ای دی شرکت مسافربری	1545
Bus.Company.Name	string	نام شرکت مسافربری	گیتی پیما
Bus.Company.Logo	string	آدرس لوگو	https://storage.
Bus.Vehicle	Vehicle Model	مدل وسیله نقلیه
Bus.Vehicle.VehicleID	int	ای دی وسیله	1383
Bus.Vehicle.Name	string	نام وسیله نقلیه	اسکانیا 32 نفره
Bus.Vehicle.Manufacturer	string	کد تامین کننده	Scania
Bus.DepartureDate	string	زمان حرکت	2019-10-14T21:15:00
Bus.ArrivalDate	string	زمان رسیدن به مقصد	در نسخه بعد ارائه میشود
Bus.Capacity	int	ظرفیت موجود	15
Bus.DisplayMode	string	مهم نیست	0
Bus.Price	string	مبلغ نهائی بلیط	45000
Bus.Commission	decimal	مقدار تخفیف به صورت درصد	20
Bus.IsForeign	Bool	سفر داخلی یا خارجی	false
Bus.Departure	Region Model	اطلاعات مبدا
Bus.Arrival	Region Model	اطلاعات مقصد
Bus.FinalArrival	string	مقصد نهائی اتوبوس	یزد
Bus.OtherArrivals	string	منطقه های که در مسیر از آن رد میشود	اردکان (یزد),میب
Bus.Description	string	توضیحات تامین کننده در صورت لزوم
Bus.UpdTime	Datetime	آخرین زمان بروزرسانی رکورد
Bus.BusDetail	BusDetail Model	جزئیات اتوبوس شامل ظرفیت و غیره
Bus.BusDetail.Capacity	int	ظرفیت کل اتوبوس
Bus.BusDetail.Floor	int	طبقه اتوبوس
Bus.BusDetail.Col	int	تعداد ستون
Bus.BusDetail.Row	int	تعداد ردیف
Bus.BusDetail.Space	int	فاصله صندلی
Bus.BusDetail.Seats	List Seat Model	مدل صندلی های اتوبوس
Bus.BusDetail.Status	string	جنسیت رزرو شده صندلی	Man - Free - Woman
Bus.BusDetail.SeatNumber	int	شماره صندلی
Bus.BusDetail.CellNumber	int	جایگاه صندلی

با استفاده از مقادیری که در مدل Seats قرار دارد باید طراحی اتوبوس و صندلی ها را انجام دهید مانند شکل زیر

مثال شماره یک

api.hiholiday.ir/v4/bus/detail/{ApiKey}

مقادیر ورودی Request Body

{ "Code": 2255 }

مقادیر خروجی Response

{ "Result": { "Type": "Success", "Message": "", "Code": 0 }, "Bus": { "BusID": 2255, "Code": "2255", "Manufacturer": "PYN", "Company": { "CompanyID": 1014, "Name": "تک سفر ایرانیان", "Logo": "https://storage.hiholiday.ir/File/AirlineLogo/1014.jpg" }, "Vehicle": { "VehicleID": 1383, "Name": "اسکانیا 32 نفره", "Manufacturer": "Scania" }, "DepartureDate": "2019-10-14T21:15:00", "ArrivalDate": "", "Capacity": 26, "DisplayMode": 0, "Price": 46400, "Commission": 20, "IsForeign": false, "Departure": { "RegionID": 1189, "RegionName": "پایانه غرب تهران", "FaRegionName": "پايانه غرب تهران", "RegionType": null, "Code": "", "ParentRegion": { "RegionID": 0, "RegionName": "تهران", "FaRegionName": "تهران", "RegionType": null, "Code": null, "ParentRegion": null } }, "Arrival": { "RegionID": 80, "RegionName": "یزد", "FaRegionName": null, "RegionType": null, "Code": "AZD", "ParentRegion": { "RegionID": 0, "RegionName": "یزد (استان)", "FaRegionName": "يزد (استان)", "RegionType": null, "Code": null, "ParentRegion": null } }, "FinalArrival": "یزد", "OtherArrivals": "اردکان (یزد),میبد,نائین", "Description": "", "UpdTime": "2019-10-05T20:00:00", "BusDetail": { "Capacity": 32, "Floor": 1, "Col": 3, "Row": 12, "Space": 2, "Seats": [ { "Status": "Man", "SeatNumber": 1, "CellNumber": 1 }, { "Status": "Man", "SeatNumber": 2, "CellNumber": 2 }, { "Status": "Man", "SeatNumber": 3, "CellNumber": 3 }, { "Status": "Man", "SeatNumber": 4, "CellNumber": 4 }, { "Status": "Man", "SeatNumber": 5, "CellNumber": 5 }, { "Status": "Man", "SeatNumber": 6, "CellNumber": 6 }, { "Status": "Free", "SeatNumber": 7, "CellNumber": 7 }, { "Status": "Free", "SeatNumber": 8, "CellNumber": 8 }, { "Status": "Free", "SeatNumber": 9, "CellNumber": 9 }, { "Status": "Free", "SeatNumber": 10, "CellNumber": 10 }, { "Status": "Free", "SeatNumber": 11, "CellNumber": 11 }, { "Status": "Free", "SeatNumber": 12, "CellNumber": 12 }, { "Status": "Free", "SeatNumber": 13, "CellNumber": 13 }, { "Status": "Free", "SeatNumber": 14, "CellNumber": 14 }, { "Status": "Free", "SeatNumber": 15, "CellNumber": 15 }, { "Status": "Free", "SeatNumber": 0, "CellNumber": 16 }, { "Status": "Free", "SeatNumber": 0, "CellNumber": 17 }, { "Status": "Free", "SeatNumber": 16, "CellNumber": 18 }, { "Status": "Free", "SeatNumber": 0, "CellNumber": 19 }, { "Status": "Free", "SeatNumber": 0, "CellNumber": 20 }, { "Status": "Free", "SeatNumber": 17, "CellNumber": 21 }, { "Status": "Free", "SeatNumber": 18, "CellNumber": 22 }, { "Status": "Free", "SeatNumber": 19, "CellNumber": 23 }, { "Status": "Free", "SeatNumber": 20, "CellNumber": 24 }, { "Status": "Free", "SeatNumber": 21, "CellNumber": 25 }, { "Status": "Free", "SeatNumber": 22, "CellNumber": 26 }, { "Status": "Free", "SeatNumber": 23, "CellNumber": 27 }, { "Status": "Free", "SeatNumber": 24, "CellNumber": 28 }, { "Status": "Free", "SeatNumber": 25, "CellNumber": 29 }, { "Status": "Free", "SeatNumber": 26, "CellNumber": 30 }, { "Status": "Free", "SeatNumber": 27, "CellNumber": 31 }, { "Status": "Free", "SeatNumber": 28, "CellNumber": 32 }, { "Status": "Free", "SeatNumber": 29, "CellNumber": 33 }, { "Status": "Free", "SeatNumber": 30, "CellNumber": 34 }, { "Status": "Free", "SeatNumber": 31, "CellNumber": 35 }, { "Status": "Free", "SeatNumber": 32, "CellNumber": 36 } ] } } }

ارسال درخواست (POST)

api.hiholiday.ir/v4/bus/Revalidate/{ApiKey}

نکته: برای استفاده از وب سرویس تست باید آدرس متدهای مربوط به رزرو شامل Revalidate - preReserve - Reserve را به شکل زیر تغییر دهید تا امکان تست فعال شود
مثال:
api.hiholiday.ir/v4/BusTest/Revalidate/YourApiKey
api.hiholiday.ir/v4/BusTest/Revalidate/YourApiKey

پارامترهای ورودی

نام فیلد	نوع	توضیحات	مثال
Code	int	کد رکورد اتوبوس	354
Username	string	نام کاربری شما در سیستم های هالیدی
Password	string	رمز عبور شما در سیستم های هالیدی
Seats	List int	لیستی از شماره صندلی های انتخابی	Seats:[23,24]

معرفی فیلدهای خروجی

Result	Result Model
Result.Type	string	نوع وضعیت شامل Error - Success
Result.Message	string	در صورت بروز خطا متن خطا را نمایش می دهد
Result.Code	int	کد خطا	در حال حاظر مورد استفاده نمی باشد
SearchHistory	SearchHistory Model	اطلاعاتی از جستجوی انجام شده	قبلا در متد Search توضیج داده شده است
Bus	Bus Model	مدل اتوبوس
Bus.BusID	int	ای دی رکورد
Bus.Code	string	کد شناسایی	جهت رزرو
Bus.Manufacturer	enum string	کد تامین کننده اتوبوس	PYN
Bus.Company	Company Model	مشخصات شرکت مسافربری
Bus.Company.CompanyID	int	ای دی شرکت مسافربری	1545
Bus.Company.Name	string	نام شرکت مسافربری	گیتی پیما
Bus.Company.Logo	string	آدرس لوگو	https://storage.
Bus.Vehicle	Vehicle Model	مدل وسیله نقلیه
Bus.Vehicle.VehicleID	int	ای دی وسیله	1383
Bus.Vehicle.Name	string	نام وسیله نقلیه	اسکانیا 32 نفره
Bus.Vehicle.Manufacturer	string	کد تامین کننده	Scania
Bus.DepartureDate	string	زمان حرکت	2019-10-14T21:15:00
Bus.ArrivalDate	string	زمان رسیدن به مقصد	در نسخه بعد ارائه میشود
Bus.Capacity	int	ظرفیت موجود	15
Bus.DisplayMode	string	مهم نیست	0
Bus.Price	string	مبلغ نهائی بلیط	45000
Bus.Commission	decimal	مقدار تخفیف به صورت درصد	20
Bus.IsForeign	Bool	سفر داخلی یا خارجی	false
Bus.Departure	Region Model	اطلاعات مبدا
Bus.Arrival	Region Model	اطلاعات مقصد
Bus.FinalArrival	string	مقصد نهائی اتوبوس	یزد
Bus.OtherArrivals	string	منطقه های که در مسیر از آن رد میشود	اردکان (یزد),میب
Bus.Description	string	توضیحات تامین کننده در صورت لزوم
Bus.UpdTime	Datetime	آخرین زمان بروزرسانی رکورد
Bus.BusDetail	BusDetail Model	جزئیات اتوبوس شامل ظرفیت و غیره
Bus.BusDetail.Capacity	int	ظرفیت کل اتوبوس
Bus.BusDetail.Floor	int	طبقه اتوبوس
Bus.BusDetail.Col	int	تعداد ستون
Bus.BusDetail.Row	int	تعداد ردیف
Bus.BusDetail.Space	int	فاصله صندلی
Bus.BusDetail.Seats	List Seat Model	مدل صندلی های اتوبوس
Bus.BusDetail.Status	string	جنسیت رزرو شده صندلی	Man - Free - Woman
Bus.BusDetail.SeatNumber	int	شماره صندلی
Bus.BusDetail.CellNumber	int	جایگاه صندلی

مثال شماره یک

api.hiholiday.ir/v4/bus/Revalidate/{ApiKey}

مقادیر ورودی Request Body

{ "Username":"iman", "Password":"leila24276", "Code":2255, "Seats":[23,24], "Manufacturer":"HiHolidayApi" }

مقادیر خروجی Response

{ "Result": { "Type": "Success", "Message": "", "Code": 0 }, "SearchHistory": { "SearchHistoryID": "97b11e09-ca91-4ea0-85f5-3a76cef71100", "Departure": { "RegionID": 1189, "RegionName": "پایانه غرب تهران", "FaRegionName": "پايانه غرب تهران", "RegionType": null, "Code": "", "ParentRegion": { "RegionID": 0, "RegionName": "تهران", "FaRegionName": "تهران", "RegionType": null, "Code": null, "ParentRegion": null } }, "Arrival": { "RegionID": 80, "RegionName": "یزد", "FaRegionName": null, "RegionType": null, "Code": "AZD", "ParentRegion": { "RegionID": 0, "RegionName": "یزد (استان)", "FaRegionName": "يزد (استان)", "RegionType": null, "Code": null, "ParentRegion": null } }, "DepartureDate": "2019-10-14", "PersianDepartureDate": "1398-07-22", "SearchType": "Bus" }, "Bus": { "BusID": 2255, "Code": "2255", "Manufacturer": "PYN", "Company": { "CompanyID": 1014, "Name": "تک سفر ایرانیان", "Logo": "https://storage.hiholiday.ir/File/AirlineLogo/1014.jpg" }, "Vehicle": { "VehicleID": 1383, "Name": "اسکانیا 32 نفره", "Manufacturer": "Scania" }, "DepartureDate": "2019-10-14T21:15:00", "ArrivalDate": "", "Capacity": 26, "DisplayMode": 0, "Price": 46400, "Commission": 20, "IsForeign": false, "Departure": { "RegionID": 1189, "RegionName": "پایانه غرب تهران", "FaRegionName": "پايانه غرب تهران", "RegionType": null, "Code": "", "ParentRegion": { "RegionID": 0, "RegionName": "تهران", "FaRegionName": "تهران", "RegionType": null, "Code": null, "ParentRegion": null } }, "Arrival": { "RegionID": 80, "RegionName": "یزد", "FaRegionName": null, "RegionType": null, "Code": "AZD", "ParentRegion": { "RegionID": 0, "RegionName": "یزد (استان)", "FaRegionName": "يزد (استان)", "RegionType": null, "Code": null, "ParentRegion": null } }, "FinalArrival": "یزد", "OtherArrivals": "اردکان (یزد),میبد,نائین", "Description": "", "UpdTime": "2019-10-05T22:05:00", "BusDetail": { "Capacity": 32, "Floor": 1, "Col": 3, "Row": 12, "Space": 2, "Seats": [ { "Status": "Free", "SeatNumber": 23, "CellNumber": 27 }, { "Status": "Free", "SeatNumber": 24, "CellNumber": 28 } ] } } }

ارسال درخواست (POST)

api.hiholiday.ir/v4/bus/PreReserve/{ApiKey}

پارامترهای ورودی

نام فیلد	نوع	توضیحات	مثال
SessionID	int	کد جستجو تولید شده در متد قبل

معرفی فیلدهای خروجی

Request	Model Request
Request.SearchHistoryID	Guid	کد جستجو که در متد قبل تولید شده
Request.RequestNumber	string	شماره درخواست جهت استفاده در مراحل بعد
Request.CreateDate	ِDateTime	تاریخ ثبت
Request.CreateBy	string	نام کاربری
Request.Status	Enum int	وضعیت رزرو	در انتهای این جدول توضیحات داده می شود
Request.SupplierName	string	نام تامین کننده
Request.TimeLimit	DateTime	مدت زمان نهائی کردن رزرو در متد بعد قبل از درگاه باید محاسبه کنید
Request.TotalFare	decimal	جمع فاکتور
Request.Manufacturer	Enum int	کد تامین کننده	در انتهای این جدول توضیحات داده می شود
Request.RequestFares	List Model RequestFare
Request.RequestFare.Type	string	همیشه ثابت است
Request.RequestFare.BaseFare	decimal	مبلغ پایه بلیط
Request.RequestFare.Commission	decimal	کمیسیون
Request.RequestFare.Markup	decimal	کارمزد رزرو
Request.RequestFare.TotalFare	decimal	نرخ نهائی مسافران
Request.RequestPassengers	List Model RequestPassenger		در متد بعد این اطلاعات پر می شود در حال حاظر لیست نشان دهنده تعداد مسافران مورد نیاز است
Member	`Model Member`	اطلاعات کاربری سرویس گیرنده	مشخصات و موجودی اعتبار اکانت سرویس گیرنده را مشخص می کند
Member.Username	`string`
Member.Balance	`decimal`		موجودی نقدی اکانت شما برای خرید
Member.Mobile	`string`		راه ارتباطی های هالیدی با سرویس گیرنده
Member.Email	`string`		راه ارتباطی های هالیدی با سرویس گیرنده
PassengerInput	`Model PassengerInput`	اطلاعات دریافتی از مسافران	از طریق این مدل می توانید مشخص کنید تامین کننده هتل کدام اطلاعات را برای رزرو هتل نیاز دارد تا از دریافت اطلاعات اضافه از مسافران جلوگیری کنید
PassengerInput.PassengerType	`bool`	گروه سنی	Adt=0,Chd=1,Inf=2,Any=3
PassengerInput.PersianName	`bool`	مشخصات فارسی
PassengerInput.EnglishName	`bool`	مشخصات انگلیسی
PassengerInput.NationalCode	`bool`	کد ملی
PassengerInput.Nationality	`bool`	ملیت
PassengerInput.Gender	`bool`	جنسیت
PassengerInput.PassportNumber	`bool`	شماره پاسپورت
PassengerInput.PassportExpiryDate	`bool`	تاریخ اعتبار پاس
PassengerInput.BirthPlace	`bool`	محل تولد
PassengerInput.DateOfBirth	`bool`	تاریخ تولد

Request.Status:
وضعیت ها به شرح زیر می باشد
Revalidate = 3, PreReserve = 4, Book = 1, PaymentGateway = 6, PaymentFail = 7, PaymentSuccess = 8, Cancelled = 12, Expired = 13, Confirmed = 14, Waitlist = 15, ReserveInProcess = 16
در صورتی که وضعیت بر روی Book باشد به این معنی است که اتاق تایید شده و در انتظار پرداخت است و شما می توانید بعد از پرداخت مسافر متد Reserve را صدا بزنید
متد Book قبل از درگاه بانک می باشد و RequestFare های ارائه شده در این متد قیمت نهایی رزرو می باشد.
Request.Manufacturer:
Test = 0, Payaneh = 23

مثال شماره یک

api.hiholiday.ir/V4/bus/PreReserve/{ApiKey}

مقادیر ورودی Request Body

{ "SessionID":"a7395848-a519-4a5c-9bda-09c1b8572567" }

مقادیر خروجی Response

{ "Result": { "Type": "Success", "Message": "", "Code": 0 }, "SearchHistory": { "SearchHistoryID": "a7395848-a519-4a5c-9bda-09c1b8572567", "Departure": { "RegionID": 1189, "RegionName": "پایانه غرب تهران", "FaRegionName": "پايانه غرب تهران", "RegionType": null, "Code": "", "ParentRegion": { "RegionID": 0, "RegionName": "تهران", "FaRegionName": "تهران", "RegionType": null, "Code": null, "ParentRegion": null } }, "Arrival": { "RegionID": 80, "RegionName": "یزد", "FaRegionName": null, "RegionType": null, "Code": "AZD", "ParentRegion": { "RegionID": 0, "RegionName": "یزد (استان)", "FaRegionName": "يزد (استان)", "RegionType": null, "Code": null, "ParentRegion": null } }, "DepartureDate": "2019-10-14", "PersianDepartureDate": "1398-07-22", "SearchType": "Bus" }, "Member": { "Username": "username", "Balance": 127100, "Mobile": "09353303023", "Email": "info@hiholiday.ir" }, "Request": { "SearchHistoryID": "a7395848-a519-4a5c-9bda-09c1b8572567", "RequestNumber": "13532209106", "CreateDate": "/Date(1570348332000)/", "CreateBy": "iman", "Status": "PreReserve", "SupplierName": "پایانه", "TimeLimit": "/Date(1570348332895)/", "TotalFare": 92800, "Manufacturer": "Payaneh", "RequestBus": { "Code": "2255", "Company": { "CompanyID": 1014, "Name": "تک سفر ایرانیان", "Logo": "https://storage.hiholiday.ir/File/AirlineLogo/1014.jpg" }, "Vehicle": { "VehicleID": 1383, "Name": "اسکانیا 32 نفره", "Manufacturer": "Scania" }, "BusType": null, "CompanyPnr": null, "DepartureDate": "10/14/2019 9:15:00 PM", "Departure": { "RegionID": 1189, "RegionName": "پایانه غرب تهران", "FaRegionName": "پايانه غرب تهران", "RegionType": null, "Code": "", "ParentRegion": { "RegionID": 0, "RegionName": "تهران", "FaRegionName": "تهران", "RegionType": null, "Code": null, "ParentRegion": null } }, "Arrival": { "RegionID": 80, "RegionName": "یزد", "FaRegionName": null, "RegionType": null, "Code": "AZD", "ParentRegion": { "RegionID": 0, "RegionName": "یزد (استان)", "FaRegionName": "يزد (استان)", "RegionType": null, "Code": null, "ParentRegion": null } }, "FinalArrival": "یزد", "OthersArrival": null, "BusDetail": { "Capacity": 32, "Floor": 1, "Col": 3, "Row": 12, "Space": 2, "Seats": [ { "Status": "Free", "SeatNumber": 23, "CellNumber": 27 }, { "Status": "Free", "SeatNumber": 24, "CellNumber": 28 } ] } }, "RequestFares": [ { "PassengerCount": 2, "Type": "Sale", "BaseFare": 46400, "Commission": 0, "Markup": 0, "TotalFare": 92800 } ], "RequestPassengers": [ { "PassengerType": 3, "Gender": 0, "NationalCode": "", "FirstName": "", "LastName": "", "PersianFirstName": "", "PersianLastName": "", "BirthPlace": null, "PassportNumber": "", "PassportExpireDate": null, "Nationality": "", "AreaCode": "", "CountryCode": "", "PhoneNumber": "", "Email": "" }, { "PassengerType": 3, "Gender": 0, "NationalCode": "", "FirstName": "", "LastName": "", "PersianFirstName": "", "PersianLastName": "", "BirthPlace": null, "PassportNumber": "", "PassportExpireDate": null, "Nationality": "", "AreaCode": "", "CountryCode": "", "PhoneNumber": "", "Email": "" } ] }, "PassengerInput": [ { "PassengerType": 0, "PersianName": false, "EnglishName": true, "NationalCode": false, "Nationality": false, "Gender": true, "PassportNumber": false, "PassportExpiryDate": false, "BirthPlace": false, "DateOfBirth": false }, { "PassengerType": 1, "PersianName": false, "EnglishName": true, "NationalCode": true, "Nationality": false, "Gender": true, "PassportNumber": false, "PassportExpiryDate": false, "BirthPlace": false, "DateOfBirth": false }, { "PassengerType": 2, "PersianName": false, "EnglishName": true, "NationalCode": false, "Nationality": false, "Gender": true, "PassportNumber": false, "PassportExpiryDate": false, "BirthPlace": false, "DateOfBirth": false }, { "PassengerType": 3, "PersianName": false, "EnglishName": true, "NationalCode": false, "Nationality": false, "Gender": true, "PassportNumber": false, "PassportExpiryDate": false, "BirthPlace": false, "DateOfBirth": false } ] }

ارسال درخواست (POST)

api.hiholiday.ir/v4/bus/Book/{ApiKey}

پارامترهای ورودی

نام فیلد	نوع	توضیحات	مثال
RequestNumber	`string`	شماره درخواست که در متد قبل تولید شده	96738788528
RequestPassengers	`List [RequestPassenger]`	لیست از مشخصات مسافران مطابق با مدل RequestPassenger
RequestPassenger.FirstName	`string`	نام انگلیسی
RequestPassenger.LastName	`string`	نام خانوادگی انگلیسی
RequestPassenger.PersianFirstName	`string`	نام
RequestPassenger.PersianLastName	`string`	نام خانوادگی
RequestPassenger.Gender	`Enum`		Male Female
RequestPassenger.DateOfBirth	`DateTime`	تاریخ تولد	میلادی فقط وارد شود نمونه `1983-01-01`
RequestPassenger.PassengerType	`Enum int`	گروه سنی
RequestPassenger.NationalCode	`string`	کد ملی	1630028304
RequestPassenger.PassportNumber	`string`	شماره پاسپورت	L36951847
RequestPassenger.BirthPlace	`string`	محل تولد	Tehran
RequestPassenger.Nationality	`string`		Tehran
RequestPassenger.PhoneNumber	`string`		Tehran
RequestPassenger.Email	`string`		Tehran
RequestPassenger.DocumentType	`string`	نوع مدارک	Nic = کد ملی \| Psp = پاسپورت

نکته: در متد قبل فیلد PassengerInput اطلاعات مورد نیاز مسافران جهت رزرو را در اختیار شما قرار می دهد لذا نیاز نیست تمامی مشخصات مسافران را ارسال نماید

معرفی فیلدهای خروجی

در متد قبل تمامی مقادیر توضیح داده شده و در اینجا فقط مقادیر مهم دوباره توضیح داده میشود
این متد در واقع متد فاکتور می باشد و ررو را برای شما قفل می کند تا مسافر را به درگاه بانک هدایت کنید

Request.TimeLimit	DateTime	مدت زمان نهائی کردن رزرو
Request.TotalFare	decimal	جمع فاکتور قیمت نهائی رزرو شما
Request.RequestPassengers	List Model RequestPassenger		اطلاعات مسافران را بررسی کنید

Request.Status:
وضعیت ها به شرح زیر می باشد
Revalidate = 3, PreReserve = 4, Book = 1, PaymentGateway = 6, PaymentFail = 7, PaymentSuccess = 8, Cancelled = 12, Expired = 13, Confirmed = 14, Waitlist = 15, ReserveInProcess = 16
در صورتی که وضعیت WaitList باشد به این معنی است که نیاز به تایید توسط اپراتور دارد
در صورتی که وضعیت بر روی Book باشد به این معنی است که اتاق تایید شده و در انتظار پرداخت است و شما می توانید بعد از پرداخت مسافر متد Reserve را صدا بزنید
متد Book قبل از درگاه بانک می باشد و RequestFare های ارائه شده در این متد قیمت نهایی رزرو می باشد.

خطاهای احتمالی

در خروجی متد مقداری به نام Result می باشد که شامل فیلد Type,Code,Message می باشد

Type=Success	متد به درستی کار کرده و خطایی رخ نداده
Type=Error	خطایی در هنگام اجرای متد رخ داده که در فیلد Message دلیل آن نوشته شده است
Message=RequestNumberIsEmpty	شماره درخواست را وارد نکرده اید
Message=RequestPassengersIsEmpty	مشخصات مسافران وارد نکرده اید
Message=RequestNotFound	شماره درخواست یافت نشد
Message=RequestNumberTerminated	وضعیت درخواست جاری برای این متد نمی باشد
Message=AccessDenied	دسترسی شما به این متد وجود ندارد
Message=LowBalance	موجودی اکانت شما کمتر از رزرو میباشد
Message=HttpError	قطعی سرور یا تامین کننده
Message=ServerError	خطایی سمت سرور رخ داده که متن خطا برای مدیر پشتیبانی وب سرویس ارسال می شود

مثال شماره یک

api.hiholiday.ir/V4/bus/Book/{ApiKey}

مقادیر ورودی Request Body

{ "RequestNumber": "13532209106", "RequestPassengers": [ { "FirstName": "Nikan", "LastName": "Mahmodi", "Gender": "Male", "PhoneNumber": 09353303023, "Email": "office@hiholiday.ir" }, { "FirstName": "leila", "LastName": "Mahmodi", "Gender": "Female" } ] }

مقادیر خروجی

{ "Result": { "Type": "Success", "Message": "", "Code": 0 }, "SearchHistory": { "SearchHistoryID": "a7395848-a519-4a5c-9bda-09c1b8572567", "Departure": { "RegionID": 1189, "RegionName": "پایانه غرب تهران", "FaRegionName": "پايانه غرب تهران", "RegionType": null, "Code": "", "ParentRegion": { "RegionID": 0, "RegionName": "تهران", "FaRegionName": "تهران", "RegionType": null, "Code": null, "ParentRegion": null } }, "Arrival": { "RegionID": 80, "RegionName": "یزد", "FaRegionName": null, "RegionType": null, "Code": "AZD", "ParentRegion": { "RegionID": 0, "RegionName": "یزد (استان)", "FaRegionName": "يزد (استان)", "RegionType": null, "Code": null, "ParentRegion": null } }, "DepartureDate": "2019-10-14", "PersianDepartureDate": "1398-07-22", "SearchType": "Bus" }, "Member": { "Username": "iman", "Balance": 127100, "Mobile": "09363304318", "Email": "processor.p1@gmail.com" }, "Request": { "SearchHistoryID": "a7395848-a519-4a5c-9bda-09c1b8572567", "RequestNumber": "13532209106", "CreateDate": "/Date(1570348332000)/", "CreateBy": "iman", "Status": "Book", "SupplierName": "پایانه", "TimeLimit": "/Date(1570350695000)/", "TotalFare": 92800, "Manufacturer": "Payaneh", "RequestBus": { "Code": "2255", "Company": { "CompanyID": 1014, "Name": "تک سفر ایرانیان", "Logo": "https://storage.hiholiday.ir/File/AirlineLogo/1014.jpg" }, "Vehicle": { "VehicleID": 1383, "Name": "اسکانیا 32 نفره", "Manufacturer": "Scania" }, "BusType": null, "CompanyPnr": null, "DepartureDate": "10/14/2019 9:15:00 PM", "Departure": { "RegionID": 1189, "RegionName": "پایانه غرب تهران", "FaRegionName": "پايانه غرب تهران", "RegionType": null, "Code": "", "ParentRegion": { "RegionID": 0, "RegionName": "تهران", "FaRegionName": "تهران", "RegionType": null, "Code": null, "ParentRegion": null } }, "Arrival": { "RegionID": 80, "RegionName": "یزد", "FaRegionName": null, "RegionType": null, "Code": "AZD", "ParentRegion": { "RegionID": 0, "RegionName": "یزد (استان)", "FaRegionName": "يزد (استان)", "RegionType": null, "Code": null, "ParentRegion": null } }, "FinalArrival": "یزد", "OthersArrival": null, "BusDetail": { "Capacity": 32, "Floor": 1, "Col": 3, "Row": 12, "Space": 2, "Seats": [ { "Status": "Free", "SeatNumber": 23, "CellNumber": 27 }, { "Status": "Free", "SeatNumber": 24, "CellNumber": 28 } ] } }, "RequestFares": [ { "PassengerCount": 2, "Type": "Sale", "BaseFare": 46400, "Commission": 0, "Markup": 0, "TotalFare": 92800 } ], "RequestPassengers": [ { "PassengerType": 0, "Gender": 0, "NationalCode": "", "FirstName": "Nikan", "LastName": "Mahmodi", "PersianFirstName": "", "PersianLastName": "", "BirthPlace": null, "PassportNumber": "", "PassportExpireDate": null, "Nationality": "", "AreaCode": "", "CountryCode": "", "PhoneNumber": "9353303023", "Email": "office@hiholiday.ir" }, { "PassengerType": 0, "Gender": 1, "NationalCode": "", "FirstName": "leila", "LastName": "Mahmodi", "PersianFirstName": "", "PersianLastName": "", "BirthPlace": null, "PassportNumber": "", "PassportExpireDate": null, "Nationality": "", "AreaCode": "", "CountryCode": "", "PhoneNumber": "", "Email": "" } ] }, "PassengerInput": null }

ارسال درخواست (POST)

api.hiholiday.ir/v4/bus/Reserve/{ApiKey}

پارامترهای ورودی

نام فیلد	نوع	مثال
RequestNumber	`string`	96738788528

معرفی فیلدهای خروجی

در متد قبل تمامی مقادیر توضیح داده شده و در اینجا فقط مقادیر مهم دوباره توضیح داده میشود
این متد متد نهائی رزرو می باشد و بعد از موفقیت در اجرای متد شماره بلیط و شماره رفرنس به شما برگشت داده میشود

Request.RequestBus.CompanyPnr	string	شماره رفرنس
Request.RequestPassengers.Ticketnumber	string	شماره بلیط مسافران که تقریبا برای همگی آنها یک شماره بلیط صادر میشود

مثال شماره یک

api.hiholiday.ir/V4/bus/Reserve/{ApiKey}

مقادیر ورودی Request Body

{ "RequestNumber": "13532209106" }

مقادیر خروجی Response

{ "Result": { "Type": "Success", "Message": "", "Code": 0 }, "SearchHistory": { "SearchHistoryID": "a7395848-a519-4a5c-9bda-09c1b8572567", "Departure": { "RegionID": 1189, "RegionName": "پایانه غرب تهران", "FaRegionName": "پايانه غرب تهران", "RegionType": null, "Code": "", "ParentRegion": { "RegionID": 0, "RegionName": "تهران", "FaRegionName": "تهران", "RegionType": null, "Code": null, "ParentRegion": null } }, "Arrival": { "RegionID": 80, "RegionName": "یزد", "FaRegionName": null, "RegionType": null, "Code": "AZD", "ParentRegion": { "RegionID": 0, "RegionName": "یزد (استان)", "FaRegionName": "يزد (استان)", "RegionType": null, "Code": null, "ParentRegion": null } }, "DepartureDate": "2019-10-14", "PersianDepartureDate": "1398-07-22", "SearchType": "Bus" }, "Member": { "Username": "****", "Balance": 127100, "Mobile": "09363304325", "Email": "mail@gmail.com" }, "Request": { "SearchHistoryID": "a7395848-a519-4a5c-9bda-09c1b8572567", "RequestNumber": "13532209106", "CreateDate": "/Date(1570348332000)/", "CreateBy": "***", "Status": "Book", "SupplierName": "پایانه", "TimeLimit": "/Date(1570350695000)/", "TotalFare": 92800, "Manufacturer": "Payaneh", "RequestBus": { "Code": "2255", "Company": { "CompanyID": 1014, "Name": "تک سفر ایرانیان", "Logo": "https://storage.hiholiday.ir/File/AirlineLogo/1014.jpg" }, "Vehicle": { "VehicleID": 1383, "Name": "اسکانیا 32 نفره", "Manufacturer": "Scania" }, "BusType": null, "CompanyPnr": "54128756", "DepartureDate": "10/14/2019 9:15:00 PM", "Departure": { "RegionID": 1189, "RegionName": "پایانه غرب تهران", "FaRegionName": "پايانه غرب تهران", "RegionType": null, "Code": "", "ParentRegion": { "RegionID": 0, "RegionName": "تهران", "FaRegionName": "تهران", "RegionType": null, "Code": null, "ParentRegion": null } }, "Arrival": { "RegionID": 80, "RegionName": "یزد", "FaRegionName": null, "RegionType": null, "Code": "AZD", "ParentRegion": { "RegionID": 0, "RegionName": "یزد (استان)", "FaRegionName": "يزد (استان)", "RegionType": null, "Code": null, "ParentRegion": null } }, "FinalArrival": "یزد", "OthersArrival": null, "BusDetail": { "Capacity": 32, "Floor": 1, "Col": 3, "Row": 12, "Space": 2, "Seats": [ { "Status": "Free", "SeatNumber": 23, "CellNumber": 27 }, { "Status": "Free", "SeatNumber": 24, "CellNumber": 28 } ] } }, "RequestFares": [ { "PassengerCount": 2, "Type": "Sale", "BaseFare": 46400, "Commission": 0, "Markup": 0, "TotalFare": 92800 } ], "RequestPassengers": [ { "PassengerType": 0, "Gender": 0, "NationalCode": "", "FirstName": "Nikan", "LastName": "Mahmodi", "PersianFirstName": "", "PersianLastName": "", "BirthPlace": null, "PassportNumber": "", "TicketNumber": "546657874", "PassportExpireDate": null, "Nationality": "", "AreaCode": "", "CountryCode": "", "PhoneNumber": "9353303023", "Email": "office@hiholiday.ir" }, { "PassengerType": 0, "Gender": 1, "NationalCode": "", "FirstName": "leila", "LastName": "Mahmodi", "PersianFirstName": "", "PersianLastName": "", "BirthPlace": null, "PassportNumber": "", "TicketNumber": "546657874", "PassportExpireDate": null, "Nationality": "", "AreaCode": "", "CountryCode": "", "PhoneNumber": "", "Email": "" } ] }, "PassengerInput": null }

ارسال درخواست (POST)

api.hiholiday.ir/V4/bus/Requests/{ApiKey}

پارامترهای ورودی

نام فیلد	نوع	توضیحات	مثال
CreateBy	`string`	نام کاربری شما در سیستم های هالیدی که دارای دسترسی وب سرویس اتوبوس میباشد
PageSize	`int`	تعداد رکورد قابل نمایش در هر صفحه
PageNumber	`int`	شماره صفحه

معرفی فیلدهای خروجی

Requests	`List [Request]`	لیستی از مدل درخواست ها	تمامی درخواست ها برگشت داده می شود شامل آنهایی که رزرو قطعی شده و یا ناموفق بوده اند
Request.SearchHistoryID	`Guid`	کد جستجو	کد یکتا توسط سیستم تولید میشود که سوابق جستجو را نگه داری می کند و در مرحله PreReserve تولید شده
Request.RequestNumber	`string`	شماره درخواست
Request.CreateDate	`DateTime`	تاریخ و زمان ثبت درخواست
Request.CreateBy	`string`	نام کاربری درخواست کننده
Request.Status	`Enum int`	وضعیت رزرو	Search = 10, SearchResult = 2, Revalidate = 3, PreReserve = 4, Book = 1, PaymentGateway = 6, PaymentFail = 7, PaymentSuccess = 8, TicketInProcess = 9, Ticketed = 5, TicketedChanged = 11, Cancelled = 12, Expired = 13, Confirmed = 14, Waitlist = 15, ReserveInProcess = 16
Request.SupplierName	`string`	نام تامین کننده
Request.TotalFare	`decimal`	قیمت تمام شده کل رزرو
Request.Manufacturer	`Enum int`	تامین کننده
Request.RequestFares	`List[RequestFare]`	لیست نرخ ها	در این متد خالی می باشد و زمانی که متد Detail را صدا بزنید جزئیات آن پر می شود
Request.RequestBus	`Model RequestBus`	مدل مشخصات اتوبوس

خطاهای احتمالی

در خروجی متد مقداری به نام Result می باشد که شامل فیلد Type,Code,Message می باشد

Type=Success	متد به درستی کار کرده و خطایی رخ نداده
Type=Error	خطایی در هنگام اجرای متد رخ داده که در فیلد Message دلیل آن نوشته شده است
Message=ServerError	خطایی سمت سرور رخ داده که متن خطا برای مدیر پشتیبانی وب سرویس ارسال می شود
Message=NoData	لیست درخواست ها خالی می باشد
Message=UsernameIsEmpty	نام کاربری را وارد نمایید

مثال شماره یک

api.hiholiday.ir/V4/Bus/Requests/{ApiKey}

مقادیر ورودی Request Body

{ "CreateBy": "YourUsername", "PageSize": 10, "PageNumber": 1 }

مقادیر خروجی Response

خروجی آن مدل Request است

ارسال درخواست (POST)

api.hiholiday.ir/V4/bus/RequestDetail/{ApiKey}

پارامترهای ورودی

نام فیلد	نوع	توضیحات	مثال
RequestNumber	`string`		96738788528
CreateBy	`string`	نام کاربری

به این نکته توجه کنید که زمانی ممکن است در هنگام رزرو نهائی ارتباط سرور ها قطع شود و به شما پاسخی ندهد در این زمان باید این متد را صدا بزنید تا وضعیت رزرو خود را ببینید شاید رزرو شما قطعی شده باشد و از طریق این متد متوجه می شود وضعیت رزرو شما چیست.

معرفی فیلدهای خروجی

در متد های قبل توضیح داده شده

خطاهای احتمالی

در خروجی متد مقداری به نام Result می باشد که شامل فیلد Type,Code,Message می باشد

Type=Success	متد به درستی کار کرده و خطایی رخ نداده
Type=Error	خطایی در هنگام اجرای متد رخ داده که در فیلد Message دلیل آن نوشته شده است
Message=ServerError	خطایی سمت سرور رخ داده که متن خطا برای مدیر پشتیبانی وب سرویس ارسال می شود
Message=RequestNumberIsEmpty	شماره درخواست را وارد نکرده اید
Message=RequestNotFound	شماره درخواست یافت نشد

مثال شماره یک

api.hiholiday.ir/V4/bus/requestdetail/{ApiKey}

مقادیر ورودی Request Body

{ "CreateBy": "username", "RequestNumber": "17327570528" }

مقادیر خروجی Response

{ "Result": { "Type": "Success", "Message": "", "Code": 0 }, "SearchHistory": { "SearchHistoryID": "a7395848-a519-4a5c-9bda-09c1b8572567", "Departure": { "RegionID": 1189, "RegionName": "پایانه غرب تهران", "FaRegionName": "پايانه غرب تهران", "RegionType": null, "Code": "", "ParentRegion": { "RegionID": 0, "RegionName": "تهران", "FaRegionName": "تهران", "RegionType": null, "Code": null, "ParentRegion": null } }, "Arrival": { "RegionID": 80, "RegionName": "یزد", "FaRegionName": null, "RegionType": null, "Code": "AZD", "ParentRegion": { "RegionID": 0, "RegionName": "یزد (استان)", "FaRegionName": "يزد (استان)", "RegionType": null, "Code": null, "ParentRegion": null } }, "DepartureDate": "2019-10-14", "PersianDepartureDate": "1398-07-22", "SearchType": "Bus" }, "Member": { "Username": "iman", "Balance": 127100, "Mobile": "09363304318", "Email": "processor.p1@gmail.com" }, "Request": { "SearchHistoryID": "a7395848-a519-4a5c-9bda-09c1b8572567", "RequestNumber": "13532209106", "CreateDate": "/Date(1570348332000)/", "CreateBy": "iman", "Status": "Book", "SupplierName": "پایانه", "TimeLimit": "/Date(1570350695000)/", "TotalFare": 92800, "Manufacturer": "Payaneh", "RequestBus": { "Code": "2255", "Company": { "CompanyID": 1014, "Name": "تک سفر ایرانیان", "Logo": "https://storage.hiholiday.ir/File/AirlineLogo/1014.jpg" }, "Vehicle": { "VehicleID": 1383, "Name": "اسکانیا 32 نفره", "Manufacturer": "Scania" }, "BusType": null, "CompanyPnr": "54128756", "DepartureDate": "10/14/2019 9:15:00 PM", "Departure": { "RegionID": 1189, "RegionName": "پایانه غرب تهران", "FaRegionName": "پايانه غرب تهران", "RegionType": null, "Code": "", "ParentRegion": { "RegionID": 0, "RegionName": "تهران", "FaRegionName": "تهران", "RegionType": null, "Code": null, "ParentRegion": null } }, "Arrival": { "RegionID": 80, "RegionName": "یزد", "FaRegionName": null, "RegionType": null, "Code": "AZD", "ParentRegion": { "RegionID": 0, "RegionName": "یزد (استان)", "FaRegionName": "يزد (استان)", "RegionType": null, "Code": null, "ParentRegion": null } }, "FinalArrival": "یزد", "OthersArrival": null, "BusDetail": { "Capacity": 32, "Floor": 1, "Col": 3, "Row": 12, "Space": 2, "Seats": [ { "Status": "Free", "SeatNumber": 23, "CellNumber": 27 }, { "Status": "Free", "SeatNumber": 24, "CellNumber": 28 } ] } }, "RequestFares": [ { "PassengerCount": 2, "Type": "Sale", "BaseFare": 46400, "Commission": 0, "Markup": 0, "TotalFare": 92800 } ], "RequestPassengers": [ { "PassengerType": 0, "Gender": 0, "NationalCode": "", "FirstName": "Nikan", "LastName": "Mahmodi", "PersianFirstName": "", "PersianLastName": "", "BirthPlace": null, "PassportNumber": "", "TicketNumber": "546657874", "PassportExpireDate": null, "Nationality": "", "AreaCode": "", "CountryCode": "", "PhoneNumber": "9353303023", "Email": "office@hiholiday.ir" }, { "PassengerType": 0, "Gender": 1, "NationalCode": "", "FirstName": "leila", "LastName": "Mahmodi", "PersianFirstName": "", "PersianLastName": "", "BirthPlace": null, "PassportNumber": "", "TicketNumber": "546657874", "PassportExpireDate": null, "Nationality": "", "AreaCode": "", "CountryCode": "", "PhoneNumber": "", "Email": "" } ] }, "PassengerInput": null }

ارسال درخواست (POST)

api.hiholiday.ir/V4/bus/CancelInfo/{ApiKey}

پارامترهای ورودی

نام فیلد	نوع	توضیحات	مثال
RequestNumber	`string`		96738788528

خروجی این متد شامل درصد جریمه مبلغ قابل برگشت می باشد که در قالب یک مدل برگشت داده میشود

ارسال درخواست (POST)

api.hiholiday.ir/V4/bus/Cancel/{ApiKey}

پارامترهای ورودی

نام فیلد	نوع	توضیحات	مثال
RequestNumber	`string`		96738788528

خروجی این متد رزرو شما را کنسل کرده و در سیستم ثبت می کند درضد جریمه و مبلغ برگشتی به اعتبار شما برگشت داده میشود

ارسال درخواست (POST)

api.hiholiday.ir/V4/member/balance/{ApiKey}

پارامترهای ورودی

نام فیلد	نوع	توضیحات	مثال
Username	string	نام کاربری شما در های هالیدی دارای دسترسی وب سرویس اتوبوس
Password	string	رمز عبور شما در های هالیدی دارای دسترسی وب سرویس اتوبوس

معرفی فیلدهای خروجی

Balance	decimal	موجودی اعتبار فعلی

پشتیبانی

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

وب سرویس اتوبوس

اطلاعاتی که باید قبل از استفاده از وب سرویس اتوبوس بدانید

ارسال درخواست (POST)

معرفی فیلدهای خروجی

ارسال درخواست (POST)

پارامترهای ورودی

معرفی فیلدهای خروجی

مقادیر ورودی Request Body

مقادیر خروجی Response

ارسال درخواست (POST)

پارامترهای ورودی

معرفی فیلدهای خروجی

مقادیر ورودی Request Body

مقادیر خروجی Response

ارسال درخواست (POST)

پارامترهای ورودی

معرفی فیلدهای خروجی

مقادیر ورودی Request Body

مقادیر خروجی Response

ارسال درخواست (POST)

پارامترهای ورودی

معرفی فیلدهای خروجی

مقادیر ورودی Request Body

مقادیر خروجی Response

ارسال درخواست (POST)

پارامترهای ورودی

معرفی فیلدهای خروجی

خطاهای احتمالی

مقادیر ورودی Request Body

مقادیر خروجی

ارسال درخواست (POST)

پارامترهای ورودی

معرفی فیلدهای خروجی

مقادیر ورودی Request Body

مقادیر خروجی Response

ارسال درخواست (POST)

پارامترهای ورودی

معرفی فیلدهای خروجی

خطاهای احتمالی

مقادیر ورودی Request Body

مقادیر خروجی Response

ارسال درخواست (POST)

پارامترهای ورودی

معرفی فیلدهای خروجی

خطاهای احتمالی

مقادیر ورودی Request Body

مقادیر خروجی Response

ارسال درخواست (POST)

پارامترهای ورودی

ارسال درخواست (POST)

پارامترهای ورودی

ارسال درخواست (POST)

پارامترهای ورودی

معرفی فیلدهای خروجی

نرم افزار فروش بلیط اتوبوس

موتور هوشمند گردشگری مقایسه صدها آژانس هواپیمایی در لحظه، بهترین قیمت بلیط هواپیما را در سریعترین زمان بیابید.

موتور هوشمند گردشگری
مقایسه صدها آژانس هواپیمایی در لحظه، بهترین قیمت بلیط هواپیما را در سریعترین زمان بیابید.