Мастер-Тур:Работа с методами веб-сервисов

Статья находится на стадии разработки.

Содержание

1 Введение
- 1.1 Обзор
- 1.2 Установка
2 Список существующих web-сервисов

Введение

Обзор

Краткое описание, что такое web-сервиса и для чего они нужны В этой статье собраны ссылки на статьи с описаниями работы Web-сервисов.

Установка

Общее описание установки web-сервисов. Тонкости, отличительные особенности и т.д.

Список существующих web-сервисов

Сервис 1

Краткое описание сервиса 1 (для чего он нужен). Ссылка на статью.

Метод 1

Описание метода
Сигнатура метода
Описание принимаемых методом параметров
Возвращаемые значения

Либо краткое описание и ссылка внутрь статьи, где именно описан этот метод.

Метод 2

Описание метода
Сигнатура метода
Описание принимаемых методом параметров
Возвращаемые значения

Либо краткое описание и ссылка внутрь статьи, где именно описан этот метод.

Метод 3

Описание метода
Сигнатура метода
Описание принимаемых методом параметров
Возвращаемые значения

Либо краткое описание и ссылка внутрь статьи, где именно описан этот метод.

Поисковый сервис (Search)

Данный модуль предназначен для осуществления поиска и подбора туров из внешних приложений - Поисковый сервис.

Метод Search.DoSearch

Метод Search.DoSearch позволяет осуществлять поиск туров - Метод Search.DoSearch

Метод DoSearch обладает параметрами:

SearchFilter filter – объект класса, описывающего критерии подбора тура
int pageNumber – порядковый номер запрашиваемой страницы
SearchParams searchParams – объект класса, описывающего параметры подбора тура

Сервис возвращает объект класса SearchResult, содержащий коллекцию объектов класса SearchResultItem.

AddCostLogic

AdminService

ApplicationsLog

CalculatePriceListDynamic

DictionaryService

QuotaLogic

TourMarginLogic

UserService

TourML

Сервис по оплате путевок внешними системами (сервис для интеграции с платежной системой, прием наличных через платежный терминал, FinanceService)

Данный модуль предназначен для проверки заявки и проведения платежа через платежную систему в базу туроператора(Сервис для интеграции с платежной системой). Модуль совместим со следующими платежными системами:

TourPay
Контакт
Лидер

Метод GetUserToken

Метод GetUserToken возвращает строку - идентификатор аутентификации, который используется для подтверждения авторизации при вызове методов web-сервисов - Метод GetUserToken.

Сигнатура метода - public TokenResult GetUserToken(string userLogin, string userPassword)

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

userLogin - имя пользователя;
userPassword - пароль.

Возвращаемые значения - метод возвращает результат своей работы в виде класса TokenResult. Корректность результата проверяется значением поля ErrorCode данного класса:

0 - результат корректный;
2 – внутренняя ошибка;
5 - неправильный логин или пароль.

Описание класса приведено ниже:

public class TokenResult
 {
     public int ErrorCode;
     public string Token;
 }

где

ErrorCode - код результата;
Token - идентификатор аутентификации.

Метод CheckReservation

Метод CheckReservation предназначен для проверки наличия заявки в БД и определения ее стоимости - Метод CheckReservation. Сигнатура метода - public AmountSum CheckReservation(string userToken, string dgCode)

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

userToken - идентификатор аутентификации, полученный при вызове метода GetUserToken;
dgCode - строковая переменная, представляющая собой код проверяемой путевки.

Возвращаемые значения - метод возвращает результат своей работы в виде класса AmountSum. Корректность результата проверяется значением поля ErrorCode данного класса:

0 – результат корректный, в полях возвращены корректные значения;
1 – заявка не найдена в БД;
2 – внутренняя ошибка;
3 - заявка была аннулирована;
4 - путевка уже оплачена;
6 - некорректный или устаревший идентификатор аутентификации(token).

Ниже приводится описание класса.

public class AmountSum
    {
        public double Amount
        public string RateCode
        public double NationalCurrencyPrice
        public string NationalRateCode
        public int ErrorCode
        public int FilialKey
        public DateTime BeginTourDate
        public DateTime EndTourDate
    }

Amount - сумма к оплате в валюте тура;
RateCode - iso-код валюты тура;
NationalCurrencyPrice - сумма к оплате в национальной валюте;
NationalRateCode - iso-код национальной валюты;
ErrorCode - код результата;
FilialKey - ключ филиала, который создал заявку;
BeginTourDate - дата начала тура;
EndTourDate - дата окончания тура.

Метод CreatePayment

Метод CreatePayment предназначен для создания платежа по путевке в финансовом блоке ПК Мастер-Тур - Метод CreatePayment. Сигнатура метода - public int CreatePayment(string userToken, DateTime date, Decimal sum, string currencyIsoCode, string reservationCode, string paymentId)

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

userToken - идентификатор аутентифкации;
date – дата проведения платежа;
sum – сумма платежа;
currencyIsoCode – ISO-код валюты, в которой осуществляется платеж;
reservationCode – номер путевки;
paymentId – идентификатор платежа во внешней системе.

Возвращаемые значения - метод возвращает целочисленное значение обозначающее результат выполнения операции:

0 – операция выполнена успешно, платеж проведен;
1 – заявка не найдена в БД;
2 – внутренняя ошибка при создании платежа;
3 - заявка была аннулирована;
4 - путевка уже оплачена;
6 - некорректный или устаревший идентификатор аутентификации(token).

При этом в БД создается платеж по выбранной путевке.

MasterTourFacade

Сервис по работе с курсами валют (Rates)

Данный модуль предназначен для работы с курсами валют - Сервис по работе с курсами валют.