Master-Interlook:HotelService — различия между версиями

Материал из Megatec
Перейти к: навигация, поиск
[непроверенная версия][досмотренная версия]
(→‎SearchBookingsJSON (Получение списка забронированных заявок в формате JSON))
(→‎ManageBooking (Передача изменений по услуге проживания в Interlook))
Строка 600: Строка 600:
 
===ManageBooking (Передача изменений по услуге проживания в Interlook)===
 
===ManageBooking (Передача изменений по услуге проживания в Interlook)===
 
Принимаемые параметры запроса ( '''*''' – обязательный):
 
Принимаемые параметры запроса ( '''*''' – обязательный):
−
* '''ManageBooking>
+
* '''guid *''' – идентификатор аутентификации (возвращается при запросе к методу [[Master-Interlook:HotelService#Connect (получение аутентификационного токена)|Connect]])<br />
−
** '''guid *''' – идентификатор аутентификации (возвращается при запросе к методу [[Master-Interlook:HotelService#Connect (получение аутентификационного токена)|Connect]])<br />
+
* '''hotelServiceId *''' – ключ услуги проживания (возвращается при запросе к методу [[Master-Interlook:HotelService#SearchBookings (Получение списка забронированных заявок)|SearchBookings]])<br />
−
** '''hotelServiceId *''' – ключ услуги проживания (возвращается при запросе к методу [[Master-Interlook:HotelService#SearchBookings (Получение списка забронированных заявок)|SearchBookings]])<br />
+
* '''status''' – фильтр для отбора услуг с определенным статусом (1 - Wait, 2 - Confirmed, 3 - notConfirmed)
−
** '''status''' – фильтр для отбора услуг с определенным статусом (1 - Wait, 2 - Confirmed, 3 - notConfirmed)
+
* '''message''' – сообщение для пользователя Interlook
−
** '''message''' – сообщение для пользователя Interlook
+
* '''hotelWorkStatus''' – отметка отеля по заявке (true - отель взял заявку в работу, false - отель заявку в работу не взял). При отправке этого параметра формируется запись в историю по заявке и сообщение от провайдера.  
−
** '''hotelWorkStatus''' – отметка отеля по заявке (true - отель взял заявку в работу, false - отель заявку в работу не взял). При отправке этого параметра формируется запись в историю по заявке и сообщение от провайдера.  
 
  
 
Возвращаемый результат:
 
Возвращаемый результат:

Версия 15:37, 23 марта 2022

Версия статьи от 23-03-2022.

Поддерживаемые версии «»:
Начиная с


Введение

Сервис InterlookHotelService работает с методами REST API. Для вызова методов REST API можно использовать SoapUi.

Предупреждение


Для доступа к сервису у онлайн пользователя должен быть установлен признак Hotel/Service в настройке Person connection и в настройках Role активирован параметр Show hotel reservations by date.


Методы HotelService

Методы аутентификации

Connect (Получение аутентификационного токена)

Принимаемые параметры запроса ( * – обязательный):

  • Login * – логин online пользователя
  • Password * – пароль online пользователя

Возвращаемый результат:

  • ConnectResult – идентификатор аутентификации (если аутентификация прошла успешно. то получаем идентификатор, в противном случае результат -1)
развернутьПример


CheckConnect (Проверка активности подключения под конкретным идентификатором)

Метод проверяет наличие активного подключения под конкретным идентификатором аутентификации.
Принимаемые параметры запроса ( * – обязательный):

  • Guid * – идентификатор аутентификации (возвращается при запросе к методу Connect)

Возвращаемый результат:

  • CheckConnectResult – идентификатор аутентификации (true – если подключение активно, false – если подключения нет)
развернутьПример


Методы поиска

SearchBookings (Получение списка забронированных заявок)

Метод предназначен для поиска забронированных заявок. Отбираются те заявки, у которых партнер предоставления услуги совпадает с партнером для логина, под которым осуществляется поиск.
Принимаемые параметры запроса ( * – обязательный):

  • Guid * – идентификатор аутентификации (возвращается при запросе к методу Connect)
  • hotelID – массив данных с ключами отелей. Можно передавать как один так и несколько ключей отелей. Если не передаём данный параметр, то в ответ получаем все заказы, подходящие под выбранные даты.
  • dateInfo * – по какой дате осуществлять поиск (1 - дата создания заявки, 2 - дата заезда в отель, 3 - дата выезда из отеля)
  • dateFrom * – дата начала
  • dateTo * – дата окончания
  • checkInFrom – дата заезда от
  • checkInTo – дата заезда по
  • New – возвращает новые бронирования с датой, попадающей в указанное выше условие
  • change – возвращает измененные бронирования с изменениями, внесенными в выбранный период
  • cancel – возвращает информацию об отмененных бронированиях за выбранный период

Возвращаемый результат:

    • BookingInfo – массив данных брони
      • Booking – номер брони в системе Interlook
      • BookingID – ключ заявки из базы данных
      • Action – новая, отмененная или измененная заявка
      • CreationDate – дата создания услуги в заявке
      • ChangeDate – не используется
      • CancelDate – не используется
      • CustomerMarket – данные туроператора, оформившего заявку
        • CustomerMarketId – ключ туроператора, оформившего заявку
        • CustomerMarketName – имя туроператора, оформившего заявку
      • HotelServices – массив данных по сервисам отелей
        • HotelServiceInfo – информация по сервису отеля
          • HotelServiceId – ключ сервиса отеля
          • HotelServiceName – имя сервиса отеля
          • Hotel – массив данных по отелям
            • HotelId – ключ отеля
            • HotelName – имя отеля
          • Pansion – тип питания
            • PansionId – ключ питания
            • PansionName – имя питания
          • RoomType – тип номера
            • RoomTypeId – ключ типа номера
            • RoomTypeName – имя типа номера
          • RoomAccomodation – тип размещения
            • AccommodationId – ключ типа размещения
            • AccommodationName – имя типа размещения
          • RoomCategory – категория номер
            • RoomCategoryId – ключ категории номера
            • RoomCategoryName – имя категории номера
          • Status – статус по услуге проживания
            • StatusId – ключ статуса по услуге проживания
            • StatusName – имя статуса по услуге проживания
          • CheckIn – дата заезда в отель
          • CheckOut – дата выезда из отеля
          • Tourists – массив данных туристов
            • TouristInfo – массив данных по туристу
              • Name – имя туриста
              • BirthDate – дата рождения туриста
              • Sex – пол туриста
              • HotelServiceId – ключ услуги проживания с которой связан турист
          • CostOffers – массив данных по CostOffers, по которым рассчитана цена услуги
            • CostOfferInfo – массив данных по конкретному CostOffer
              • CostOfferName – название CostOffer (Если заявка не аннулирована, то выводим название CostOffer по цене netto. Если заявка аннулирована со штрафами, то выводим название CostOffer по цене брутто. Если заявка аннулирована без штрафов, то выводим текст "Canceled without penalty")
              • CostOfferDateBegin – дата начала действия CostOffer
              • CostOfferDateEnd – дата окончания действия CostOffer
              • CostOfferDuration – продолжительность проживания до данному CostOffer
          • Penalty – информация о штрафах по аннулированной заявке
      • MessageInfo – массив данных сообщений
        • Id – идентификатор сообщения
        • IsOutgoing – исходящее (true - исходящее, false - входящее)
        • DateCreate – дата создания сообщения
        • IsRead – прочитано (true - прочитано, false - не прочитано )
        • Text – текст сообщения
развернутьПример


SearchBookingsJSON (Получение списка забронированных заявок в формате JSON)

Метод предназначен для поиска забронированных заявок. Отбираются те заявки, у которых партнер предоставления услуги совпадает с партнером для логина, под которым осуществляется поиск.
Принимаемые параметры запроса ( * – обязательный):

  • Guid * – идентификатор аутентификации (возвращается при запросе к методу Connect)
  • hotelID – массив данных с ключами отелей. Можно передавать как один так и несколько ключей отелей. Если не передаём данный параметр, то в ответ получаем все заказы, подходящие под выбранные даты.
  • dateInfo * – по какой дате осуществлять поиск (1 - дата создания заявки, 2 - дата заезда в отель, 3 - дата выезда из отеля)
  • dateFrom * – дата начала
  • dateTo * – дата окончания
  • checkInFrom – дата заезда от
  • checkInTo – дата заезда по
  • New – возвращает новые бронирования с датой, попадающей в указанное выше условие
  • change – возвращает измененные бронирования с изменениями, внесенными в выбранный период
  • cancel – возвращает информацию об отмененных бронированиях за выбранный период

Возвращаемый результат:

  • Booking – номер брони в системе Interlook
  • BookingID – ключ заявки из базы данных
  • Action – новая, отмененная или измененная заявка
  • CreationDate – дата создания услуги в заявке
  • ChangeDate – не используется
  • CancelDate – не используется
  • CustomerMarket – данные туроператора, оформившего заявку
    • CustomerMarketId – ключ туроператора, оформившего заявку
    • CustomerMarketName – имя туроператора, оформившего заявку
  • HotelServices – массив данных по сервисам отелей
    • CheckIn – дата заезда в отель
    • CheckOut – дата выезда из отеля
    • Tourists – массив данных туристов
        • Name – имя туриста
        • BirthDate – дата рождения туриста
        • Sex – пол туриста
        • HotelServiceId – ключ услуги проживания с которой связан турист
    • Notes – не указывается
      • HotelServiceId – ключ сервиса отеля
      • HotelServiceName – имя сервиса отеля
      • Hotel – массив данных по отелям
        • HotelId – ключ отеля
        • HotelName – имя отеля
      • Pansion – тип питания
        • PansionId – ключ питания
        • PansionName – имя питания
      • RoomType – тип номера
        • RoomTypeId – ключ типа номера
        • RoomTypeName – имя типа номера
      • RoomAccomodation – тип размещения
        • AccommodationId – ключ типа размещения
        • AccommodationName – имя типа размещения
      • RoomCategory – категория номер
        • RoomCategoryId – ключ категории номера
        • RoomCategoryName – имя категории номера
      • Status – статус по услуге проживания
        • StatusId – ключ статуса по услуге проживания
        • StatusName – имя статуса по услуге проживания
          • CheckIn – дата заезда в отель
          • CheckOut – дата выезда из отеля
          • Tourists – массив данных туристов
            • TouristInfo – массив данных по туристу
              • Name – имя туриста
              • BirthDate – дата рождения туриста
              • Sex – пол туриста
              • HotelServiceId – ключ услуги проживания с которой связан турист
          • CostOffers – массив данных по CostOffers, по которым рассчитана цена услуги
            • CostOfferInfo – массив данных по конкретному CostOffer
              • CostOfferName – название CostOffer (Если заявка не аннулирована, то выводим название CostOffer по цене netto. Если заявка аннулирована со штрафами, то выводим название CostOffer по цене брутто. Если заявка аннулирована без штрафов, то выводим текст "Canceled without penalty")
              • CostOfferDateBegin – дата начала действия CostOffer
              • CostOfferDateEnd – дата окончания действия CostOffer
              • CostOfferDuration – продолжительность проживания до данному CostOffer
          • Penalty – информация о штрафах по аннулированной заявке
      • MessageInfo – массив данных сообщений
        • Id – идентификатор сообщения
        • IsOutgoing – исходящее (true - исходящее, false - входящее)
        • DateCreate – дата создания сообщения
        • IsRead – прочитано (true - прочитано, false - не прочитано )
        • Text – текст сообщения
развернутьПример


Методы передачи изменений по услугам

ManageBooking (Передача изменений по услуге проживания в Interlook)

Принимаемые параметры запроса ( * – обязательный):

  • guid * – идентификатор аутентификации (возвращается при запросе к методу Connect)
  • hotelServiceId * – ключ услуги проживания (возвращается при запросе к методу SearchBookings)
  • status – фильтр для отбора услуг с определенным статусом (1 - Wait, 2 - Confirmed, 3 - notConfirmed)
  • message – сообщение для пользователя Interlook
  • hotelWorkStatus – отметка отеля по заявке (true - отель взял заявку в работу, false - отель заявку в работу не взял). При отправке этого параметра формируется запись в историю по заявке и сообщение от провайдера.

Возвращаемый результат:

  • ManageBookingResult – массив данных
  • HotelServiceId – ключ сервиса отеля
  • HotelServiceName – имя сервиса отеля
    • Hotel – массив данных по отелям
      • HotelId – ключ отеля
      • HotelName – имя отеля
    • Pansion – тип питания
      • PansionId – ключ питания
      • PansionName – имя питания
    • RoomType – тип номера
      • RoomTypeId – ключ типа номера
      • RoomTypeName – имя типа номера
    • RoomAccomodation – тип размещения
      • AccommodationId – ключ типа размещения
      • AccommodationName – имя типа размещения
    • RoomCategory – категория номер
      • RoomCategoryId – ключ категории номера
      • RoomCategoryName – имя категории номера
    • Status – статус по услуге проживания
      • StatusId – ключ статуса по услуге проживания
      • StatusName – имя статуса по услуге проживания


развернутьПример


Источник — «http://wiki.megatec.ru/index.php?title=Master-Interlook:HotelService&oldid=27213»