Описание 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 (формат можно выбрать, установив соответствующий глобальный параметр).

Банкетный флот - Список теплоходов

Возвращает список теплоходов.

Параметры

• own  -  Только собственный флот. Ограничивает выборку только собственным флотом ОАО "Мостурфлот".
  • Тип: Логический
  • Обязательный: Нет
  • Значение по умолчанию: TRUE

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

• createdate  -  Дата и время создания ответа
  • Тип: Дата и время, формат определяется значением глобального параметра DATETIME
  • Обязательный: Да
• version  -  Текущая версия API
  • Тип: Строка
  • Обязательный: Да
• status  -  Результат выполнения запроса. -1 - Ошибка выполнения, 0 - Нет данных, 1 - Выполнен успешно.
  • Тип: Целое число
  • Обязательный: Да
• answer  -  Ответ
  • Тип: Массив данных
  • Обязательный: Да
  • item (элемент массива)  -  Данные по теплоходу
    • Тип: Набор данных
    • Обязательный: Нет
    • shipid  -  ID теплохода
      • Тип: Целое число
      • Обязательный: Да
    • shipname  -  Название теплохода
      • Тип: Строка
      • Обязательный: Да
    • shipown  -  Признак собственности. TRUE - собственный теплоход ОАО "Мостурфлот".
      • Тип: Логический
      • Обязательный: Да
• request  -  Запрос. Содержит массив принятых и использованных для выполнения запроса параметров.
  • Тип: Массив данных
  • Обязательный: Да
• warnings  -  Предупреждения. Содержит массив предупреждений (если есть).
  • Тип: Массив данных
  • Обязательный: Да
• errors  -  Ошибки. Содержит массив ошибок (если есть).
  • Тип: Массив данных
  • Обязательный: Да

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

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

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

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

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

<?xml version="1.0" encoding="utf-8"?> <result> <createdate>2025-05-06T12:43:39</createdate> <version>2.0.14</version> <status>1</status> <answer items="2"> <item id="219"> <shipid>219</shipid> <shipname>Князь Юрий</shipname> <shipown>1</shipown> </item> <item id="212"> <shipid>212</shipid> <shipname>СОЮЗ</shipname> <shipown>1</shipown> </item> </answer> <request> <format>xml</format> <dateformat>msk</dateformat> <userhash>6ab4436ca3aeb1fcbb81a58a9f9d622baa400194</userhash> <section>banquetfleet</section> <request>ships</request> <own>1</own> </request> <errors/> <warnings/> </result>

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

array ( 'createdate' => '2025-05-06T12:43:39', 'version' => '2.0.14', 'status' => 1, 'answer' => array ( 219 => array ( 'shipid' => '219', 'shipname' => 'Князь Юрий', 'shipown' => 1, ), 212 => array ( 'shipid' => '212', 'shipname' => 'СОЮЗ', 'shipown' => 1, ), ), 'request' => array ( 'format' => 'xml', 'dateformat' => 'msk', 'userhash' => '6ab4436ca3aeb1fcbb81a58a9f9d622baa400194', 'section' => 'banquetfleet', 'request' => 'ships', 'own' => true, ), 'errors' => array ( ), 'warnings' => array ( ), )