get_account_data
Для получения подробной информации об учетной записи используйте следующую сигнатуру метода account/get_account_data:
svc=account/get_account_data¶ms={"itemId":<long>,
"type":<uint>}
Для получения информации о нескольких учетных записях используйте следующую сигнатуру:
svc=account/get_account_data¶ms={"itemId":[<long>],
"type":<uint>}
Параметры
Запрос может содержать следующие параметры. Обязательные параметры отмечены звездочкой (*).
Параметр | Описание |
---|---|
itemId* | ID ресурса (учетной записи). |
type | Флаг ответа. Типы ответа: |
Ответ
Если запрос выполнен успешно, ответ для одной учетной записи имеет следующий вид:
{
"parentAccountName":<text>, /* Название родительской учетной записи. */
"parentAccountId":<long>, /* ID родительской учетной записи. */
"parentEnabled":<bool>, /* Родительская учетная запись: 1 — доступна, 0 — заблокирована. */
"plan":<text>, /* Название тарифного плана. */
"enabled":<int>, /* Состояние: 0 — заблокирована, 1 — активна. */
"flags":<uint>, /* Флаги - дублируют флаги из настроек тарифного плана. */
"created":<unit>, /* Время создания учетной записи, UNIX-время. */
"balance":<text>, /* Баланс (с валютой). */
"daysCounter":<uint>, /* Счетчик дней. */
"settings":{
"balance":<double>, /* Баланс. */
"plan":{ /* Настройки тарифного плана. */
"flags":<uint>, /* Флаги тарифного плана (см. ниже). */
"blockBalance":<int>, /* Минимальный баланс для активности учетной записи. */
"denyBalance":<int>, /* Запрещающий баланс */
"minDaysCounter":<int>, /* Минимальное количество дней. Если остается меньше дней, учетная запись блокируется. */
"historyPeriod":<uint>, /* Период хранения сообщений. Если указан 0, период хранения не ограничен. */
"currencyFormat":"<currency_format>", /* Формат валюты учетной записи. */
"services":{ /* Список услуг. */
<text>:{ /* Название услуги. */
"type":<int>, /* Тип услуги: 1 — по требованию; 2 — периодическая */
"usage":<uint>, /* Количество созданных ресурсов в текущей услуге */
"maxUsage":<int>, /* Максимальное количество ресурсов. */
"cost":<text>, /* Таблица стоимости. */
"interval":<int> /* Частота сброса: 0 — нет, 1 — ежечасно, 2 — ежедневно, 3 — еженедельно, 4 — ежемесячно.*/
"descr":"<text>" /* Описание тарифицируемой услуги. */
}
}
},
"personal":{ /* Настройки учетной записи (персональные). */
... /* Имеет тот же формат, что и настройки тарифного плана. */
},
"combined":{ /* Комбинированные настройки, состоящие из настроек тарифного плана и учетной записи. */
... /* Имеет тот же формат, что и настройки тарифного плана. */
}
},
"siteAccess":{
"<service_name>":"<dns_name>", /* Где ключ — это название услуги, а значение — DNS-имя */
...
/* При использовании параметра "type=8" (см. выше) объект включает следующую дополнительную информацию.*/
"<service_name>": {
"n":"<dns_name>", /* Где значение — это DNS-имя. */
"tt":"<template_type>", /* Где значение — это тип шаблона сайта (wialon_web, cms_manager.) */
"b":"<branch>", /* Ветка сайта (v1311, master, develop,v1408). */
"sp":<int>, /* SSL-порт. */
"force_https":"<force_https>", /* Пользовательское свойство сайта "force_https". */
"ignore_in_cms_login_as":"<ignore_in_cms_login_as>" /* Пользовательское свойство сайта "ignore_in_cms_login_as". */
}
...
},
"serviceKeys":{ /* Внешние поставщики карт. */ "name":"<text>", /* Название ключа карты.*/
"type":<int>, /* Тип ключа. */
"provider":"<text>" /* Название поставщика карт. */
},
"managable":<int>, /* Разрешить управление указанной в запросе учетной записью: 1 — да, 0 — нет. */
"dealerRights":<int>, /* Разрешить использование дилерских прав для тарифного плана указанной учетной записи: 0 — нет, 1 — да. */
"subPlans":[<text>] /* Массив подчиненных тарифных планов. */
}
Ответ для нескольких учетных записей имеет следующую структуру:
{
"<account_id1>": { /* ID запрошенной учетной записи. */
... /* Информация об учетной записи (см. выше). */
},
"<account_id2>": { /* ID запрошенной учетной записи. */
... /* Информация об учетной записи (см. выше). */
},
...
}
Типы ключей услуг
Тип | Описание |
---|---|
0x01 | Защищенный ключ (ключ Gurtam). |
0x02 | Ключ маршрутизации. |
0x04 | Ключ геокодирования. |
0x08 | Ключ матрицы расстояний. |
0x10 | Ключ тайлов карт. |
Флаги учетной записи
Флаг | Описание |
---|---|
0x01 | Блокировать пользователей, если баланс ниже порога блокировки. |
0x02 | Запретить вход в систему и заблокировать учетную запись, если баланс меньше порога блокировки. |
0x20 | Уменьшать количество дней в счетчике дней и блокировать учетную запись, когда количество оставшихся дней достигает минимума. |
0x40 | Переопределить флаги тарифного плана. |
0x04 | Разрешить неизвестные услуги. |
Список услуг
Услуга | Тип | Описание |
---|---|---|
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 | периодическая | Типы обработки |