Получение списка дополнительных параметров услуг для тарифного плана
Метод Get list of order attributes of plan используется для получения списка дополнительных параметров, необходимых для провижининга услуг, по указанному ID тарифного плана текущего реселлера или любого из его нижестоящих реселлеров.
Для авторизации требуется API-токен менеджера (сотрудника). API-токен можно получить через Панель управления Оператора (см. Просмотр и обновление информации о сотруднике).
По указанному в запросе API-токену определяются:
- Роль и уровень доступа менеджера, от которых зависит доступность метода.
- Текущий реселлер и его нижестоящие реселлеры, доступные в рамках метода.
Метод Get list of order attributes of plan может использоваться для услуг на основе следующих модулей:
- 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 | Обязательный | Тип данных, передаваемых в запросе. Необходимо указать: application/vnd.api+json |
| Accept | header | string | Обязательный | Поддерживаемые типы данных в ответе. Необходимо указать: application/vnd.api+json |
| base_url | path | string | Обязательный | URL ActivePlatform |
| 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 | Список дополнительных параметров в зависимости от услуги | ||||||
| required | bool | Обязательность дополнительного параметра:
| ||||||
| values | array | Список допустимых значений дополнительного параметра | ||||||
label | string | Название дополнительного параметра | ||||||
| type | string | Тип данных дополнительного параметра:
| ||||||
| key | string | Ключ дополнительного параметра | ||||||
| priority | integer | Приоритет дополнительного параметра | ||||||
| default_value | string | Значение по умолчанию дополнительного параметра | ||||||
| plugin_slug | string | Модуль, на основе которого создана услуга для указанного дополнительного параметра:
| ||||||
| order_attributes_info | array | Не используется в текущей версии | ||||||
| common_message | array of objects | Дополнительное сообщение при оформлении заказа | ||||||
| key | string | Модуль, на основе которого создана услуга:
| ||||||
| value | string | Текст сообщения | ||||||
Пример запроса (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": [],
"common_message": []
}
}Пример запроса (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": [],
"common_message": [
{
"key": "office365",
"value": "Перед добавлением существующего домена, пожалуйста, подтвердите приглашение от <a class=\"link\" href=\"https://admin.microsoft.com/Adminportal/Home?invType=ResellerRelationship&partnerId=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&msppId=0&DAP=true#/BillingAccounts/partner-invitation\">Microsoft Cloud Solution Provider</a>"
}
]
}
}