Справочный центр Wialon
Wialon для разработчиков Руководство пользователя Документация API apps list

list

Чтобы получить список доступных приложений, используйте метод apps/list.

Этот метод доступен только в Wialon Hosting.

Конечная точка

Copied!
svc=apps/list&params={
  "manageMode": <uint>,
  "filterLang": <text>
}

Параметры

В запросе можно использовать следующие необязательные параметры:

Параметр Описание
manageMode Режим запроса:

  • 0 (по умолчанию): получить приложения, доступные текущему пользователю;
  • 1: получить все приложения сервиса со всеми их параметрами. Этот режим доступен только пользователю верхнего уровня. Для других пользователей используется режим по умолчанию.
filterLang Язык интерфейса, например "ru". Ответ содержит только приложения, доступные для этого языка. Параметр используется, только если manageMode равен 0.

Список содержит приложения, добавленные в сервис, и приложения с вкладки Библиотека окна Конфигурация Apps в CMS Manager.

Ответ

Если запрос выполнен успешно, ответ возвращается в следующем формате:

Copied!
[
  {
    "name": <text>,                  /* Имя приложения */
    "description": <text>,           /* Описание приложения */
    "url": <text>,                   /* URL приложения */
    "flags": <uint>,                 /* Флаги приложения */
    "sortOrder": <int>,              /* Порядок сортировки */
    "serviceName": <text>,           /* Имя услуги приложения без префикса "app." */
    "id": <long>,                    /* ID приложения */
    "langs": <text>,                 /* Языки интерфейса */
    "requiredServicesList": <text>,  /* Необходимые услуги */
    "billingPlans": <text>           /* Тарифные планы */
  },
  ...
]

Параметры id, langs, requiredServicesList и billingPlans возвращаются, только если manageMode равен 1. Для приложений из библиотеки id равен 0. Значения flags описаны в разделе Флаги.

Если запрос выполнить не удалось, возвращается код ошибки.

Коды ошибок

Код ошибки Описание
7 Нет доступа: сервис не является Wialon Hosting, или учетная запись текущего пользователя не найдена.

Если вы заметили ошибку в тексте, пожалуйста, выделите её и нажмите Ctrl+Enter.