Wialon для разработчиков Руководство пользователя Документация API account activation_code_report

activation_code_report

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

Предварительные требования

Для сервиса должна быть включена функция кодов активации (billing_by_codes).
Пользователь должен быть создателем учетной записи верхнего уровня или учетной записи с правами дилера.

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

Copied!

svc=account/activation_code_report&params={
    "timeFrom": <long>,
    "timeTo": <long>
}

Параметры

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

Параметр	Описание
timeFrom	Начало периода (Unix-время). Должно быть меньше timeTo.
timeTo	Конец периода (Unix-время). Должен быть больше timeFrom.

Ответ

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

Copied!

[
    {
        "guid": <text>,      /* GUID кода активации. */
        "uid": <long>,       /* ID объекта. Возвращается 0, если на момент действия код не был назначен. */
        "uname": <text>,     /* Имя объекта. Пустое, если код не был назначен. */
        "action": <int>,     /* Тип действия: 0 — назначен, 1 — снят, 2 — истек. */
        "acc_id": <long>,    /* ID учетной записи, в которой создан объект. Возвращается 0, если объект не был назначен. */
        "acc_name": <text>,  /* Имя учетной записи. Пустое, если объект не был назначен. */
        "tmc": <long>,       /* Время создания кода (Unix-время). */
        "ttl": <long>,       /* Срок действия в секундах. */
        "tma": <long>,       /* Время активации, то есть первого назначения кода объекту (Unix-время). */
        "tme": <long>        /* Расчетное время истечения срока действия (Unix-время). */
    }
]

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

Пользователь учетной записи верхнего уровня: возвращаются все действия с кодами активации за указанный период.
Учетная запись с правами дилера: возвращаются только действия, связанные с объектами, на которые у пользователя есть право доступа Управление кодами активации.

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

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

Коды ошибок

Код ошибки	Описание
4	Неверные входные параметры (параметры отсутствуют или `timeFrom` >= `timeTo`).
5	Ошибка выполнения запроса (внутренняя ошибка сервера).
7	Доступ запрещен: пользователь не относится к сервису с включенной функцией `billing_by_codes` или не является создателем учетной записи с правами дилера.

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