Метод используется для валидации нового количества ресурсов, указанного при оформлении заказа для существующей подписки:
-
Проверка вхождения в диапазон, заданный для ресурса в тарифном плане.
-
Проверка доступности изменения количества ресурса с учетом правила предоставления (см. Параметры изменения ресурсов в ).
-
Проверка доступности изменения количества ресурса с учетом типа биллинга тарифного плана.
-
Проверка доступности изменения количества ресурса на стороне вендора (если эту проверку поддерживает модуль, на основе которого создана подписка).
-
Получение от вендора минимального количества ресурса, которое должно остаться в подписке, если в заказе уменьшается количество этого ресурса (опционально).
В результате:
-
Если указанное количество ресурсов доступно для заказа, метод возвращает пустой ответ. Код ответа 204 No content.
-
Если указанное количество ресурсов недоступно для заказа, метод возвращает текст ошибки на стороне платформы или вендора. Код ответа 422 Unprocessable Entity. При этом если от вендора получено минимальное количество ресурса, которое должно остаться в подписке, оно включается в текст ошибки.
POST {reseller_domain}/internal_api/accounts/{account_id}/subscriptions/{subscription_id}/resources_validation
В этой статье:
Авторизация
Требуется авторизация с помощью access token пользователя.
Аргументы
|
Название |
Тип параметра |
Тип данных |
Обязательный/
|
Описание |
|
|---|---|---|---|---|---|
|
Content-Type |
header |
string |
Обязательный |
Тип данных, передаваемых в запросе. Укажите application/vnd.api+json |
|
|
Accept |
header |
string |
Обязательный |
Поддерживаемые типы данных в ответе. Укажите application/vnd.api+json |
|
|
X-Api-Locale |
header |
string |
Опциональный |
Двухбуквенный код языка данных в ответе и созданной асинхронной задачи |
|
|
Authorization |
header |
string |
Обязательный |
Действующий access token пользователя. Формат: |
|
|
reseller_domain |
path |
string |
Обязательный |
Доменное имя реселлера |
|
|
account_id |
path |
integer |
Обязательный |
ID аккаунта, которому принадлежит подписка |
|
|
subscription_id |
path |
integer |
Обязательный |
ID подписки |
|
|
resources |
form |
array of objects |
Обязательный |
Список ресурсов в заказе |
|
|
|
plan_resource_id |
form |
integer |
Обязательный |
ID ресурса тарифного плана в заказе |
|
|
quantity |
form |
integer |
Обязательный |
Количество ресурса тарифного плана в заказе |
|
order_type |
form |
string |
Обязательный |
Тип заказа для существующей подписки. Влияет на то, как будет выполняться валидация нового количества ресурсов. Доступные значения:
|
|
Пример запроса
curl --location --request POST 'https://test.activeplatform.com/internal_api/accounts/1938/subscriptions/3010784/resources_validation' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Api-Locale: en' \
--header 'Authorization: Bearer AccessTokenExample' \
--data-raw '{
"data": {
"attributes": {
"resources": [
{
"plan_resource_id": 23044,
"quantity": 99
}
],
"order_type": "ChangeOrder"
}
}
}'