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

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

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

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

VSP (Vendor service plugin).
Office365.
MicrosoftCspProducts.

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

Аргументы

Название	Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
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 Тарифного плана
account_id	query	integer	Обязательный	ID Клиента, для которого заказывается Подписка. Может влиять на список дополнительных параметров
plan_resource_ids[]	query	integer	Обязательный	Список ID заказываемых Ресурсов указанного Тарифного плана (см. Создание Заказа на покупку), разделенных запятыми. Может влиять на список дополнительных параметров

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

Название

Тип данных

Описание

data

array of objects

Данные ответа

order_attributes

array of objects

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

Услуга	Ключ дополнительного параметра	Дополнительный параметр	Примечание
Google Workspace (G Suite)	domain_name	Название домена, для которого заказывается Услуга
	customer_alternate_email	Альтернативный email для связи с Клиентом
	admin_login	Логин администратора домена
Kaspersky	approval_code	Код специальной цены	Cм. Kaspersky (PAYG, Yearly). Особенности работы услуги
Услуги на основе модуля Office365	is_new_domain	Признак "Новый домен клиента в сети Microsoft"	Отсутствует в ответе, если в запросе указан ID Клиента, для которого в платформе уже есть Tenant Name (у Клиента уже есть Подписка на одну из Услуг Microsoft)
	with_subdomain	Признак "С субдоменом .onmicrosoft.com"
	customer_domain	Доменное имя Office 365
	microsoft_customer_agreement	Признак принятия Клиентом соглашения Microsoft Customer Agreement	Отсутствует в ответе, если в запросе указан ID Клиента, для которого в платформе уже принято соглашение Microsoft Customer Agreement
Услуги на основе модуля MicrosoftCspProducts	is_new_domain	Признак "Новый домен клиента в сети Microsoft"	Отсутствует в ответе, если в запросе указан ID Клиента, для которого в платформе уже есть Tenant Name (у Клиента уже есть Подписка на одну из Услуг Microsoft)
	with_subdomain	Признак "С субдоменом .onmicrosoft.com"
	customer_domain	Доменное имя Office 365
	microsoft_customer_agreement	Признак принятия Клиентом соглашения Microsoft Customer Agreement	Отсутствует в ответе, если ни для одного из указанных ID Ресурсов принятие соглашения Microsoft Customer Agreement не требуется или соглашение уже принято
	microsoft_azure_subscription	Подписка клиента Microsoft Azure	Отсутствует в ответе, если ни для одного из указанных ID Ресурсов не требуется наличие у Клиента активной Подписки Microsoft Azure. Пример использования этих параметров см. в Заказ подписки на услугу Microsoft Software Subscriptions через Панель управления Оператора
	reservation_scope	Область резервирования

required

bool

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

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

values

array

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

Услуга	Ключ дополнительного параметра	Список допустимых значений дополнительного параметра
Google Workspace (G Suite)	Допустимые значения всех дополнительных параметров не ограничиваются. Метод возвращает пустой массив
Услуги на основе модуля Office365
Kaspersky
Услуги на основе модуля MicrosoftCspProducts	microsoft_azure_subscription	Массив объектов — список ID и названий активных Подписок Microsoft Azure указанного Клиента
Услуги на основе модуля MicrosoftCspProducts	reservation_scope	Массив объектов — список значений и отображаемых названий: all — Все подписки. current — Текущая подписка.

label

string

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

type

string

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

string — строка.
select — список.
checkbox — флажок (например, для соглашения Microsoft Customer Agreement).
boolean — переключатель (например, для домена в сети Microsoft).

key

string

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

priority

integer

Приоритет дополнительного параметра

default_value

string

Значение по умолчанию дополнительного параметра

plugin_slug

string

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

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

order_attributes_info

array

Не используется в текущей версии

Пример запроса (Google, модуль VSP)

GET /api/v3/resellers/1/plans/1238/order_attributes?account_id=826&plan_resource_ids[]=2205
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json

Пример ответа (Google, модуль VSP)

{
    "data": {
        "order_attributes": [
            {
                "required": true,
                "values": [],
                "label": "Имя домена",
                "type": "string",
                "key": "domain_name",
                "priority": 1,
                "default_value": "",
                "plugin_slug": "vendor_service"
            },
            {
                "required": true,
                "values": [],
                "label": "Альтернативный email",
                "type": "string",
                "key": "customer_alternate_email",
                "priority": 2,
                "default_value": "",
                "plugin_slug": "vendor_service"
            },
            {
                "required": true,
                "values": [],
                "label": "Имя администратора аккаунта",
                "type": "string",
                "key": "admin_login",
                "priority": 3,
                "default_value": "",
                "plugin_slug": "vendor_service"
            }
        ],
        "order_attributes_info": []
    }
}

Пример запроса (Microsoft 365, модуль Office365)

GET /api/v3/resellers/1/plans/1132/order_attributes&account_id=820&plan_resource_ids[]=1394
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json

Пример ответа (Microsoft 365, модуль Office365)

{
    "data": {
        "order_attributes": [
            {
                "label": "Новый домен клиента в сети Microsoft",
                "type": "boolean",
                "key": "is_new_domain",
                "values": [],
                "priority": 1,
                "default_value": "",
                "plugin_slug": "office365",
                "required": true
            },
            {
                "label": "С субдоменом .onmicrosoft.com",
                "type": "boolean",
                "key": "with_subdomain",
                "values": [],
                "priority": 1,
                "default_value": "",
                "plugin_slug": "office365",
                "required": true
            },
            {
                "label": "Доменное имя Office 365",
                "type": "string",
                "key": "customer_domain",
                "values": [],
                "priority": 1,
                "default_value": "",
                "plugin_slug": "office365",
                "required": true
            },
            {
                "label": "Cоглашение Microsoft Customer Agreement",
                "type": "checkbox",
                "key": "microsoft_customer_agreement",
                "values": [],
                "priority": 1,
                "default_value": "",
                "plugin_slug": "office365",
                "required": true
            }
        ],
        "order_attributes_info": []
    }
}