Валидация дополнительных параметров Услуги для Тарифного плана Реселлера
Метод Validate the Reseller's Plan provisioning attributes используется при покупке новой Подписки для валидации значений дополнительных параметров, необходимых для провижининга Услуги, по указанному ID Тарифного плана текущего Реселлера или любого из его нижестоящих Реселлеров. См. также Получение списка дополнительных параметров Услуги для Тарифного плана Реселлера и Создание Заказа на покупку.
Если требуется, то одновременно с валидацией домена клиента в сети Microsoft (Tenant name) для указанного Клиента принимается соглашение Microsoft Customer Agreement от лица Сотрудника, API-токен которого использовался при отправке запроса.
Доступ к текущему Реселлеру, относительно которого формируется список нижестоящих Реселлеров, определяется по токену Сотрудника, указанному в заголовке запроса.
Метод Validate the Reseller's Plan provisioning attributes валидирует значения дополнительных параметров только для следующих Услуг:
POST {base_url}/api/v3/resellers/{reseller_id}/plans/{plan_id}/provisioning_attributes/validationАргументы
Название | Тип параметра | Тип данных | Обязательный/ | Описание | ||
|---|---|---|---|---|---|---|
| X-Api-Token | header | string | Обязательный | API токен Сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике) | ||
| Content-Type | header | string | Обязательный | Предназначен для идентификации формата и способа представления сущности | ||
| Accept | header | string | Обязательный | Предназначен для информирования сервера о типах данных, которые поддерживаются клиентом (браузером) | ||
| reseller_id | path | integer | Обязательный | ID Реселлера. Возможно указать ID текущего Реселлера или ID любого из его нижестоящих Реселлеров (см. Просмотр информации о реселлере) | ||
| plan_id | path | integer | Обязательный | ID Тарифного плана | ||
| data | form | object | Обязательный | Информация об атрибутах операции | ||
| account_id | form | integer | Обязательный | ID Клиента, для которого покупается Подписка | ||
| attributes | form | array | Обязательный | Список дополнительных параметров и их значений в зависимости от Услуги, связанной с указанным Тарифным планом (см. Получение списка дополнительных параметров Услуги для Тарифного плана Реселлера) | ||
| key | form | string | Обязательный | Ключ дополнительного параметра | ||
| value | form | Зависит от параметра | Обязательный | Значение дополнительного параметра | ||
Модель ответа
Название | Тип данных | Описание | ||||||
|---|---|---|---|---|---|---|---|---|
| key | string | Ключ дополнительного параметра | ||||||
| value | Зависит от параметра | Значение дополнительного параметра | ||||||
| microsoft_customer_agreement | bool | Информация о факте принятия соглашения Microsoft Customer Agreement:
Указывается, если одновременно с валидацией домена клиента в сети Microsoft (Tenant name) для указанного Клиента было принято соглашение Microsoft Customer Agreement | ||||||
Ошибки
| Статус ошибки | Текст ошибки | Комментарий |
|---|---|---|
| 422 | Ошибка при валидации параметров | Ошибка на стороне поставщика Услуги. Чтобы выполнить валидацию, повторите попытку позже |
| План не имеет дополнительных параметров услуги | Для Услуги, связанной с указанным Тарифным планом, валидация дополнительных параметров с помощью этого запроса не требуется | |
| Запрос содержит два типа доменов (новый и существующий) | Чтобы выполнить валидацию домена клиента в сети Microsoft (Tenant name), в запросе необходимо указать только один домен клиента — новый или существующий | |
| Неверный субдомен. Должен быть '.onmicrosoft.com' | Чтобы выполнить валидацию домена клиента в сети Microsoft (Tenant name), в запросе необходимо указать домен клиента, содержащий субдомен '.onmicrosoft.com' (например, example.onmicrosoft.com) | |
| Для клиента уже существует домен в сети Microsoft <домен> |
| |
| Должна быть указана подписка на услугу Microsoft Azure | Чтобы выполнить валидацию Подписки для Услуги Microsoft Azure RI, в запросе необходимо указать существующую Подписку на Услугу Microsoft Azure, принадлежащую указанному Клиенту | |
| Клиент должен быть владельцем подписки |
Пример запроса (Microsoft Azure RI)
POST /api/v3/resellers/1/plans/1770/provisioning_attributes/validation
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json{
"data": {
"account_id": 784,
"attributes": [
{
"key": "reservation_scope",
"value": "All Subscriptions"
},
{
"key": "azure_subscriptions",
"value": [
"#3007831 Azure (Office365 plugin) (XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX)"
]
}
]
}
}Пример ответа (Microsoft Azure RI)
[
{
"key": "reservation_scope",
"value": "All Subscriptions"
},
{
"key": "azure_subscriptions",
"value": [
"3007831 Azure (Office365 plugin) (XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX)"
]
}
]Пример запроса (Microsoft Azure, новый домен клиента в сети Microsoft)
POST /api/v3/resellers/1/plans/1768/provisioning_attributes/validation
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json{
"data": {
"account_id": 784,
"attributes": [
{
"key": "new_customer_domain",
"value": "example.onmicrosoft.com"
}
]
}
}Пример ответа (Microsoft Azure, новый домен клиента в сети Microsoft)
[
{
"key": "new_customer_domain",
"value": "example.onmicrosoft.com",
"microsoft_customer_agreement": true
}
]