Получение информации об асинхронной задаче Реселлера по 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-Token | header | string | Обязательный | API токен Сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике) | ||
Content-Type | header | string | Обязательный | Предназначен для идентификации формата и способа представления сущности | ||
Accept | header | string | Обязательный | Предназначен для информирования сервера о типах данных, которые поддерживаются клиентом (браузером) | ||
reseller_id | path | integer | Обязательный | ID Реселлера. Возможно указать ID текущего Реселлера или ID любого из его нижестоящих Реселлеров (см. Просмотр информации о реселлере) | ||
async_task_id | path | integer | Обязательный | ID асинхронной задачи |
Модель ответа
Название | Тип данных | Описание | ||||||
---|---|---|---|---|---|---|---|---|
data | object | Данные ответа | ||||||
id | string | ID асинхронной задачи | ||||||
type | string | Тип данных | ||||||
attributes | object | Параметры асинхронной задачи | ||||||
status | string | Статус асинхронной задачи:
| ||||||
failure_message | string | Описание ошибки в случае, если асинхронная задача завершались неуспешно из-за ошибки на стороне платформы (status = failed) | ||||||
results | object | Информация о результатах валидации дополнительных параметров на стороне Услуги в случае, если асинхронная задача завершались успешно (status = completed) | ||||||
valid | bool | Результат валидации дополнительных параметров:
| ||||||
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}
}
}
}
}