Мастер-Тур(15):API для разработки онлайн поиска и бронирования — различия между версиями

Материал из Megatec
Перейти к: навигация, поиск
[досмотренная версия][досмотренная версия]
(→‎Установка)
 
(не показаны 292 промежуточные версии 12 участников)
Строка 7: Строка 7:
  
 
==Введение==
 
==Введение==
−
Данный web-сервис разработан для разработки собственного сайта туроператору на основе API.
+
Данный web-сервис служит для разработки собственного сайта туроператору на основе API.
  
 
==Установка==
 
==Установка==
−
Для работы с web-сервисом необходимо установить [[Мастер-Тур(15):Установка#Установка службы поиска|службу поиска]].<br />
+
Для работы с web-сервисом необходимо на отдающей стороне установить [[Мастер-Тур(15):Установка#Установка службы поиска|службу поиска]].<br />
 
После установки web-сервис будет доступен по адресу ''<nowiki>http://значение настройки "serviceAddress" в TourSearchOwin/"название метода"</nowiki>'' (пример: ''http://localhost:9000/TourSearchOwin/Settings'')
 
После установки web-сервис будет доступен по адресу ''<nowiki>http://значение настройки "serviceAddress" в TourSearchOwin/"название метода"</nowiki>'' (пример: ''http://localhost:9000/TourSearchOwin/Settings'')
 +
 +
==Swagger==
 +
Работу методов можно проверить с помощью Swagger по пути: ''http://localhost:9000/TourSearchOwin/SwaggerUI''
  
 
==Список методов==
 
==Список методов==
Строка 18: Строка 21:
 
[[Файл:mb_273.png|1000px|Последовательность вызова методов сервиса]]
 
[[Файл:mb_273.png|1000px|Последовательность вызова методов сервиса]]
  
 +
===Информация о состоянии службы поиска (statusCache)===
 +
Метод выводит информацию о состоянии службы поиска при ее загрузке.
 +
* Формат запроса:
 +
** GET .../TourSearchOwin/statusCache?
 +
* Принимаемые параметры:
 +
** нет принимаемых параметров
 +
* Возвращаемый результат:
 +
** '''Initialized''' – информация о том, загружена ли служба или нет ('''false''' – инициализация кешей не завершена, '''true''' – инициализация кешей завершена)
 +
** '''Status''' – состояние службы. Возможные значения: ''Запущена инициализация кэшей'', ''Инициализация кэшей завершена''
 +
** '''CacheName''' – информация о том, какой именно кеш сейчас считается (название)
 +
** '''Iteration''' – порядковый номер считаемого справочника кеша
 +
** '''CacheCount''' – общее количество кешей
 +
** '''ProcessMessage''' – детализация. Информацию можно разделить на 3 блока:
 +
*** Загрузка всех справочных данных, кроме расчета маршрутов и актуальных фильтров. В этом случае сообщение будет ''Загрузка кэшей из БД''
 +
*** Расчет маршрутов. ''CacheName'' – ''HotelScheme'', сообщение будет ''tours load: 956 / 1234''
 +
*** Расчет актуальных фильтров. ''CacheName'' – ''ActualFilters'', сообщение будет ''Actual filter processed: 783012 / 3865687"''
 +
 +
<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>
 +
Вызов метода Settings
 +
<syntaxhighlight lang="java" enclose="div">
 +
GET http://localhost:9000/TourSearchOwin/statusCache
 +
</syntaxhighlight>
 +
Возвращаемый результат метода statusCache (в формате JSON)
 +
<syntaxhighlight lang="java" enclose="div">
 +
{
 +
    "Initialized": false,
 +
    "Status": "Запущена инициализация кэшей",
 +
    "CacheName": "ToursSearchView",
 +
    "Iteration": 10,
 +
    "CacheCount": 112,
 +
    "ProcessMessage": "Загрузка кэшей из БД"
 +
}
 +
{
 +
    "Initialized": false,
 +
    "Status": "Запущена инициализация кэшей",
 +
    "CacheName": "HotelScheme",
 +
    "Iteration": 109,
 +
    "CacheCount": 112,
 +
    "ProcessMessage": "tours load: 956 / 1234"
 +
}
 +
{
 +
    "Initialized": false,
 +
    "Status": "Запущена инициализация кэшей",
 +
    "CacheName": "ActualFilters",
 +
    "Iteration": 112,
 +
    "CacheCount": 112,
 +
    "ProcessMessage": "Actual filter processed: 783012 / 3865687"
 +
}
 +
{
 +
    "Initialized": true,
 +
    "Status": "Инициализация кэшей завершена",
 +
    "CacheName": null,
 +
    "Iteration": 0,
 +
    "CacheCount": 0,
 +
    "ProcessMessage": null
 +
}
 +
</syntaxhighlight>
 +
</TD></TR></TABLE>
 +
</div></div><br />
  
 
===Авторизация (Token)===
 
===Авторизация (Token)===
−
Метод производит получение авторизационного токена.
+
Метод производит получение авторизационного токена ([https://tools.ietf.org/html/rfc6749#section-1.3.3 описание стандарта]).
 
* Формат запроса:
 
* Формат запроса:
−
** .../TourSearchOwin/Token?
+
** POST .../TourSearchOwin/Token?
 +
* Принимаемые параметры headers ( '''*''' – обязательный):
 +
** '''Content-Type *''' – application/x-www-form-urlencoded
 +
 
 
* Принимаемые параметры POST запроса ( '''*''' – обязательный):
 
* Принимаемые параметры POST запроса ( '''*''' – обязательный):
−
** '''grant_type *''' – password
+
** '''grant_type *''' – текст ''password''
−
** '''username *''' – логин представителя партнера
+
** '''username *''' – логин представителя партнера или частного лица
−
** '''password *''' – пароль представителя партнера
+
** '''password *''' – пароль представителя партнера или частного лица
  
 
* Возвращаемый результат:
 
* Возвращаемый результат:
Строка 33: Строка 100:
 
** '''expires_in''' – код
 
** '''expires_in''' – код
 
** '''userKey''' – ключ пользователя
 
** '''userKey''' – ключ пользователя
 +
** '''userType''' – тип пользователя (0 – представитель партнера, 1 – частное лицо)
 
** '''.issued''' – дата получения
 
** '''.issued''' – дата получения
 
** '''.expires''' – дата действия до
 
** '''.expires''' – дата действия до
Строка 41: Строка 109:
 
Вызов метода Token
 
Вызов метода Token
 
<syntaxhighlight lang="java" enclose="div">
 
<syntaxhighlight lang="java" enclose="div">
−
http://localhost:9000/TourSearchOwin/Token
+
POST http://localhost:9000/TourSearchOwin/Token HTTP/1.1
−
POST
+
Content-Type: application/x-www-form-urlencoded
−
{
+
 
−
"grant_type": "password",
+
grant_type=password&username=test&password=1
−
"username": "test",
 
−
"password": "1",
 
−
}
 
 
</syntaxhighlight>
 
</syntaxhighlight>
−
Возвращаемый результат метода TransportPlan (в формате JSON)
+
Возвращаемый результат метода Token (в формате JSON)
 
<syntaxhighlight lang="java" enclose="div">
 
<syntaxhighlight lang="java" enclose="div">
 
{
 
{
−
"access_token": "AQAAANCMnd8BFdERjHoAwE_Cl-sBAAAAdsCC8X7m9E-2bg0-uS0VfgAAAAACAAAAAAADZgAAwAAAA-
+
"access_token": "AQAAANCMnd8BFdERjHoAwE_Cl-sBAAAAdsCC8X7m9E-2bg0-uS0VfgAAAAAAAAADZgAAwAAAA-
−
EqAAAAAASAAACgAAAAEAAAAO4S-VrqBhQuhqliqrAKKfIgAQAAn-gfgP-rYjk-Krr1Ck2A-IGCw6FBhamJDQdedCxccciUOzFxgTtk1hR-
+
EqAAAAAASAAACgAAAAEAAAAO4S-VrqBhQuhqliqrAKKfIgAQAAn-gfgP-rYjk-Krr1Ck2A-IGCw6FBhamUOzFxgTtk1hR-
−
GLMryFIH8VK5GmHdHubZWj4S7XcazGL1Kn5-VlbiYdW2ZVWpYlk638aV-XS2kpZ9YrKgViiM_x8RH5TPo4tmtVAg9Y8OWyjX8Qx9SzwTzB9LhE7V-SjiB_CP_qs58DRKcyohq3Tz9QaiFgH1Ko7O2XKjTBG7SHyQPDPYjaqg0oD5Rs8d0gNsTtpt2EvNH7Wnj59kDxmzq0UcIT6Fm4YkDxmm9-CW7u3cEFWcpiqKOc2VvZFKPPHc07uDOO4w9FXPhpXZwOcV8GaHQpOqrJBxzhbr73RuhzPs_e-hgxKaIlsMaKqt1PFAAAAC7J54NXq5b0v5ReAMy1kuY0ebXA",
+
GLMryFIH8VK5GmHdHubZWj4S7XcazGL1Kn5-VlbiYdW2ZVWpYlk638aV-XS2kpZ9YrKgViiM_x8RH5TPo4-
 +
9LhE7V-SjiB_CP_qs58DRKcyohq3Tz9QaiFgH1Ko7O2XKjTBG7SHyQPDPYjaqg9kDxmzq0UcIT6Fm4YkDxmm9-
 +
CW7u3cEFWcpiqKOc2VvZFKPPHc07uDOO4w9FXPhpXZwOqrJBxzhbr73RuhzPs_e-hgxKaIlsMaK5b0v5ReAMy1kuY0ebXA",",
 
"token_type": "bearer",
 
"token_type": "bearer",
 
"expires_in": 1209599,
 
"expires_in": 1209599,
 
"userKey": "333",
 
"userKey": "333",
 +
        "userType": "0",
 
".issued": "Thu, 05 Apr 2018 12:05:31 GMT",
 
".issued": "Thu, 05 Apr 2018 12:05:31 GMT",
 
".expires": "Thu, 19 Apr 2018 12:05:31 GMT"
 
".expires": "Thu, 19 Apr 2018 12:05:31 GMT"
Строка 68: Строка 136:
 
Метод производит выгрузку настроек службы поиска.
 
Метод производит выгрузку настроек службы поиска.
 
* Формат запроса:
 
* Формат запроса:
−
** .../TourSearchOwin/Settings?
+
** GET .../TourSearchOwin/Settings?
 
* Принимаемые параметры:
 
* Принимаемые параметры:
 
** нет принимаемых параметров
 
** нет принимаемых параметров
 
* Возвращаемый результат:
 
* Возвращаемый результат:
−
** '''ChildAgesSetting''' – регулируется настройкой [[Мастер-Тур(15):Программа туров. Панель администрирования#Общие настройки|максимальный возраст ребенка]] (массив возрастов, при которых турист будет считаться ребенком
+
** '''ChildAgesSetting''' – регулируется настройкой [[Мастер-Тур(15):Программа туров. Настройки|максимальный возраст ребенка]] (массив возрастов, при которых турист будет считаться ребенком
−
** '''DurationSetting''' – регулируется настройкой [[Мастер-Тур(15):Программа туров. Панель администрирования#Общие настройки|максимальная продолжительность тура]] (массив продолжительностей, доступных в фильтрах для поиска)
+
** '''DurationSetting''' – регулируется настройкой [[Мастер-Тур(15):Программа туров. Настройки|максимальная продолжительность тура]] (массив продолжительностей, доступных в фильтрах для поиска)
 
** '''RoundServiceSetting''' – признак округления цены (количество знаков после запятой)
 
** '''RoundServiceSetting''' – признак округления цены (количество знаков после запятой)
 
** '''CacheReady''' – статус готовности службы поиска к работе (true/false)
 
** '''CacheReady''' – статус готовности службы поиска к работе (true/false)
Строка 94: Строка 162:
 
** '''MaxSearchDatesCountClient''' – максимальное количество дат, которое будет обрабатываться в клиенте поиска
 
** '''MaxSearchDatesCountClient''' – максимальное количество дат, которое будет обрабатываться в клиенте поиска
 
** '''MaxDurationsCountClient''' – максимальное количество продолжительностей, которое будет обрабатываться в клиенте поиска
 
** '''MaxDurationsCountClient''' – максимальное количество продолжительностей, которое будет обрабатываться в клиенте поиска
−
 
+
** '''UseHotelCategoryGlobalCodeInDopFilter''' – использовать глобальные коды категорий отелей в поиске
 +
** '''UsePansionGlobalCodeInDopFilter''' – использовать глобальные коды питаний в поиске
 +
** '''CheckTouristDataInBasket''' – проверять корректность данных туристов
 +
** '''SimpleRegistration''' – упрощенная регистрация частного лица
 +
** '''ShowHotelImagesInSearch''' – показывать описание и изображения отелей в поиске
 +
** '''CacheReadyMessage''' – сообщение о готовности службы поиска или службы расчета актуальных фильтров. Варианты возвращаемых значений:
 +
*** ''<add key="enableActualFilters" value="true" />'' - CacheReady: true = CacheReadyMessage: "Кеш инициализирован"; CacheReady: false = CacheReadyMessage: "Кеш еще не инициализирован"
 +
*** ''<add key="enableActualFilters" value="false" />'' - Служба актуальных фильтров недоступна (выключена, неверно указана ссылка на нее и т.п.) CacheReadyMessage: "Служба актуальных фильтров недоступна"; Служба актуальных фильтров доступна но не готова - CacheReadyMessage: "Кеш службы актуальных фильтров не инициализирован"; Служба актуальных фильтров готова, а основная служба не готова - CacheReadyMessage: "Кеш ещё не инициализирован"; Служба актуальных фильтров готова, и основная служба готова - CacheReadyMessage: "Кеш ещё инициализирован".
 +
** '''nodeId''' – уникальный идентификатор узла в кластере балансировки нагрузки [[Мастер-Тур(15):Балансировщик нагрузки HaProxy|HaProxy]]
 +
** '''FullPaymentPeriod''' – полная оплата с даты бронирования (может быть null)
 +
** '''FullPaymentCheckin''' – полная оплата до даты заезда (может быть null)
 +
** '''PrePaymentPeriod''' – предоплата с даты бронирования (может быть null)
 +
** '''PrePaymentCheckin''' – предоплата до даты заезда (может быть null)
 +
** '''PrePaymentCu"''' – значение предоплаты в y.e. (может быть null)
 +
** '''PrePaymentPercent''' – значение предоплаты в процентах (может быть null)
 
<div class="toccolours mw-collapsible mw-collapsed" style="width:900px">Пример
 
<div class="toccolours mw-collapsible mw-collapsed" style="width:900px">Пример
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
Строка 100: Строка 182:
 
Вызов метода Settings
 
Вызов метода Settings
 
<syntaxhighlight lang="java" enclose="div">
 
<syntaxhighlight lang="java" enclose="div">
−
http://localhost:9000/TourSearchOwin/Settings
+
GET http://localhost:9000/TourSearchOwin/Settings
 
</syntaxhighlight>
 
</syntaxhighlight>
 
Возвращаемый результат метода Settings (в формате JSON)
 
Возвращаемый результат метода Settings (в формате JSON)
Строка 165: Строка 247:
 
   "MaxSearchDatesCountClient": 10,
 
   "MaxSearchDatesCountClient": 10,
 
   "MaxDurationsCountClient": 14
 
   "MaxDurationsCountClient": 14
 +
  "UseHotelCategoryGlobalCodeInDopFilter": false
 +
  "UsePansionGlobalCodeInDopFilter": false
 +
  "CheckTouristDataInBasket": true
 +
  "SimpleRegistration": false
 +
  "ShowHotelImagesInSearch": true
 +
  "CacheReadyMessage": "Кеш инициализирован"
 +
    "nodeId": 2147483647,
 +
    "FullPaymentPeriod": null,
 +
    "FullPaymentCheckin": 5,
 +
    "PrePaymentPeriod": null,
 +
    "PrePaymentCheckin": 10,
 +
    "PrePaymentPercent": 50.0,
 +
    "PrePaymentCu": null
 
}
 
}
 
</syntaxhighlight>
 
</syntaxhighlight>
Строка 170: Строка 265:
 
</div></div><br />
 
</div></div><br />
  
−
===Выгрузка списка валют (Currency)===
+
===Выгрузка списка валют в онлайне (Currency)===
 
Метод возвращает список используемых валют.
 
Метод возвращает список используемых валют.
 
* Формат запроса:
 
* Формат запроса:
−
** .../TourSearchOwin/Currency
+
** GET .../TourSearchOwin/Currency
 
* Принимаемые параметры:
 
* Принимаемые параметры:
 
** нет принимаемых параметров
 
** нет принимаемых параметров
Строка 182: Строка 277:
 
** '''IsNational''' – признак валюты «Национальная»
 
** '''IsNational''' – признак валюты «Национальная»
 
** '''IsoCode''' – ISO код валюты
 
** '''IsoCode''' – ISO код валюты
 +
** '''IsShowInSearch''' – признак показывать ли валюту в поиске
 +
** '''Symbol''' – символ валюты (обрабатывается с 15.7)
 
** '''Key''' – идентификатор валюты
 
** '''Key''' – идентификатор валюты
−
** '''IsShowInSearch''' – признак показывать ли валюту в поиске
+
 
  
 
<div class="toccolours mw-collapsible mw-collapsed" style="width:900px">Пример
 
<div class="toccolours mw-collapsible mw-collapsed" style="width:900px">Пример
Строка 190: Строка 287:
 
Вызов метода Currency
 
Вызов метода Currency
 
<syntaxhighlight lang="java" enclose="div">
 
<syntaxhighlight lang="java" enclose="div">
−
http://localhost:9000/TourSearchOwin/Currency
+
GET http://localhost:9000/TourSearchOwin/Currency
 
</syntaxhighlight>
 
</syntaxhighlight>
 
Возвращаемый результат метода Currency (в формате JSON)
 
Возвращаемый результат метода Currency (в формате JSON)
Строка 201: Строка 298:
 
       "IsNational": false,
 
       "IsNational": false,
 
       "IsoCode": "EUR",
 
       "IsoCode": "EUR",
−
       "Key": 2,
+
       "IsShowInSearch": true,
−
       "IsShowInSearch": true
+
      "Symbol": "€",
 +
       "Key": 2
 
   },
 
   },
 
       {
 
       {
Строка 210: Строка 308:
 
       "IsNational": true,
 
       "IsNational": true,
 
       "IsoCode": "RUR",
 
       "IsoCode": "RUR",
−
       "Key": 14,
+
       "IsShowInSearch": true,
−
       "IsShowInSearch": true
+
      "Symbol": "₽",
 +
       "Key": 14
 
   },
 
   },
 
       {
 
       {
Строка 219: Строка 318:
 
       "IsNational": false,
 
       "IsNational": false,
 
       "IsoCode": "USD",
 
       "IsoCode": "USD",
−
       "Key": 1,
+
       "IsShowInSearch": true,
−
       "IsShowInSearch": true
+
      "Symbol": "$",
 +
       "Key": 1
 
   }
 
   }
 
]
 
]
Строка 227: Строка 327:
 
</div></div><br />
 
</div></div><br />
  
−
===Выгрузка квотируемых услуг системы (QuotedServices)===
+
 
−
Метод производит выгрузку услуг с признаком «Квотируемая»
+
===Выгрузка курсов валют (CurrencyRates) начиная с 15.7===
 +
Полный аналог метода [[Мастер-Тур(15):API для отдачи цен в поисковые системы#Выгрузка курсов валют (GetCurrencyRates)|Выгрузка курсов валют (GetCurrencyRates)]]<br />
 +
Метод возвращает список курсов валют, актуальных на дату запроса. Курсы отображаются только для тех валют, которые отмечены в справочнике признаком ''Отображать в онлайне''
 
* Формат запроса:
 
* Формат запроса:
−
** .../TourSearchOwin/QuotedServices
+
** GET .../TourSearchOwin/CurrencyRates
 
* Принимаемые параметры:
 
* Принимаемые параметры:
−
** нет принимаемых параметров
+
** '''dateFrom''' – начальная дата, от которой вывести список курсов валют, в формате DD.MM.YYYY, необязательный параметр (если не указан, берется за текущий день)
 +
** '''dateTo''' – конечная дата, до которой вывести список курсов валют, в формате DD.MM.YYYY, необязательный параметр (если не указан, берется за текущий день)
 +
** '''otherBaseCurrencyId''' – идентификатор любой валюты, эмулирующей работу национальной валюты, необязательный параметр. Если заполнен, то в результатах выдачи параметр ''baseCurrencyId'' будет заменяться на валюту из параметра ''otherBaseCurrencyId'' (обрабатывается с релиза 15.9).
 +
 
 
* Возвращаемый результат:
 
* Возвращаемый результат:
−
** '''Key''' – идентификатор услуги
+
** '''baseCurrencyId''' – идентификатор национальной валюты, либо произвольной валюты, указанной в настройке ''basketCurrency'' в конфигурационном файле (обрабатывается с релиза 15.6)
−
** '''Code''' – код услуги
+
** '''currencyId''' – идентификатор валюты, курс которой приводится
−
** '''Name''' – наименование услуги (русский)
+
** '''rate''' – курс валюты (отношение '''currencyId''' к '''baseCurrencyId''')
−
** '''NameLat''' – наименование услуги (английский)
+
** '''date''' – дата, на которую был зарегистрирован выводимый курс валюты
−
** '''IsDuration''' – наличие продолжительности у услуги
+
 
−
** '''IsCity''' – наличие города у услуги
+
<div class="toccolours mw-collapsible mw-collapsed" style="width:900px">Пример
−
** '''IsSubCode1''' – признак наличия ''SubCode1'' у услуги (вид проживания у отеля, тариф у авиаперелета)
+
<div class="mw-collapsible-content">
−
** '''IsSubCode2''' – признак наличия ''SubCode2'' у услуги (тип питания у отеля)
 
−
** '''Quoted''' – признак квотируемости услуги
 
−
** '''CheckGeoPoint''' – наличие геоточек у услуги
 
−
** '''IsRoute''' – признак маршрутной услуги
 
−
** '''LittlePercent''' – число в %, при которых будет считаться количество мест «Мало»
 
−
** '''LittlePlace''' – число, при котором будет считаться количество мест «Мало»
 
−
** '''LittleAnd''' – признак наличия мест «Мало» – будем ли учитывать количество мест вместе с процентным соотношением между общим и оставшимся количеством мест
 
−
** '''IsPartnerBasedOn''' – признак сопоставления партнера услуги в зависимости от отеля
 
−
** '''Control''' – идентификатор статуса услуги
 
−
 
 
−
<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>
 
<TABLE STYLE="border: 0.1em dashed #2F6FAB; margin: 8px; padding: 8px" WIDTH="99%"><TR><TD>
−
Вызов метода QuotedServices
+
Вызов метода CurrencyRates
 
<syntaxhighlight lang="java" enclose="div">
 
<syntaxhighlight lang="java" enclose="div">
−
http://localhost:9000/TourSearchOwin/QuotedServices
+
http://localhost:9000/TourSearchOwin/CurrencyRates?dateFrom=18.09.2024&dateTo=19.09.2024
 
</syntaxhighlight>
 
</syntaxhighlight>
−
Возвращаемый результат метода QuotedServices (в формате JSON)
+
Возвращаемый результат метода CurrencyRates (в формате JSON)
 
<syntaxhighlight lang="java" enclose="div">
 
<syntaxhighlight lang="java" enclose="div">
 
[
 
[
−
      {
+
    {
−
      "Key": 1,
+
        "BaseCurrencyId": 14,
−
      "Code": "А_П",
+
        "CurrencyId": 1,
−
      "Name": "Авиаперелет",
+
        "Rate": 91.429200,
−
      "NameLat": "Flight",
+
        "Date": "18.09.2024"
−
      "IsDuration": false,
+
    },
−
      "IsCity": true,
+
    {
−
      "IsSubCode1": true,
+
        "BaseCurrencyId": 14,
−
      "IsSubCode2": false,
+
        "CurrencyId": 2,
−
      "Quoted": true,
+
        "Rate": 101.505700,
−
      "CheckGeoPoint": true,
+
        "Date": "18.09.2024"
−
      "IsRoute": true,
+
    },
−
      "LittlePercent": null,
+
    {
−
      "LittlePlace": 10,
+
        "BaseCurrencyId": 14,
−
      "LittleAnd": true,
+
        "CurrencyId": 1,
−
      "IsPartnerBasedOn": false,
+
        "Rate": 91.671200,
−
      "Control": 1
+
        "Date": "19.09.2024"
−
  },
+
    },
−
      {
+
    {
−
      "Key": 3,
+
        "BaseCurrencyId": 14,
−
      "Code": "HOTEL",
+
        "CurrencyId": 2,
−
      "Name": "Отель/Круиз",
+
        "Rate": 102.039000,
−
      "NameLat": "Hotel/Cruise",
+
        "Date": "19.09.2024"
−
      "IsDuration": true,
+
    }
−
      "IsCity": true,
 
−
      "IsSubCode1": true,
 
−
      "IsSubCode2": true,
 
−
      "Quoted": true,
 
−
      "CheckGeoPoint": true,
 
−
      "IsRoute": true,
 
−
      "LittlePercent": 99,
 
−
      "LittlePlace": 5,
 
−
      "LittleAnd": false,
 
−
      "IsPartnerBasedOn": false,
 
−
      "Control": 1
 
−
  }
 
 
]
 
]
 +
 
</syntaxhighlight>
 
</syntaxhighlight>
 
</TD></TR></TABLE>
 
</TD></TR></TABLE>
 
</div></div><br />
 
</div></div><br />
  
−
===Выгрузка городов отправления (departureCities)===
+
===Выгрузка списка всех валют (getAllCurrencies)===
−
Метод производит выгрузку всех доступных городов отправления для поискового запроса.
+
Метод возвращает список всех валют.
 
* Формат запроса:
 
* Формат запроса:
−
** .../TourSearchOwin/departureCities?
+
** GET .../TourSearchOwin/AllCurencies/getAllCurrencies
 
* Принимаемые параметры:
 
* Принимаемые параметры:
 
** нет принимаемых параметров
 
** нет принимаемых параметров
 
* Возвращаемый результат:
 
* Возвращаемый результат:
−
** '''Key''' – идентификатор города
+
** '''Code''' – код валюты
−
** '''Name''' – название города
+
** '''Name''' – наименование валюты
 +
** '''IsMain''' – признак валюты «Главная»
 +
** '''IsNational''' – признак валюты «Национальная»
 +
** '''IsoCode''' – ISO код валюты
 +
** '''IsShowInSearch''' – признак показывать ли валюту в поиске
 +
** '''Symbol''' – символ валюты (обрабатывается с 15.7)
 +
** '''Key''' – идентификатор валюты
  
 
<div class="toccolours mw-collapsible mw-collapsed" style="width:900px">Пример
 
<div class="toccolours mw-collapsible mw-collapsed" style="width:900px">Пример
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
 
<TABLE STYLE="border: 0.1em dashed #2F6FAB; margin: 8px; padding: 8px" WIDTH="99%"><TR><TD>
 
<TABLE STYLE="border: 0.1em dashed #2F6FAB; margin: 8px; padding: 8px" WIDTH="99%"><TR><TD>
−
Вызов метода departureCities
+
Вызов метода getAllCurrencies
 
<syntaxhighlight lang="java" enclose="div">
 
<syntaxhighlight lang="java" enclose="div">
−
http://localhost:9000/TourSearchOwin/departureCities
+
GET http://localhost:9000/TourSearchOwin/AllCurencies/getAllCurrencies
 
</syntaxhighlight>
 
</syntaxhighlight>
−
Возвращаемый результат метода departureCities (в формате JSON)
+
Возвращаемый результат метода getAllCurrencies (в формате JSON)
 
<syntaxhighlight lang="java" enclose="div">
 
<syntaxhighlight lang="java" enclose="div">
 
[
 
[
 
       {
 
       {
−
       "Key": -1,
+
       "Code": "EU",
−
       "Name": "Без перелета"
+
       "Name": "Euro",
 +
      "IsMain": false,
 +
      "IsNational": false,
 +
      "IsoCode": "EUR",
 +
      "IsShowInSearch": true,
 +
      "Symbol": "€",
 +
      "Key": 2
 
   },
 
   },
 
       {
 
       {
−
       "Key": 312,
+
       "Code": "рб",
−
       "Name": "Астрахань"
+
       "Name": "Рубль",
 +
      "IsMain": false,
 +
      "IsNational": true,
 +
      "IsoCode": "RUR",
 +
      "IsShowInSearch": true,
 +
      "Symbol": "₽",
 +
      "Key": 14
 
   },
 
   },
 
       {
 
       {
−
       "Key": 1,
+
      "Code": "$",
−
      "Name": "Москва"
+
      "Name": "US Dollar",
 +
      "IsMain": true,
 +
      "IsNational": false,
 +
      "IsoCode": "USD",
 +
      "IsShowInSearch": true,
 +
      "Symbol": "$",
 +
       "Key": 1
 +
  },
 +
  {
 +
      "Code": "гр",
 +
      "Name": "Гривна",
 +
      "IsMain": false,
 +
      "IsNational": false,
 +
      "IsoCode": "UAH",
 +
      "IsShowInSearch": true,
 +
      "Symbol": "₴",
 +
      "Key": 6
 
   }
 
   }
 
]
 
]
Строка 339: Строка 455:
 
</div></div><br />
 
</div></div><br />
  
−
===Выгрузка списка стран (Destination)===
+
 
−
Метод производит выгрузку всех доступных направлений туроператора.
+
===Получение сконвертированных цен (convertFilterPrice)===
 +
Метод возвращает сконвертированные цен для допфильтра ''Цена'' (используется в canary)
 
* Формат запроса:
 
* Формат запроса:
−
** .../TourSearchOwin/Destination?
+
** GET .../TourSearchOwin/AllCurencies/convertFilterPrice
 
* Принимаемые параметры ( '''*''' – обязательный):
 
* Принимаемые параметры ( '''*''' – обязательный):
−
** '''term *''' – фильтрация результатов по контекстному поиску (по умолчанию параметр пустой)
+
** '''SourceRateKey *''' – ключ исходной валюты конвертации
−
** '''departureCities *''' – идентификатор города отправления (из контроллера ''.../TourSearchOwin/departureCities?'')
+
** '''TargetRateKey *''' – ключ валюты, в которую будет произведена конвертация
 +
** '''MinPrice *''' – значение минимальной цены, которое будет участвовать в конвертации
 +
** '''MaxPrice *''' – значение максимальной цены, которое будет участвовать в конвертации
 
* Возвращаемый результат:
 
* Возвращаемый результат:
−
** '''Name''' – название страны
+
** '''m_Item1''' – сконвертированная минимальная цена
−
** '''Key''' – идентификатор страны
+
** '''m_Item12''' – сконвертированная максимальная цена
−
** '''DestinationType''' – тип результата (всегда возвращается в JSON = 1, в xml = country)
 
  
 
<div class="toccolours mw-collapsible mw-collapsed" style="width:900px">Пример
 
<div class="toccolours mw-collapsible mw-collapsed" style="width:900px">Пример
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
 
<TABLE STYLE="border: 0.1em dashed #2F6FAB; margin: 8px; padding: 8px" WIDTH="99%"><TR><TD>
 
<TABLE STYLE="border: 0.1em dashed #2F6FAB; margin: 8px; padding: 8px" WIDTH="99%"><TR><TD>
−
Вызов метода Destination
+
Вызов метода convertFilterPrice
 
<syntaxhighlight lang="java" enclose="div">
 
<syntaxhighlight lang="java" enclose="div">
−
http://localhost:9000/TourSearchOwin/Destination?pageNumber=1&term=&showAll=false&departureCities=1
+
GET http://localhost:9000/TourSearchOwin/AllCurencies/convertFilterPrice?SourceRateKey=2&TargetRateKey=1&MinPrice=10&MaxPrice=200
 
</syntaxhighlight>
 
</syntaxhighlight>
−
Возвращаемый результат метода Destination (в формате JSON)
+
Возвращаемый результат метода convertFilterPrice (в формате JSON)
 
<syntaxhighlight lang="java" enclose="div">
 
<syntaxhighlight lang="java" enclose="div">
−
[
+
{
−
      {
+
    "m_Item1": 12.035142616440004814057046576,
−
      "Name": "Болгария",
+
    "m_Item2": 240.70285232880009628114093152
−
      "Key": 359,
+
}
−
      "DestinationType": 1
 
−
  },
 
−
      {
 
−
      "Name": "Индия",
 
−
      "Key": 26,
 
−
      "DestinationType": 1
 
−
  },
 
−
      {
 
−
      "Name": "Финляндия",
 
−
      "Key": 64,
 
−
      "DestinationType": 1
 
−
  }
 
−
]
 
 
</syntaxhighlight>
 
</syntaxhighlight>
 
</TD></TR></TABLE>
 
</TD></TR></TABLE>
 
</div></div><br />
 
</div></div><br />
  
−
===Выгрузка списка городов (ActualizeCities)===
+
===Выгрузка квотируемых услуг системы (QuotedServices)===
−
Метод возвращает список всех доступных городов по определенному городу отправления и стране прибытия.
+
Метод производит выгрузку услуг с признаком «Квотируемая»
 
* Формат запроса:
 
* Формат запроса:
−
** .../TourSearchOwin/ActualizeCities?
+
** GET .../TourSearchOwin/QuotedServices
−
* Принимаемые параметры ( '''*''' – обязательный):
+
* Принимаемые параметры:
−
** '''cityKeys *''' – идентификатор города отправления (полученный из метода ''.../TourSearchOwin/departureCities?'')
+
** нет принимаемых параметров
−
** '''Key *''' – идентификатор страны прибытия (полученный из метода ''.../TourSearchOwin/Destination?'')
 
−
** '''Name *''' – название страны прибытия (полученный из метода ''.../TourSearchOwin/Destination?'')
 
−
** '''term *''' – фильтрация результатов по контекстному поиску (по умолчанию параметр пустой)
 
 
* Возвращаемый результат:
 
* Возвращаемый результат:
−
** '''Key''' – идентификатор города
+
** '''Key''' – идентификатор услуги
−
** '''Name''' – название города
+
** '''Code''' – код услуги
 +
** '''Name''' – наименование услуги (русский)
 +
** '''NameLat''' – наименование услуги (английский)
 +
** '''IsDuration''' – наличие продолжительности у услуги
 +
** '''IsCity''' – наличие города у услуги
 +
** '''IsSubCode1''' – признак наличия [[#Приложение 1: параметры услуги (ServiceType, Code, SubCode1, SubCode2)|SubCode1]] у услуги
 +
** '''IsSubCode2''' – признак наличия [[#Приложение 1: параметры услуги (ServiceType, Code, SubCode1, SubCode2)|SubCode2]] у услуги
 +
** '''Quoted''' – признак квотируемости услуги
 +
** '''CheckGeoPoint''' – наличие геоточек у услуги
 +
** '''IsRoute''' – признак маршрутной услуги
 +
** '''IsPartnerBasedOn''' – признак сопоставления партнера услуги в зависимости от отеля
 +
** '''Control''' – идентификатор статуса услуги
  
 
<div class="toccolours mw-collapsible mw-collapsed" style="width:900px">Пример
 
<div class="toccolours mw-collapsible mw-collapsed" style="width:900px">Пример
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
 
<TABLE STYLE="border: 0.1em dashed #2F6FAB; margin: 8px; padding: 8px" WIDTH="99%"><TR><TD>
 
<TABLE STYLE="border: 0.1em dashed #2F6FAB; margin: 8px; padding: 8px" WIDTH="99%"><TR><TD>
−
Вызов метода ActualizeCities
+
Вызов метода QuotedServices
 
<syntaxhighlight lang="java" enclose="div">
 
<syntaxhighlight lang="java" enclose="div">
−
http://localhost:9000/TourSearchOwin/ActualizeCities?cityKeys=1&Key=90&Name=Австрия&term=
+
GET http://localhost:9000/TourSearchOwin/QuotedServices
 
</syntaxhighlight>
 
</syntaxhighlight>
−
Возвращаемый результат метода ActualizeCities (в формате JSON)
+
Возвращаемый результат метода QuotedServices (в формате JSON)
 
<syntaxhighlight lang="java" enclose="div">
 
<syntaxhighlight lang="java" enclose="div">
 
[
 
[
 
       {
 
       {
−
       "Key": -1,
+
       "Key": 1,
−
       "Name": "Все"
+
      "Code": "А_П",
−
  },
+
       "Name": "Авиаперелет",
−
       {
+
      "NameLat": "Flight",
−
       "Key": 35,
+
      "IsDuration": false,
−
       "Name": "Вена"
+
       "IsCity": true,
−
   },
+
       "IsSubCode1": true,
 +
       "IsSubCode2": false,
 +
      "Quoted": true,
 +
      "CheckGeoPoint": true,
 +
      "IsRoute": true,
 +
      "IsPartnerBasedOn": false,
 +
      "Control": 1
 +
   },
 
       {
 
       {
−
       "Key": 440,
+
       "Key": 3,
−
       "Name": "Зельден"
+
      "Code": "HOTEL",
 +
       "Name": "Отель/Круиз",
 +
      "NameLat": "Hotel/Cruise",
 +
      "IsDuration": true,
 +
      "IsCity": true,
 +
      "IsSubCode1": true,
 +
      "IsSubCode2": true,
 +
      "Quoted": true,
 +
      "CheckGeoPoint": true,
 +
      "IsRoute": true,
 +
      "IsPartnerBasedOn": false,
 +
      "Control": 1
 
   }
 
   }
 
]
 
]
Строка 421: Строка 552:
 
</div></div><br />
 
</div></div><br />
  
−
===Выгрузка типов туров (ActualizeTourType)===
+
===Выгрузка актуальных городов отправления (departureCities)===
−
Метод возвращает список типов туров по определенному городу отправления, стране и городу прибытия.
+
Метод производит выгрузку всех доступных городов отправления для поискового запроса.
 
* Формат запроса:
 
* Формат запроса:
−
** .../TourSearchOwin/ActualizeTourType?
+
** GET .../TourSearchOwin/departureCities?  
−
* Принимаемые параметры ( '''*''' – обязательный):
+
* Принимаемые параметры:
−
** '''departureCityKeys *''' – идентификатор города отправления (полученный из метода ''.../TourSearchOwin/departureCities?'')
+
** нет принимаемых параметров
−
** '''Key *''' – идентификатор страны прибытия (полученный из метода ''.../TourSearchOwin/Destination?'')
 
−
** '''Name *''' – название страны прибытия (полученный из метода ''.../TourSearchOwin/Destination?'')
 
−
** '''Type *''' – тип результата (всегда возвращается в JSON = 1, в xml = country)
 
−
** '''destinationCity *''' – идентификатор города прибытия (полученный из метода ''.../TourSearchOwin/ActualizeCities?''), по умолчанию передается ''-1'', то есть все города в рамках данной страны
 
−
** '''term *''' – фильтрация результатов по контекстному поиску (по умолчанию параметр пустой)
 
 
* Возвращаемый результат:
 
* Возвращаемый результат:
−
** '''Key''' – идентификатор типа тура
+
** '''Key''' – идентификатор города
−
** '''Name''' – название типа тура
+
** '''Name''' – название города
−
** '''ParentId''' – идентификатор группы, к которой относится данный типа тура (если тип тура не относится к группе, то возвращается ''null'')
 
  
 
<div class="toccolours mw-collapsible mw-collapsed" style="width:900px">Пример
 
<div class="toccolours mw-collapsible mw-collapsed" style="width:900px">Пример
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
 
<TABLE STYLE="border: 0.1em dashed #2F6FAB; margin: 8px; padding: 8px" WIDTH="99%"><TR><TD>
 
<TABLE STYLE="border: 0.1em dashed #2F6FAB; margin: 8px; padding: 8px" WIDTH="99%"><TR><TD>
−
Вызов метода ActualizeTourType
+
Вызов метода departureCities
 
<syntaxhighlight lang="java" enclose="div">
 
<syntaxhighlight lang="java" enclose="div">
−
http://localhost:9000/TourSearchOwin/ActualizeTourType?departureCityKeys=1&Key=90&Name=Австрия&Type=1&destinationCity=-1&terms=
+
GET http://localhost:9000/TourSearchOwin/departureCities
 
</syntaxhighlight>
 
</syntaxhighlight>
−
Возвращаемый результат метода ActualizeTourType (в формате JSON)
+
Возвращаемый результат метода departureCities (в формате JSON)
 
<syntaxhighlight lang="java" enclose="div">
 
<syntaxhighlight lang="java" enclose="div">
 
[
 
[
 
       {
 
       {
 
       "Key": -1,
 
       "Key": -1,
−
       "Name": "Все",
+
       "Name": "Без перелета"
−
      "ParentId": null
 
 
   },
 
   },
 
       {
 
       {
−
       "Key": 2,
+
       "Key": 312,
−
       "Name": "Стандартный тур",
+
       "Name": "Астрахань"
−
      "ParentId": null
 
 
   },
 
   },
 
       {
 
       {
−
       "Key": 16,
+
       "Key": 1,
−
       "Name": "Экскурсионный тур",
+
       "Name": "Москва"
−
      "ParentId": 35
 
 
   }
 
   }
 
]
 
]
Строка 467: Строка 589:
 
</div></div><br />
 
</div></div><br />
  
−
===Выгрузка актуальных дат заездов (TourDate)===
+
===Выгрузка актуальных стран (Destination)===
−
Метод производит выгрузку доступных дат заездов для поискового запроса.
+
Метод производит выгрузку всех доступных направлений туроператора.
 
* Формат запроса:
 
* Формат запроса:
−
** .../TourSearchOwin/TourDate?
+
** GET .../TourSearchOwin/Destination?
 
* Принимаемые параметры ( '''*''' – обязательный):
 
* Принимаемые параметры ( '''*''' – обязательный):
−
** '''departureCity *''' – идентификатор города отправления (полученный из метода ''.../TourSearchOwin/departureCities?'')
+
** '''departureCities *''' – идентификатор города(ов) отправления (из контроллера [[#Выгрузка актуальных городов отправления (departureCities)|''.../TourSearchOwin/departureCities?'']])
−
** '''destinationCity *''' – идентификатор города прибытия (полученный из метода ''.../TourSearchOwin/ActualizeCities?''), по умолчанию передается ''-1'', то есть все города в рамках данной страны
+
** '''type''' – настройка easySearchFilter (0/не указано - настройка выключена, 1 - настройка включена)
−
** '''Key *''' – идентификатор страны прибытия (полученный из метода ''.../TourSearchOwin/Destination?'')
+
** '''term''' – фильтрация результатов по контекстному поиску (по умолчанию параметр пустой)
−
** '''Name *''' – название страны прибытия (полученный из метода ''.../TourSearchOwin/Destination?'')
 
−
** '''Type *''' – тип результата (всегда возвращается в JSON = 1, в xml = country)
 
−
** '''tourTypes *''' – идентификатор типа тура (полученный из метода ''.../TourSearchOwin/ActualizeTourType?''), по умолчанию передается ''-1'', то есть все типы тура в рамках данной страны
 
−
** '''term *''' – фильтрация результатов по контекстному поиску (по умолчанию параметр пустой)
 
 
* Возвращаемый результат:
 
* Возвращаемый результат:
−
** массив дат
+
** '''Name''' – название страны
 +
** '''Key''' – идентификатор страны
 +
** '''DestinationType''' – тип результата (внутренний параметр, не изменяемый, всегда возвращается значение = 1)
 +
** '''IsExist''' – не используется
 +
** '''Data''' – массив данных для контекстного поиска
 +
*** '''CityKey''' – код города
 +
*** '''CityName''' – Название
 +
*** '''HotelKey''' – код отеля
 +
*** '''HotelName''' – название отеля
 +
*** '''ResortKey''' – код курорта
 +
*** '''ResortName''' – название курорта
 +
 
  
 
<div class="toccolours mw-collapsible mw-collapsed" style="width:900px">Пример
 
<div class="toccolours mw-collapsible mw-collapsed" style="width:900px">Пример
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
 
<TABLE STYLE="border: 0.1em dashed #2F6FAB; margin: 8px; padding: 8px" WIDTH="99%"><TR><TD>
 
<TABLE STYLE="border: 0.1em dashed #2F6FAB; margin: 8px; padding: 8px" WIDTH="99%"><TR><TD>
−
Вызов метода TourDate
+
Вызов метода Destination
 
<syntaxhighlight lang="java" enclose="div">
 
<syntaxhighlight lang="java" enclose="div">
−
http://localhost:9000/TourSearchOwin/TourDate?departureCity=1&destinationCity=-1&Key=90&Name=Австрия&Type=1&tourTypes=-1&term=
+
 
 +
GET http://localhost:9000/TourSearchOwin/Destination?departureCities=1
 
</syntaxhighlight>
 
</syntaxhighlight>
−
Возвращаемый результат метода TourDate (в формате JSON)
+
Возвращаемый результат метода Destination (в формате JSON)
 +
<syntaxhighlight lang="java" enclose="div">
 +
[
 +
      {
 +
      "Data": null,
 +
      "DestinationType": 1,
 +
      "IsExist": false,
 +
      "Key": 90,
 +
      "Name": "Австрия"
 +
   
 +
   
 +
  },
 +
      {
 +
      "Data": null,
 +
      "DestinationType": 1,
 +
      "IsExist": false,
 +
      "Key": 53,
 +
      "Name": "Тайланд"
 +
     
 +
     
 +
  },
 +
      {
 +
      "Data": null,
 +
      "DestinationType": 1,
 +
      "IsExist": false,
 +
      "Key": 460,
 +
      "Name": "Россия"
 +
     
 +
     
 +
  }
 +
]
 +
GET http://localhost:9000/TourSearchOwin/Destination?departureCities=1&type=1
 +
</syntaxhighlight>
 +
Возвращаемый результат метода Destination (в формате JSON) с включенной настройкой easySearchFilter
 
<syntaxhighlight lang="java" enclose="div">
 
<syntaxhighlight lang="java" enclose="div">
 
[
 
[
−
  "21.02.2018",
+
{
−
  "22.02.2018",
+
  "Name": "Австрия",
−
  "23.02.2018",
+
  "Key": 90,
−
  "24.02.2018",
+
  "DestinationType": 1,
−
  "25.02.2018",
+
  "IsExist": false,
−
  "26.02.2018",
+
  "Data":
−
  "27.02.2018",
+
        [
−
  "28.02.2018"
+
        {
 +
          "CityKey": 35,
 +
          "CityName": "Вена",
 +
          "HotelKey": 178,
 +
          "HotelName": "Ananas, 5+++*",
 +
          "ResortKey": 232,
 +
          "ResortName": "Малина"
 +
        },
 +
        {
 +
          "CityKey": 35,
 +
          "CityName": "Вена",
 +
          "HotelKey": 20748,
 +
          "HotelName": "Dev, 1-4*Boutique",
 +
          "ResortKey": 0,
 +
          "ResortName": ""
 +
        },
 +
      ],
 +
}
 +
{
 +
  "Name": "Тайланд",
 +
  "Key": 53,
 +
  "DestinationType": 1,
 +
  "IsExist": false,
 +
  "Data":
 +
        [
 +
          {
 +
            "CityKey": 415,
 +
            "CityName": "Пхукет",
 +
            "HotelKey": 5263,
 +
            "HotelName": "7Q Hotel, HV",
 +
            "ResortKey": 123,
 +
            "ResortName": "Пхукет"
 +
          }
 +
        ],
 +
},
 +
{
 +
  "Name": "Россия",
 +
  "Key": 460,
 +
  "DestinationType": 1,
 +
  "IsExist": false,
 +
  "Data":
 +
        [
 +
          {
 +
            "CityKey": 295,
 +
            "CityName": "Санкт-Петербург",
 +
            "HotelKey": 20365,
 +
            "HotelName": "Бристоль, 3*",
 +
            "ResortKey": 0,
 +
            "ResortName": ""
 +
          }
 +
        ],
 +
},
 +
{
 +
  "Name": "ОАЭ",
 +
  "Key": 2,
 +
  "DestinationType": 1,
 +
  "IsExist": false,
 +
  "Data":
 +
        [
 +
          {
 +
          "CityKey": 12,
 +
          "CityName": "ДУБАЙ",
 +
          "HotelKey": 1257,
 +
          "HotelName": "Avari, APTH3",
 +
          "ResortKey": 0,
 +
          "ResortName": ""
 +
          },
 +
      ],
 +
}
 
]
 
]
 
</syntaxhighlight>
 
</syntaxhighlight>
Строка 505: Строка 736:
 
</div></div><br />
 
</div></div><br />
  
−
===Выгрузка актуальных продолжительностей (Duration)===
+
===Выгрузка актуальных городов (ActualizeCities)===
−
Метод производит выгрузку доступных продолжительностей для поискового запроса.
+
Метод возвращает список всех доступных городов по определенному городу отправления и стране прибытия.
 
* Формат запроса:
 
* Формат запроса:
−
** .../TourSearchOwin/Duration?
+
** GET .../TourSearchOwin/ActualizeCities?
 
* Принимаемые параметры ( '''*''' – обязательный):
 
* Принимаемые параметры ( '''*''' – обязательный):
−
** '''departureCity *''' – идентификатор города отправления (полученный из метода ''.../TourSearchOwin/departureCities?'')
+
** '''cityKeys *''' – идентификатор города(ов) отправления (полученный из метода ''.../TourSearchOwin/departureCities?'')
−
** '''destinationCity *''' – идентификатор города прибытия (полученный из метода ''.../TourSearchOwin/ActualizeCities?''), по умолчанию передается ''-1'', то есть все города в рамках данной страны
 
 
** '''Key *''' – идентификатор страны прибытия (полученный из метода ''.../TourSearchOwin/Destination?'')
 
** '''Key *''' – идентификатор страны прибытия (полученный из метода ''.../TourSearchOwin/Destination?'')
−
** '''Name *''' – название страны прибытия (полученный из метода ''.../TourSearchOwin/Destination?'')
+
** '''term''' – фильтрация результатов по контекстному поиску (по умолчанию параметр пустой)
−
** '''Type *''' – тип результата (всегда возвращается в JSON = 1, в xml = country)
+
* Возвращаемый результат:
−
** '''tourDate *''' – массив дат заезда (полученные из метода ''.../TourSearchOwin/TourDate?''). Если параметры передаются через url, то каждое значение необходимо передавать отдельным параметром.
+
** '''Key''' – идентификатор города
−
** '''tourTypes *''' – идентификатор типа тура (полученный из метода ''.../TourSearchOwin/ActualizeTourType?''), по умолчанию передается ''-1'', то есть все типы тура в рамках данной страны
+
** '''Name''' – название города
−
** '''term *''' – фильтрация результатов по контекстному поиску (по умолчанию параметр пустой)
 
−
* Возвращаемый результат:
 
−
** массив продолжительностей
 
  
 
<div class="toccolours mw-collapsible mw-collapsed" style="width:900px">Пример
 
<div class="toccolours mw-collapsible mw-collapsed" style="width:900px">Пример
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
 
<TABLE STYLE="border: 0.1em dashed #2F6FAB; margin: 8px; padding: 8px" WIDTH="99%"><TR><TD>
 
<TABLE STYLE="border: 0.1em dashed #2F6FAB; margin: 8px; padding: 8px" WIDTH="99%"><TR><TD>
−
Вызов метода Duration
+
Вызов метода ActualizeCities
 
<syntaxhighlight lang="java" enclose="div">
 
<syntaxhighlight lang="java" enclose="div">
−
http://localhost:9000/TourSearchOwin/Duration?departureCity=1&destinationCity=-1&Key=90&Name=Австрия&Type=1&tourDate=25.02.2018&tourDate=26.02.2018&tourTypes=-1&term=
+
GET http://localhost:9000/TourSearchOwin/ActualizeCities?cityKeys=1&Key=90
 
</syntaxhighlight>
 
</syntaxhighlight>
−
Возвращаемый результат метода Duration (в формате JSON)
+
Возвращаемый результат метода ActualizeCities (в формате JSON)
 
<syntaxhighlight lang="java" enclose="div">
 
<syntaxhighlight lang="java" enclose="div">
 
[
 
[
−
  7,
+
      {
−
   8,
+
      "Key": -1,
−
  10,
+
      "Name": "Все"
−
   12,
+
   },
−
  15,
+
      {
−
   18
+
      "Key": 35,
 +
      "Name": "Вена"
 +
   },
 +
      {
 +
      "Key": 440,
 +
      "Name": "Зельден"
 +
   }
 
]
 
]
 
</syntaxhighlight>
 
</syntaxhighlight>
Строка 542: Строка 775:
 
</div></div><br />
 
</div></div><br />
  
−
===Поиск туров (Tour)===
+
===Выгрузка актуальных типов туров (ActualizeTourType)===
−
Метод поиска туров использует множество параметров для поиска и фильтрации туров. Метод возвращает наиболее дешевые предложения, найденные по предоставленным параметрам и сгруппированные по отелям в порядке возрастания цены.  
+
Метод возвращает список типов туров по определенному городу отправления, стране и городу прибытия.
 
* Формат запроса:
 
* Формат запроса:
−
** .../TourSearchOwin/Tour?
+
** GET .../TourSearchOwin/ActualizeTourType?
 
* Принимаемые параметры ( '''*''' – обязательный):
 
* Принимаемые параметры ( '''*''' – обязательный):
−
** '''DepartureCityKeys *''' – идентификатор города отправления (полученный из метода ''.../TourSearchOwin/departureCities?'')
+
** '''departureCityKeys *''' – идентификатор города(ов) отправления (полученный из метода ''.../TourSearchOwin/departureCities?'')
−
** '''Dates *''' – массив дат заезда (полученные из метода ''.../TourSearchOwin/TourDate?''). Если параметры передаются через url, то каждое значение необходимо передавать отдельным параметром.
+
** '''Key *''' – идентификатор страны прибытия (полученный из метода ''.../TourSearchOwin/Destination?'')
−
** '''Durations *''' – массив продолжительностей (полученные из метода ''.../TourSearchOwin/Duration?''). Если параметры передаются через url, то каждое значение необходимо передавать отдельным параметром.
+
** '''Type *''' – тип результата (внутренний параметр, не изменяемый, всегда указывать значение = 1)
−
** '''Groups''' – группировка результатов (2 – по названию тура, 4 – по дате тура, 8 – по продолжительности тура, 16 – по городу вылета, 32 – по отелю, 64 – по городу отеля, 128 – по курорту отеля, 256 – по категории отеля)
+
** '''destinationCity *''' – идентификатор города(ов) прибытия (полученный из метода ''.../TourSearchOwin/ActualizeCities?''), по умолчанию передается ''-1'', то есть все города в рамках данной страны
−
** '''PageNumber *''' – номер возвращаемой страницы (по умолчанию возвращается 1)
+
** '''terms''' – фильтрация результатов по контекстному поиску (по умолчанию параметр пустой)
−
** '''PageSize *''' – количество возвращаемых результатов на одной странице (возвращается 20)
+
* Возвращаемый результат:
−
** '''HotelScheme''' – пустой по умолчанию. Заполняется при вызове вариантов размещений в рамках одного отеля. Передаются следующие параметры: '''TemplateId''' – идентификатор шаблона услуги, '''DurationInNight''' – продолжительность отеля в ночах, '''Code''' – ключ отеля, '''PacketKey''' – ключ пакета, '''PartnerKey''' – ключ партнера
+
** '''Key''' – идентификатор типа тура
−
** '''BusTransferPointKeys''' – данный признак проставляется в ''true'' в том случае, когда происходит запрос вариантов проживания (кнопка ''Варианты'') в автобусных переездах
+
** '''Name''' – название типа тура
−
** '''TourKey''' – пустой по умолчанию. Заполняется при вызове вариантов размещений в рамках одного отеля: ключ программы тура
+
** '''ParentId''' – идентификатор группы, к которой относится данный тип тура (если тип тура не относится к группе, то возвращается ''null'')
−
** '''TourDuration''' – пустой по умолчанию. Заполняется при вызове вариантов размещений в рамках одного отеля: продолжительность тура в днях
+
 
−
** '''isFromBasket *''' – происходит ли обращение из корзины или из поиска туров (true/false)
+
<div class="toccolours mw-collapsible mw-collapsed" style="width:900px">Пример
−
** '''isFillSecondaryFilters *''' – заполнены ли дополнительные фильтры (по умолчанию всегда приходит true)
+
<div class="mw-collapsible-content">
−
** '''DestinationType *''' – тип результата (всегда возвращается в JSON = 1, в xml = country)
+
<TABLE STYLE="border: 0.1em dashed #2F6FAB; margin: 8px; padding: 8px" WIDTH="99%"><TR><TD>
−
** '''DestinationKey *''' – идентификатор страны прибытия (полученный из метода ''.../TourSearchOwin/Destination?'')
+
Вызов метода ActualizeTourType
−
** '''AdultCount *''' – количество взрослых
+
<syntaxhighlight lang="java" enclose="div">
−
** '''ChildAges''' – возраст детей. Если детей несколько, и параметры передаются через url, то каждое значение необходимо передавать отдельным параметром.
+
GET http://localhost:9000/TourSearchOwin/ActualizeTourType?departureCityKeys=1&Key=90&Type=1&destinationCity=-1
−
** '''CurrencyName''' – код валюты
+
</syntaxhighlight>
−
** '''AviaQuota *''' – информация о квотах на авиаперелет (значения параметров: ''"1"'' — фильтр "Есть", ''"5"'' — фильтр "Есть+запрос", ''"7"'' — фильтр "Все")
+
Возвращаемый результат метода ActualizeTourType (в формате JSON)
−
** '''HotelQuota *''' – информация о квотах на отель (значения параметров: ''"1"'' — фильтр "Есть", ''"5"'' — фильтр "Есть+запрос", ''"7"'' — фильтр "Все")
+
<syntaxhighlight lang="java" enclose="div">
−
** '''BusTransferQuota''' – информация о квотах на автобусный переезд (значения параметров: ''"1"'' — фильтр "Есть", ''"5"'' — фильтр "Есть+запрос", ''"7"'' — фильтр "Все")
+
[
−
** '''MinPrice *''' – минимальная цена (по умолчанию не задана, передается ''NaN'')
+
      {
−
** '''MaxPrice''' – максимальная цена (по умолчанию не передается)
+
      "Key": -1,
−
** '''TourType''' – идентификатор типа тура (полученный из метода ''.../TourSearchOwin/ActualizeTourType?''), по умолчанию передается ''-1'', то есть все типы тура в рамках данной страны. Возможна множественная передача параметров.
+
      "Name": "Все",
−
** '''Tour''' – ключ программы тура (дополнительный фильтр)
+
      "ParentId": null
−
** '''Duration''' – продолжительность тура (дополнительный фильтр)
+
  },
−
** '''DateTour''' – дата тура (дополнительный фильтр)
+
      {
−
** '''HotelResort''' – ключ курорта отеля (дополнительный фильтр)
+
      "Key": 2,
−
** '''HotelCity''' – ключ города отеля (дополнительный фильтр)
+
      "Name": "Стандартный тур",
−
** '''HotelType''' – ключ признака отеля (дополнительный фильтр)
+
      "ParentId": null
−
** '''HotelStars''' – ключ категории отеля (дополнительный фильтр)
+
  },
−
** '''Hotel''' – ключ отеля (дополнительный фильтр)
+
      {
−
** '''Pansions''' – ключ питания (дополнительный фильтр)
+
      "Key": 16,
−
** '''Airline''' – ключ авиакомпании (дополнительный фильтр)
+
      "Name": "Экскурсионный тур",
−
** '''AirportDeparture''' – ключ аэропорта вылета (дополнительный фильтр)
+
      "ParentId": 35
−
** '''AirportArrival''' – ключ аэропорта прилета (дополнительный фильтр)
+
  }
−
** '''CityIds''' – идентификатор города прибытия (полученный из метода ''.../TourSearchOwin/ActualizeCities?''), по умолчанию передается ''-1'', то есть все города в рамках данной страны. Возможна множественная передача параметров.
+
]
−
** '''TimeDepartureFrom''' – время отправления с (по умолчанию возвращается 00:00)
+
</syntaxhighlight>
−
** '''TimeDepartureTo''' – время отправления по (по умолчанию возвращается 23:59)
+
</TD></TR></TABLE>
−
** '''TimeArrivalFrom''' – время прибытия с (по умолчанию возвращается 00:00)
+
</div></div><br />
−
** '''TimeArrivalTo''' – время прибытия по (по умолчанию возвращается 23:59)
 
−
** '''ArrivalFlightNoTransfer''' – производить поиск без пересадок в прямом направлении (true/false, по умолчанию false)
 
−
** '''DepartureFlightNoTransfer''' – производить поиск без пересадок в обратном направлении (true/false, по умолчанию false)
 
−
** '''Tariff''' – ключ класса авиаперелета (дополнительный фильтр)
 
−
** '''FlightCityDeparture''' – ключ город вылета в параметрах авиаперелета (дополнительный фильтр)
 
−
** '''CityDeparture''' – ключ города начала поездки (дополнительный фильтр)
 
  
 +
===Выгрузка актуальных дат заездов (TourDate)===
 +
Метод производит выгрузку доступных дат заездов для поискового запроса.
 +
* Формат запроса:
 +
** GET .../TourSearchOwin/TourDate?
 +
* Принимаемые параметры ( '''*''' – обязательный):
 +
** '''departureCity *''' – идентификатор города(ов) отправления (полученный из метода ''.../TourSearchOwin/departureCities?'')
 +
** '''destinationCity *''' – идентификатор города(ов) прибытия (полученный из метода ''.../TourSearchOwin/ActualizeCities?''), по умолчанию передается ''-1'', то есть все города в рамках данной страны
 +
** '''Key *''' – идентификатор страны прибытия (полученный из метода ''.../TourSearchOwin/Destination?'')
 +
** '''Type *''' – тип результата (внутренний параметр, не изменяемый, всегда указывать значение = 1)
 +
** '''tourTypes *''' – идентификатор типа тура (полученный из метода ''.../TourSearchOwin/ActualizeTourType?''), по умолчанию передается ''-1'', то есть все типы тура в рамках данной страны
 
* Возвращаемый результат:
 
* Возвращаемый результат:
−
** '''CheckMessages''' – сообщения для логики проверки тура (не используется)
+
** массив дат
−
** '''Message''' – сообщение об ошибке
+
 
−
*** '''Key''' – код ошибки
+
<div class="toccolours mw-collapsible mw-collapsed" style="width:900px">Пример
−
*** '''Value''' – сообщение об ошибке
+
<div class="mw-collapsible-content">
−
** '''Result''' – результаты поиска
+
<TABLE STYLE="border: 0.1em dashed #2F6FAB; margin: 8px; padding: 8px" WIDTH="99%"><TR><TD>
−
*** '''Key''' – идентификатов программы тура
+
Вызов метода TourDate
−
*** '''Name''' – название программы тура
+
<syntaxhighlight lang="java" enclose="div">
−
*** '''TourUrl''' – ссылка на программу тура
+
GET http://localhost:9000/TourSearchOwin/TourDate?departureCity=1&destinationCity=-1&Key=90&Type=1&tourTypes=-1
−
*** '''BookingConditions''' – условия бронирования программы туров
+
</syntaxhighlight>
−
*** '''StartDate''' – дата начала тура
+
Возвращаемый результат метода TourDate (в формате JSON)
−
*** '''Duration''' – продолжительность тура (в днях)
+
<syntaxhighlight lang="java" enclose="div">
−
*** '''DurationInNight''' – продолжительность проживания (в ночах)
+
[
−
*** '''Types''' – идентификатор типа туров
+
  "21.02.2018",
−
*** '''Cost''' – цена тура
+
  "22.02.2018",
−
*** '''Rate''' – код валюты тура
+
  "23.02.2018",
−
*** '''CityDepature''' – город отправления
+
  "24.02.2018",
−
**** '''Key''' – идентификатор города отправления
+
  "25.02.2018",
−
**** '''Value''' – название города отправления
+
  "26.02.2018",
−
*** '''CountryId''' – всегда возвращается ключ 0
+
  "27.02.2018",
−
*** '''Services''' – услуги в туре
+
  "28.02.2018"
−
**** '''DepartureCity''' – город отправления
+
]
−
***** '''Key''' – идентификатор
+
</syntaxhighlight>
−
***** '''Value''' – название
+
</TD></TR></TABLE>
−
**** '''DepartureCountry
+
</div></div><br />
 +
 
 +
===Выгрузка актуальных продолжительностей (Duration)===
 +
Метод производит выгрузку доступных продолжительностей для поискового запроса.
 +
* Формат запроса:
 +
** GET .../TourSearchOwin/Duration?
 +
* Принимаемые параметры ( '''*''' – обязательный):
 +
** '''departureCity *''' – идентификатор города(ов) отправления (полученный из метода ''.../TourSearchOwin/departureCities?'')
 +
** '''destinationCity *''' – идентификатор города(ов) прибытия (полученный из метода ''.../TourSearchOwin/ActualizeCities?''), по умолчанию передается ''-1'', то есть все города в рамках данной страны
 +
** '''Key *''' – идентификатор страны прибытия (полученный из метода ''.../TourSearchOwin/Destination?'')
 +
** '''Type *''' – тип результата (внутренний параметр, не изменяемый, всегда указывать значение = 1)
 +
** '''tourDate *''' – массив дат заезда (полученные из метода ''..
 
                         {
 
                         {
−
               "Hotel":                {
+
               "DepartureCity":                {
−
                   "Key": 709,
+
                   "Key": 1,
−
                   "Value": "Am Brilliantengrund"
+
                   "Value": "Москва"
 +
              },
 +
              "DepartureCountry":                {
 +
                  "Key": 460,
 +
                  "Value": "Россия"
 
               },
 
               },
−
               "City":                {
+
               "ArrivalCity":                {
 
                   "Key": 35,
 
                   "Key": 35,
 
                   "Value": "Вена"
 
                   "Value": "Вена"
 
               },
 
               },
−
               "Stars":                {
+
               "ArrivalCountry":                {
−
                   "Key": -1,
+
                   "Key": 90,
−
                   "Value": null
+
                  "Value": "Австрия"
 +
              },
 +
              "DepartureAirport":                {
 +
                  "Key": "SVO4",
 +
                  "Value": "Шереметьево-24"
 +
              },
 +
              "ArrivalAirport":                {
 +
                  "Key": "VIE1",
 +
                   "Value": "Vena1"
 +
              },
 +
              "Airline":                {
 +
                  "Key": "BA7",
 +
                  "Value": "BRITISH  AIRWAYS"
 
               },
 
               },
−
               "Resort":                {
+
               "Aircraft":                {
−
                   "Key": -1,
+
                   "Key": "319",
−
                   "Value": null
+
                   "Value": "AIRBUS "
 
               },
 
               },
−
               "ImageURL": "",
+
               "Flight":                {
−
              "Http": null,
+
                   "Key": 882,
−
              "Description": "",
+
                   "Value": "4444"
−
              "Country":                {
 
−
                   "Key": 90,
 
−
                   "Value": "Австрия"
 
 
               },
 
               },
−
               "HotelDetails": [              {
+
               "DepartureTime": "10:00:00",
−
                  "HotelRoom": 46463,
+
              "ArrivalTime": "12:00:00",
−
                   "Room":                  {
+
              "EndDateTime": "2018-02-25T12:00:00",
−
                     "Key": 129,
+
              "FlightDetails": [              {
−
                     "Value": "DBL"
+
                   "Tariff":                  {
 +
                     "Key": 89,
 +
                    "Code": "Y",
 +
                     "Name": "Экономический класс"
 
                   },
 
                   },
−
                  "RoomCategory":                  {
+
                   "Cost": 10,
−
                    "Key": 3493,
+
                   "QuotaStatus":                  {
−
                    "Value": "Cosy"
+
                     "PlacesStatus": 4,
−
                  },
 
−
                  "AccomodationType":                  {
 
−
                    "Key": 1256,
 
−
                    "Value": "2+1_K",
 
−
                    "AdultCount": 2,
 
−
                    "ChildCount": 1
 
−
                  },
 
−
                  "Pansion":                  {
 
−
                    "Key": 4,
 
−
                    "Value": "Завтрак"
 
−
                  },
 
−
                   "Cost": 19.47,
 
−
                   "QuotaStatus":                  {
 
−
                     "PlacesStatus": 4,
 
 
                     "FreePlaces": 0,
 
                     "FreePlaces": 0,
−
                     "TotalPlaces": 0
+
                     "IsFewPlaces": false
 
                   },
 
                   },
−
                   "PartnerId": 12667,
+
                   "PartnerId": 12668,
−
                   "ByPax": false,
+
                   "ByPax": true,
 
                   "Partner":                  {
 
                   "Partner":                  {
−
                     "Key": 12667,
+
                     "Key": 0,
−
                     "Value": "Партнер-покупатель1"
+
                     "Value": null
 
                   }
 
                   }
 
               }],
 
               }],
−
               "HotelTypes": [              {
+
               "FlightSetting":               {
−
                   "Key": 5,
+
                   "ServiceId": 3,
−
                   "Value": "Рекомендуемые"
+
                   "PatternId": 13,
−
               }],
+
                  "FlightId": 13
−
               "Id": 1,
+
               },
−
               "SvKey": 3,
+
              "FlightSourceMode": 1,
 +
               "Id": 3,
 +
               "SvKey": 1,
 
               "IsSubCode1": true,
 
               "IsSubCode1": true,
−
               "IsSubCode2": true,
+
               "IsSubCode2": false,
 
               "IsPartnerBasedOn": false,
 
               "IsPartnerBasedOn": false,
 
               "Day": 1,
 
               "Day": 1,
−
               "DurationInNight": 3,
+
               "DurationInNight": 0,
−
               "BeginDateTime": "2018-02-25T12:00:00",
+
               "BeginDateTime": "2018-02-25T10:00:00",
−
              "EndDateTime": "2018-02-28T12:00:00",
 
 
               "IsHooded": false,
 
               "IsHooded": false,
 
               "IsDeleted": false,
 
               "IsDeleted": false,
 
               "IsNotCalculate": false,
 
               "IsNotCalculate": false,
 
               "PacketId": 779,
 
               "PacketId": 779,
−
               "Index": 1
+
               "Index": 0
 
             },
 
             },
 
                         {
 
                         {
−
               "DepartureCity":                {
+
               "Hotel":                {
 +
                  "Key": 709,
 +
                  "Value": "Am Brilliantengrund"
 +
              },
 +
              "City":                {
 
                   "Key": 35,
 
                   "Key": 35,
 
                   "Value": "Вена"
 
                   "Value": "Вена"
 
               },
 
               },
−
               "DepartureCountry":                {
+
               "Stars":                {
 +
                  "Key": -1,
 +
                  "Value": null
 +
              },
 +
              "Resort":                {
 +
                  "Key": -1,
 +
                  "Value": null
 +
              },
 +
              "ImageURL": "",
 +
              "Http": null,
 +
              "Description": "",
 +
              "Country":                {
 
                   "Key": 90,
 
                   "Key": 90,
 
                   "Value": "Австрия"
 
                   "Value": "Австрия"
 
               },
 
               },
−
               "ArrivalCity":               {
+
               "HotelDetails": [              {
−
                   "Key": 1,
+
                   "HotelRoom": 46463,
−
                   "Value": "Москва"
+
                   "Room":                   {
−
              },
+
                    "Key": 129,
−
              "ArrivalCountry":                {
</