Session — активные сеансы приложений абонента

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

Для выполнения методов этой группы пользователь, от имени которого вызывается программный интерфейс, должен обладать следующей ролью:

Владелец абонента.

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

Метод	Назначение
session/check_list	Проверить актуальность списка сеансов в приложениях абонента
session/list	Актуальный список сеансов в приложениях абонента
session/prepare_list	Подготовить список сеансов в приложениях абонента
session/terminate	Завершить сеанс в приложении абонента

session/check_list

Проверить актуальность списка сеансов в приложениях абонента

Параметр	Тип	Описание	Пример
Запрос
account	Число (+12.0)	Код абонента	1010
request_id *	Строка переменная (100)	Идентификатор запроса	abc
Ответ
ready	Булево	Список сеансов подготовлен	false
ready_time *	Дата и время в строке формата ISO	Момент UTC+00 подготовки списка сеансов

Пример запроса Развернуть

POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/session/check_list
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "account": 1010,
  "auth": {
    "account": 1010
  }
}

Пример ответа Развернуть

{
  "ready": false,
  "ready_time": "0001-01-01T00:00:00",
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 37,
    "sm_version": "1.1.48.6",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

session/list

Актуальный список сеансов в приложениях абонента

Параметр	Тип	Описание	Пример
Запрос
account	Число (+12.0)	Код абонента	1010
request_id *	Строка переменная (100)	Идентификатор запроса	abc
tenants *	Массив из Число (+7.0)	Номера приложений	["1","2"]
Ответ
session	Список (0..*)	Список сеансов
- tenant *	Число (+7.0)	Номер приложения	2000
- tenant_name *	Строка переменная (100)	Название приложения	Мое приложение
- user *	Строка переменная (150)	Имя пользователя	Abramov
- start	Дата и время в строке формата ISO	Момент начала сеанса	28.02.2019 0:00:00
- id	Число (любое)	Номер сеанса	1500
- application	Строка неограниченной длины	Имя приложения	WebClient
- sleeping	Булево	Спящий сеанс	false
- IP *	Строка неограниченной длины	IP-адрес	127.0.0.1
- exclusive *	Булево	(не используется) Установлен монопольный режим
tenant_with_errors	Список (0..*)	Приложения с ошибкой получения списка сеансов
- code *	Число (+7.0)	Номер приложения	2000
- name *	Строка переменная (100)	Название приложения	Мое приложение
general		Общие поля ответа
- response	Число (+5.0)	Код возврата: 10200 (Запрос успешно выполнен) 10201 (Объект добавлен) 10202 (Запрос принят для обработки) 10240 (Запрос обработан с корректировкой) 10400 (Плохой запрос) 10401 (Запрос не авторизован) 10403 (Нарушение прав доступа) 10404 (Объект не найден) 10405 (Метод не поддерживается) 10406 (Неприемлемые входные данные) 10409 (Конфликт в данных) 10500 (Внутренняя ошибка) 10501 (Метод не реализован) 10520 (Неизвестная ошибка)	10202
- error	Булево	Флаг ошибки. Истина означает, что при выполнении метода возникла ошибка	false
- message *	Строка неограниченной длины	Описание ошибки
- version	Число (+5.0)	Версия API, которая была задействована при выполнении запроса	37
- sm_version	Строка переменная (18)	Версия конфигурации менеджера сервиса	1.1.48.6
- sm_timezone	Строка переменная (100)	Часовой пояс информационной базы менеджера сервиса	Europe/Moscow

Пример запроса Развернуть

POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/session/list
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "account": 1010,
  "auth": {
    "account": 1010
  }
}

Пример ответа Развернуть

{
  "session": [
    {
      "tenant": 2000,
      "tenant_name": "Мое приложение",
      "user": "Abramov",
      "start": "2019-02-28T00:00:00",
      "id": 1500,
      "application": "WebClient",
      "sleeping": false,
      "IP": "127.0.0.1",
      "exclusive": true
    }
  ],
  "tenant_with_errors": [
    {
      "code": 2000,
      "name": "Мое приложение"
    }
  ],
  "general": {
    "response": 10202,
    "error": false,
    "message": "",
    "version": 37,
    "sm_version": "1.1.48.6",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

session/prepare_list

Подготовить список сеансов в приложениях абонента

Параметр	Тип	Описание	Пример
Запрос
account	Число (+12.0)	Код абонента	1010
request_id *	Строка переменная (100)	Идентификатор запроса	abc
tenants *	Массив из Число (+7.0)	Номера приложений	["1","2"]
Ответ: general (1)
response	Число (+5.0)	Код возврата: 10200 (Запрос успешно выполнен) 10201 (Объект добавлен) 10202 (Запрос принят для обработки) 10240 (Запрос обработан с корректировкой) 10400 (Плохой запрос) 10401 (Запрос не авторизован) 10403 (Нарушение прав доступа) 10404 (Объект не найден) 10405 (Метод не поддерживается) 10406 (Неприемлемые входные данные) 10409 (Конфликт в данных) 10500 (Внутренняя ошибка) 10501 (Метод не реализован) 10520 (Неизвестная ошибка)	10202
error	Булево	Флаг ошибки. Истина означает, что при выполнении метода возникла ошибка	false
message *	Строка неограниченной длины	Описание ошибки
version	Число (+5.0)	Версия API, которая была задействована при выполнении запроса	37
sm_version	Строка переменная (18)	Версия конфигурации менеджера сервиса	1.1.48.6
sm_timezone	Строка переменная (100)	Часовой пояс информационной базы менеджера сервиса	Europe/Moscow

Пример запроса Развернуть

POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/session/prepare_list
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "account": 1010,
  "auth": {
    "account": 1010
  }
}

Пример ответа Развернуть

{
  "general": {
    "response": 10202,
    "error": false,
    "message": "",
    "version": 37,
    "sm_version": "1.1.48.6",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

session/terminate

Завершить сеанс в приложении абонента

Параметр	Тип	Описание	Пример
Запрос
account	Число (+12.0)	Код абонента	1010
tenant	Число (+7.0)	Номер приложения	2000
user	Строка переменная (150)	Имя пользователя	Abramov
id	Массив из Число (любое)	Номера сеансов	["1 500"]
Ответ: general (1)
response	Число (+5.0)	Код возврата: 10200 (Запрос успешно выполнен) 10201 (Объект добавлен) 10202 (Запрос принят для обработки) 10240 (Запрос обработан с корректировкой) 10400 (Плохой запрос) 10401 (Запрос не авторизован) 10403 (Нарушение прав доступа) 10404 (Объект не найден) 10405 (Метод не поддерживается) 10406 (Неприемлемые входные данные) 10409 (Конфликт в данных) 10500 (Внутренняя ошибка) 10501 (Метод не реализован) 10520 (Неизвестная ошибка)	10202
error	Булево	Флаг ошибки. Истина означает, что при выполнении метода возникла ошибка	false
message *	Строка неограниченной длины	Описание ошибки
version	Число (+5.0)	Версия API, которая была задействована при выполнении запроса	37
sm_version	Строка переменная (18)	Версия конфигурации менеджера сервиса	1.1.48.6
sm_timezone	Строка переменная (100)	Часовой пояс информационной базы менеджера сервиса	Europe/Moscow

Пример запроса Развернуть

POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/session/terminate
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "account": 1010,
  "tenant": 2000,
  "user": "Abramov",
  "id": [
    1500
  ],
  "auth": {
    "account": 1010
  }
}

Пример ответа Развернуть

{
  "general": {
    "response": 10202,
    "error": false,
    "message": "",
    "version": 37,
    "sm_version": "1.1.48.6",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх