پشتیبانی
مستندات وب سرویس هتل
وب سرویس هتلapi.hiholiday.ir/V4/Accommodation/Regions/{ApiKey}| ApiKey | Guid | |
| Search | string | نام شهر یا هتل (اختیاری) |
توجه این متد استاتیک می باشد یعنی با وارد نکردن پارامتر Search تمامی شهر هایی که هتل برای آن است نمایش داده میشود و شما باید این اطلاعات را در بانک خود ذخیره کرده و ماهی 1 بار با این متد مقایسه نمایید.(از این متد برای دریافت اطلاعات به صورت مکرر استفاده نکنید.)
| RegionID | آی دی منطقه در بانک های هالیدی. این کد در تمام سیستم یک پارچه شده و از طریق آن می توانید پرواز ها هتل ها و هر خدمات گردشگری ارائه شده در های هالیدی را از طریق وب سرویس صدا بزنید |
| RegionName | نام منطقه شهر یا کشور |
| FaRegionName | نام فارسی منطقه شهر یا کشور |
| RegionNameLong | نام کامل شامل شهر استان منطقه |
| Region.Type | Type Model |
| Region.Type.TypeTitle | نوع مقدار به عنوان مثال اگر هتل بود این مقدار می تواند اقامتگاه- هتل -هتل اپارتمان و غیره باشد |
| Region.Type.TypeID | آی دی نوع اقامتگاه |
api.hiholiday.ir/V4/Accommodation/Regions/{ApiKey}api.hiholiday.ir/V4/Accommodation/Search/{ApiKey}| نام فیلد | نوع | توضیحات | مثال |
| RegionID | int | کد منطقه که در متد Regions تمامی مناطق با کدها وجود دارند | 354 |
| Adult | int[] | آرایه عددی از تعداد اتاق و تعداد بزرگسال هر اتاق | Adult: [1] |
| Child | int[] | آرایه عددی از تعداد کودک | Child: [0] |
| ChildAge | int[] | آرایه عددی از سن کودک | Child: [0] |
| CheckinDate | string | تاریخ ورود که هم به صورت میلادی و هم شمسی می توانید ارسال نمایید | 1398-05-04 2019-10-11 |
| CheckoutDate | string | تاریخ خروج که هم به صورت میلادی و هم شمسی می توانید ارسال نمایید | 1398-05-04 2019-10-11 |
| SearchHistory | Object SearchHistory | جزئیات جستجوی جاری | |
| Accommodations | List Accommodation | لیستی از هتل ها | |
| Accommodation.AccommodationID | int | آیدی هتل | |
| Accommodation.Name | string | نام هتل | |
| Accommodation.FaName | string | نام فارسی هتل | |
| Accommodation.CheckinTime | string | ساعت ورود | |
| Accommodation.CheckoutTime | string | ساعت خروج | |
| Accommodation.Location | string | موقعیت هتل در شهر | |
| Accommodation.ThumbNailUrl | string | مسیر عکس پیش فرض | |
| Accommodation.Address | string | آدرس | |
| Accommodation.Phone | string | تلفن | |
| Accommodation.Website | string | وب سایت | |
| Accommodation.BoardPrice | decimal | قیمت بورد اتاق برای یک شب | |
| Accommodation.Price | decimal | هر شب قیمت | |
| Accommodation.TotalPrice | decimal | جمع کل شب ها | |
| Accommodation.TotalBoardPrice | decimal | جمع کل شب ها بورد | |
| Accommodation.Commission | decimal | میزان درصد کمیسیون | |
| Accommodation.StarRating | decimal | درجه هتل | |
| Accommodation.Reservable | bool | رزرو آنلاین یا آفلاین | |
| Accommodation.IsForeign | bool | داخلی یا خراجی بودن هتل | |
| Accommodation.Latitude | float | مختصات | |
| Accommodation.Longitude | float | مختصات | |
| Accommodation.Description | string | توضیحاتی در باره هتل | |
| Accommodation.DisplayMode | int | اهمیتی ندارد | |
| Accommodation.Region | Model Region | منطقه قرارگیری هتل | |
| Accommodation.Region.RegionName | string | نام منطقه |
api.hiholiday.ir/V4/Accommodation/Search/{ApiKey}api.hiholiday.ir/V4/Accommodation/Rooms/{ApiKey}| نام فیلد | نوع | توضیحات | مثال |
| RegionID | int | کد منطقه که در متد Regions تمامی مناطق با کدها وجود دارند | 354 |
| Adult | int[] | آرایه عددی از تعداد اتاق و تعداد بزرگسال هر اتاق | Adult: [1] |
| Child | int[] | آرایه عددی از تعداد کودک | Child: [0] |
| ChildAge | int[] | آرایه عددی از سن کودک | Child: [0] |
| CheckinDate | string | تاریخ ورود که هم به صورت میلادی و هم شمسی می توانید ارسال نمایید | 1398-05-04 2019-10-11 |
| CheckoutDate | string | تاریخ خروج که هم به صورت میلادی و هم شمسی می توانید ارسال نمایید | 1398-05-04 2019-10-11 |
| AccommodationRooms | Model AccommodationRoom | این فیلد اختیاری می باشد و زمانی کاربرد دارد که نیاز به دریافت اتاق خاصی از هتل را داشته باشید | "AccommodationRooms": [ { "Code":"EG-408072", "RatePlanCode":"201"}] |
| Accommodations | List Accommodation | لیستی از هتل ها | |
| Accommodation.AccommodationID | int | آیدی هتل | |
| Accommodation.Name | string | نام هتل | |
| Accommodation.CheckinTime | string | ساعت ورود | |
| Accommodation.CheckoutTime | string | ساعت خروج | |
| Accommodation.Location | string | موقعیت هتل در شهر | |
| Accommodation.ThumbNailUrl | string | مسیر عکس پیش فرض | |
| Accommodation.Address | string | آدرس | |
| Accommodation.Phone | string | تلفن | |
| Accommodation.Website | string | وب سایت | |
| Accommodation.BoardPrice | decimal | قیمت بورد اتاق برای یک شب | |
| Accommodation.Price | decimal | هر شب قیمت | |
| Accommodation.TotalPrice | decimal | جمع کل شب ها | |
| Accommodation.Commission | decimal | میزان درصد کمیسیون | |
| Accommodation.StarRating | decimal | درجه هتل | |
| Accommodation.Reservable | bool | رزرو آنلاین یا آفلاین | |
| Accommodation.IsForeign | bool | داخلی یا خراجی بودن هتل | |
| Accommodation.Latitude | float | مختصات | |
| Accommodation.Longitude | float | مختصات | |
| Accommodation.Description | string | توضیحاتی در باره هتل | |
| Accommodation.DisplayMode | int | اهمیتی ندارد | |
| Accommodation.Region | Model Region | منطقه قرارگیری هتل | |
| Accommodation.Region.RegionName | string | نام منطقه | |
| Accommodation.AccommodationRooms | List Model AccommodationRoom | مدل اتاق ها | |
| Accommodation.AccommodationRoom.Code | string | کد اتاق برای رزرو مورد استفاده می باشد | |
| Accommodation.AccommodationRoom.Name | string | نام اتاق | |
| Accommodation.AccommodationRoom.Description | string | توضیحات | |
| Accommodation.AccommodationRoom.Capacity | int | ظرفیت اتاق | |
| Accommodation.AccommodationRoom.BedType | string | نوع تخت | |
| Accommodation.AccommodationRoom.ExtraBed | int | تخت اضافه | |
| Accommodation.AccommodationRoom.ExtraBedType | string | نوع تخت اضافه | |
| Accommodation.AccommodationRoom.ThumbNailUrl | string | آدرس عکس هتل | |
| Accommodation.AccommodationRoom.Price | decimal | قیمت هر شب | |
| Accommodation.AccommodationRoom.TotalPrice | decimal | قیمت کل شبها | |
| Accommodation.AccommodationRoom.BoardPrice | decimal | قیمت بورد هتل | |
| Accommodation.AccommodationRoom.Commission | decimal | میزان کمیسیون درصد | |
| Accommodation.AccommodationRoom.Reservable | bool | امکان رزرو آنلاین یا آفلاین | |
| Accommodation.AccommodationRoom.Manufacturer | string | تامین کننده اتاق | |
| AccommodationRoom.AccommodationRoomRatePlans | List Model AccommodationRoomRatePlan | گروه های نرخی | |
| AccommodationRoomRatePlan.Code | string | کد گروه نرخی | |
| AccommodationRoomRatePlan.Name | stirng | نام گروه نرخی | |
| AccommodationRoomRatePlan.AccommodationRoomRatePlanPrices | List Model AccommodationRoomRatePlanPrice | قیمت های هر شب | |
| AccommodationRoomRatePlanPrice.Date | DateTime | تاریخ انتخابی ورود و خروج | |
| AccommodationRoomRatePlanPrice.BoardPrice | decimal | قیمت بورد هتل | |
| AccommodationRoomRatePlanPrice.Price | decimal | قیمت هر شب |
api.hiholiday.ir/V4/Accommodation/Rooms/{ApiKey}api.hiholiday.ir/V4/Accommodation/Revalidate/{ApiKey}نکته: برای استفاده از وب سرویس تست باید آدرس متدهای مربوط به رزرو شامل Revalidate - preReserve - Reserve را به شکل زیر تغییر دهید تا امکان تست فعال شود
مثال:
api.hiholiday.ir/v4/accommodation/Revalidate/YourApiKey
api.hiholiday.ir/v4/accommodationTest/Revalidate/YourApiKey
| نام فیلد | نوع | توضیحات | مثال |
| RegionID | int | کد منطقه که در متد Regions تمامی مناطق با کدها وجود دارند | 354 |
| AccommodationRooms | List Model AccommodationRoom | مدلی از هر اتاقی که قصد رزرو آن را دارید | |
| AccommodationRooms.Code | string | کد اتاق که در متد قبل قابل دریافت است | |
| AccommodationRooms.ExtraBed | int | در صورت داشتن تخت اضافه پر شود | |
| AccommodationRooms.RatePlanCode | string | کد گروه نرخی اتاق که در متد قبل دریافت شده است | |
| CheckinDate | string | تاریخ ورود که هم به صورت میلادی و هم شمسی می توانید ارسال نمایید | 1398-05-04 2019-10-11 |
| CheckoutDate | string | تاریخ خروج که هم به صورت میلادی و هم شمسی می توانید ارسال نمایید | 1398-05-04 2019-10-11 |
| Username | string | نام کاربری شما در سیستم های هالیدی | |
| Password | string | رمز عبور شما در سیستم های هالیدی |
| Accommodations | List Accommodation | لیستی از هتل ها | |
| Accommodation.AccommodationID | int | آیدی هتل | |
| Accommodation.Name | string | نام هتل | |
| Accommodation.CheckinTime | string | ساعت ورود | |
| Accommodation.CheckoutTime | string | ساعت خروج | |
| Accommodation.Location | string | موقعیت هتل در شهر | |
| Accommodation.ThumbNailUrl | string | مسیر عکس پیش فرض | |
| Accommodation.Address | string | آدرس | |
| Accommodation.Phone | string | تلفن | |
| Accommodation.Website | string | وب سایت | |
| Accommodation.BoardPrice | decimal | قیمت بورد اتاق برای یک شب | |
| Accommodation.Price | decimal | هر شب قیمت | |
| Accommodation.TotalPrice | decimal | جمع کل شب ها | |
| Accommodation.Commission | decimal | میزان درصد کمیسیون | |
| Accommodation.StarRating | decimal | درجه هتل | |
| Accommodation.Reservable | bool | رزرو آنلاین یا آفلاین | |
| Accommodation.IsForeign | bool | داخلی یا خراجی بودن هتل | |
| Accommodation.Latitude | float | مختصات | |
| Accommodation.Longitude | float | مختصات | |
| Accommodation.Description | string | توضیحاتی در باره هتل | |
| Accommodation.DisplayMode | int | اهمیتی ندارد | |
| Accommodation.Region | Model Region | منطقه قرارگیری هتل | |
| Accommodation.Region.RegionName | string | نام منطقه | |
| Accommodation.AccommodationRooms | List Model AccommodationRoom | مدل اتاق ها | |
| Accommodation.AccommodationRoom.Code | string | کد اتاق برای رزرو مورد استفاده می باشد | |
| Accommodation.AccommodationRoom.Name | string | نام اتاق | |
| Accommodation.AccommodationRoom.Description | string | توضیحات | |
| Accommodation.AccommodationRoom.Capacity | int | ظرفیت اتاق | |
| Accommodation.AccommodationRoom.BedType | string | نوع تخت | |
| Accommodation.AccommodationRoom.ExtraBed | int | تخت اضافه | |
| Accommodation.AccommodationRoom.ExtraBedType | string | نوع تخت اضافه | |
| Accommodation.AccommodationRoom.ThumbNailUrl | string | آدرس عکس هتل | |
| Accommodation.AccommodationRoom.Price | decimal | قیمت هر شب | |
| Accommodation.AccommodationRoom.TotalPrice | decimal | قیمت کل شبها | |
| Accommodation.AccommodationRoom.BoardPrice | decimal | قیمت بورد هتل | |
| Accommodation.AccommodationRoom.Commission | decimal | میزان کمیسیون درصد | |
| Accommodation.AccommodationRoom.Reservable | bool | امکان رزرو آنلاین یا آفلاین | |
| Accommodation.AccommodationRoom.Manufacturer | string | تامین کننده اتاق | |
| AccommodationRoom.AccommodationRoomRatePlans | List Model AccommodationRoomRatePlan | گروه های نرخی | |
| AccommodationRoomRatePlan.Code | string | کد گروه نرخی | |
| AccommodationRoomRatePlan.Name | stirng | نام گروه نرخی | |
| AccommodationRoomRatePlan.AccommodationRoomRatePlanPrices | List Model AccommodationRoomRatePlanPrice | قیمت های هر شب | |
| AccommodationRoomRatePlanPrice.Date | DateTime | تاریخ انتخابی ورود و خروج | |
| AccommodationRoomRatePlanPrice.BoardPrice | decimal | قیمت بورد هتل | |
| AccommodationRoomRatePlanPrice.Price | decimal | قیمت هر شب |
api.hiholiday.ir/V4/Accommodation/Revalidate/{ApiKey}api.hiholiday.ir/V4/Accommodation/PreReserve/{ApiKey}| نام فیلد | نوع | توضیحات | مثال |
| SessionID | int | کد جستجو تولید شده در متد قبل | SearchHistoryID |
| 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.Name | string | نام اتاق | |
| Request.RequestFare.Type | string | همیشه ثابت است | |
| Request.RequestFare.BaseFare | decimal | نرخ بورد هتل برای 1 اتاق | |
| Request.RequestFare.Commission | decimal | کمیسیون | |
| Request.RequestFare.Markup | decimal | کارمزد رزرو اتاق | |
| Request.RequestPassengers | List Model RequestPassenger | در متد بعد این اطلاعات پر می شود در حال حاظر لیست نشان دهنده تعداد مسافران مورد نیاز است | |
| Request.RequestAccommodation | Model RequestAccommodation | مدل رزرو هتل | |
| RequestAccommodation.AccommodationID | int | ||
| RequestAccommodation.Name | string | ||
| RequestAccommodation.CheckinTime | string | ||
| RequestAccommodation.CheckoutTime | string | ||
| RequestAccommodation.Location | string | ||
| RequestAccommodation.Address | string | ||
| RequestAccommodation.StarRating | decimal | ||
| RequestAccommodation.Region | Model Region | منطقه قرارگیری هتل | |
| Accommodation.Region.RegionName | string | نام منطقه | |
| RequestAccommodationRooms | List Model RequestAccommodationRoom | مدل اتاق ها انتخابی برای رزرو | |
| RequestAccommodationRooms.Code | string | کد اتاق برای رزرو مورد استفاده می باشد | |
| RequestAccommodationRooms.Name | string | نام اتاق | |
| RequestAccommodationRooms.Capacity | int | ظرفیت اتاق | |
| Member | Model Member | اطلاعات کاربری سرویس گیرنده | مشخصات و موجودی اعتبار اکانت سرویس گیرنده را مشخص می کند |
| Member.Username | string | ||
| Member.Balance | decimal | موجودی نقدی اکانت شما برای خرید | |
| Member.Mobile | string | راه ارتباطی های هالیدی با سرویس گیرنده | |
| Member.Email | string | راه ارتباطی های هالیدی با سرویس گیرنده | |
| PassengerInput | Model PassengerInput | اطلاعات دریافتی از مسافران | از طریق این مدل می توانید مشخص کنید تامین کننده هتل کدام اطلاعات را برای رزرو هتل نیاز دارد تا از دریافت اطلاعات اضافه از مسافران جلوگیری کنید |
| PassengerInput.PassengerType | bool | گروه سنی | |
| 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 | تاریخ تولد |
api.hiholiday.ir/V4/Accommodation/PreReserve/{ApiKey}api.hiholiday.ir/V4/Accommodation/Book/{ApiKey}| نام فیلد | نوع | توضیحات | مثال |
| RequestNumber | string | شماره درخواست که در متد قبل تولید شده | 96738788528 |
| SpecialRequest | string | درخواست های اضافه یا توضیحات خود را در این فیلد پر کنید | |
| RequestPassengers | List [RequestPassenger] | لیست از مشخصات مسافران مطابق با مدل RequestPassenger | |
| RequestPassenger.FirstName | string | نام انگلیسی | |
| RequestPassenger.LastName | string | نام خانوادگی انگلیسی | |
| RequestPassenger.PersianFirstName | string | نام | |
| RequestPassenger.PersianLastName | string | نام خانوادگی | |
| RequestPassenger.PassengerTitle | Enum int | Mr=0 Mrs=1 | |
| 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 |
| 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.Name | string | نام اتاق | |
| Request.RequestFare.Type | string | همیشه ثابت است | |
| Request.RequestFare.BaseFare | decimal | نرخ بورد هتل برای 1 اتاق | |
| Request.RequestFare.Commission | decimal | کمیسیون | |
| Request.RequestFare.Markup | decimal | کارمزد رزرو اتاق | |
| Request.RequestPassengers | List Model RequestPassenger | ||
| Request.RequestAccommodation | Model RequestAccommodation | مدل رزرو هتل | |
| RequestAccommodation.AccommodationID | int | ||
| RequestAccommodation.Name | string | ||
| RequestAccommodation.CheckinTime | string | ||
| RequestAccommodation.CheckoutTime | string | ||
| RequestAccommodation.Location | string | ||
| RequestAccommodation.Address | string | ||
| RequestAccommodation.StarRating | decimal | ||
| RequestAccommodation.Region | Model Region | منطقه قرارگیری هتل | |
| Accommodation.Region.RegionName | string | نام منطقه | |
| RequestAccommodationRooms | List Model RequestAccommodationRoom | مدل اتاق ها انتخابی برای رزرو | |
| RequestAccommodationRooms.Code | string | ||
| RequestAccommodationRooms.Name | string | نام اتاق | |
| RequestAccommodationRooms.Capacity | int | ظرفیت اتاق | |
| Member | Model Member | اطلاعات کاربری سرویس گیرنده | مشخصات و موجودی اعتبار اکانت سرویس گیرنده را مشخص می کند |
| Member.Username | string | ||
| Member.Balance | decimal | موجودی نقدی اکانت شما برای خرید | |
| Member.Mobile | string | راه ارتباطی های هالیدی با سرویس گیرنده | |
| Member.Email | string | راه ارتباطی های هالیدی با سرویس گیرنده |
در خروجی متد مقداری به نام Result می باشد که شامل فیلد Type,Code,Message می باشد
| Type=Success | متد به درستی کار کرده و خطایی رخ نداده |
| Type=Error | خطایی در هنگام اجرای متد رخ داده که در فیلد Message دلیل آن نوشته شده است |
| Message=RequestNumberIsEmpty | شماره درخواست را وارد نکرده اید |
| Message=RequestPassengersIsEmpty | مشخصات مسافران وارد نکرده اید |
| Message=RequestNotFound | شماره درخواست یافت نشد |
| Message=RequestNumberTerminated | وضعیت درخواست جاری برای این متد نمی باشد |
| Message=AccessDenied | دسترسی شما به این متد وجود ندارد |
| Message=LowBalance | موجودی اکانت شما کمتر از رزرو میباشد |
| Message=DateOfBirthNotValid | تاریخ تولد اشتباه وارد شده است |
| Message=EnglishFirstNameOrLastNameIsNonEnglish | مشخصات انگلیسی اشتباه وارد شده است |
| Message=PersianFirstNameOrLastNameIsNonPersian | مشخصات فارسی اشتباه وارد شده است |
| Message=NationalCodeIsRequired | کد ملی الزامی میباشد |
| Message=NationalCodeNotValid | کد ملی اشتباه وارد شده است |
| Message=PassportNumberIsRequired | شماره پاسپورت الزامی می باشد |
| Message=HttpError | قطعی سرور یا تامین کننده |
| Message=ServerError | خطایی سمت سرور رخ داده که متن خطا برای مدیر پشتیبانی وب سرویس ارسال می شود |
api.hiholiday.ir/V4/Accommodation/Book/{ApiKey}api.hiholiday.ir/V4/Accommodation/Reserve/{ApiKey}| نام فیلد | نوع | توضیحات | مثال |
| RequestNumber | string | 96738788528 |
| 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.Name | string | نام اتاق | |
| Request.RequestFare.Type | string | همیشه ثابت است | |
| Request.RequestFare.BaseFare | decimal | نرخ بورد هتل برای 1 اتاق | |
| Request.RequestFare.Commission | decimal | کمیسیون | |
| Request.RequestFare.Markup | decimal | کارمزد رزرو اتاق | |
| Request.RequestPassengers | List Model RequestPassenger | در متد بعد این اطلاعات پر می شود در حال حاظر لیست نشان دهنده تعداد مسافران مورد نیاز است | |
| Request.RequestAccommodation | Model RequestAccommodation | مدل رزرو هتل | |
| RequestAccommodation.AccommodationID | int | ||
| RequestAccommodation.Name | string | ||
| RequestAccommodation.CheckinTime | string | ||
| RequestAccommodation.CheckoutTime | string | ||
| RequestAccommodation.Location | string | ||
| RequestAccommodation.Address | string | ||
| RequestAccommodation.StarRating | decimal | ||
| RequestAccommodation.Region | Model Region | منطقه قرارگیری هتل | |
| Accommodation.Region.RegionName | string | نام منطقه | |
| RequestAccommodationRooms | List Model RequestAccommodationRoom | مدل اتاق ها انتخابی برای رزرو | |
| RequestAccommodationRooms.Code | string | ||
| RequestAccommodationRooms.Name | string | نام اتاق | |
| RequestAccommodationRooms.Capacity | int | ظرفیت اتاق | |
| Member | Model Member | اطلاعات کاربری سرویس گیرنده | مشخصات و موجودی اعتبار اکانت سرویس گیرنده را مشخص می کند |
| Member.Username | string | ||
| Member.Balance | decimal | موجودی نقدی اکانت شما برای خرید | |
| Member.Mobile | string | راه ارتباطی های هالیدی با سرویس گیرنده | |
| Member.Email | string | راه ارتباطی های هالیدی با سرویس گیرنده |
api.hiholiday.ir/V4/Accommodation/Reserve/{ApiKey}api.hiholiday.ir/V4/Accommodation/Requests/{ApiKey}| نام فیلد | نوع | توضیحات | مثال |
| CreateBy | string | نام کاربری شما در سیستم های هالیدی که دارای دسترسی وب سرویس هتل میباشد | |
| PageSize | int | تعداد رکورد قابل نمایش در هر صفحه | |
| PageNumber | int | شماره صفحه |
| Requests | List [Request] | لیستی از مدل درخواست ها | تمامی درخواست ها برگشت داده می شود شامل آنهایی که رزرو قطعی شده و یا ناموفق بوده اند |
| Request.SearchHistoryID | Guid | کد جستجو | کد یکتا توسط سیستم تولید میشود که سوابق جستجو را نگه داری می کند و در مرحله PreReserve تولید شده |
| Request.RequestNumber | string | شماره درخواست | شماره درخواست که در مرحله PreReserve تولید شده و یکتا می باشد |
| Request.CreateDate | DateTime | تاریخ و زمان ثبت درخواست | |
| Request.CreateBy | string | نام کاربری درخواست کننده | |
| Request.Status | Enum int | وضعیت رزرو | PreReserve = 4 Book = 1 PaymentGateway = 6 PaymentFail = 7 PaymentSuccess = 8 Cancelled = 12 Expired = 13 Confirmed = 14 Waitlist = 15 ReserveInProcess = 16 |
| Request.SupplierName | string | نام تامین کننده | |
| Request.TimeLimit | DateTime | مدت زمان اعتبار رزرو | در این متد اهمیتی ندارد |
| Request.TotalFare | decimal | قیمت تمام شده کل رزرو | |
| Request.Manufacturer | Enum int | تامین کننده | PasargadInsurance = 21 SamanInsurance=16 |
| Request.RequestFares | List[RequestFare] | لیست نرخ ها | در ایم متد خالی می باشد و زمانی که متد Detail را صدا بزنید جزئیات آن پر می شود |
| Request.RequestAccommodation | Model RequestAccommodation | مدل مشخصات بیمه |
در خروجی متد مقداری به نام Result می باشد که شامل فیلد Type,Code,Message می باشد
| Type=Success | متد به درستی کار کرده و خطایی رخ نداده |
| Type=Error | خطایی در هنگام اجرای متد رخ داده که در فیلد Message دلیل آن نوشته شده است |
| Message=ServerError | خطایی سمت سرور رخ داده که متن خطا برای مدیر پشتیبانی وب سرویس ارسال می شود |
| Message=NoData | لیست درخواست ها خالی می باشد |
| Message=UsernameIsEmpty | نام کاربری را وارد نمایید |
api.hiholiday.ir/V4/Insurance/Requests/{ApiKey}api.hiholiday.ir/V4/Accommodation/RequestDetail/{ApiKey}| نام فیلد | نوع | توضیحات | مثال |
| RequestNumber | string | 96738788528 | |
| CreateBy | string | نام کاربری |
| Request.SearchHistoryID | Guid | کد جستجو | |
| Request.RequestNumber | string | شماره درخواست | |
| Request.CreateDate | DateTime | تاریخ و زمان ثبت درخواست | |
| Request.CreateBy | string | نام کاربری درخواست کننده | |
| Request.Status | Enum int | وضعیت رزرو | PreReserve = 4 Book = 1 PaymentGateway = 6 PaymentFail = 7 PaymentSuccess = 8 Cancelled = 12 Expired = 13 Confirmed = 14 Waitlist = 15 ReserveInProcess = 16 |
| Request.SupplierName | string | نام تامین کننده | |
| Request.TimeLimit | DateTime | مدت زمان اعتبار رزرو | در این متد اهمیتی ندارد |
| Request.TotalFare | decimal | قیمت تمام شده کل رزرو | |
| Request.Manufacturer | Enum int | تامین کننده | |
| Request.RequestFares | List[RequestFare] | لیست نرخ ها | |
| Request.RequestFare.Type | string | گروه نرخ | همیشه Sale می باشد |
| Request.RequestFare.BaseFare | decimal | نرخ پایه | برای هر نفر |
| Request.RequestFare.Commission | decimal | کمیسیون | برای هر نفر |
| Request.RequestFare.Markup | decimal | کارمزد | برای هر نفر |
| Request.RequestFare.PassengerCount | int | تعداد نفرات | |
| Request.RequestFare.PassengerType | Enum int | گروه سنی | Adt=0 Chd=1 Inf=2 Any=3 |
| Request.RequestFare.TotalFare | decimal | جمع کل رکورد | |
| Request.RequestFare.Tax | decimal | مالیات | |
| Request.RequestPassengers | List [RequestPassenger] | اطلاعات مسافران | مشخصات مسافران |
| Request.RequestPassenger.DateOfBirth | DateTime | تاریخ تولد | |
| Request.RequestPassenger.PassengerTitle | Enum int | نوع مسافر | Mr=0 Mrs=1 |
| Request.RequestPassenger.PassengerType | Enum int | گروه سنی | Adt=0 Chd=1 Inf=2 Any=3 |
| Request.RequestPassenger.Gender | Enum int | جنسیت | Male=0 Female=1 |
| Request.RequestPassenger.NationalCode | string | کد ملی | |
| Request.RequestPassenger.FirstName | string | نام انگلیسی | |
| Request.RequestPassenger.LastName | string | نام خانوادگی انگلیسی | |
| Request.RequestPassenger.PersianFirstName | string | نام | |
| Request.RequestPassenger.PersianLastName | string | نام خانوادگی | |
| Request.RequestPassenger.BirthPlace | string | محل تولد | |
| Request.RequestPassenger.PassportNumber | string | شماره پاسپورت |
در خروجی متد مقداری به نام Result می باشد که شامل فیلد Type,Code,Message می باشد
| Type=Success | متد به درستی کار کرده و خطایی رخ نداده |
| Type=Error | خطایی در هنگام اجرای متد رخ داده که در فیلد Message دلیل آن نوشته شده است |
| Message=ServerError | خطایی سمت سرور رخ داده که متن خطا برای مدیر پشتیبانی وب سرویس ارسال می شود |
| Message=RequestNumberIsEmpty | شماره درخواست را وارد نکرده اید |
| Message=RequestNotFound | شماره درخواست یافت نشد |
api.hiholiday.ir/V4/Accommodation/RequestDetail/{ApiKey}http://Api.HiHoliday.ir/V4/Accommodation/Files/{ApiKey}| نام فیلد | نوع | توضیحات | مثال |
PropertyName | string | مشخص کنند عکس های هتل یا اتاق | Accommodation Or AccommodationRoom |
| PropertyID | int | ایدی هتل یا اتاق | 732 |
| Accommodation.AccommodationFiles | List Model AccommodationFile | شامل لیستی از مدل | |
| AccommodationFile.FileID | int | ای دی فایل | |
| AccommodationFile.PropertyName | string | مشخص کننده عکس هتل یا عکس اتاق | |
| AccommodationFile.Caption | string | توضیح عکس | |
| AccommodationFile.Url | string | آدرس فایل | |
| AccommodationFile.Type | Type Model | مدل دسته بندی | |
| AccommodationFile.Type.TypeID | int | ای دی دسته بندی | 14 |
| AccommodationFile.Type.TypeTitle | string | دسته بندی فایل(مثال: عکس فیلم نقشه...) | عکس |
http://Api.HiHoliday.ir/V4/Accommodation/Files/{ApiKey}http://Api.HiHoliday.ir/V4/Accommodation/Policy/{ApiKey}| نام فیلد | نوع | توضیحات | مثال |
| AccommodationID | int | ایدی هتل | 732 |
| Accommodation.AccommodationPolicy | List Model AccommodationPolicy | مدل | |
| Accommodation.AccommodationPolicy.AccommodationID | int | ای دی توضیحات | |
| Accommodation.AccommodationPolicy.Description | string | توضیحات قوانین |
http://Api.HiHoliday.ir/V4/Accommodation/Policy/{ApiKey}http://Api.HiHoliday.ir/V4/Accommodation/Policy/{ApiKey}| نام فیلد | نوع | توضیحات | مثال |
| AccommodationID | int | ایدی هتل | 732 |
| Accommodation.AccommodationFacilities | List Model AccommodationPolicy | مدل | |
| Accommodation.AccommodationFacilities.AccommodationFacilityID | int | ای دی امکانات | |
| Accommodation.AccommodationFacilities.Description | string | توضیحات امکانات | |
| Accommodation.AccommodationFacilities.DisplayMode | string | اصولا امکاناتی که مهم هستند را با عدد 1 مشخص می کنیم | |
| Accommodation.AccommodationFacilities.AccommodationID | string | ای دی هتل | |
| Accommodation.AccommodationFacilities.AccommodationRoomID | string | در صورتی که امکانات برای اتاق باشد ایدی اتاق | |
| Accommodation.AccommodationFacilities.Type | Model | دسته بندی | شامل نام امکانات و ایدی ان |
http://Api.HiHoliday.ir/V4/Accommodation/Policy/{ApiKey}http://Api.HiHoliday.ir/V4/Accommodation/Detail/{ApiKey}| نام فیلد | نوع | توضیحات | مثال |
| AccommodationID | int | ای دی هتل | 354 |
| Adult | int[] | آرایه عددی از تعداد اتاق و تعداد بزرگسال هر اتاق | Adult: [1] |
| Child | int[] | آرایه عددی از تعداد کودک | Child: [0] |
| ChildAge | int[] | آرایه عددی از سن کودک | Child: [0] |
| CheckinDate | string | تاریخ ورود که هم به صورت میلادی و هم شمسی می توانید ارسال نمایید | 1398-05-04 2019-10-11 |
| CheckoutDate | string | تاریخ خروج که هم به صورت میلادی و هم شمسی می توانید ارسال نمایید | 1398-05-04 2019-10-11 |
http://Api.HiHoliday.ir/V4/Accommodation/Detail/{ApiKey}هتل اوین یکی از زیباترین هتلهای 4 ستاره ایران در منطقهای خوش آب و هوا در شمال تهران و در تقاطع بزرگراه چمران و اتوبان یادگار امام واقع شده است . موقعیت مکانی هتل نسبت به بزرگراههای مختلف، دسترسی به فرودگاه، مرکز شهر و نمایشگاه بینالمللی را آسان نموده است
", "DisplayMode": 0, "Region": { "RegionID": 107, "RegionName": "Tehran", "FaRegionName": "تهران", "RegionNameLong": null, "Code": "THR", "Type": null }, "AccommodationRooms": [ { "Code": "HHA-5711", "Name": "یک تخته", "Description": "", "Capacity": 1, "BedType": "", "ExtraBed": 0, "ExtraBedType": "", "ThumbNailUrl": "NULL", "BoardPrice": 0, "Price": 0, "TotalPrice": 0, "TotalBoardPrice": 0, "Commission": 0, "Reservable": false, "Manufacturer": "HH", "AccommodationRoomRatePlans": [], "AccommodationRoomFacilities": null }, { "Code": "HHA-5712", "Name": "دو تخته دبل", "Description": "", "Capacity": 2, "BedType": "", "ExtraBed": 1, "ExtraBedType": "", "ThumbNailUrl": "https://storage.hiholiday.ir/file/hotel/accommodationroom/tehran-parsian-evin-hotel-double-room.jpg", "BoardPrice": 0, "Price": 0, "TotalPrice": 0, "TotalBoardPrice": 0, "Commission": 0, "Reservable": false, "Manufacturer": "HH", "AccommodationRoomRatePlans": [], "AccommodationRoomFacilities": null }, { "Code": "HHA-5713", "Name": "سوییت معمولی", "Description": "", "Capacity": 2, "BedType": "", "ExtraBed": 2, "ExtraBedType": "", "ThumbNailUrl": "https://storage.hiholiday.ir/file/hotel/accommodationroom/tehran-parsian-evin-hotel-normal-suite.jpg", "BoardPrice": 0, "Price": 0, "TotalPrice": 0, "TotalBoardPrice": 0, "Commission": 0, "Reservable": false, "Manufacturer": "HH", "AccommodationRoomRatePlans": [], "AccommodationRoomFacilities": null }, { "Code": "HHA-5714", "Name": "سوییت رویال", "Description": "", "Capacity": 2, "BedType": "", "ExtraBed": 3, "ExtraBedType": "", "ThumbNailUrl": "https://storage.hiholiday.ir/file/hotel/accommodationroom/tehran-parsian-evin-hotel-large-suite.jpg", "BoardPrice": 0, "Price": 0, "TotalPrice": 0, "TotalBoardPrice": 0, "Commission": 0, "Reservable": false, "Manufacturer": "HH", "AccommodationRoomRatePlans": [], "AccommodationRoomFacilities": null }, { "Code": "HHA-5715", "Name": "دو تخته توئین", "Description": "", "Capacity": 2, "BedType": "", "ExtraBed": 1, "ExtraBedType": "", "ThumbNailUrl": "https://storage.hiholiday.ir/file/hotel/accommodationroom/tehran-parsian-evin-hotel-twin-room.jpg", "BoardPrice": 0, "Price": 0, "TotalPrice": 0, "TotalBoardPrice": 0, "Commission": 0, "Reservable": false, "Manufacturer": "HH", "AccommodationRoomRatePlans": [], "AccommodationRoomFacilities": null }, { "Code": "HHA-5716", "Name": "استاندارد یک تخته", "Description": "", "Capacity": 1, "BedType": "", "ExtraBed": 1, "ExtraBedType": "", "ThumbNailUrl": "", "BoardPrice": 0, "Price": 0, "TotalPrice": 0, "TotalBoardPrice": 0, "Commission": 0, "Reservable": false, "Manufacturer": "HH", "AccommodationRoomRatePlans": [], "AccommodationRoomFacilities": null } ], "AccommodationFacilities": [ { "AccommodationFacilityID": 11475, "Description": "", "Type": { "TypeID": 11828, "TypeTitle": "اتاق سیگار" } }, { "AccommodationFacilityID": 11477, "Description": "", "Type": { "TypeID": 11768, "TypeTitle": "بازرچه خرید" } }, { "AccommodationFacilityID": 11466, "Description": "", "Type": { "TypeID": 11634, "TypeTitle": "برق اضطراری" } }, { "AccommodationFacilityID": 11480, "Description": "", "Type": { "TypeID": 12253, "TypeTitle": "پارکینگ (رایگان)" } }, { "AccommodationFacilityID": 11461, "Description": "امکان کرایه اتوموبیل ", "Type": { "TypeID": 11594, "TypeTitle": "ترانسفر" } }, { "AccommodationFacilityID": 11476, "Description": "", "Type": { "TypeID": 11738, "TypeTitle": "دستگاه فتوکپی و پرینت" } }, { "AccommodationFacilityID": 11478, "Description": "", "Type": { "TypeID": 11837, "TypeTitle": "سالن زیبایی" } }, { "AccommodationFacilityID": 11474, "Description": "خرید لوازم به صورت رایگان", "Type": { "TypeID": 11813, "TypeTitle": "فروشگاه" } }, { "AccommodationFacilityID": 11481, "Description": "", "Type": { "TypeID": 11715, "TypeTitle": "فضای سبز" } }, { "AccommodationFacilityID": 11471, "Description": "", "Type": { "TypeID": 11871, "TypeTitle": "ویلچر" } } ], "AccommodationPolicy": { "AccommodationID": 37, "Description": "قانون کنسلی هتل