@@ Строка 12: / Строка 12: @@
 Для работы с web-сервисом необходимо на отдающей стороне установить [[Мастер-Тур(15):Установка#Установка службы поиска|службу поиска]].<br />
 После установки web-сервис будет доступен по адресу ''<nowiki>http://значение настройки "serviceAddress" в TourSearchOwin/"название метода"</nowiki>'' (пример: ''http://localhost:9000/TourSearchOwin/Settings'')
+==Swagger==
+Работу методов можно проверить с помощью Swagger по пути: ''http://localhost:9000/TourSearchOwin/SwaggerUI''
 ==Список методов==
@@ Строка 17: / Строка 20: @@
 Последовательность вызова методов сервиса<br />
 [[Файл: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)===
@@ Строка 105: / Строка 170: @@
 *** ''<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="mw-collapsible-content">
@@ Строка 182: / Строка 253: @@
     "ShowHotelImagesInSearch": true
     "CacheReadyMessage":	"Кеш инициализирован"
+    "nodeId": 2147483647,
+    "FullPaymentPeriod": null,
+    "FullPaymentCheckin": 5,
+    "PrePaymentPeriod": null,
+    "PrePaymentCheckin": 10,
+    "PrePaymentPercent": 50.0,
+    "PrePaymentCu": null
 }
 </syntaxhighlight>
 </TD></TR></TABLE>
 </div></div><br />
 ===Выгрузка списка валют в онлайне (Currency)===
@@ Строка 257: / Строка 334: @@
 ** GET .../TourSearchOwin/CurrencyRates
 * Принимаемые параметры:
-** нет принимаемых параметров
+** '''dateFrom''' – начальная дата, от которой вывести список курсов валют, в формате DD.MM.YYYY, необязательный параметр (если не указан, берется за текущий день)
+** '''dateTo''' – конечная дата, до которой вывести список курсов валют, в формате DD.MM.YYYY, необязательный параметр (если не указан, берется за текущий день)
+** '''otherBaseCurrencyId''' – идентификатор любой валюты, эмулирующей работу национальной валюты, необязательный параметр. Если заполнен, то в результатах выдачи параметр ''baseCurrencyId'' будет заменяться на валюту из параметра ''otherBaseCurrencyId'' (обрабатывается с релиза 15.9).
 * Возвращаемый результат:
 ** '''baseCurrencyId''' – идентификатор национальной валюты, либо произвольной валюты, указанной в настройке ''basketCurrency'' в конфигурационном файле (обрабатывается с релиза 15.6)
 ** '''currencyId''' – идентификатор валюты, курс которой приводится
 ** '''rate''' – курс валюты (отношение '''currencyId''' к '''baseCurrencyId''')
+** '''date''' – дата, на которую был зарегистрирован выводимый курс валюты
 <div class="toccolours mw-collapsible mw-collapsed" style="width:900px">Пример
@@ Строка 268: / Строка 349: @@
 Вызов метода CurrencyRates
 <syntaxhighlight lang="java" enclose="div">
-http://localhost:9000/TourSearchOwin/CurrencyRates
+http://localhost:9000/TourSearchOwin/CurrencyRates?dateFrom=18.09.2024&dateTo=19.09.2024
 </syntaxhighlight>
 Возвращаемый результат метода CurrencyRates (в формате JSON)
 <syntaxhighlight lang="java" enclose="div">
-{
+[
-   "version": "1.08",
+    {
-   "currencyRates":    [
+        "BaseCurrencyId": 14,
-            {
+        "CurrencyId": 1,
-         "baseCurrencyId": 2,
+        "Rate": 91.429200,
-         "currencyId": 1,
+        "Date": "18.09.2024"
-         "rate": 65.256054
+    },
-      },
+    {
-            {
+        "BaseCurrencyId": 14,
-         "baseCurrencyId": 2,
+        "CurrencyId": 2,
-         "currencyId": 3,
+        "Rate": 101.505700,
-         "rate": 71.168955
+        "Date": "18.09.2024"
-      }
+    },
-   ]
+    {
-}
+        "BaseCurrencyId": 14,
+        "CurrencyId": 1,
+        "Rate": 91.671200,
+        "Date": "19.09.2024"
+    },
+    {
+        "BaseCurrencyId": 14,
+        "CurrencyId": 2,
+        "Rate": 102.039000,
+        "Date": "19.09.2024"
+    }
+]
 </syntaxhighlight>
@@ Строка 503: / Строка 595: @@
 * Принимаемые параметры ( '''*''' – обязательный):
 ** '''departureCities *''' – идентификатор города(ов) отправления (из контроллера [[#Выгрузка актуальных городов отправления (departureCities)|''.../TourSearchOwin/departureCities?'']])
+** '''type''' – настройка easySearchFilter (0/не указано - настройка выключена, 1 - настройка включена)
 ** '''term''' – фильтрация результатов по контекстному поиску (по умолчанию параметр пустой)
 * Возвращаемый результат:
 ** '''Name''' – название страны
 ** '''Key''' – идентификатор страны
-** '''DestinationType''' – тип результата (всегда возвращается в JSON = 1, в xml = country)
+** '''DestinationType''' – тип результата (внутренний параметр, не изменяемый, всегда возвращается значение = 1)
+** '''IsExist''' – не используется
+** '''Data''' – массив данных для контекстного поиска
+*** '''CityKey''' – код города
+*** '''CityName''' – Название
+*** '''HotelKey''' – код отеля
+*** '''HotelName''' – название отеля
+*** '''ResortKey''' – код курорта
+*** '''ResortName''' – название курорта
 <div class="toccolours mw-collapsible mw-collapsed" style="width:900px">Пример
@@ Строка 514: / Строка 616: @@
 Вызов метода Destination
 <syntaxhighlight lang="java" enclose="div">
 GET http://localhost:9000/TourSearchOwin/Destination?departureCities=1
 </syntaxhighlight>
@@ Строка 520: / Строка 623: @@
 [
        {
-       "Name": "Болгария",
+       "Data": null,
-       "Key": 359,
+      "DestinationType": 1,
-       "DestinationType": 1
+      "IsExist": false,
+       "Key": 90,
+       "Name": "Австрия"
     },
        {
-       "Name": "Индия",
+       "Data": null,
-       "Key": 26,
+      "DestinationType": 1,
-       "DestinationType": 1
+      "IsExist": false,
+       "Key": 53,
+       "Name": "Тайланд"
     },
        {
-       "Name": "Финляндия",
+       "Data": null,
-       "Key": 64,
+      "DestinationType": 1,
-       "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">
+[
+ {
+  "Name": "Австрия",
+  "Key": 90,
+  "DestinationType": 1,
+  "IsExist": false,
+  "Data":
+        [
+         {
+          "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>
@@ Строка 585: / Строка 782: @@
 ** '''departureCityKeys *''' – идентификатор города(ов) отправления (полученный из метода ''.../TourSearchOwin/departureCities?'')
 ** '''Key *''' – идентификатор страны прибытия (полученный из метода ''.../TourSearchOwin/Destination?'')
-** '''Type *''' – тип результата (всегда возвращается в JSON = 1, в xml = country)
+** '''Type *''' – тип результата (внутренний параметр, не изменяемый, всегда указывать значение = 1)
 ** '''destinationCity *''' – идентификатор города(ов) прибытия (полученный из метода ''.../TourSearchOwin/ActualizeCities?''), по умолчанию передается ''-1'', то есть все города в рамках данной страны
 ** '''terms''' – фильтрация результатов по контекстному поиску (по умолчанию параметр пустой)
@@ Строка 591: / Строка 788: @@
 ** '''Key''' – идентификатор типа тура
 ** '''Name''' – название типа тура
-** '''ParentId''' – идентификатор группы, к которой относится данный типа тура (если тип тура не относится к группе, то возвращается ''null'')
+** '''ParentId''' – идентификатор группы, к которой относится данный тип тура (если тип тура не относится к группе, то возвращается ''null'')
 <div class="toccolours mw-collapsible mw-collapsed" style="width:900px">Пример
@@ Строка 631: / Строка 828: @@
 ** '''destinationCity *''' – идентификатор города(ов) прибытия (полученный из метода ''.../TourSearchOwin/ActualizeCities?''), по умолчанию передается ''-1'', то есть все города в рамках данной страны
 ** '''Key *''' – идентификатор страны прибытия (полученный из метода ''.../TourSearchOwin/Destination?'')
-** '''Type *''' – тип результата (всегда возвращается в JSON = 1, в xml = country)
+** '''Type *''' – тип результата (внутренний параметр, не изменяемый, всегда указывать значение = 1)
 ** '''tourTypes *''' – идентификатор типа тура (полученный из метода ''.../TourSearchOwin/ActualizeTourType?''), по умолчанию передается ''-1'', то есть все типы тура в рамках данной страны
 * Возвращаемый результат:
@@ Строка 667: / Строка 864: @@
 ** '''destinationCity *''' – идентификатор города(ов) прибытия (полученный из метода ''.../TourSearchOwin/ActualizeCities?''), по умолчанию передается ''-1'', то есть все города в рамках данной страны
 ** '''Key *''' – идентификатор страны прибытия (полученный из метода ''.../TourSearchOwin/Destination?'')
-** '''Type *''' – тип результата (всегда возвращается в JSON = 1, в xml = country)
+** '''Type *''' – тип результата (внутренний параметр, не изменяемый, всегда указывать значение = 1)
 ** '''tourDate *''' – массив дат заезда (полученные из метода ''.../TourSearchOwin/TourDate?''). Если параметры передаются через url, то каждое значение необходимо передавать отдельным параметром.
 ** '''tourTypes *''' – идентификатор типа(ов) тура (полученный из метода ''.../TourSearchOwin/ActualizeTourType?''), по умолчанию передается ''-1'', то есть все типы тура в рамках данной страны
@@ Строка 706: / Строка 903: @@
 ** '''PageSize *''' – количество возвращаемых результатов на одной странице (возвращается 20)
 ** '''isFromBasket *''' – происходит ли обращение из корзины или из поиска туров (true/false)
-** '''isFillSecondaryFilters *''' – заполнены ли дополнительные фильтры (по умолчанию всегда приходит true)
+** '''isFillSecondaryFilters''' – заполнены ли дополнительные фильтры (по умолчанию всегда приходит true). Служебный внутренний параметр. При работе с API не используется.
-** '''DestinationType *''' – тип результата (всегда возвращается в JSON = 1, в xml = country)
+** '''DestinationType *''' – тип результата (внутренний параметр, не изменяемый, всегда указывать значение = 1)
 ** '''DestinationKey *''' – идентификатор страны прибытия (полученный из метода ''.../TourSearchOwin/Destination?'')
 ** '''AdultCount *''' – количество взрослых
@@ Строка 719: / Строка 916: @@
 ** '''Groups''' – группировка результатов (2 – по названию тура, 4 – по дате тура, 8 – по продолжительности тура, 16 – по городу вылета, 32 – по отелю, 64 – по городу отеля, 128 – по курорту отеля, 256 – по категории отеля)
 ** '''HotelScheme''' – пустой по умолчанию. Заполняется при вызове вариантов размещений в рамках одного отеля. Передаются следующие параметры:
-*** '''TemplateId''' – идентификатор шаблона услуги,
+*** '''TemplateId''' – идентификатор шаблона услуги (этот параметр можно взять из контроллера Tour->Result->MinCostServicesComposition->Key->TemplateId),
-*** '''DurationInNight''' – продолжительность отеля в ночах,
+*** '''DurationInNight''' – продолжительность отеля в ночах (этот параметр можно взять из контроллера Tour->Result->MinCostServicesComposition->Value->DurationInNight),
-*** '''Code''' – ключ отеля,
+*** '''Code''' – ключ отеля (этот параметр можно взять из контроллера Tour->Result->MinCostServicesComposition->Value->Code),
-*** '''PacketKey''' – ключ пакета,
+*** '''PacketKey''' – ключ пакета (этот параметр можно взять из контроллера Tour->Result->MinCostServicesComposition->Value->PacketId),
-*** '''PartnerKey''' – ключ партнера
+*** '''PartnerKey''' – ключ партнера (этот параметр можно взять из контроллера Tour->Result->MinCostServicesComposition->Value->PartnerId),
-*** '''GDSProviderId''' – ключ провайдера из внешней системы
+*** '''GDSProviderId''' – ключ провайдера из внешней системы (этот параметр можно взять из контроллера Tour->Result->MinCostServicesComposition->Value->GDSProviderId),
-*** '''TotalTourDuration''' – общая продолжительность тура в днях
+*** '''TotalTourDuration''' – общая продолжительность тура в днях (этот параметр можно взять из контроллера Tour->Result->Duration)
 ** '''BusTransferPointKeys''' – данный признак проставляется в ''true'' в том случае, когда происходит запрос вариантов проживания (кнопка ''Варианты'') в автобусных переездах
 ** '''TourKey''' – пустой по умолчанию. Заполняется при вызове вариантов размещений в рамках одного отеля: ключ программы тура
@@ Строка 757: / Строка 954: @@
 ** '''CityDeparture''' – ключ города начала поездки (дополнительный фильтр)
 ** '''RemoteHotelMode''' – признак того, производится поиск только локальных отелей или и от внешних поставщиков тоже (только локальные отели – 0, только внешние отели – 2, локальные и внешние отели – 1). Если признак отсутствует – поиск будет только по локальным отелям. Обрабатывается начиная с релиза 15.4.
-** '''GroupGuid''' – используется для получения турпрограмм по уникальному ключу из кэша при использовании группировки. Примеры использования. ''GroupGuid=00000000-0000-0000-0000-000000000000'' – при первом запросе от локальной системы. ''GroupGuid=936DA01F-9ABD-4d9d-80C7-02AF85C822A8'' (уникальный ключ) – передается на клиент от первого запроса из внешней системы. С данным уникальным ключом осуществляется второй запрос от удаленной внешней системы. Далее происходит получение значений по данному уникальному ключу. Обрабатывается начиная с релиза 15.4.
+** '''GroupGuid''' – используется для получения турпрограмм по уникальному ключу из кэша при использовании группировки. Примеры использования. ''GroupGuid=00000000-0000-0000-0000-000000000000'' – при первом запросе от локальной системы. ''GroupGuid=936DA01F-9ABD-4d9d-80C7-02AF85C822A8'' (уникальный ключ) – передается на клиент от первого запроса из внешней системы. С данным уникальным ключом осуществляется второй запрос от внешней системы. Дале

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