Методы группы Tariff внешнего программного интерфейса Менеджера сервиса предназначены для получения информации о тарифах сервиса, доступных абоненту.
Сводка по методам
Метод | Назначение |
---|---|
tariff/info | Информация о тарифе провайдера |
tariff/list | Список тарифов провайдера |
tariff/info
Информация о тарифе провайдера
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
id | Строка переменная (9) | Код тарифа | 000000001 |
Ответ: tariff (1) | |||
id | Строка переменная (9) | Код тарифа | 000000001 |
name | Строка переменная (150) | Наименование тарифа | Основной тариф |
updated * | Дата и время в строке формата ISO | Дата изменения | |
start * | Дата в строке формата ISO (без времени) | Начало действия | |
expiration * | Дата в строке формата ISO (без времени) | Окончание действия | |
description * | Строка неограниченной длины | Описание | |
prolongation_validity * | Число (+10.0) | Число дней действия продлевающей подписки | 3 |
extension_validity * | Число (+10.0) | Число дней действия расширяющей подписки | 3 |
prolongation_during * | Число (+10.0) | Число дней для создания продлевающей подписки после завершения основной | 7 |
is_extension | Булево | Это расширение тарифа | false |
type | Строка (перечисление) | Тип тарифа:
| basic |
is_payable | Булево | Это платный тариф | true |
is_trial | Булево | Это тестовый тариф | false |
payment_by_periods | Булево | Это тариф с периодической оплатой | false |
periods_frequency * | Строка неограниченной длины | Периодичность оплаты тарифа | month |
has_condition * | Булево | Есть условие | true |
condition * | Условие использования | Пример описания условия | |
- code * | Число (+9.0) | Код условия | 1 |
- name * | Строка переменная (120) | Наименование условия | Пример наименования условия |
- description * | Строка неограниченной длины | Описание условия | Пример описания условия |
description_for_subscribers * | Информация для абонентов | ||
- html * | Строка неограниченной длины | HTML-код описания для абонентов | <html><body><img src="image001?_=1727359272"/><p>Пример описания тарифа</p></body></html> |
- images | Список (0..*) | Картинки описания | |
- images.name | Строка переменная (255) | Имя картинки | image001 |
- images.data | Двоичные данные размером до 1048576 байт в строке Base64 | Данные картинки, размер до 1 Мб | 89 50 4E 47 0D 0A 1A 0A 00 00 00 0D 49 48 44 52 00 00 00 10 00 00 00 10 08 06 00 00 00 1F F3 FF 61 0... |
services | Список (0..*) | Предоставляемые услуги | |
- id | Строка переменная (9) | Код услуги | 000000001 |
- name | Строка переменная (100) | Наименование услуги | Количество прав пользователей на запуск приложений |
- service_id | Строка переменная (50) | Идентификатор услуги | КоличествоПравПользователейНаЗапускПриложений |
- provider_name | Строка переменная (150) | Наименование поставщика услуги | Менеджер сервиса |
- provider_id | Строка переменная (50) | Идентификатор поставщика услуги | sm |
- description * | Строка неограниченной длины | Описание | |
- type | Строка (перечисление) | Тип услуги:
| limited |
- amount * | Число (+10.0) | Количество предоставляемых лицензий | 10 |
- extend_amount * | Число (+10.0) | Количество лицензий, которое может быть предоставлено расширяющей подпиской | 5 |
applications | Список (1..*) | Виды приложений | Работа в модели сервиса |
- name | Строка переменная (150) | Наименование вида приложения | Работа в модели сервиса |
- id | Строка переменная (22) | Код вида приложения | mt |
- description * | Строка неограниченной длины | Описание вида приложения | |
validity_periods | Список (0..*) | Периоды действия тарифа | |
- id | Строка переменная (10) | Код периода | 1YR |
- name | Строка переменная (50) | Наименование периода | 1 год |
- quantity | Число (+10.0) | Количество периодов | 1 |
- cost * | Число (+10.2) | Стоимость | 1500 |
- comment * | Строка переменная (1024) | Комментарий | Комментарий периода действия |
- period | Строка (перечисление) | Тип периода действия:
| year |
extensions | Список (0..*) | Расширения тарифа | |
- id | Строка переменная (9) | Код тарифа | 000000002 |
- name | Строка переменная (150) | Наименование тарифа | Расширение тарифа |
notification_periods | Список (0..*) | Периоды оповещений об окончании подписки | 7 |
- days_quantity * | Число (2.0) | Количество дней | 7 |
tariff/list
Список тарифов провайдера
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
name * | Строка переменная (150) | Фильтр по наименованию тарифа | Основной |
scope * | Массив из Строка (перечисление) | Параметры получения данных:
| ["is_payable","validity_periods","services","is_extension"] |
available_tariffs * | Массив из Строка переменная (9) | Отбор доступных тарифов расширений | ["000000002","000000003"] |
Ответ: tariff (0..*) | |||
id | Строка переменная (9) | Код тарифа | 000000001 |
name | Строка переменная (150) | Наименование тарифа | Основной тариф |
updated * | Дата и время в строке формата ISO | Дата изменения | |
start * | Дата в строке формата ISO (без времени) | Начало действия | |
expiration * | Дата в строке формата ISO (без времени) | Окончание действия | |
description * | Строка неограниченной длины | Описание | |
prolongation_validity * | Число (+10.0) | Число дней действия продлевающей подписки | 3 |
extension_validity * | Число (+10.0) | Число дней действия расширяющей подписки | 3 |
prolongation_during * | Число (+10.0) | Число дней для создания продлевающей подписки после завершения основной | 7 |
is_extension | Булево | Это расширение тарифа | false |
type | Строка (перечисление) | Тип тарифа:
| basic |
is_payable | Булево | Это платный тариф | true |
is_trial | Булево | Это тестовый тариф | false |
payment_by_periods | Булево | Это тариф с периодической оплатой | false |
periods_frequency * | Строка неограниченной длины | Периодичность оплаты тарифа | month |
has_condition * | Булево | Есть условие | true |
validity_periods | Список (0..*) | Периоды действия тарифа | |
- id | Строка переменная (10) | Код периода | 1YR |
- name | Строка переменная (50) | Наименование периода | 1 год |
- quantity | Число (+10.0) | Количество периодов | 1 |
- cost * | Число (+10.2) | Стоимость | 1500 |
- comment * | Строка переменная (1024) | Комментарий | Комментарий периода действия |
- period | Строка (перечисление) | Тип периода действия:
| year |
services | Список (0..*) | Предоставляемые услуги | |
- id | Строка переменная (9) | Код услуги | 000000001 |
- name | Строка переменная (100) | Наименование услуги | Количество прав пользователей на запуск приложений |
- service_id | Строка переменная (50) | Идентификатор услуги | КоличествоПравПользователейНаЗапускПриложений |
- provider_name | Строка переменная (150) | Наименование поставщика услуги | Менеджер сервиса |
- provider_id | Строка переменная (50) | Идентификатор поставщика услуги | sm |
- description * | Строка неограниченной длины | Описание | |
- type | Строка (перечисление) | Тип услуги:
| limited |
- amount * | Число (+10.0) | Количество предоставляемых лицензий | 10 |
- extend_amount * | Число (+10.0) | Количество лицензий, которое может быть предоставлено расширяющей подпиской | 5 |