Группа методов Subscription внешнего программного интерфейса Менеджера сервиса предназначена для управления подписками абонента.
Для управления подписками обслуживаемых абонентов необходимо использовать методы группы account/customer_subscriptions .
Сводка по методам
Метод | Примечание |
---|---|
root | |
Возвращает список подписок абонента. | |
Возвращает информацию об указанной подписке. | |
Создает продлевающую подписку. | |
Создает расширяющую подписку. |
subscription/list
Метод возвращает список существующих подписок абонента.
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
account | Число (+12.0) | Код абонента | 1 010 |
start_date * | Дата и время в строке формата ISO | Выводить подписки с датой создания не ранее start_date | 01.01.2020 0:00:00 |
end_date * | Дата и время в строке формата ISO | Выводить подписки с датой создания не позднее end_date | 28.02.2020 0:00:00 |
Ответ: subscription (0..*) | |||
id | Строка переменная (9) | Номер подписки | 000000001 |
created | Дата и время в строке формата ISO | Дата оформления подписки | 28.02.2019 0:00:00 |
start | Дата и время в строке формата ISO | Начало действия | 14.04.2020 0:00:00 |
completion | Дата и время в строке формата ISO | Завершение действия | 13.04.2021 23:59:59 |
account | Число (+12.0) | Код обслуживаемого абонента | 1 010 |
servant | Число (+12.0) | Код ведущего абонента | 1 000 |
servant_tariff * | Строка переменная (9) | Код тарифа обслуживающей организации | SERV00001 |
tariff | Строка переменная (9) | Код тарифа | PROV00001 |
period | Строка переменная (10) | Код периода действия | 1YR |
parent * | Строка переменная (9) | Номер основной подписки | |
amount | Число (+12.0) | Количество (может быть больше 1 для подписок на расширения тарифов) | 1 |
type | Строка неограниченной длины | Тип подписки | basic |
Возможные значения поля type:
- basic - Основная подписка.
- prolonging - Продлевающая подписка.
- extending - Расширяющая подписка.
subscription/info
Метод возвращает информацию об указанной подписке.
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
account | Число (+12.0) | Код абонента | 1 010 |
id | Строка переменная (9) | Номер подписки | 000000001 |
Ответ: subscription (1) | |||
id | Строка переменная (9) | Номер подписки | 000000001 |
created | Дата и время в строке формата ISO | Дата оформления подписки | 28.02.2019 0:00:00 |
start | Дата и время в строке формата ISO | Начало действия | 14.04.2020 0:00:00 |
completion | Дата и время в строке формата ISO | Завершение действия | 13.04.2021 23:59:59 |
account | Число (+12.0) | Код обслуживаемого абонента | 1 010 |
servant | Число (+12.0) | Код ведущего абонента | 1 000 |
servant_tariff * | Строка переменная (9) | Код тарифа обслуживающей организации | SERV00001 |
tariff | Строка переменная (9) | Код тарифа | PROV00001 |
period | Строка переменная (10) | Код периода действия | 1YR |
parent * | Строка переменная (9) | Номер основной подписки | |
amount | Число (+12.0) | Количество (может быть больше 1 для подписок на расширения тарифов) | 1 |
type | Строка неограниченной длины | Тип подписки | basic |
Возможные значения поля type:
- basic - Основная подписка.
- prolonging - Продлевающая подписка.
- extending - Расширяющая подписка.
subscription/prolong
Метод создает и записывает новую продлевающую подписку на основании указанной основной подписки. Выполнение метода равнозначно выполнению команды "Продлить" в списке подписок в интерфейсе Личного кабинета.
Параметр | Тип | Примечание |
---|---|---|
Запрос | ||
account | Число | Код абонента. |
id | Строка | Номер подписки, на основании которой нужно создать продлевающую. |
Ответ: subscription (1) | ||
id | Строка | Номер подписки. |
subscription/extend
Метод создает и записывает новую расширяющую подписку на основании указанной основной подписки. Выполнение метода равнозначно выполнению команды "Расширить" в списке подписок в интерфейсе Личного кабинета.
Параметр | Тип | Примечание |
---|---|---|
Запрос | ||
account | Число | Код абонента. |
id | Строка | Номер подписки, на основании которой нужно создать расширяющую. |
Ответ: subscription (1) | ||
id | Строка | Номер подписки. |