Проверка наличия вызова в очереди событий

Эта страница только для чтения. Вы можете посмотреть её исходный текст, но не можете его изменить. Сообщите администратору, если считаете, что это неправильно.
====== Проверка наличия вызова в очереди событий ======
Метод: **CheckTimerEvent**

Позволяет увидеть всю очередь сообщений бизнес-операции. 

**Примечание:**
Информацию о способе вызова также можно найти на странице «APIScheduledEvents» (относительный путь для установленной системы ADVANTA: «/components/services/APIScheduledEvents.asmx»).

=====Передаваемые параметры=====
^Параметр^Тип^Назначение^
|**SessionID**|string|Идентификатор сессии пользователя, от имени которого выполняется операция|
|**OperationCode**|int|**Обязательный**. Код бизнес-операции. Определяет тип обрабатываемого события|
|**ObjectID**|Guid|Идентификатор объекта, с которым связано событие. Влияет на логику поиска существующих записей в очереди: \\ • Если параметр передан (не null), производится поиск записей с точным совпадением по GUID и коду операции \\ • Если параметр имеет значение null, поиск осуществляется только по коду операции с условием ObjectID = null|

<code xml>
<!-- Позволяет проверить расписание вызова  -->
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <CheckTimerEvent xmlns="http://streamline/">
        <contract>
            <ASPNETSessionId>string</ASPNETSessionId>
            <ObjectId>guid</ObjectId>
            <OperationCode>int</OperationCode>
        </contract>
    </CheckTimerEvent>
  </soap:Body>
</soap:Envelope>
</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:

{{ :product:api:picture_10.png?600direct&400 |}}
<TEXT align="center">//Рисунок 1. Настройки заголовков вызова API «CheckTimerEvent»//</text>

\\
{{ :product:api:picture_11.png?600direct&400 |}}
<TEXT align="center">//Рисунок 2. Настройки тела запроса API «CheckTimerEvent»//</text>

\\
Если запрос настроен верно, в Postman появится перечень сообщений указанной бизнес-операции. Пример:

{{ :product:api:picture_12.png?600direct&400 |}}
<TEXT align="center">//Рисунок 3. Пример списка запланированных сообщений//</text>