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

Метод Get async task используется при покупке новой подписки (см. Создание заказа на покупку) для проверки статуса асинхронной задачи текущего реселлера или любого из его нижестоящих реселлеров, в рамках которой выполняется валидация дополнительных параметров на стороне услуги (см. Валидация дополнительных параметров услуг для тарифного плана).

Для авторизации требуется API-токен менеджера (сотрудника). API-токен можно получить через Панель управления Оператора (см. Просмотр и обновление информации о сотруднике).

По указанному в запросе API-токену определяются:

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

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

Аргументы

Название	Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
X-Api-Token	header	string	Обязательный	API-токен сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике)
Content-Type	header	string	Обязательный	Тип данных, передаваемых в запросе. Необходимо указать: application/vnd.api+json
Accept	header	string	Обязательный	Поддерживаемые типы данных в ответе. Необходимо указать: application/vnd.api+json
base_url	path	string	Обязательный	URL ActivePlatform
reseller_id	path	integer	Обязательный	ID реселлера. Возможно указать ID текущего реселлера или ID любого из его нижестоящих реселлеров (см. Просмотр информации о реселлере)
async_task_id	path	integer	Обязательный	ID асинхронной задачи

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

Название				Тип данных	Описание
data				object	Данные ответа
	id			string	ID асинхронной задачи
	type			string	Тип данных
	attributes			object	Параметры асинхронной задачи
		status		string	Статус асинхронной задачи: pending — задача создана. running — задача выполняется, идет процесс валидации. completed — задача завершена успешно. failed — задача завершена неуспешно из-за ошибки на стороне платформы.
		failure_message		string	Описание ошибки в случае, если асинхронная задача завершались неуспешно из-за ошибки на стороне платформы (`status = failed`)
		results		object	Информация о результатах валидации дополнительных параметров на стороне Услуги в случае, если асинхронная задача завершались успешно (`status = completed`)
			valid	bool	Результат валидации дополнительных параметров: true — все дополнительные параметры валидны. false — один или несколько дополнительных параметров невалидны.
			errors	array	Список ключей дополнительных параметров и связанных описаний ошибок в случае, если валидация дополнительных параметров завершилась неуспешно (`valid = false`)
			application_attributes	object

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

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