Получение списка дополнительных параметров Услуги для Тарифного плана Реселлера

Метод Get a List of the Reseller's Plan provisioning attributes используется для получения списка дополнительных параметров, необходимых для провижининга Услуги, по указанному ID Тарифного плана текущего Реселлера или любого из его нижестоящих Реселлеров.

Доступ к текущему Реселлеру, относительно которого формируется список нижестоящих Реселлеров, определяется по токену Сотрудника, указанному в заголовке запроса.

Метод Get a List of the Reseller's Plan provisioning attributes возвращает список дополнительных параметров только для следующих Услуг:

GET {base_url}/api/v3/resellers/{reseller_id}/plans/{plan_id}/provisioning_attributes

Аргументы

Название

Тип параметра

Тип данных

Обязательный/ 
Опциональный

Описание

X-Api-TokenheaderstringОбязательныйAPI токен Сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике)
Content-TypeheaderstringОбязательныйПредназначен для идентификации формата и способа представления сущности
AcceptheaderstringОбязательныйПредназначен для информирования сервера о типах данных, которые поддерживаются клиентом (браузером)
reseller_idpathintegerОбязательныйID Реселлера. Возможно указать ID текущего Реселлера или ID любого из его нижестоящих Реселлеров (см. Просмотр информации о реселлере)
plan_idpathintegerОбязательный

ID Тарифного плана

account_idqueryintegerОпциональныйID Клиента, для которого определяется список Подписок на Услугу Microsoft Azure, подходящих для покупки резервирования. Обязательный, если указан ID Тарифного плана на основе Услуги Microsoft Azure RI

Модель ответа

Название

Тип данных

Описание

dataarray of objectsДанные ответа


id

integer

ID дополнительного параметра. Значение зависит от Услуги:

УслугаID дополнительного параметраДополнительный параметр
Microsoft 365 (Microsoft Office 365)new_customer_domainНовый домен клиента в сети Microsoft (Tenant name)
exist_customer_domainСуществующий домен клиента в сети Microsoft (Tenant name)
Microsoft Azurenew_customer_domain
Новый домен клиента в сети Microsoft (Tenant name)
exist_customer_domainСуществующий домен клиента в сети Microsoft (Tenant name)
Microsoft Azure RIexist_customer_domainСуществующий домен клиента в сети Microsoft (Tenant name)
reservation_scopeОбласть резервирования (Reservations Scope)
azure_subscriptionsСписок Подписок Microsoft Azure Клиента, для которых доступен заказ Услуги Microsoft Azure RI
Microsoft Software Subscriptionsnew_customer_domainНовый домен клиента в сети Microsoft (Tenant name)
exist_customer_domainСуществующий домен клиента в сети Microsoft (Tenant name)
Google Workspace (G Suite)domain_nameНазвание домена, для которого заказывается Услуга
customer_alternate_emailАльтернативный email для связи с Клиентом
admin_loginЛогин администратора домена



typestringТип данных

attributesobjectИнформация о дополнительном параметре для провижининга Услуги


label

string

Название дополнительного параметра



typestring

Тип данных дополнительного параметра:

  • string — строка.
  • list — список.


keystringКлюч дополнительного параметра


requiredbool

Обязательность дополнительного параметра:

  • true — обязательный.
  • false — опциональный.


valuesarray

Список допустимых значений дополнительного параметра

УслугаID дополнительного параметраСписок допустимых значений дополнительного параметра
Microsoft 365 (Microsoft Office 365)——
Microsoft Azure——
Microsoft Azure RIreservation_scope
  • Current Subscription — область резервирования Текущая подписка.
  • All Subscriptions — область резервирования Все подписки.
azure_subscriptionsID, название и MS Subscription ID Подписок Microsoft Azure Клиента, для которых доступен заказ Услуги Microsoft Azure RI
exist_customer_domainСуществующий домен клиента в сети Microsoft (Tenant name), для которого доступен заказ Услуги Microsoft Azure RI
Microsoft Software Subscriptions——
Google Workspace (G Suite)——


plugin_slugstring

Модуль, на основе которого создана Услуга для указанного Тарифного плана:

  • office365 — модуль Office365.
  • microsoft_csp_products — модуль MicrosoftCspProducts.
  • vendor_service — модуль VSP (Vendor service plugin).

Ошибки

Статус ошибкиТекст ошибкиКомментарий
403У клиента нет подписок, подходящих для покупки резервирования. Клиент должен быть владельцем подписки Microsoft AzureЧтобы была возможность заказать Подписку Microsoft Azure RI, у указанного Клиента должна быть Подписка Microsoft Azure (см. параметр azure_subscriptions)

Пример запроса (Microsoft Azure RI)

GET /api/v3/resellers/1/plans/1770/provisioning_attributes?account_id=784
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json

Пример ответа (Microsoft Azure RI)

{
    "data": [
        {
            "id": "exist_customer_domain",
            "type": "provisioning_attributes",
            "attributes": {
                "label": "Exist tenant name",
                "type": "string",
                "key": "exist_customer_domain",
                "required": false,
                "values": [
                    "example.onmicrosoft.com"
                ],
                "plugin_slug": "microsoft_csp_products"
            }
        },
        {
            "id": "reservation_scope",
            "type": "provisioning_attributes",
            "attributes": {
                "label": "Reservations Scope",
                "type": "list",
                "key": "reservation_scope",
                "required": true,
                "values": [
                    "Current Subscription",
                    "All Subscriptions"
                ],
                "plugin_slug": "microsoft_csp_products"
            }
        },
        {
            "id": "azure_subscriptions",
            "type": "provisioning_attributes",
            "attributes": {
                "label": "Microsoft Customer Azure Subscription",
                "type": "list",
                "key": "azure_subscriptions",
                "required": true,
                "values": [
                    "#3007774 Azure (Office365 plugin) (XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX)",
                    "#3007831 Azure (Office365 plugin) (XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX)"
                ],
                "plugin_slug": "microsoft_csp_products"
            }
        }
    ]
}

Пример запроса (Google)

GET /api/v3/resellers/1/plans/1238/provisioning_attributes
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json

Пример ответа (Google)

{
    "data": [
        {
            "id": "domain_name",
            "type": "provisioning_attributes",
            "attributes": {
                "label": "Domain name",
                "type": "string",
                "key": "domain_name",
                "required": true,
                "values": [],
                "plugin_slug": "vendor_service"
            }
        },
        {
            "id": "customer_alternate_email",
            "type": "provisioning_attributes",
            "attributes": {
                "label": "Alternate customer email",
                "type": "string",
                "key": "customer_alternate_email",
                "required": true,
                "values": [],
                "plugin_slug": "vendor_service"
            }
        },
        {
            "id": "admin_login",
            "type": "provisioning_attributes",
            "attributes": {
                "label": "Administrator's account username",
                "type": "string",
                "key": "admin_login",
                "required": true,
                "values": [],
                "plugin_slug": "vendor_service"
            }
        }
    ]
}