Это старая версия документа!


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

Метод: CheckTimerEvent

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

ПараметрОписание
SessionIDID сессии пользователя
OperationCodeобязательный целочисленный параметр с кодом операции
ObjectIDGUID объекта.
Не обязательный параметр. Если он передан, ищутся сохраненные в очереди записи с точным совпадением на GUID и код операции. Если параметр null, то необходимо искать в очереди записи только с кодом операции и ObjectID = null.
<!-- Позволяет проверить расписание вызова  -->
<?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>
ПараметрОписаниеОписаниеТип данных

CheckTimerEventResponse|Ответ на проверку таймера|Корневой элемент ответа|Контейнер CheckTimerEventResult|Результат проверки таймера|Содержит список событий таймера|Контейнер TimerEvents|Список событий|Коллекция событий таймера|Массив CheckTimerEventWrapper|Событие таймера|Информация о запланированном событии|Объект Id|Идентификатор события|Уникальный идентификатор события|GUID ObjectId|Идентификатор объекта|ID объекта, с которым связано событие|GUID CallTime|Время вызова|Дата и время запланированного вызова|DateTime (ISO 8601) Parameters|Параметры|JSON-строка с дополнительными параметрами|JSON

CheckTimerEventResultГруппирующий элемент массива бизнес-операций
TimerEventsМассив бизнес-операций
CheckTimerEventWrapperМассив вызовов
IdМассив вызовов
ObjectIdМассив вызовов
CallTimeМассив вызовов
ParametersМассив вызовов
<?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>

Пример настройки POST-запроса для вызова «CheckTimerEvent» в Postman:

Рисунок 1. Настройки заголовков вызова API «CheckTimerEvent»


Рисунок 2. Настройки тела запроса API «CheckTimerEvent»


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

Рисунок 3. Пример списка запланированных сообщений