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

Материал из Megatec
Перейти к: навигация, поиск
[досмотренная версия][досмотренная версия]
Строка 22: Строка 22:
  
 
===Выгрузка списка стран (GetCountries)===
 
===Выгрузка списка стран (GetCountries)===
Метод производит выгрузку всех направлений туроператора.<br />
+
Метод производит выгрузку всех направлений туроператора.
 
* Формат запроса:
 
* Формат запроса:
 
** ?action=GetCountries
 
** ?action=GetCountries
* Входные параметры:
+
* Принимаемые параметры:
 
** '''id''' – идентификатор страны (опциональный, если указан, то запрашивается только одна запись)
 
** '''id''' – идентификатор страны (опциональный, если указан, то запрашивается только одна запись)
 
* Возвращаемый результат:
 
* Возвращаемый результат:
 
** '''id''' – идентификатор страны
 
** '''id''' – идентификатор страны
 
** '''name''' – название страны (рус/анг)
 
** '''name''' – название страны (рус/анг)
 
 
 
<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">
Строка 56: Строка 54:
 
         "name": "Франция"
 
         "name": "Франция"
 
       }             
 
       }             
 +
  ]
 +
}
 +
</syntaxhighlight>
 +
</TD></TR></TABLE>
 +
</div></div><br />
 +
 +
===Выгрузка списка городов вылета (GetDepartCities)===
 +
Метод производит выгрузку всех доступных городов вылета, а также содержит данные о том, какие направления доступны из каждого города вылета.
 +
* Формат запроса:
 +
** ?action=GetDepartCities
 +
* Принимаемые параметры:
 +
** '''id''' – идентификатор города вылета (опциональный, если указан, то запрашивается только одна запись)
 +
* Возвращаемый результат:
 +
** '''id''' – идентификатор города
 +
** '''name''' – название города (рус/анг)
 +
** '''countriesTo''' – идентификаторы стран, которые присутствуют в данном городе вылета
 +
<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>
 +
Вызов метода GetCountries
 +
<syntaxhighlight lang="java" enclose="div">
 +
http://localhost:9000/TourSearchOwin/searchApi?action=GetDepartCities
 +
</syntaxhighlight>
 +
Возвращаемый результат метода GetCountries (в формате JSON)
 +
<syntaxhighlight lang="java" enclose="div">
 +
{
 +
  "version": "1.0",
 +
  "departCities":    [
 +
            {
 +
        "id": -1,
 +
        "name": "Не указан",
 +
        "countriesTo":          [
 +
            97,
 +
            90
 +
        ]
 +
      },
 +
            {
 +
        "id": 1,
 +
        "name": "Москва",
 +
        "countriesTo":          [
 +
            90,
 +
            30
 +
        ]
 +
      }
 
   ]
 
   ]
 
}
 
}

Версия 09:34, 9 августа 2016

Статья находится на стадии разработки.
Версия статьи от 9-08-2016.

Поддерживаемые версии ПК «Мастер-Тур»:
Начиная с 15 версии


Введение

Данный web-сервис выполняет следующие задачи:

  • выгружает справочники (города вылета, страны, курорты, отели и т.д.)
  • осуществляет параметризованный поиск цен
  • актуализирует выбранный тур по его идентификатору

Выдача результатов осуществляется в формате JSON

Установка

Настройка

Загрузка справочников

Выгрузка списка стран (GetCountries)

Метод производит выгрузку всех направлений туроператора.

  • Формат запроса:
    •  ?action=GetCountries
  • Принимаемые параметры:
    • id – идентификатор страны (опциональный, если указан, то запрашивается только одна запись)
  • Возвращаемый результат:
    • id – идентификатор страны
    • name – название страны (рус/анг)
Пример

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

http://localhost:9000/TourSearchOwin/searchApi?action=GetCountries

Возвращаемый результат метода GetCountries (в формате JSON)

{
   "version": "1.0",
   "countries":    [
            {
         "id": 97,
         "name": "Тунис"
      },            
            {
         "id": 90,
         "name": "Австрия"
      },
            {
         "id": 30,
         "name": "Франция"
      }            
   ]
}


Выгрузка списка городов вылета (GetDepartCities)

Метод производит выгрузку всех доступных городов вылета, а также содержит данные о том, какие направления доступны из каждого города вылета.

  • Формат запроса:
    •  ?action=GetDepartCities
  • Принимаемые параметры:
    • id – идентификатор города вылета (опциональный, если указан, то запрашивается только одна запись)
  • Возвращаемый результат:
    • id – идентификатор города
    • name – название города (рус/анг)
    • countriesTo – идентификаторы стран, которые присутствуют в данном городе вылета
Пример

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

http://localhost:9000/TourSearchOwin/searchApi?action=GetDepartCities

Возвращаемый результат метода GetCountries (в формате JSON)

{
   "version": "1.0",
   "departCities":    [
            {
         "id": -1,
         "name": "Не указан",
         "countriesTo":          [
            97,
            90
         ]
      },
            {
         "id": 1,
         "name": "Москва",
         "countriesTo":          [
            90,
            30
         ]
      }
   ]
}



Выгрузка списка курортов (GetResorts)

Метод возвращает список всех доступных курортов.

  • Формат запроса:
    •  ?action=GetResorts
  • Параметры:
    • id – идентификатор курорта (опциональный, если указан, то запрашивается только одна запись)
Формат выдачи (JSON)
{
   "version": "1.0",
   "resorts":    [            
            { 
         "id": {Int32}, 
         "name": {String} 
         "countryId": {Int32}
      }, 
      ... 
   ] 
}

Корневой элемент resorts содержит произвольное количество элементов resort, каждый из которых описывает курорт атрибутами id (идентификатор курорта), name (название курорта) и countryId (идентификатор страны, в котором расположен курорт).


Пример
{
   "version": "1.0",
   "countries":    [
            {
         "id": 1,
         "name": "Каринтия",
         "countryId": 90
      },           
            {
         "id": 42,
         "name": "Хаммамед",
         "countryId": 97
      },
            {
         "id": 40,
         "name": "Сусс",
         "countryId": 97
      }           
   ]
}


Выгрузка списка категорий отелей (GetHotelCategories)

Метод возвращает список категорий отелей (примеры: 3*, 4*, Apts и т.д.).

  • Формат запроса:
    •  ?action=GetHotelCategories
  • Параметры:
    • id – идентификатор категории отеля (опциональный, если указан, то запрашивается только одна запись)
Формат выдачи (JSON)
{
   "version": "1.0",
   "hotelCategories":    [            
            { 
         "id": {Int32}, 
         "name": {String} 
      }, 
      ... 
   ] 
}

Корневой элемент hotelCategories содержит произвольное количество элементов hotelCategory, каждый из которых описывает категорию отеля атрибутами id (идентификатор) и name (название).


Пример
{
   "version": "1.0",
   "countries":    [
            {
         "id": 97,
         "name": "Тунис"
      },            
            {
         "id": 90,
         "name": "Австрия"
      },
            {
         "id": 30,
         "name": "Франция"
      }            
   ]
}