Остановка Подписки Реселлера
Метод Stop the Reseller's Subscription позволяет запустить процесс остановки Подписки по ее ID для текущего Реселлера или любого из его нижестоящих Реселлеров. Процесс остановки Подписки выполняется в соответствии со стандартной логикой платформы (см. Остановка подписки).
Доступ к текущему Реселлеру, относительно которого формируется список нижестоящих Реселлеров, определяется по токену Сотрудника, указанному в заголовке запроса.
POST {base_url}/api/v3/resellers/{reseller_id}/subscriptions/{subscription_id}/stop_operationАргументы
Название | Тип параметра | Тип данных | Обязательный/ | Описание | ||
|---|---|---|---|---|---|---|
| X-Api-Token | header | string | Обязательный | API токен Сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике) | ||
| Content-Type | header | string | Обязательный | Предназначен для идентификации формата и способа представления сущности | ||
| Accept | header | string | Обязательный | Предназначен для информирования сервера о типах данных, которые поддерживаются клиентом (браузером) | ||
| reseller_id | path | integer | Обязательный | ID Реселлера. Возможно указать ID текущего Реселлера или ID любого из его нижестоящих Реселлеров (см. Просмотр информации о реселлере) | ||
| subscription_id | path | integer | Обязательный | ID Подписки | ||
| data | form | object | Обязательный | Информация об атрибутах операции | ||
| attributes | form | object | Обязательный | Атрибуты операции | ||
| reason | form | string | Обязательный | Причина остановки Подписки | ||
| comment | form | string | Обязательный | Комментарий | ||
Модель ответа
В случае отсутствия ошибок метод возвращает пустой ответ со статусом 200 OK.
Ошибки
| Статус ошибки | Текст ошибки | Комментарий |
|---|---|---|
| 403 | Выполнение действия запрещено | Список доступных действий над Подпиской см. в Получение информации о Подписке Реселлера |
Пример запроса
POST /api/v3/resellers/1/subscriptions/3007255/stop_operation
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json{
"data":
{
"attributes":
{
"reason" : "reason",
"comment" : "comment"
}
}
}Пример ответа