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

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

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

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

Google Workspace (G Suite)

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 Клиента, для которого определяется список Подписок на Услугу Microsoft Azure, подходящих для покупки резервирования. Обязательный, если указан ID Тарифного плана на основе Услуги Microsoft Azure RI

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

Название

Тип данных

Описание

data

array of objects

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

order_attributes

array of objects

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

Услуга	Ключ дополнительного параметра	Дополнительный параметр
Google Workspace (G Suite)	domain_name	Название домена, для которого заказывается Услуга
	customer_alternate_email	Альтернативный email для связи с Клиентом
	admin_login	Логин администратора домена

required

bool

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

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

values

array

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

Услуга	Ключ дополнительного параметра	Список допустимых значений дополнительного параметра
Google Workspace (G Suite)	Допустимые значения всех дополнительных параметров не ограничиваются. Метод возвращает пустой массив

label

string

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

type

string

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

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

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
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": []
    }
}