Описание
Запрашивает лицензию у сервера документов с информацией о сервере и квоте пользователя.
Пример запроса
{
"c": "license"
}
Параметр
| Название | Описание | Тип | Наличие |
|---|
| c | Определяет тип команды. | строковый | обязательно |
Пример ответа
{
"error": 0,
"license": {
"end_date": "2021-07-07T23:59:59.000Z",
"trial": false,
"customization": false,
"connections": 0,
"connections_view": 0,
"users_count": 10,
"users_view_count": 10,
"users_expire": 30
},
"server": {
"resultType": 3,
"packageType": 1,
"buildDate": "2021-05-21T00:00:00.000Z",
"buildVersion": "6.3.0",
"buildNumber": 111
},
"quota": {
"users": [
{
"userid": "uid-0",
"expire": "2021-07-07T23:59:59.000Z"
},
{
"userid": "uid-1",
"expire": "2021-07-09T23:59:59.000Z"
},
...
],
"users_view": [
{
"userid": "uid-0",
"expire": "2021-07-07T23:59:59.000Z"
},
{
"userid": "uid-1",
"expire": "2021-07-09T23:59:59.000Z"
},
...
]
}
}
Параметры
| Параметр | Описание | Тип | Наличие |
|---|
| error | Определяет код ошибки. | целое число | обязательно |
| license | Определяет информацию о лицензии документа:- end_date -дата истечения срока действия лицензии.
- Тип: строковый
Наличие: обязательно - trial -определяет, является ли лицензия пробной или нет.
Тип: логический Наличие: обязательно - customization — по умолчанию параметр false, по наличию кастомизации.
Тип: логический Наличие: обязательно - connections — количество подключений для лицензии на подключение.
Тип: целое число Наличие: Необязательно - connections_view — количество подключений для просмотра в реальном времени.
type: целое число presence: Необязательно - users_count — количество пользователей для пользовательской лицензии.
Тип: целое число Наличие: Необязательно - users_view_count — количество пользователей для просмотра в реальном времени.
Тип: целое число Наличие: Необязательно - users_expire — количество дней после которых пользовательская лицензия недействительна, так как истек срок годности.
Тип: целое число Наличие: Необязательно
| объект | обязательно |
| server | Определяет характеристики сервера:- resultType — статус лицензии (1 — произошла ошибка, 2 — срок действия лицензии истек, 3 — лицензия еще доступна, 6 — срок действия пробной лицензии истек).
Тип: целое число наличие: обязательно - packageType — Версия продукта (0 — продукт с открытым исходным кодом, 1 — Enterprise Edition, 2 — Developer Edition).
Versiya produkta (0 — produkt s otkrytym is Тип: целое число наличие: обязательно - buildDate — дата сборки.
Тип: строковый наличие: обязательно - buildVersion — версия сборки.
Тип: строковый наличие: Необязательно - buildNumber — номер сборки.
Тип: целое число наличие: обязательно
| объект | обязательно |
| quota | Определяет значение пользовательской квоты:- users -пользовательская квота для пользовательской лицензии, где userid — идентификатор пользователя, открывшего редактор, expire — дата истечения срока действия лицензии для данного пользователя.
Тип: массив объектов наличие: обязательно - users_view — пользовательская квота на просмотр в реальном времени, где userid — id пользователя, открывшего редактор, expire — дата истечения срока просмотра для данного пользователя.
Тип: массив объектов наличие: обязательно
| объект | обязательно |