Различия

Показаны различия между двумя версиями страницы.

Ссылка на это сравнение

Предыдущая версия справа и слева Предыдущая версия
Следующая версия		 Предыдущая версия
product:api:list:checktimerevent [13.02.2026 06:08] – Москвитина Алинаproduct:api:list:checktimerevent [02.03.2026 06:39] (текущий) – Москвитина Алина
Строка 2: Строка 2:
 Метод: **CheckTimerEvent** Метод: **CheckTimerEvent**
  
-^Параметр^Описание^ +Позволяет увидеть всю очередь сообщений бизнес-операции. 
-|SessionID|ID сессии пользователя| +
-|OperationCode|обязательный целочисленный параметр с кодом операции| +
-|ObjectID|GUID объекта. \\ Не обязательный параметр. Если он передан, ищутся сохраненные в очереди записи с точным совпадением на GUID и код операции. Если параметр null, то необходимо искать в очереди записи только с кодом операции и ObjectID = null.|+
  
-===== Просмотр очереди через API «CheckTimerEvent» ===== +**Примечание:** 
-Увидеть всю очередь сообщений бизнес-операции можно с помощью API-функции «CheckTimerEvent». Информацию о способе её вызова также можно найти на странице службы «APIScheduledEvents» (относительный путь на стенде ADVANTA: «/components/services/APIScheduledEvents.asmx»).+Информацию о способе вызова также можно найти на странице «APIScheduledEvents» (относительный путь для установленной системы ADVANTA: «/components/services/APIScheduledEvents.asmx»).
  
-Формат вызова API «CheckTimerEvent»: +=====Передаваемые параметры===== 
-<code>+^Параметр^Тип^Назначение^ 
 +|**SessionID**|string|Идентификатор сессии пользователя, от имени которого выполняется операция| 
 +|**OperationCode**|int|**Обязательный**. Код бизнес-операции. Определяет тип обрабатываемого события| 
 +|**ObjectID**|Guid|Идентификатор объекта, с которым связано событие. Влияет на логику поиска существующих записей в очереди: \\ • Если параметр передан (не null), производится поиск записей с точным совпадением по GUID и коду операции \\ • Если параметр имеет значение null, поиск осуществляется только по коду операции с условием ObjectID = null| 
 + 
 +<code xml>
 <!-- Позволяет проверить расписание вызова  --> <!-- Позволяет проверить расписание вызова  -->
 <?xml version="1.0" encoding="utf-8"?> <?xml version="1.0" encoding="utf-8"?>
Строка 25: Строка 27:
   </soap:Body>   </soap:Body>
 </soap:Envelope> </soap:Envelope>
- 
 </code> </code>
 +
 +=====Возвращаемые параметры=====
 +^Параметр^Название^Описание^Тип данных^
 +|CheckTimerEventResponse|Ответ на проверку таймера|Корневой элемент ответа|Контейнер|
 +|CheckTimerEventResult|Результат проверки таймера|Содержит список событий таймера|Контейнер|
 +|TimerEvents|Список событий|Коллекция событий таймера|Массив|
 +|CheckTimerEventWrapper|Событие таймера|Информация о запланированном событии|Объект|
 +|Id|Идентификатор события|Уникальный идентификатор события|GUID|
 +|ObjectId|Идентификатор объекта|ID объекта, с которым связано событие|GUID|
 +|CallTime|Время вызова|Дата и время запланированного вызова|DateTime (ISO 8601)|
 +|Parameters|Параметры|JSON-строка с дополнительными параметрами|JSON|
 +
 +
 +**Примечания:**
 +  * ''CallTime'' представлен в формате ISO 8601: ''ГГГГ-ММ-ДДTЧЧ:ММ:СС''
 +  * ''Parameters'' содержит сериализованный JSON с данными объекта
 +  * Все GUID идентификаторы имеют стандартный формат ''8-4-4-4-12''
 +  * Пространство имен XML: ''http://streamline/''
  
 \\ \\
 +<code xml>
 +<?xml version="1.0" encoding="utf-8"?>
 +<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
 +    <soap:Body>
 +        <CheckTimerEventResponse xmlns="http://streamline/">
 +            <CheckTimerEventResult>
 +                <TimerEvents>
 +                    <CheckTimerEventWrapper>
 +                        <Id>string</Id>
 +                        <ObjectId>string</ObjectId>
 +                        <CallTime>dateTime</CallTime>
 +                        <Parameters>string</Parameters>
 +                    </CheckTimerEventWrapper>
 +                    <CheckTimerEventWrapper>
 +                        <Id>string</Id>
 +                        <ObjectId>string</ObjectId>
 +                        <CallTime>dateTime</CallTime>
 +                        <Parameters>string</Parameters>
 +                    </CheckTimerEventWrapper>
 +                </TimerEvents>
 +            </CheckTimerEventResult>
 +        </CheckTimerEventResponse>
 +    </soap:Body>
 +</soap:Envelope>
 +</code>
 + 
 +
 +===== Пример вызова API «CheckTimerEvent» в Postman =====
 Пример настройки POST-запроса для вызова «CheckTimerEvent» в Postman: Пример настройки POST-запроса для вызова «CheckTimerEvent» в Postman: