Web-сервисы: Сервис для прикрепления файлов к туристам

Версия статьи от 22-03-2016.

Введение

Данный модуль предназначен для прикрепления файлов (документов) к туристам. Файлы можно просматривать и распечатывать в ПК "Мастер-Тур" и ПК "Мастер-Web". Подробнее см. Модуль "Печать документов".

Установка

Для установки web-сервиса нужно создать отдельную директорию, например, TouristInfoService(далее в примерах будет использоваться данное название каталога) в корневом каталоге IIS (по умолчанию c:/inetpub/wwwroot) и выложить туда распакованные файлы из архива ws-touristInfoService-9.2.XX.XXXXX.zip. В управлении IIS необходимо создать виртуальный каталог для папки TouristInfoService.

Создание виртуального каталога

По умолчанию корневым каталогом IIS является C:/Inetpub/wwwroot. Для создания виртуального каталога для приложения находящегося в этом каталоге нужно выполнить следующие действия:

• 1. Зайти в Пуск (Start) – Панель управления (Control Panel) – Администрирование (Administrative Tools)

• 2. Запустить Internet Information Services (IIS) Manager

• 3. В открывшемся дереве каталогов выбрать сайты (Web Sites) – Default Web Site (либо другой сайт, на который планируется установить приложение). В открывшемся списке найти папку, для которой нужно создать виртуальный каталог, кликнуть по ней правой кнопкой мыши и выбрать пункт «Преобразовать в приложение».

Подключение к базе данных ПК «Мастер-Тур»

В файле web.config, расположенном в папке TouristInfoService, в которую установлен web-сервис «Сервис для прикрепления файлов к туристам», пропишите необходимые параметры подключения (курсивом выделены значения, которые необходимо ввести). Строка подключения к базе данных ПК «Мастер-Тур»:

<add key = "connectionString" value = "Data Source=ip-адрес сервера базы данных ПК Мастер-тур;Initial Catalog=название базы данных ПК Мастер-тур;User ID=логин пользователя ПК Мастер-тур;Password=пароль пользователя ПК Мастер-тур"/>

Настройка

После установки «Сервис для прикрепления файлов к туристам» доступен по адресу: http://ip-адрес сервера Мастер-Веб/TouristInfoService/TouristInfoService.svc

Методы web-сервиса

Поиск туриста

Метод ищет туриста в системе по различным параметрам.

Фильтры в методе поиска туриста являются взаимодополняющими. Т.е. при определении значения какого-либо фильтра отбор данных осуществляться строго по указанным значениям.

Если при поиске произошла ошибка, то ее код вернется в параметре ErrorCode, а описание – в параметре ErrorMsg выходной коллекции метода. При этом значения остальных параметров выходной коллекции могут быть не определены.

Входные параметры

Название параметра	Тип	Обязательный	Значения	Значение по умолчанию
Surname	String	Да	Фамилия туриста	-
Name	String	Да	Имя туриста	-
Gender	Int	Да	Пол туриста	-
BirthDate	DateTime	Нет	Дата рождения	-
PassportSeries	String	Нет	Серия паспорта	-
PassportNumber	String	Нет	Номер паспорта	-
TurDate	DateTime	Нет	Дата заезда по путевке	-
Service	ServiceType	Нет	Услуга в путевке	-
DogovorKey	Int	Нет	Ключ путевки	-

Выходные параметры

Поля выходной коллекции:

• TouristKey (Int) – ключ туриста (таблица Turist)
• Service – ключи услуги
• ErrorCode (Int) – код ошибки
• ErrorMsg (String) – описание ошибки

Список исключений

• Турист не найден
• Неверный формат данных
• Необработанное исключение

Прикрепление файлов к туристам

Метод загружает файл в БД, привязывая его к туристу.

Входные параметры

Название параметра	Тип	Обязательный	Значения	Значение по умолчанию
DocType	Int[]	Да	Ключ типа документа (таблица DocumentGroups). Подробнее см. Описание справочника "Группы документов".	-
DocTitle	String	Да	Название документа.	-
FileName	String	Да	Имя файла.	-
TouristKey	Int	Да	Ключ туриста (таблица Turist).	-
File	Byte	Да	Файл.	-
DocNumber1	String	Нет	Номер документа (поле TU_Numdoc таблицы TurService).	-
DocNumber2	String	Нет	Номер подтверждения поставщика (поле DL_Doccodepartner таблицы tbl_DogovorList).	-
ServiceKey	Int	Нет	Ключ услуги в путевке	-

Выходные параметры

Поля выходной коллекции:

• ErrorCode (Int) – код ошибки
• ErrorMsg (String) – описание ошибки

Список исключений

• Не удалось прикрепить файл
• Турист не найден
• Указанный тип документа отсутствует в справочнике
• Необработанное исключение
• Не указан servicekey (Если переданы параметры DocNumber1и/или DocNumber2)

Удаление туриста

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

При удалении туристов файлы, привязанные к ним, удаляются автоматически.

В случае, если во входных параметрах метода не указан тип документа, то происходит удаление всех файлов, привязанных к туристу.

Входные параметры

Название параметра	Тип	Обязательный	Значения	Значение по умолчанию
TouristKey	Int	да	ключ туриста (таблица Turist)	-
DocType	Int	нет	Ключ типа документа (таблица DocumentGroups).Подробнее см. Описание справочника "Группы документов".	-

Выходные параметры

Поля выходной коллекции:

• ErrorCode (Int) – код ошибки
• ErrorMsg (String) – описание ошибки

Список исключений

• Не удалось удалить файл
• Турист не найден
• Указанный тип документа отсутствует в справочнике
• Файл не найден
• Необработанное исключение

Описание типов данных

ServiceType

Тип ServiceType - это сложная структура, содержащая параметры:

Название параметра	Тип	Обязательный	Значения	Значение по умолчанию
ServiceClass	Int	Нет	ключ класса услуги	-
ServiceCode	Int	Нет	ключ услуги (0-любой) DL_code	-
ServiceDate	DateTime	Нет	дата начала услуги	-
ServiceKey	int	нет	Ключ услуги в путевке DL_key