Группа методов Subscription внешнего программного интерфейса Менеджера сервиса предназначена для управления подписками абонента.

Для управления подписками обслуживаемых абонентов необходимо использовать методы группы  account/customer_subscriptions .

Сводка по методам

Метод

Примечание

root

list 

Возвращает список подписок абонента.

info

Возвращает информацию об указанной подписке.

prolong

Создает продлевающую подписку.

extend

Создает расширяющую подписку.

subscription/list

Метод возвращает список существующих подписок абонента.

ПараметрТипОписаниеПример
Запрос
accountЧисло (+12.0)Код абонента1 010
start_date *Дата и время в строке формата ISOВыводить подписки с датой создания не ранее start_date01.01.2020 0:00:00
end_date *Дата и время в строке формата ISOВыводить подписки с датой создания не позднее end_date28.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 - Расширяющая подписка.
Пример запроса  Развернуть
{
  "account": 1010,
  "start_date": "2020-06-01T00:00:00",
  "auth": {
    "account": 1010
  },
  "general": {
    "version": 10,
    "type": "usr",
    "method": "subscription/list",
    "debug": true
  }
}
Пример ответа  Развернуть
{
  "subscription": [
    {
      "id": "000000001",
      "created": "2020-06-12T00:00:00",
      "start": "2020-06-14T00:00:00",
      "completion": "2021-07-13T23:59:59",
      "account": 1010,
      "servant": 1000,
      "servant_tariff": "SERV00001",
      "tariff": "PROV00001",
      "period": "1YR",
      "parent": "",
      "amount": 1,
      "type": "basic"
    }
  ],
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 10,
    "sm_version": "1.0.96.7",
    "sm_timezone": "Europe/Moscow"
  }
}

 Вверх

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 - Расширяющая подписка.
Пример запроса  Развернуть
{
  "account": 1010,
  "id": "000000001",
  "auth": {
    "account": 1010
  },
  "general": {
    "version": 10,
    "type": "usr",
    "method": "subscription/info",
    "debug": true
  }
}
Пример ответа  Развернуть
{
  "subscription": {
    "id": "000000001",
    "created": "2019-02-28T00:00:00",
    "start": "2020-04-14T00:00:00",
    "completion": "2021-04-13T23:59:59",
    "account": 1010,
    "servant": 1000,
    "servant_tariff": "SERV00001",
    "tariff": "PROV00001",
    "period": "1YR",
    "parent": "",
    "amount": 1,
    "type": "basic"
  },
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 10,
    "sm_version": "1.0.96.7",
    "sm_timezone": "Europe/Moscow"
  }
}

 Вверх

subscription/prolong

Метод создает и записывает новую продлевающую подписку на основании указанной основной подписки. Выполнение метода равнозначно выполнению команды "Продлить" в списке подписок в интерфейсе Личного кабинета.

Параметр

Тип

Примечание

Запрос

account

Число

Код абонента.

id

Строка

Номер подписки, на основании которой нужно создать продлевающую.

Ответ: subscription (1)

id

Строка

Номер подписки.

 Вверх

subscription/extend

Метод создает и записывает новую расширяющую подписку на основании указанной основной подписки. Выполнение метода равнозначно выполнению команды "Расширить" в списке подписок в интерфейсе Личного кабинета.

Параметр

Тип

Примечание

Запрос

account

Число

Код абонента.

id

Строка

Номер подписки, на основании которой нужно создать расширяющую.

Ответ: subscription (1)

id

Строка

Номер подписки.

 Вверх