get_account_data
Чтобы получить информацию о настройках учетной записи, в которой вы авторизованы, и ее тарифного плана (имя тарифного плана, баланс, остаток дней, доступные услуги), используйте метод core/get_account_data:
svc=core/get_account_data¶ms={
"type": <int>,
}
Параметры
Запрос должен содержать параметр type с одним из следующих значений:
- 1 — для получения основной информации, необходимой для оценки состояния пользователя, авторизованного в данный момент.
- 2 — для получения подробной информации, включающей настройки учетной записи, настройки тарифного плана и объединенные настройки (учетной записи и тарифного плана).
Ответ
Если запрос выполнен успешно, ответ содержит основную или подробную информацию в зависимости от значения параметра type.
Если запрос выполняется для учетной записи верхнего уровня, ответ не содержит полей
parentAccountName,parentAccountIdиparentEnabled, так как у учетной записи верхнего уровня нет родительской учетной записи.
Основная информация
{
"parentAccountName": <text>, /* Имя родительской учетной записи. Не возвращается для учетных записей верхнего уровня. */
"parentAccountId": <long>, /* GUID родительской учетной записи. Не возвращается для учетных записей верхнего уровня. */
"parentEnabled": <int>, /* Показывает, активна ли родительская учетная запись. Не возвращается для учетных записей верхнего уровня. */
"plan": <text>, /* Имя тарифного плана. */
"enabled": <int>, /* Состояние учетной записи: 0 — заблокирована, 1 — активна. */
"switchTime": <int>, /* Время последнего изменения параметра "enabled". */
"created": <uint>, /* Время создания (UNIX time). */
"flags": <uint>, /* Флаги тарифного плана. */
"balance": <text>, /* Баланс (с валютой). */
"daysCounter": <int>, /* Счетчик дней. */
"services": { /* Список услуг. */
<text>: { /* Имя услуги. */
"type": <int>, /* Тип: 1 — по требованию; 2 — периодическая. */
"usage": <uint>, /* Количество активных ресурсов, в которых используется услуга. */
"maxUsage": <int>, /* Максимальное количество ресурсов. */
"cost": <text>, /* Таблица стоимости. */
"interval": <int>, /* Интервал сброса: 0 — нет, 1 — каждый час, 2 — каждый день, 3 — каждую неделю, 4 — каждый месяц. */
"descr": <text> /* Описание. */
},
...
},
"dealerRights": <int>, /* Разрешить использование прав дилера для этого тарифного плана: 0 — нет, 1 — да */
"subPlans":[<text>] /* Массив дочерних тарифных планов. */
}
Подробная информация
{
"parentAccountName": <text>, /* Имя родительской учетной записи. Не возвращается для учетных записей верхнего уровня. */
"parentAccountId": <long>, /* GUID родительской учетной записи. Не возвращается для учетных записей верхнего уровня. */
"parentEnabled": <int>, /* Показывает, активна ли родительская учетная запись. Не возвращается для учетных записей верхнего уровня. */
"plan": <text>, /* Имя тарифного плана. */
"enabled": <int>, /* Состояние учетной записи: 0 — заблокирована, 1 — активна. */
"switchTime": <int>, /* Время последнего изменения параметра "enabled". */
"flags": <uint>, /* Дублирует те же флаги из настроек тарифного плана (см. поле "plan" ниже). */
"balance": <text>, /* Баланс (с валютой). */
"daysCounter": <int>, /* Счетчик дней. */
"settings": {
"balance": <double>, /* Баланс. */
"plan":{ /* Настройки тарифного плана. */
"flags": <uint>, /* Флаги тарифного плана. */
"blockBalance": <int>, /* Баланс блокировки. */
"denyBalance": <int>, /* Минимальный баланс, необходимый для доступности платных услуг. */
"minDaysCounter": <int>, /* Минимальное количество дней, необходимое для активации учетной записи. */
"historyPeriod": <int>, /* Период истории, в течение которого хранятся сообщения объектов, в днях (если указано 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": { /* Настройки учетной записи. */
... /* В том же формате, что и настройки тарифного плана. */
},
"combined": { /* Объединенные настройки (настройки, относящиеся к тарифному плану и учетной записи). */
... /* В том же формате, что и настройки тарифного плана */
}
},
"siteAccess": {
"<service_name>":"<dns_name>", /* Где ключ — это название услуги, а значение — DNS-имя. */
...
},
"dealerRights": <int>, /* Разрешить использование прав дилера для этого тарифного плана: 0 — нет, 1 — да */
"subPlans": [<text>] /* Массив дочерних тарифных планов. */
}
Доступные значения флагов тарифного плана и учетной записи, а также список услуг можно найти на странице account/get_account_data.
Для получения дополнительной информации о структуре настроек учетной записи и тарифного плана см. account/update_billing_plan.
Коды ошибок
Если запрос завершается с ошибкой, возвращается код ошибки 4, который указывает на одну из следующих проблем:
- неверные входные параметры,
- не удалось получить пользователя.