Описание 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
• tariffs  -  Тарифы. При установке в TRUE в ответ будут добавлены данные о тарифах на аренду теплохода.
  • Тип: Логический
  • Обязательный: Нет
  • Значение по умолчанию: FALSE

Формат ответа

• createdate  -  Дата и время создания ответа
  • Тип: Дата и время, формат определяется значением глобального параметра DATETIME
  • Обязательный: Да
• version  -  Текущая версия API
  • Тип: Строка
  • Обязательный: Да
• status  -  Результат выполнения запроса. -1 - Ошибка выполнения, 0 - Нет данных, 1 - Выполнен успешно.
  • Тип: Целое число
  • Обязательный: Да
• answer  -  Ответ
  • Тип: Набор данных
  • Обязательный: Да
  • shipid  -  ID теплохода
    • Тип: Целое число
    • Обязательный: Да
  • shipname  -  ID теплохода
    • Тип: Целое число
    • Обязательный: Да
  • shipown  -  Признак собственности. TRUE - собственный теплоход ОАО "Мостурфлот".
    • Тип: Логический
    • Обязательный: Да
  • shipdesc  -  Описание теплохода. Текст в формате HTML.
    • Тип: Строка
    • Обязательный: Да
  • shipclass  -  Класс теплохода
    • Тип: Строка
    • Обязательный: Да
  • shipdeckplan  -  План палуб теплохода. URL изображения без указания протокола (http://).
    • Тип: Строка
    • Обязательный: Да
  • shiptitleimage  -  Заглавная фотография теплохода. URL изображения без указания протокола (http://).
    • Тип: Строка
    • Обязательный: Да
  • shipimages  -  Массив фотографий теплохода. Присутствует при установке в TRUE параметра IMAGES.
    • Тип: Массив данных
    • Обязательный: Нет
    • item (элемент массива)  -  Данные о фотографии
      • Тип: Набор данных
      • Обязательный: Нет
      • image  -  Полноразмерная фотография. URL изображения без указания протокола (http://).
        • Тип: Строка
        • Обязательный: Да
      • thumb  -  Предпросмотр (thumbnail) фотографии. URL изображения без указания протокола (http://).
        • Тип: Строка
        • Обязательный: Да
      • desc  -  Описание. Подпись к фотографии.
        • Тип: Строка
        • Обязательный: Да
      • width  -  Ширина полноразмерной фотографии в пикселях
        • Тип: Целое число
        • Обязательный: Да
      • height  -  Высота полноразмерной фотографии в пикселях
        • Тип: Целое число
        • Обязательный: Да
  • shiptariffs  -  Массив тарифов. Присутствует при установке в TRUE параметра TARIFFS.
    • Тип: Массив данных
    • Обязательный: Нет
    • item (элемент массива)  -  Данные о тарифе на определённый месяц(-ы)
      • Тип: Набор данных
      • Обязательный: Нет
      • season  -  Месяц(-ы) действия тарифа. Перечислены месяцы действия тарифа через запятую. При круглогодичном действии тарифа будет указано "Круглогодично".
        • Тип: Строка
        • Обязательный: Да
      • seasontariffs  -  Массив тарифов
        • Тип: Массив данных
        • Обязательный: Нет
        • item (элемент массива)  -  Данные о тарифах при определённой продолжительности рейса
          • Тип: Набор данных
          • Обязательный: Нет
          • duration  -  Минимальная продолжительность рейса
            • Тип: Строка
            • Обязательный: Да
          • daytariffs  -  Массив тарифов по дням недели
            • Тип: Массив данных
            • Обязательный: Да
            • item (элемент массива)  -  Данные о тарифах на определённый день
              • Тип: Набор данных
              • Обязательный: Нет
              • weekday  -  День недели
                • Тип: Строка
                • Обязательный: Да
              • price  -  Цена за 1 час аренды
                • Тип: Строка
                • Обязательный: Да
• request  -  Запрос. Содержит массив принятых и использованных для выполнения запроса параметров.
  • Тип: Массив данных
  • Обязательный: Да
• warnings  -  Предупреждения. Содержит массив предупреждений (если есть).
  • Тип: Массив данных
  • Обязательный: Да
• errors  -  Ошибки. Содержит массив ошибок (если есть).
  • Тип: Массив данных
  • Обязательный: Да

Пример GET-запроса

https://booking.mosturflot.ru/api?language=ru?userhash=6ab4436ca3aeb1fcbb81a58a9f9d622baa400194&section=banquetfleet&request=ship&shipid=211

Пример XML-запроса

<?xml version="1.0" encoding="utf-8"?> <request> <userhash>6ab4436ca3aeb1fcbb81a58a9f9d622baa400194</userhash> <section>banquetfleet</section> <request>ship</request> <shipid>211</shipid> </request>

Пример XML ответа

<?xml version="1.0" encoding="utf-8"?> <result> <createdate>2025-05-06T12:49:07</createdate> <version>2.0.14</version> <status>-1</status> <answer></answer> <request> <format>xml</format> <dateformat>msk</dateformat> <userhash>6ab4436ca3aeb1fcbb81a58a9f9d622baa400194</userhash> <section>banquetfleet</section> <request>ship</request> <shipid>211</shipid> <images>0</images> <tariffs>0</tariffs> </request> <errors> <notfound>Теплоход не найден.</notfound> </errors> <warnings/> </result>

Пример JSON ответа (преобразован в массив)

array ( 'createdate' => '2025-05-06T12:49:07', 'version' => '2.0.14', 'status' => -1, 'answer' => false, 'request' => array ( 'format' => 'xml', 'dateformat' => 'msk', 'userhash' => '6ab4436ca3aeb1fcbb81a58a9f9d622baa400194', 'section' => 'banquetfleet', 'request' => 'ship', 'shipid' => 211, 'images' => 0, 'tariffs' => 0, ), 'errors' => array ( 'notfound' => 'Теплоход не найден.', ), 'warnings' => array ( ), )