Дата последней модификации страницы: 01.12.2024

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

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

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

МетодНазначение
subscription/infoИнформация о подписке
subscription/listCписок подписок
subscription/prolongСоздать продлевающую подписку
subscription/extendСоздать расширяющую подписку

subscription/info

Информация о подписке

ПараметрТипОписаниеПример
Запрос
idСтрока переменная (9)Номер подписки000000001
Ответ: subscription (1)
idСтрока переменная (9)Номер подписки000000001
createdДата и время в строке формата ISOДата оформления подписки28.02.2019 10:00:00
updated *Дата и время в строке формата ISOДата изменения подписки28.02.2019 10:00:00
startДата и время в строке формата ISOНачало действия02.12.2024 0:00:00
completionДата и время в строке формата ISOЗавершение действия01.12.2025 23:59:59
accountЧисло (+12.0)Код обслуживаемого абонента1010
servant *Число (+12.0)Код ведущего абонента1000
servant_tariff *Строка переменная (9)Код тарифа обслуживающей организацииSERV00001
tariffСтрока переменная (9)Код тарифаPROV00001
period *Строка переменная (10)Код периода действия1YR
parent *Строка переменная (9)Номер основной подписки
typeСтрока (перечисление)Тип подписки:
  • basic (Основная)
  • extending (Расширяющая)
  • prolonging (Продлевающая)
basic
amountЧисло (+10.0)Количество1
bill *Строка переменная (9)Номер счета на оплату000000001
bill_id *Строка переменная (36)Идентификатор счета на оплату00000000-0000-0000-0000-000000000000
servicesСписок (0..*)Услуги
  - idСтрока переменная (9)Код услуги000000001
  - nameСтрока переменная (100)Наименование услугиКоличество прав пользователей на запуск приложений
  - service_idСтрока переменная (50)Идентификатор услугиКоличествоПравПользователейНаЗапускПриложений
  - provider_nameСтрока переменная (150)Наименование поставщика услугиМенеджер сервиса
  - provider_idСтрока переменная (50)Идентификатор поставщика услугиsm
  - description *Строка неограниченной длиныОписание
  - typeСтрока (перечисление)Тип услуги:
  • limited (Лимитированная)
  • unique (Уникальная)
  • unlimited (Безлимитная)
limited
  - activation_status *Строка (перечисление)Состояние активации:
  • activated (Активирована)
  • error (Ошибка при активации)
  • in_process (В процессе активации)
activated
  - amountЧисло (+10.0)Количество лицензий1
  - start_date *Дата и время в строке формата ISOДата подключения01.01.2020 0:00:00
  - end_date *Дата и время в строке формата ISOДата отключения28.02.2020 0:00:00
Пример запроса  Развернуть 
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/subscription/info
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": "000000001",
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть 
{
  "subscription": {
    "id": "000000001",
    "created": "2019-02-28T10:00:00",
    "updated": "2019-02-28T10:00:00",
    "start": "2024-12-02T00:00:00",
    "completion": "2025-12-01T23:59:59",
    "account": 1010,
    "servant": 1000,
    "servant_tariff": "SERV00001",
    "tariff": "PROV00001",
    "period": "1YR",
    "parent": "",
    "type": "basic",
    "amount": 1,
    "bill": "000000001",
    "bill_id": "00000000-0000-0000-0000-000000000000",
    "services": [
      {
        "id": "000000001",
        "name": "Количество прав пользователей на запуск приложений",
        "service_id": "КоличествоПравПользователейНаЗапускПриложений",
        "provider_name": "Менеджер сервиса",
        "provider_id": "sm",
        "description": "",
        "type": "limited",
        "activation_status": "activated",
        "amount": 1,
        "start_date": "2020-01-01T00:00:00",
        "end_date": "2020-02-28T00:00:00"
      }
    ]
  },
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 31,
    "sm_version": "1.1.39.17",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

subscription/list

Cписок подписок

ПараметрТипОписаниеПример
Запрос
scope *Массив из Строка (перечисление)Параметры получения данных:
  • services (Включать услуги)
["services"]
start_date *Дата и время в строке формата ISOДата создания подписки. Начальная, для отбора по периоду01.01.2020 0:00:00
end_date *Дата и время в строке формата ISOДата создания подписки. Конечная, для отбора по периоду28.02.2020 0:00:00
active *БулевоПолучение только активных подписокtrue
basic *БулевоПолучение только основных подписокfalse
account *Число (+12.0)Код обслуживаемого абонента1010
Ответ: subscription (0..*)
idСтрока переменная (9)Номер подписки000000001
createdДата и время в строке формата ISOДата оформления подписки28.02.2019 10:00:00
updated *Дата и время в строке формата ISOДата изменения подписки28.02.2019 10:00:00
startДата и время в строке формата ISOНачало действия02.12.2024 0:00:00
completionДата и время в строке формата ISOЗавершение действия01.12.2025 23:59:59
accountЧисло (+12.0)Код обслуживаемого абонента1010
servant *Число (+12.0)Код ведущего абонента1000
servant_tariff *Строка переменная (9)Код тарифа обслуживающей организацииSERV00001
tariffСтрока переменная (9)Код тарифаPROV00001
period *Строка переменная (10)Код периода действия1YR
parent *Строка переменная (9)Номер основной подписки
typeСтрока (перечисление)Тип подписки:
  • basic (Основная)
  • extending (Расширяющая)
  • prolonging (Продлевающая)
basic
amountЧисло (+10.0)Количество1
bill *Строка переменная (9)Номер счета на оплату000000001
bill_id *Строка переменная (36)Идентификатор счета на оплату00000000-0000-0000-0000-000000000000
servicesСписок (0..*)Услуги
  - idСтрока переменная (9)Код услуги000000001
  - nameСтрока переменная (100)Наименование услугиКоличество прав пользователей на запуск приложений
  - service_idСтрока переменная (50)Идентификатор услугиКоличествоПравПользователейНаЗапускПриложений
  - provider_nameСтрока переменная (150)Наименование поставщика услугиМенеджер сервиса
  - provider_idСтрока переменная (50)Идентификатор поставщика услугиsm
  - description *Строка неограниченной длиныОписание
  - typeСтрока (перечисление)Тип услуги:
  • limited (Лимитированная)
  • unique (Уникальная)
  • unlimited (Безлимитная)
limited
  - activation_status *Строка (перечисление)Состояние активации:
  • activated (Активирована)
  • error (Ошибка при активации)
  • in_process (В процессе активации)
activated
  - amountЧисло (+10.0)Количество лицензий1
  - start_date *Дата и время в строке формата ISOДата подключения01.01.2020 0:00:00
  - end_date *Дата и время в строке формата ISOДата отключения28.02.2020 0:00:00
Пример запроса  Развернуть 
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/subscription/list
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть 
{
  "subscription": [
    {
      "id": "000000001",
      "created": "2019-02-28T10:00:00",
      "updated": "2019-02-28T10:00:00",
      "start": "2024-12-02T00:00:00",
      "completion": "2025-12-01T23:59:59",
      "account": 1010,
      "servant": 1000,
      "servant_tariff": "SERV00001",
      "tariff": "PROV00001",
      "period": "1YR",
      "parent": "",
      "type": "basic",
      "amount": 1,
      "bill": "000000001",
      "bill_id": "00000000-0000-0000-0000-000000000000",
      "services": [
        {
          "id": "000000001",
          "name": "Количество прав пользователей на запуск приложений",
          "service_id": "КоличествоПравПользователейНаЗапускПриложений",
          "provider_name": "Менеджер сервиса",
          "provider_id": "sm",
          "description": "",
          "type": "limited",
          "activation_status": "activated",
          "amount": 1,
          "start_date": "2020-01-01T00:00:00",
          "end_date": "2020-02-28T00:00:00"
        }
      ]
    }
  ],
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 31,
    "sm_version": "1.1.39.17",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

subscription/prolong

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

ПараметрТипОписаниеПример
Запрос
accountЧисло (+12.0)Код абонента1010
idСтрока переменная (9)Номер основной подписки000000001
Ответ: id (1)
Нет параметров
Пример запроса  Развернуть 
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/subscription/prolong
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "account": 1010,
  "id": "000000001",
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть 
{
  "id": "000000002",
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 31,
    "sm_version": "1.1.39.17",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

subscription/extend

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

ПараметрТипОписаниеПример
Запрос
accountЧисло (+12.0)Код абонента1010
idСтрока переменная (9)Номер основной подписки000000001
Ответ: id (1)
Нет параметров
Пример запроса  Развернуть 
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/subscription/extend
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "account": 1010,
  "id": "000000001",
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть 
{
  "id": "000000002",
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 31,
    "sm_version": "1.1.39.17",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх