EventLogger POST GET

Предоставляет механизмы работы с журналами событий.


Запросы следует отправлять на адрес:

Анонимные запросы запрещены. Требуется авторизация.

Поддерживаются запросы методом GET и POST.

По умолчанию ответ сервера будет в формате JSON. Для получения ответа в другом формате, можно добавить расширение к файлу в адресе: .xml, .html или .txt. Например: /v2/EventLogger.xml Либо использовать HTTP-заголовок Accept: text/xml, text/html или text/plain.


Параметры

Имя параметра Тип Обязательный По умолчанию Описание
mode EventLoggerMode Нет Auto Режим работы с жруналом.
type MessageType Условно NULL Тип записи журнала.
Обязательно, если mode = Add.
Если mode = Get, будут возвращены записи указанного типа. При выборке допустимо указывать сразу несколько вариантов (битовое значение).
owner String Нет NULL Имя владельца. Не более 100 символов.
category String Нет NULL Название категории. Не более 100 символов.
title String Условно NULL Заголовок записи журнала. Не более 200 символов.
Обязательно, если mode = Add.
description String Нет NULL Описание записи журнала. Не более 4 000 символов.
Используется только, если mode = Add.
dateTime String Нет NULL Дата и время возникновения события.
Если mode = Add.
page Int32 Нет 1 Номер страницы, для которой следует получить данные.
limit Int32 Нет 100 Максимальное число данных на одной странице.
search String Нет NULL Строка поиска записей в журнале.
Если mode = Get.
dateFrom String Нет NULL Дата и время начала периода выборки данных.
Если mode = Get.
dateTo String Нет NULL Дата и время конца периода выборки данных.
Если mode = Get.
Общие параметры

В таблице ниже представлен список параметров, которые могут быть использованы при запросе к любому методу API.

Имя параметра Тип Обязательный По умолчанию Описание
appId Int32 Нет NULL Идентификатор приложения.
appSecret String Условно NULL Секретный ключ приложения.
token String Нет NULL Маркер доступа клиента, полученный методом GetToken.
formatting ResponseFormatting Нет None Определяет параметры форматирования выдачи результатов.
details Boolean Нет False Позволяет отобразить дополнительную информацию о запросе.
cp String Нет UTF-8 Имя кодовой страницы.
lang Language Нет Auto Язык, на котором будут выдаваться системные сообщения. Этот параметр также можно использовать при работе со справочной информацией API.
auth Boolean Нет False При наличии этого параметра, сервер вернет ответ с кодом HTTP401 и потребует указание идентификатора приложения и секретного ключа в HTTP заголовке Authorization.

Результат

Этот метод может возвращать результат нескольких типов.

StringResult

Имя свойства Тип Описание
Исходное XML JSON
Value value value String Строка, содержащая результат выполнения операции.
Messages messages messages Message[] Список сообщений системы.
Trace trace trace TraceItem[] Детальная информация о выполнении запроса. Добавляется, если параметр details имеет значение True.

StringArrayResult

Имя свойства Тип Описание
Исходное XML JSON
PageNumber pageNumber pageNumber Int32 Содержит номер страницы, для который были получены данные.
PageCount pageCount pageCount Int32 Содержит число доступных для просмотра страниц.
Items items items String[] Массив строк, содержащий результат выполнения операции.
Messages messages messages Message[] Список сообщений системы.
Trace trace trace TraceItem[] Детальная информация о выполнении запроса. Добавляется, если параметр details имеет значение True.

EventLogResult

Имя свойства Тип Описание
Исходное XML JSON
PageNumber pageNumber pageNumber Int32 Содержит номер страницы, для который были получены данные.
PageCount pageCount pageCount Int32 Содержит число доступных для просмотра страниц.
Items items items EventLogResultItem[] Список записей журнала событий.
Messages messages messages Message[] Список сообщений системы.
Trace trace trace TraceItem[] Детальная информация о выполнении запроса. Добавляется, если параметр details имеет значение True.

Имя XML и JSON используется при выдаче результатов в XML и, соответственно, JSON.

Если имя XML начинается с символа «собака» (@), то значит в XML это имя будет использоваться в качестве имени атрибута, а не самостоятельного элемента.

Исходное имя - это имя, которое используется непосредственно в коде API.


Ошибки

При возникновении ошибок, будет возвращаен результат типа ErrorResult.

В таблице ниже представлен список ошибок, которые могут возникнуть при работе с методом EventLogger.

Ключ Код Описание
AccessDenied 1100 Ошибка возникает при попытке выполнить запрос без указания параметров доступа, либо при отсутствии разрешений на доступ к данным.
ArgumentNullOrEmpty 2001 Ошибка происходит, если один из обязательных параметров не указан или имеет пустое значение.

Ключ и код соответствуют элементам перчисления ErrorCode.

В некоторых случаях, в ответе сервера могут содержать предупреждения (Warning) и сообщения о проблемах (Critical), которые можно найти в коллекции Messages. При этом, ответ сервера будет иметь тип EventLogResult.

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


Примечания

Для доступа к методу требуется указывать идентификатор приложения и секретный ключ. Анонимный доступ к методу невозможен!

Записи журнала хранятся от 3 до 7 дней.

Максимальное число записей 1 000. При превышении лимита, старые записи могут быть досрочно удалены.

Значение параметра dateTime не влияет на сроки хранения данных.

Информация добавляется в журнал с задержкой, примерно в 5-10 минут. При выводе, информация кэшируется примерно на 5-10 минут. Проще говоря, получать обновления имеет смысл не чаще одного раза в 30 минут.


Статистика


Конструктор запросов

mode:
type:
owner:
category:
title:
description:
dateTime:
page:
limit:
search:
dateFrom:
dateTo:

http:
lang:
auth:
cp: