Получение информации об асинхронной задаче Реселлера по ID

Метод Get information about the Reseller async task by ID используется при покупке новой Подписки (см. Создание Заказа на покупку) для проверки статуса асинхронной задачи текущего Реселлера или любого из его нижестоящих Реселлеров, в рамках которой выполняется валидация дополнительных параметров на стороне Услуги (см. Валидация дополнительных параметров Услуг для Тарифного плана Реселлера).

Доступ к текущему Реселлеру, относительно которого формируется список нижестоящих Реселлеров, определяется по токену Сотрудника, указанному в заголовке запроса.

GET {base_url}/api/v3/resellers/{reseller_id}/async_tasks/{async_task_id}

Аргументы

Название

Тип параметра

Тип данных

Обязательный/ 
Опциональный

Описание

X-Api-TokenheaderstringОбязательныйAPI токен Сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике)
Content-TypeheaderstringОбязательныйПредназначен для идентификации формата и способа представления сущности
AcceptheaderstringОбязательныйПредназначен для информирования сервера о типах данных, которые поддерживаются клиентом (браузером)
reseller_idpathintegerОбязательныйID Реселлера. Возможно указать ID текущего Реселлера или ID любого из его нижестоящих Реселлеров (см. Просмотр информации о реселлере)

async_task_id

pathintegerОбязательный

ID асинхронной задачи

Модель ответа

Название

Тип данных

Описание

dataobjectДанные ответа

idstringID асинхронной задачи

typestringТип данных

attributesobjectПараметры асинхронной задачи


statusstring

Статус асинхронной задачи:

  • pending задача создана.
  • running задача выполняется, идет процесс валидации.
  • completed задача завершена успешно.
  • failed — задача завершена неуспешно из-за ошибки на стороне платформы.


failure_messagestringОписание ошибки в случае, если асинхронная задача завершались неуспешно из-за ошибки на стороне платформы (status = failed)


resultsobjectИнформация о результатах валидации дополнительных параметров на стороне Услуги в случае, если асинхронная задача завершались успешно (status = completed)



validbool

Результат валидации дополнительных параметров:

  • true — все дополнительные параметры валидны.
  • false — один или несколько дополнительных параметров невалидны.



errorsarrayСписок ключей дополнительных параметров и связанных описаний ошибок в случае, если валидация дополнительных параметров завершилась неуспешно (valid= false)



application_attributesobject

Пример запроса

GET /api/v3/resellers/1/async_tasks/9b68427b-52d5-4c01-9b77-eb1b70517414
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json

Пример ответа

{
     "data":
    {
        "id": "9b68427b-52d5-4c01-9b77-eb1b70517414",
        "type": "async_tasks",
        "attributes":
        {
            "status": "completed",
            "failure_message": "",
            "results":
                {
                    "valid": true,
                    "errors": [{}] ,
                    "application_attributes": {application_attributes}
                }
        }
    }
}