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

Материал из Megatec
Перейти к: навигация, поиск
[досмотренная версия][досмотренная версия]
(Новая страница: «Версия статьи от {{REVISIONDAY}}-{{REVISIONMONTH}}-{{REVISIONYEAR}}. <table style="background-color:#ffffcc;color:black" border="1" cellpadding="10…»)
 
Строка 9: Строка 9:
 
Сервис '''InterlookHotelService''' работает с методами REST API. Для вызова методов REST API можно использовать SoapUi.
 
Сервис '''InterlookHotelService''' работает с методами REST API. Для вызова методов REST API можно использовать SoapUi.
 
[[Файл: mb_030.png|left|Предупреждение]] <BR>
 
[[Файл: mb_030.png|left|Предупреждение]] <BR>
−
Для доступа к сервису у онлайн пользователя должен быть установлен признак '''Hotel/Service''' в настройке '''Person connection''' и в настройках '''Role'''  активирован параметр '''Show hotel reservations by date'''.<br>
+
Для доступа к сервису у онлайн пользователя должен быть установлен признак '''Hotel/Service''' в настройке '''Person connection''' и в настройках '''Role'''  активирован параметр '''Show hotel reservations by date'''.</br>
 +
<br>
 
=Методы HotelService=
 
=Методы HotelService=
  
Строка 47: Строка 48:
 
   </soap:Body>
 
   </soap:Body>
 
</soap:Envelope>
 
</soap:Envelope>
 +
</syntaxhighlight>
 +
</TD></TR></TABLE>
 +
</div></div><br />
 +
 +
===CheckConnect (Проверка активности подключения под конкретным идентификатором)===
 +
Метод проверяет наличие активного подключения под конкретным идентификатором аутентификации.<br />
 +
Принимаемые параметры запроса ( * – обязательный):
 +
* '''Guid *''' – идентификатор аутентификации (возвращается при запросе к методу [[Master-Interlook:HotelService#Connect (получение аутентификационного токена)|Connect]])<br />
 +
Возвращаемый результат:
 +
* '''CheckConnectResult''' – идентификатор аутентификации (true – если подключение активно, false – если подключения нет)
 +
<div class="toccolours mw-collapsible mw-collapsed" style="width:900px">Пример
 +
<div class="mw-collapsible-content">
 +
<TABLE STYLE="border: 0.1em dashed #2F6FAB; margin: 8px; padding: 8px" WIDTH="99%"><TR><TD>
 +
Вызов метода CheckConnect
 +
<syntaxhighlight lang="java" enclose="div">
 +
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:tem="http://tempuri.org/">
 +
  <soap:Header/>
 +
  <soap:Body>
 +
      <tem:CheckConnect>
 +
        <!--Optional:-->
 +
        <tem:guid>123c02db-3d47-4db5-861b-758be524a5fe</tem:guid>
 +
      </tem:CheckConnect>
 +
  </soap:Body>
 +
</soap:Envelope>
 +
</syntaxhighlight>
 +
 +
Возвращаемый результат метода CheckConnect
 +
<syntaxhighlight lang="java" enclose="div">
 +
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
 +
  <soap:Body>
 +
      <CheckConnectResponse xmlns="http://tempuri.org/">
 +
        <CheckConnectResult>true</CheckConnectResult>
 +
      </CheckConnectResponse>
 +
  </soap:Body>
 +
</soap:Envelope>
 +
</syntaxhighlight>
 +
</TD></TR></TABLE>
 +
</div></div><br />
 +
 +
==Методы поиска==
 +
 +
===SearchBookings (Получение списка забронированных заявок)===
 +
Метод предназначен для поиска забронированных заявок. Отбираются те заявки, у которых партнер предоставления услуги совпадает с партнером для логина, под которым осуществляется поиск.
 +
Принимаемые параметры запроса ( * – обязательный):<br />
 +
* '''Guid *''' – идентификатор аутентификации (возвращается при запросе к методу [[Master-Interlook:HotelService#Connect (получение аутентификационного токена)|Connect]])<br />
 +
* '''hotelID''' – массив данных с ключами отелей. Можно передавать как один так и несколько ключей отелей. Если не передаём данный параметр, то в ответ получаем все заказы, подходящие под выбранные даты.
 +
* '''dateInfo *''' – по какой дате осуществлять поиск (1 - дата создания, 2 - дата заезда, 3 - дата выезда)
 +
* '''dateFrom *''' – дата начала
 +
* '''dateTo *''' – дата окончания
 +
* '''checkInFrom''' – дата заезда от
 +
* '''checkInTo''' – дата заезда по
 +
* '''New''' – возвращает новые бронирования с датой, попадающей в указанное выше условие
 +
* '''change''' – возвращает измененные бронирования с изменениями, внесенными в выбранный период
 +
* '''cancel''' – возвращает информацию об отмененных бронировки за выбранный период
 +
Возвращаемый результат:
 +
* '''SearchBookingsResult''' – массив данных ответа
 +
** '''BookingInfo''' – массив данных бронирования
 +
*** '''Booking''' –
 +
*** '''BookingID''' –
 +
*** '''Action''' –
 +
*** '''CreationDate''' –
 +
*** '''ChangeDate''' –
 +
*** '''CancelDate''' –
 +
*** '''CustomerMarket''' –
 +
**** '''CustomerMarketId''' –
 +
**** '''CustomerMarketName''' –
 +
  <HotelServices>
 +
                  <HotelServiceInfo>
 +
                    <HotelServiceId>163806</HotelServiceId>
 +
                    <HotelServiceName>HTL::Kiev/Hilton/Double Room/2AD/Jakuzzi/BB</HotelServiceName>
 +
                    <Hotel>
 +
                        <HotelId>2935</HotelId>
 +
                        <HotelName>Hilton</HotelName>
 +
                    </Hotel>
 +
                    <Pansion>
 +
                        <PansionId>3</PansionId>
 +
                        <PansionName>Bed and Breakfast</PansionName>
 +
                    </Pansion>
 +
                    <RoomType>
 +
                        <RoomTypeId>3</RoomTypeId>
 +
                        <RoomTypeName>Double Room</RoomTypeName>
 +
                    </RoomType>
 +
                    <RoomAccomodation>
 +
                        <AccommodationId>5558</AccommodationId>
 +
                        <AccommodationName>2AD</AccommodationName>
 +
                    </RoomAccomodation>
 +
                    <RoomCategory>
 +
                        <RoomCategoryId>20</RoomCategoryId>
 +
                        <RoomCategoryName>Jakuzzi</RoomCategoryName>
 +
                    </RoomCategory>
 +
                    <Status>
 +
                        <StatusId>1</StatusId>
 +
                        <StatusName>Wait</StatusName>
 +
                    </Status>
 +
                    <CheckIn>2021-07-11T00:00:00</CheckIn>
 +
                    <CheckOut>2021-07-20T00:00:00</CheckOut>
 +
                    <Tourists>
 +
                        <TouristInfo>
 +
                          <Name>PatnadzProc Gen</Name>
 +
                          <BirthDate>1966-02-27T00:00:00</BirthDate>
 +
                          <Sex>MR</Sex>
 +
                          <HotelServiceId>163806</HotelServiceId>
 +
                        </TouristInfo>
 +
                        <TouristInfo>
 +
                          <Name>Gus Ek</Name>
 +
                          <BirthDate>1969-10-04T00:00:00</BirthDate>
 +
                          <Sex>MRS</Sex>
 +
                          <HotelServiceId>163806</HotelServiceId>
 +
                        </TouristInfo>
 +
                    </Tourists>
 +
                  </HotelServiceInfo>
 +
              </HotelServices>
 +
              <Mesaages/>
 +
 +
<div class="toccolours mw-collapsible mw-collapsed" style="width:900px">Пример
 +
<div class="mw-collapsible-content">
 +
<TABLE STYLE="border: 0.1em dashed #2F6FAB; margin: 8px; padding: 8px" WIDTH="99%"><TR><TD>
 +
Вызов метода Connect
 +
<syntaxhighlight lang="java" enclose="div">
 +
 +
 +
 +
</soapenv:Envelope>
 +
</syntaxhighlight>
 +
 +
Возвращаемый результат метода Connect
 +
<syntaxhighlight lang="java" enclose="div">
 +
     
 +
 +
 
</syntaxhighlight>
 
</syntaxhighlight>
 
</TD></TR></TABLE>
 
</TD></TR></TABLE>
 
</div></div><br />
 
</div></div><br />

Версия 16:34, 15 ноября 2021

Версия статьи от 15-11-2021.

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


Введение

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

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


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

Методы HotelService

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

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

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

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

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

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

Вызов метода Connect 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/">
   <soapenv:Header/>
   <soapenv:Body>
      <tem:Connect>
         <!--Optional:-->
         <tem:login>mk1</tem:login>
         <!--Optional:-->
         <tem:password>123</tem:password>
      </tem:Connect>
   </soapenv:Body>
</soapenv:Envelope>

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

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <ConnectResponse xmlns="http://tempuri.org/">
         <ConnectResult>123c02db-3d47-4db5-861b-758be524a5fe</ConnectResult>
      </ConnectResponse>
   </soap:Body>
</soap:Envelope>


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

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

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

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

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

Вызов метода CheckConnect 

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:tem="http://tempuri.org/">
   <soap:Header/>
   <soap:Body>
      <tem:CheckConnect>
         <!--Optional:-->
         <tem:guid>123c02db-3d47-4db5-861b-758be524a5fe</tem:guid>
      </tem:CheckConnect>
   </soap:Body>
</soap:Envelope>

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

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <CheckConnectResponse xmlns="http://tempuri.org/">
         <CheckConnectResult>true</CheckConnectResult>
      </CheckConnectResponse>
   </soap:Body>
</soap:Envelope>


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

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

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

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

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

  • SearchBookingsResult – массив данных ответа
    • BookingInfo – массив данных бронирования
      • Booking –
      • BookingID –
      • Action –
      • CreationDate –
      • ChangeDate –
      • CancelDate –
      • CustomerMarket –
        • CustomerMarketId –
        • CustomerMarketName –
 <HotelServices>
                 <HotelServiceInfo>
                    <HotelServiceId>163806</HotelServiceId>
                    <HotelServiceName>HTL::Kiev/Hilton/Double Room/2AD/Jakuzzi/BB</HotelServiceName>
                    <Hotel>
                       <HotelId>2935</HotelId>
                       <HotelName>Hilton</HotelName>
                    </Hotel>
                    <Pansion>
                       <PansionId>3</PansionId>
                       <PansionName>Bed and Breakfast</PansionName>
                    </Pansion>
                    <RoomType>
                       <RoomTypeId>3</RoomTypeId>
                       <RoomTypeName>Double Room</RoomTypeName>
                    </RoomType>
                    <RoomAccomodation>
                       <AccommodationId>5558</AccommodationId>
                       <AccommodationName>2AD</AccommodationName>
                    </RoomAccomodation>
                    <RoomCategory>
                       <RoomCategoryId>20</RoomCategoryId>
                       <RoomCategoryName>Jakuzzi</RoomCategoryName>
                    </RoomCategory>
                    <Status>
                       <StatusId>1</StatusId>
                       <StatusName>Wait</StatusName>
                    </Status>
                    <CheckIn>2021-07-11T00:00:00</CheckIn>
                    <CheckOut>2021-07-20T00:00:00</CheckOut>
                    <Tourists>
                       <TouristInfo>
                          <Name>PatnadzProc Gen</Name>
                          <BirthDate>1966-02-27T00:00:00</BirthDate>
                          <Sex>MR</Sex>
                          <HotelServiceId>163806</HotelServiceId>
                       </TouristInfo>
                       <TouristInfo>
                          <Name>Gus Ek</Name>
                          <BirthDate>1969-10-04T00:00:00</BirthDate>
                          <Sex>MRS</Sex>
                          <HotelServiceId>163806</HotelServiceId>
                       </TouristInfo>
                    </Tourists>
                 </HotelServiceInfo>
              </HotelServices>
              <Mesaages/>
Пример

Вызов метода Connect 

</soapenv:Envelope>

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


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