get_tasklist
1 Описание
Назначение | Получить список задач. В ответе не более 50 задач. |
Тип запроса | Синхронный |
2 Формат запросов
2.1 Формат запроса
<?xml version="1.0" encoding="utf-8"?> <RQ cmd="get_tasklist"> <GetTaskListRequest TaskGuid="00000000-0000-0000-0000-000000000000" ObjectId="int" RequestDateTimeStart="0000-00-00T00:00:00" RequestDateTimeEnd="0000-00-00T00:00:00" /> </RQ>
Описание параметров
Параметр | Тип | Обязательный | Описание | Значение по умолчанию |
---|---|---|---|---|
ObjectId | int | - | Код ресторана в системе лицензирования | |
TaskGuid | guid | - | Guid задачи | |
RequestDateTimeStart | datetime | - | Дата создания задачи - начало интервала | |
RequestDateTimeEnd | datetime | - | Дата создания задачи - конец интервала |
2.2 Формат ответа
<?xml version="1.0" encoding="utf-8"?> <RP taskguid="608f86c0-7335-4061-a5b6-c4de1ecababe" code="0" version="1.9.0"> <TaskList> <Task> <TaskGuid>3f97e526-95e6-4c00-8d4b-42c89a3f235b</TaskGuid> <TaskType>get_tasklist</TaskType> <RequestDateTime>2018-08-15T17:42:32.991536</RequestDateTime> <AggregatorStatus>2</AggregatorStatus> <AgentStatus>0</AgentStatus> <ResponseStatus>1</ResponseStatus> <TaskStatus>1</TaskStatus> </Task> <Task> <TaskGuid>e15cb06e-77c6-4268-b6f8-b485b467d482</TaskGuid> <TaskType>any_call</TaskType> <ObjectId>199996011</ObjectId> <RequestDateTime>2018-07-30T12:42:35.452</RequestDateTime> <AggregatorStatus>3</AggregatorStatus> <AgentStatus>4</AgentStatus> <ResponseStatus>3</ResponseStatus> <TaskStatus>2</TaskStatus> <CallBackUrl>http://test.com/SaveCallback</CallBackUrl> </Task> </TaskList> </RP>
Описание параметров
Параметр | Тип | Описание |
---|---|---|
TaskGuid | guid | Guid задачи |
TaskType | string | Тип задачи |
RequestDateTime | datettime | Дата создания задачи |
CallbackResponseDateTime | datettime | Дата отправки callback |
ObjectId | int | Id агента |
AggregatorStatus | int | Статус получения задачи от агрегатора, возможные значения: Nothing = 0, SyncError = 1, SyncSuccess = 2, SyncQueued = 3, AsyncQueued = 4, AsyncQueuedError = 5, BadRequest = 6, LicenseError = 7, InternalError = 8, AuthFailed = 9 |
AgentStatus | int | Статус обработки задач агентом, возможные значения: Nothing = 0, Waiting = 1, WaitingTimeoutError = 2, Requested = 3, RequestedTimeoutError = 4, RequestedError = 5, Answered = 6, AnsweredError = 7, RestoranError = 8 |
ResponseStatus | int | Статус ответа(отправки callback), возможные значения: Nothing = 0, Answered = 1, AnsweredWithAnError = 2, CallbackSent = 3, CallbackError = 4 |
TaskStatus | int | Итоговый статус по задаче (успешна или нет), возможные значения: Nothing = 0, Success = 1, Failed = 2 |
CallBackUrl | string | Адрес отправки колбэка |
3 Примеры вызовов
3.1 Примеры запросов
Запрос без фильтра
<?xml version="1.0" encoding="utf-8"?> <RQ cmd="get_tasklist"> </RQ>
Запрос с фильтром по guid задачи
<?xml version="1.0" encoding="utf-8"?> <RQ cmd="get_tasklist"> <GetTaskListRequest TaskGuid="44d20d37-45dc-47d9-9800-5cef79c58982"/> </RQ>
Запрос с фильтром по ObjectId
<?xml version="1.0" encoding="utf-8"?> <RQ cmd="get_tasklist"> <GetTaskListRequest ObjectId="199990106"/> </RQ>
Запрос с фильтрами по ObjectId и дате создания
<?xml version="1.0" encoding="utf-8"?> <RQ cmd="get_tasklist"> <GetTaskListRequest ObjectId="199990106" RequestDateTimeStart="2018-08-15T17:42:32.991536"/> </RQ>
3.2 Примеры ответов
Ответ с одной задачей
<?xml version="1.0" encoding="utf-8"?> <RP taskguid="61c56788-a288-43bb-bf50-bfc7337f344f" code="0" version="1.9.0"> <TaskList> <Task> <TaskGuid>8a026091-97b4-4984-828a-6873f187352a</TaskGuid> <TaskType>get_tasklist</TaskType> <RequestDateTime>2018-08-21T15:37:11.12798</RequestDateTime> <AggregatorStatus>2</AggregatorStatus> <AgentStatus>0</AgentStatus> <ResponseStatus>1</ResponseStatus> <TaskStatus>1</TaskStatus> </Task> </TaskList> </RP>
Ответ - несколько задач
<?xml version="1.0" encoding="utf-8"?> <RP taskguid="61c56788-a288-43bb-bf50-bfc7337f344f" code="0" version="1.9.0"> <TaskList> <Task> <TaskGuid>de36cc36-390e-4f1c-930b-7e3bfb8a1eb6</TaskGuid> <TaskType>any_call</TaskType> <ObjectId>199996011</ObjectId> <RequestDateTime>2018-08-20T14:54:55.87243</RequestDateTime> <AggregatorStatus>7</AggregatorStatus> <AgentStatus>0</AgentStatus> <ResponseStatus>1</ResponseStatus> <TaskStatus>2</TaskStatus> <CallBackUrl>https://ucs.ru/test</CallBackUrl> </Task> <Task> <TaskGuid>b273fe39-e76b-4a62-9ca1-ae45c71ccfb3</TaskGuid> <TaskType>any_call</TaskType> <ObjectId>199995826</ObjectId> <RequestDateTime>2018-08-20T14:53:52.62</RequestDateTime> <AggregatorStatus>4</AggregatorStatus> <AgentStatus>2</AgentStatus> <ResponseStatus>4</ResponseStatus> <TaskStatus>2</TaskStatus> <CallBackUrl>https://ucs.ru/test</CallBackUrl> </Task> </TaskList> </RP>