Описание API | Интернет-магазин круизов компании Мостурфлот

Описание API

Версия API 2.0.14, последнее изменение 06.05.2022 15:01 (MSK).

Для работы с API необходимо получить уникальный идентификатор пользователя (USERHASH). Работа с API организуется путём отправки HTTP-запросов на адрес https://booking.mosturflot.ru/api?language=en-US, необходимые параметры передаются методом GET, POST, либо путём загрузки XML-файла с параметрами запроса (в случае загрузки файла, его имя может быть любым, если загружено несколько файлов, будет обработан только первый из них). Обрабатываются только ожидаемые параметры, всё остальное игнорируется. Ответ предоставляется в формате XML либо JSON (формат можно выбрать, установив соответствующий глобальный параметр).


Банкетный флот - Информация о стоянке

Возвращает полные данные по конкретной стоянке банкетного флота. Объём данных определяется параметрами запроса.

Параметры
  • portid  -  ID стоянки. Определяет стоянку, по которой запрашиваются данные.
    • Тип: Строка
    • Обязательный: Да
  • images  -  Фотографии стоянки. При установке в TRUE в ответ будут добавлены ссылки на фотографии стоянки.
    • Тип: Логический
    • Обязательный: Нет
    • Значение по умолчанию: FALSE
Формат ответа
  • createdate  -  Дата и время создания ответа
    • Тип: Дата и время, формат определяется значением глобального параметра DATETIME
    • Обязательный: Да
  • version  -  Текущая версия API
    • Тип: Строка
    • Обязательный: Да
  • status  -  Результат выполнения запроса. -1 - Ошибка выполнения, 0 - Нет данных, 1 - Выполнен успешно.
    • Тип: Целое число
    • Обязательный: Да
  • answer  -  Ответ
    • Тип: Набор данных
    • Обязательный: Да
    • pointid  -  ID стоянки
      • Тип: Строка
      • Обязательный: Да
    • pointname  -  Название стоянки
      • Тип: Строка
      • Обязательный: Да
    • cityid  -  ID города (населённого пункта)
      • Тип: Целое число
      • Обязательный: Да
    • cityname  -  Название города (населённого пункта)
      • Тип: Строка
      • Обязательный: Да
    • citytitleimage  -  Заглавная фотография города (населённого пункта).. URL изображения без указания протокола (http://).
      • Тип: Строка
      • Обязательный: Да
    • federalsubjname  -  Название субъекта федерации
      • Тип: Строка
      • Обязательный: Да
    • portshortname  -  Краткое название причала
      • Тип: Строка
      • Обязательный: Да
    • portfullname  -  Полное название причала
      • Тип: Строка
      • Обязательный: Да
    • portaddress  -  Адрес причала
      • Тип: Строка
      • Обязательный: Да
  • request  -  Запрос. Содержит массив принятых и использованных для выполнения запроса параметров.
    • Тип: Массив данных
    • Обязательный: Да
  • warnings  -  Предупреждения. Содержит массив предупреждений (если есть).
    • Тип: Массив данных
    • Обязательный: Да
  • errors  -  Ошибки. Содержит массив ошибок (если есть).
    • Тип: Массив данных
    • Обязательный: Да
Пример GET-запроса
Пример XML-запроса
Пример XML ответа
Пример JSON ответа (преобразован в массив)