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

Метод: CheckTimerEvent

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

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

Передаваемые параметры

ПараметрТипНазначение
SessionIDstringИдентификатор сессии пользователя, от имени которого выполняется операция
OperationCodeintОбязательный. Код бизнес-операции. Определяет тип обрабатываемого события
ObjectIDGuidИдентификатор объекта, с которым связано событие. Влияет на логику поиска существующих записей в очереди:
• Если параметр передан (не null), производится поиск записей с точным совпадением по 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

Примечания:

  • CallTime представлен в формате ISO 8601: ГГГГ-ММ-ДДTЧЧ:ММ:СС
  • Parameters содержит сериализованный JSON с данными объекта
  • Все GUID идентификаторы имеют стандартный формат 8-4-4-4-12
  • Пространство имен XML: http://streamline/


<?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>

Пример вызова API «CheckTimerEvent» в Postman

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

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


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


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

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