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

get_account_data

Чтобы получить информацию об учетной записи текущего пользователя и ее тарифном плане (имя тарифного плана, баланс, остаток дней, доступные услуги), используйте метод core/get_account_data.

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

Copied!
svc=core/get_account_data&params={
  "type": <uint>
}

Параметры

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

Параметр Описание
type Тип возвращаемой информации. Возможные значения:

Ответ

Если запрос выполнен успешно, ответ содержит основную или подробную информацию в зависимости от значения параметра type.

Если запрос выполняется для учетной записи верхнего уровня, ответ не содержит полей parentAccountName, parentAccountId и parentEnabled, так как у учетной записи верхнего уровня нет родительской учетной записи.

Основная информация

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

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>,         /* Счетчик дней. */
  "services": {                 /* Услуги. */
    <text>: {                   /* Имя услуги. */
      "type": <int>,            /* Тип услуги: 1 (по требованию), 2 (периодическая). */
      "usage": <uint>,          /* Количество использованных элементов этой услуги. */
      "maxUsage": <int>         /* Максимальное количество элементов этой услуги. */
    },
    ...
  },
  "dealerRights": <int>,        /* Права дилера для тарифного плана: 0 (нет), 1 (да). Возвращается, только если у учетной записи есть права дилера. */
  "subPlans": [<text>]          /* Подчиненные тарифные планы. Возвращается, только если у учетной записи есть права дилера. */
}

Подробная информация

Если параметр type равен 2 или 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 равен 10, сведения о сайте. */
      ...
    },
    "serviceKeys": {            /* Внешние поставщики карт. */
      ...
    }
  },
  "dealerRights": <int>,        /* Права дилера для тарифного плана: 0 (нет), 1 (да). */
  "subPlans": [<text>]          /* Подчиненные тарифные планы. */
}

Флаги учетной записи и тарифного плана, типы ключей услуг, список услуг и формат сведений о сайтах описаны на странице account/get_account_data.

Подробнее о настройках учетной записи и тарифного плана см. account/update_billing_plan.

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

Коды ошибок

Код ошибки Описание
4 Неверные входные параметры, или не удалось получить текущего пользователя или его учетную запись.

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