Справочный центр Wialon

get_account_data

Чтобы получить подробную информацию об одной или нескольких учетных записях, используйте метод account/get_account_data.

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

Чтобы получить информацию об одной учетной записи, используйте следующий запрос:

Copied!
svc=account/get_account_data&params={
  "itemId": <long>,
  "type": <uint>
}

Чтобы получить информацию о нескольких учетных записях, укажите массив ID:

Copied!
svc=account/get_account_data&params={
  "itemId": [<long>],
  "type": <uint>
}

Параметры

Запрос должен содержать следующие параметры:

Параметр Описание
itemId ID учетной записи или массив ID учетных записей.
type Тип возвращаемой информации. Необязательно. По умолчанию 2. Значения можно суммировать. Возможные значения:
  • 1: минимальная информация, необходимая для оценки состояния текущего пользователя.
  • 2: подробная информация, включающая настройки тарифного плана, учетной записи и объединенные настройки.
  • 4: исключение подчиненных учетных записей из usage. Информация касается только указанной учетной записи.
  • 8: сведения о сайтах. Работает только вместе с 2, например "type":10. Подробнее см. Сведения о сайтах.

Ответ

При успешном выполнении запроса для одной учетной записи возвращается результат в следующем формате:

Ответ
Copied!
{
  "parentAccountName": <text>,  /* Имя родительской учетной записи. Не возвращается для учетных записей верхнего уровня. */
  "parentAccountId": <long>,    /* ID родительской учетной записи. Не возвращается для учетных записей верхнего уровня. */
  "parentEnabled": <int>,       /* Состояние родительской учетной записи: 0 (заблокирована), 1 (активна). Не возвращается для учетных записей верхнего уровня. */
  "plan": <text>,               /* Имя тарифного плана. */
  "enabled": <int>,             /* Состояние учетной записи: 0 (заблокирована), 1 (активна). */
  "switchTime": <uint>,         /* Время последнего изменения состояния учетной записи (формат Unix). */
  "created": <uint>,            /* Время создания учетной записи (формат Unix). */
  "flags": <uint>,              /* Флаги тарифного плана. Дублирует флаги из настроек тарифного плана. */
  "balance": <text>,            /* Баланс (с валютой). */
  "daysCounter": <int>,         /* Счетчик дней. */
  "settings": {                 /* Настройки. */
    "balance": <double>,        /* Баланс. */
    "plan": {                   /* Настройки тарифного плана. */
      "flags": <uint>,          /* Флаги тарифного плана (см. раздел «Флаги учетной записи»). */
      "blockBalance": <double>, /* Баланс, ниже которого учетная запись блокируется. */
      "denyBalance": <double>,  /* Баланс, ниже которого платные услуги недоступны. */
      "minDaysCounter": <int>,  /* Количество дней, ниже которого учетная запись блокируется. */
      "historyPeriod": <uint>,  /* Период хранения сообщений в днях. 0 означает неограниченный период. */
      "currencyFormat": <text>, /* Формат валюты. */
      "services": {             /* Услуги. */
        <text>: {               /* Имя услуги. */
          "type": <int>,        /* Тип услуги: 1 (по требованию), 2 (периодическая). */
          "usage": <uint>,      /* Количество использованных элементов этой услуги. */
          "maxUsage": <int>,    /* Максимальное количество элементов этой услуги. */
          "cost": <text>,       /* Таблица стоимости. */
          "interval": <int>,    /* Интервал сброса: 0 (нет), 1 (каждый час), 2 (каждый день), 3 (каждую неделю), 4 (каждый месяц). */
          "descr": <text>       /* Описание. */
        },
        ...
      }
    },
    "personal": {               /* Настройки учетной записи. */
      ...                       /* В том же формате, что и настройки тарифного плана, без currencyFormat. */
    },
    "combined": {               /* Объединенные настройки тарифного плана и учетной записи. */
      ...                       /* В том же формате, что и настройки тарифного плана, без currencyFormat. */
    },
    "siteAccess": {             /* Сайты, доступные учетной записи. */
      <text>: <text>,           /* Ключ: имя услуги. Значение: DNS-имя или, если параметр type содержит 8, сведения о сайте. */
      ...
    },
    "serviceKeys": {            /* Внешние поставщики карт. */
      <text>: {                 /* Имя услуги. */
        "name": <text>,         /* Название ключа карты. */
        "type": <int>,          /* Тип ключа (см. раздел «Типы ключей услуг»). */
        "provider": <text>      /* Название поставщика карт. */
      },
      ...
    }
  },
  "managable": <int>,           /* Текущий пользователь может управлять учетной записью: 0 (нет), 1 (да). */
  "dealerRights": <int>,        /* Права дилера для тарифного плана: 0 (нет), 1 (да). */
  "subPlans": [<text>]          /* Подчиненные тарифные планы. */
}

При успешном выполнении запроса для нескольких учетных записей возвращается результат в следующем формате:

Copied!
{
  <text>: {                     /* ID запрошенного элемента. */
    ...                         /* Информация об учетной записи в формате, описанном выше. */
  },
  ...
}

Если ID в массиве принадлежит объекту, пользователю или другому элементу, который не является учетной записью, ответ содержит данные учетной записи, к которой относится этот элемент, под запрошенным ID. Если массив содержит несколько элементов одной учетной записи, данные этой учетной записи возвращаются под ID каждого из них.

Ответ содержит только элементы, на которые у пользователя есть право доступа Просмотр подробных свойств. Остальные ID пропускаются без ошибки.

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

Коды ошибок

Код ошибки Описание
4 Неверные входные параметры, или указанный элемент не является учетной записью. Второй случай возможен только для запроса по одной учетной записи.
7 Учетная запись не существует, или у пользователя нет права доступа Просмотр подробных свойств к ней. Возвращается только для запроса по одной учетной записи.

Сведения о сайтах

Если параметр type содержит и 2, и 8 (например, "type":10), каждое значение объекта siteAccess вместо DNS-имени является объектом со сведениями о сайте:

Copied!
"siteAccess": {
  <text>: {                           /* Имя услуги. */
    "n": <text>,                      /* DNS-имя. */
    "tt": <text>,                     /* Тип шаблона сайта, например wialon_web, cms_manager, wialon_sdk. */
    "b": <text>,                      /* Ветка сайта. Возвращается, только если ветка задана. */
    "sp": <int>,                      /* SSL-порт. */
    "force_https": <text>,            /* Значение свойства сайта «force_https». Возвращается, только если свойство задано. */
    "ignore_in_cms_login_as": <text>  /* Значение свойства сайта «ignore_in_cms_login_as». Возвращается, только если свойство задано. */
  },
  ...
}

Типы ключей услуг

Поле type объекта serviceKeys может принимать следующие значения:

Тип Описание
0x01 Защищенный ключ (ключ Gurtam).
0x02 Ключ маршрутизации.
0x04 Ключ геокодирования.
0x08 Ключ матрицы расстояний.
0x10 Ключ тайлов карт.

Флаги учетной записи

В настройках учетной записи и тарифного плана используются следующие флаги:

Флаг Описание
0x01 Блокировать пользователей, если баланс ниже порога блокировки.
0x02 Запретить использование платных услуг, если баланс меньше значения, указанного в параметре denyBalance.
0x04 Разрешить неизвестные услуги.
0x20 Уменьшать количество дней в счетчике дней и блокировать учетную запись, когда количество оставшихся дней достигает минимума.
0x40 Переопределить флаги тарифного плана.

Список услуг

В тарифном плане могут быть доступны следующие услуги:

Услуга Тип Описание
avl_resource периодическая Активирует раздел Учетные записи в CMS Manager; определяет количество и стоимость ресурсов и учетных записей.
avl_retranslator периодическая Активирует раздел Ретрансляторы в CMS Manager и определяет разрешенное количество и стоимость ретрансляторов.
avl_route периодическая Активирует модуль Маршруты. Включает вкладку Маршруты и связанные отчеты и уведомления.
avl_unit периодическая Активирует раздел Объекты в CMS Manager и вкладку Объекты в системе мониторинга. Определяет стоимость и количество объектов.
avl_unit_group периодическая Активирует раздел Группы объектов в CMS Manager и вкладку Объекты в системе мониторинга. Определяет стоимость и количество групп объектов.
cms_manager по требованию Предоставляет доступ к CMS Manager.
create_units по требованию Активирует кнопку создания объектов в разделе Объекты в CMS Manager и на вкладке Объекты в системе мониторинга.
create_users по требованию Активирует кнопку создания пользователей в разделе Пользователи в CMS Manager и на вкладке Пользователи в системе мониторинга.
create_unit_groups по требованию Активирует кнопку создания групп объектов в разделе Группы объектов в CMS Manager и на вкладке Группы объектов в системе мониторинга.
create_resources по требованию Активирует кнопку создания ресурсов и учетных записей в разделе Ресурсы в CMS Manager.
custom_fields периодическая Активирует вкладку Произвольные поля в свойствах объектов, пользователей или групп. Определяет стоимость и количество (суммарно, по объектам разных типов) произвольных полей; не влияет на водителей и прицепы.
custom_reports по требованию Активирует расширенные отчеты: отчеты по группам объектов, пользователям, водителям, прицепам, а также группам водителей и прицепов (кроме таблицы Журнал для пользователей и групп объектов). Работает в рамках модуля Отчеты.
drivers периодическая Активирует модуль Водители и определяет стоимость и количество водителей. При отключении вкладка Водители не отображается, а упоминания о водителях исчезают из уведомлений, настроек пользователя и окна отправки SMS-сообщений.
driver_groups периодическая Определяет количество и стоимость групп водителей. Работает в рамках модуля Водители.
email_notification по требованию Включает отправку уведомлений по email. Рекомендуемое ограничение — 10 отчетов в час (во избежание перегрузки сервера).
email_report по требованию Включает отправку отчета по email (в рамках модуля Задания). Рекомендуемое ограничение — 10 отчетов в час (во избежание перегрузки сервера).
google_service по требованию Активирует сервисы Google.
import_export по требованию Активирует функции Импорт/Экспорт на сайтах мониторинга.
jobs периодическая Активирует вкладку Задания. Определяет стоимость и разрешенное количество заданий.
locator по требованию Активирует опцию Локатор в меню пользователя.
messages по требованию Предоставляет доступ к вкладке Сообщения.
net_access (устарело) по требованию Разрешает аутентификацию через сервисный коннектор в Wialon Pro.
notifications периодическая Активирует вкладку Уведомления и определяет стоимость и разрешенное количество уведомлений.
orders периодическая Активирует доступ к приложению Логистика и позволяет запускать отчет Заявки по объектам и водителям в системе мониторинга.
pois (устарело) периодическая Активирует панель POI и определяет стоимость и разрешенное количество POI.
reports по требованию Активирует модуль Отчеты и определяет стоимость и разрешенное количество шаблонов отчетов. При отключении исчезают связанные задания и уведомления, а детектор поездок не может быть использован.
retranslator_units периодическая Определяет количество доступных объектов, привязанных к активированным ретрансляторам.
rounds периодическая Определяет количество разрешенных рейсов и их стоимость (в рамках модуля Маршруты).
route_schedules периодическая Определяет количество разрешенных расписаний и их стоимость (в рамках модуля Маршруты).
sdk по требованию Предоставляет доступ к Apps.
service_intervals периодическая Определяет стоимость и количество интервалов техобслуживания. При активации в свойствах объекта появляется вкладка Техобслуживание. Позволяет регистрировать события типа Техобслуживание, запускать отчеты и получать уведомления о техобслуживании.
sms по требованию Определяет разрешенное количество SMS-сообщений и их стоимость.
tacho по требованию Активирует таблицы Активность водителя и Нарушения в отчетах по водителям.
storage_user периодическая Активирует вкладку Пользователи и определяет стоимость и количество пользователей.
trailers периодическая Активирует вкладку Прицепы и определяет стоимость и количество прицепов.
trailer_groups периодическая Определяет количество и стоимость прицепов; работает в рамках модуля Прицепы.
unit_commands периодическая Активирует вкладку Команды в свойствах объекта. Определяет количество (для всех объектов в сумме) и стоимость команд.
unit_sensors периодическая Определяет количество датчиков (рассчитывается для всех объектов в сумме) и их стоимость.
user_notifications периодическая Включает получение информационных сообщений от администратора сервиса.
Wialon_activex (устарело) по требованию Предоставляет удаленный доступ к системе через SDK, ActiveX.
wialon_mobile (устарело) по требованию Активирует доступ к приложению для Android и iOS.
wialon_mobile2 по требованию Активирует доступ к приложению для Android и iOS. Требуется включенная услуга wialon_mobile.
wialon_sdk по требованию Предоставляет удаленный доступ к системе через SDK.
zones_library периодическая Активирует модуль Геозоны и определяет стоимость и количество геозон. При отключении вкладка Геозоны не отображается, а любое упоминание о геозонах исчезает из отчетов и настроек пользователя.
zone_groups периодическая Активирует группы геозон.
AgroService (устарело) Тип Описание
agroplots периодическая Поля
agroplotgroups периодическая Группы полей
agrocrops периодическая Культуры
agromachines периодическая Сельхозтехника
agroequipments периодическая Оборудование
agrocultivationtypes периодическая Типы обработки

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