Мастер-Агент:Методы веб-сервиса брони.ру

Материал из Megatec
Перейти к: навигация, поиск

[править] Введение

В данной статье описываются методы веб-сервиса брони.ру.

Название метода веб-сервисаОписание метода веб-сервиса
Методы загрузки туров
GetValidTourListКомментарий к методу: Возвращает список доступных опубликованных СПО.
GetValidTourListFromПринимаемые параметры:

checkPoint – дата, начиная с которой выгружается информация о доступных опубликованных СПО

Комментарий к методу:

Возвращает список доступных опубликованных СПО
GetPriceListByTourПринимаемые параметры:

tourKey – ключ СПО

Комментарий к методу:

Возвращает цены по ключу. Вместо данного метода рекомендуется использовать метод GetSPOPageByKey

Примечание:

Не рекомендуется использовать. В следующей версии сервиса будет недоступен. Вместо данного метода используйте GetSPOPageByKey.
GetPriceListByTourFromToПринимаемые параметры:

tourKey – ключ СПО

from – дата начала периода

to – дата окончания периода

Комментарий к методу:

Возвращает цены по ключу c учетом периода.

Примечание:

Не рекомендуется использовать. В следующей версии сервиса будет недоступен. Вместо данного метода используйте GetSPOPageByKey.
GetSPOPageByKeyПринимаемые параметры:

SpoKey – ключ СПО

minPriceKey – ключ цены, начиная с которой осуществлять выгрузку

pageSize – количество записей получаемых за один запрос

Комментарий к методу:

Осуществляет постраничную загрузку цен.
Методы выгрузки информации о квотах
GetStopSalesAndQuotesПринимаемые параметры:

сheckPoint – дата, начиная с которой, выгружается информация по квотам и их изменениям

Комментарий к методу:

Возвращает информацию по квотам. В версии МТ 8.1 пока не реализовано.
GetStopSalesAndQuotes2Принимаемые параметры:

сheckPoint – дата, начиная с которой, выгружается информация по квотам и их изменениям. Дата создания квоты или дата последнего изменения должны быть больше или равны дате выгрузки информации.

В данном методе оптимизирована загрузка квот, а также указанный метод возвращает более полную информацию по квотам. Формат возвращаемых данных совместим с форматом, который будет использоваться для возврата квот версий 8.1 - 9.2.

Комментарий к методу:

Возвращает информацию по квотам. В версии МТ 8.1 пока не реализовано.
Методы бронирования
GetAgreementCredentialsПринимаемые параметры:

login – имя пользователя

password – пароль пользователя

Комментарий к методу:

Возвращает ключ агентства по логину и паролю онлайн пользователя
CheckBookingПринимаемые параметры:

Дата заезда, Ключ агентства, ключ рассчитанного тура, туристы

Комментарий к методу:

Осуществляет проверку возможности бронирования рассчитанного прайса.

Возвращает услуги по прайсу, их статусы (есть или нет мест), актуальную цену путевки.
CreateBookingПринимаемые параметры:

Дата заезда, Ключ агентства, ключ рассчитанного тура, туристы Комментарий к методу:

Осуществляет бронирование рассчитанного прайса.

Возвращает созданный договор.
Работа с путевкой
CancelAgreementПринимаемые параметры:

agencyId - ключ туристического агентства

agreementNumber – Номер путевки

Комментарий к методу:

Отправляет запрос на аннуляцию путевки
GetAgreementsByNumberПринимаемые параметры:

Ключ агентства и коды забронированных путевок

Комментарий к методу:

Возвращает информацию по забронированным путевкам
Метод проверки работы
GetVersionКомментарий к методу: Возвращает версию базы данных Мастер-Тур и текущей бизнес-логики сервиса
Методы категории "Разное"
GetReferencesПринимаемые параметры:

string queryType - идентификатор запроса

string param - ключ фильтра

Комментарий к методу:

Возврат справочной информации по идентификатору и ключу

[править] Описание метода GetSPOPageByKey

Принимаемые параметры:

SpoKey – ключ СПО

minPriceKey – ключ цены, начиная с которой осуществлять выгрузку

pageSize – количество записей получаемых за один запрос (не больше 5000)

Количество записей (pageSize) рекомендуется брать 5000, поскольку это наиболее оптимальная величина. Выгрузка страницы с 5000 ценами занимает порядка 5-20 секунд, в зависимости от производительности сервера и его текущей загрузки.

Пример.

Пусть требуется выгрузить СПО с ID = 25. Из результатов метода GetValidTourList мы знаем, что в данном СПО, например, 26430 цен. Первый запрос мы отправляем с параметрами 25, 0, 5000. В качестве ответа сервиса получим TourML, в котором будут описаны первые 5000 прайсов указанного СПО. Чтобы выполнить загрузку следующей страницы нам нужно передать в качестве параметров 25, maxPriceID, 5000, где maxPriceID - максимальный ID цены которая вернулась в предыдущем запросе.

В ответе сервиса ID прайсов возвращаются в тегах date, сгруппированных по цене.

<price gross="777">
<date key="448497" from="2009-09-06" to="2009-09-06" />
</price>

Чтобы найти maxPriceID нужно перебрать все теги date и выбрать тот, у которого атрибут key максимальный.

В последних версиях сервиса доступен атрибут lastKey у элемента loadTime, в котором указан maxPriceID. Если lastKey=-1, то загрузка окончена и этот TourML - последняя страница.

<header name="" uri="http://notfound.net">
    <loadTime timeValue="100" lastKey="87546090" 
                            xmlns="http://www.megatec.ru/tourml/extensions" />
</header>

Таким образом, чтобы выгрузить весь тур (26430 цен) необходимо отправить 6 запросов. Последний запрос также можно отправить с pageSize = 5000. Сервис вернет оставшиеся 1430 цен.

Личные инструменты
Пространства имён

Варианты
Просмотры
Действия
Навигация
Инструменты