Методы группы Session внешнего программного интерфейса менеджера сервиса предназначены для работы с активными сеансами приложений абонента
Сводка по методам
Для выполнения всех методов этой группы пользователь, от имени которого вызывается программный интерфейс, должен обладать следующей ролью:
- Владелец абонента.
Метод | Примечание |
|---|---|
root | |
Подготовить список активных сеансов в приложениях абонента | |
| check_list | Проверить статус готовности списка сеансов |
| list | Получить ранее подготовленный список сеансов |
| terminate | Прервать указанный сеанс пользователя |
session/prepare_list
Начать подготовку списка активных сеансов в приложениях указанного абонента. Выполнение метода равнозначно выполнению команд "Активные пользователи - Обновить" в интерфейсе Личного кабинета.
Метод является асинхронным. Это значит, что
- В случае успешного выполнения будет возвращен код ответа 10202.
- Результат выполнения можно будет через какое-то время получить, выполнив метод session/list.
Параметр | Тип | Примечание |
|---|---|---|
Запрос | ||
account | Число | Код абонента |
Ответ: (1) | ||
Нет параметров | ||
session/check_list
Возвращает информацию об актуальности списка активных сеансов в приложениях указанного абонента. Выполнение метода не имеет аналогов в интерфейсе Личного кабинета.
Параметр | Тип | Примечание |
|---|---|---|
Запрос | ||
account | Число | Код абонента |
Ответ: (1) | ||
| ready | Булево | Указывает, что список сеансов был подготовлен |
| ready_time | Дата и время | Момент времени, на который был актуален подготовленный список сеансов. Указывается универсальное время (UTC+00) |
session/list
Возвращает собственно список активных сеансов. Выполнение метода позволяет получить точно такую же информацию, как и на форме "Активные пользователи" в интерфейсе Личного кабинета. Метод необходимо выполнять через какое-то время после выполнения метода session/prepare_list.
Если подготовленный список сеансов отсутствует:
- Будет инициирована подготовка списка (аналогично вызову метода session/prepare_list).
- Будет возвращен код ответа 10202.
Параметр | Тип | Примечание |
|---|---|---|
Запрос | ||
account | Число | Код абонента |
Ответ: session (0..*) | ||
| tenant | Число | Номер области данных |
| tenant_name | Строка | Название приложения |
| user | Строка | Имя пользователя |
| start | Дата и время | Момент начала сеанса |
| id | Число | Номер сеанса |
| sleeping | Булево | Сеанс является спящим |
Примечание. Параметр ответа exclusive (сообщающий, установил ли сеанс монопольный доступ к области) более не поддерживается.
session/terminate
Инициирует прерывание указанного сеанса или сеансов в указанной области данных. Выполнение метода равнозначно выполнению команды "Активные пользователи - Завершить сеанс" в интерфейсе Личного кабинета. Метод является асинхронным. Это значит, что
- В случае успешного выполнения будет возвращен код ответа 10202.
- Результат выполнения можно проверить повторным выполнением методов session/prepare_list и session/list.
Параметр | Тип | Примечание |
|---|---|---|
Запрос | ||
account | Число | Код абонента |
| tenant | Число | Номер области данных |
| user | Строка | Имя пользователя |
| id | Число или массив | Номер сеанса или массив чисел (номеров сеанса) |
Ответ: (1) | ||
Нет параметров | ||