Описание API
Версия API 2.0.14, последнее изменение 06.05.2022 15:01 (MSK).
Для работы с API необходимо получить уникальный идентификатор пользователя (USERHASH). Работа с API организуется путём отправки HTTP-запросов на адрес https://booking.mosturflot.ru/api?language=ru, необходимые параметры передаются методом GET, POST, либо путём загрузки XML-файла с параметрами запроса (в случае загрузки файла, его имя может быть любым, если загружено несколько файлов, будет обработан только первый из них). Обрабатываются только ожидаемые параметры, всё остальное игнорируется. Ответ предоставляется в формате XML либо JSON (формат можно выбрать, установив соответствующий глобальный параметр).
Речные круизы - Информация о теплоходе
Возвращает полные данные по конкретному теплоходу. Объём данных определяется параметрами запроса.
- Параметры
- shipid - ID теплохода. Определяет теплоход, по которому запрашиваются данные.
- Тип: Целое число
- Обязательный: Да
- images - Фотографии теплохода. При установке в TRUE в ответ будут добавлены ссылки на фотографии теплохода.
- Тип: Логический
- Обязательный: Нет
- Значение по умолчанию: FALSE
- cabins - Каюты теплохода. При установке в TRUE в ответ будут добавлены данные обо всех каютах теплохода.
Если параметр IMAGES установлен в TRUE, также будут добавлены ссылки на фотографии кают.
- Тип: Логический
- Обязательный: Нет
- Значение по умолчанию: FALSE
- shipid - ID теплохода. Определяет теплоход, по которому запрашиваются данные.
- Формат ответа
- createdate - Дата и время создания ответа
- Тип: Дата и время, формат определяется значением глобального параметра DATETIME
- Обязательный: Да
- version - Текущая версия API
- Тип: Строка
- Обязательный: Да
- status - Результат выполнения запроса. -1 - Ошибка выполнения, 0 - Нет данных, 1 - Выполнен успешно.
- Тип: Целое число
- Обязательный: Да
- answer - Ответ
- Тип: Набор данных
- Обязательный: Да
- shipid - ID теплохода
- Тип: Целое число
- Обязательный: Да
- shipname - Название теплохода
- Тип: Строка
- Обязательный: Да
- shipown - Признак собственности. TRUE - собственный теплоход ОАО "Мостурфлот".
- Тип: Логический
- Обязательный: Да
- shipdesc - Описание теплохода. Текст в формате HTML.
- Тип: Строка
- Обязательный: Да
- shipclass - Класс теплохода
- Тип: Строка
- Обязательный: Да
- shipdeckplan - План палуб теплохода. URL изображения без указания протокола (http://).
- Тип: Строка
- Обязательный: Да
- shiptitleimage - Заглавная фотография теплохода. URL изображения без указания протокола (http://).
- Тип: Строка
- Обязательный: Да
- shipcabinsqty - Общее число кают теплохода
- Тип: Целое число
- Обязательный: Да
- shiptoursqty - Число актуальных круизов теплохода в базе данных
- Тип: Целое число
- Обязательный: Да
- shiptourmindate - Дата начала самого раннего актуального круиза теплохода в базе данных
- Тип: Дата и время, формат определяется значением глобального параметра DATETIME
- Обязательный: Да
- shiptourmaxdate - Дата окончания самого позднего актуального круиза теплохода в базе данных
- Тип: Дата и время, формат определяется значением глобального параметра DATETIME
- Обязательный: Да
- shipimages - Массив фотографий теплохода. Присутствует при установке в TRUE параметра IMAGES.
- Тип: Массив данных
- Обязательный: Нет
- item (элемент массива) - Данные о фотографии
- Тип: Набор данных
- Обязательный: Нет
- image - Полноразмерная фотография. URL изображения без указания протокола (http://).
- Тип: Строка
- Обязательный: Да
- thumb - Предпросмотр (thumbnail) фотографии. URL изображения без указания протокола (http://).
- Тип: Строка
- Обязательный: Да
- desc - Описание. Подпись к фотографии.
- Тип: Строка
- Обязательный: Да
- width - Ширина полноразмерной фотографии в пикселях
- Тип: Целое число
- Обязательный: Да
- height - Высота полноразмерной фотографии в пикселях
- Тип: Целое число
- Обязательный: Да
- shipcabins - Массив кают теплохода. Присутствует при установке в TRUE параметра CABINS.
- Тип: Массив данных
- Обязательный: Нет
- item (элемент массива) - Данные о каюте
- Тип: Набор данных
- Обязательный: Нет
- cabinid - ID каюты
- Тип: Целое число
- Обязательный: Да
- cabinnumber - Номер каюты
- Тип: Целое число
- Обязательный: Да
- cabincategoryid - ID категории каюты
- Тип: Целое число
- Обязательный: Да
- cabincategoryname - Название категории каюты
- Тип: Строка
- Обязательный: Да
- cabinclass - Класс каюты
- Тип: Строка
- Обязательный: Да
- cabindesc - Описание каюты. Текст в формате HTML.
- Тип: Строка
- Обязательный: Да
- cabinmainpass - Число основных мест в каюте
- Тип: Целое число
- Обязательный: Да
- cabinupperpass - Число верхних мест в каюте
- Тип: Целое число
- Обязательный: Да
- cabinadvpass - Число дополнительных мест в каюте
- Тип: Целое число
- Обязательный: Да
- cabinmaxpass - Максимальная пассажировместимость каюты. CABINMAINPASS + CABINUPPERPASS + CABINADVPASS.
- Тип: Целое число
- Обязательный: Да
- cabinimages - Массив фотографий каюты. Присутствует при установке в TRUE параметра IMAGES.
- Тип: Массив данных
- Обязательный: Нет
- item (элемент массива) - Данные о фотографии
- Тип: Набор данных
- Обязательный: Нет
- image - Полноразмерная фотография. URL изображения без указания протокола (http://).
- Тип: Строка
- Обязательный: Да
- thumb - Предпросмотр (thumbnail) фотографии. URL изображения без указания протокола (http://).
- Тип: Строка
- Обязательный: Да
- desc - Описание. Подпись к фотографии.
- Тип: Строка
- Обязательный: Да
- width - Ширина полноразмерной фотографии в пикселях
- Тип: Целое число
- Обязательный: Да
- height - Высота полноразмерной фотографии в пикселях
- Тип: Целое число
- Обязательный: Да
- request - Запрос. Содержит массив принятых и использованных для выполнения запроса параметров.
- Тип: Массив данных
- Обязательный: Да
- warnings - Предупреждения. Содержит массив предупреждений (если есть).
- Тип: Массив данных
- Обязательный: Да
- errors - Ошибки. Содержит массив ошибок (если есть).
- Тип: Массив данных
- Обязательный: Да
- createdate - Дата и время создания ответа
- Пример GET-запроса
- Пример XML-запроса
- Пример XML ответа
- Пример JSON ответа (преобразован в массив)