ru:vendor-api:methods:subscriptions-actions

Содержание

Старт/стоп подписки
Запрос
Ответ
- Успех

Старт/стоп подписки

Изменяет состояние подписки.

Для команды «стоп» успехом считается перевод подписки в состояние Stopping/Stopped.
Для команды «старт» успехом считается перевод подписки в состояние Starting/Started.

Повторный стоп/старт подписки уже находящейся в состояниях Stopping/Stopped или Starting/Started соответственно - не трактуется как ошибка. Сервер возвращает стандартный ответ-успех.

Запрос

Синтаксис

Метод	URI
PUT	/subscriptions/{id}?action={action}

Параметры URI

Имя	Тип	Обязательный	Описание	Значение по-умолчанию
id	string	+	уникальный ID подписки
action	string	+	Возможные значения: «stop», «start».

Тело запроса

Нет.

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

PUT /subscriptions/42?action=start

Ответ

Успех

Стандартный код HTTP: 200 OK.

Тело ответа: изменённый объект Subscription. Контракты сервиса

Ошибка

Для указания типа ошибки в ответе сервера, используются стандартные HTTP-коды 4xx-5xx.

Тело ответа: возвращается общий для сервиса набор данных, содержащий сообщение об ошибке и дополнительную информацию. Дополнительная информация в разделе Ошибки сервиса.