Авторизация

Содержит методы работы с авторизацией пользователей

Авторизация

Метод производит авторизацию пользователя внутри системы, создает специальную сессию и возвращет токен авторизации для доступа к остальным методам

{
    "noip": true,
    "email": "api@testapi.ru",
    "password": "12345678"
}

Параметры запроса

Атрибут Тип Обязательное Описание
email*
string
Да E-mail пользователя
password*
string
Да Пароль пользователя
policy*
boolean
Да Принятие политики конфиденциальности
remember
boolean
Запомнить сессию - продление сессии до 7 дней (по стандарту 12 часов)
keycloak
boolean
Отметка об авторизации через Keycloak
noip
boolean
Запомнить IP адрес пользователя
ttl
int
Время жизни сессии

Ошибки

Код Описание
40301 Неверный логин или пароль
40302 Аккаунт пользователя отключён
40303 Аккаунт пользователя не активирован

Пинг

ping

{}

Выход из системы

Метод позволяет разлогинить текущую сессию активного пользователя

{}

Активация аккаунта

Метод произведет активацию аккаунта по переданным данным

{
    "id": 33,
    "invite": "4B9Hcobl5PQXEUFMOSG28Nm8VEG6KfsGhxiyIPdP1KTXV56v7a0HPaioCZzyuCxc",
    "password": "1234"
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор пользователя
invite*
string
Да Уникальный токен активации
password*
string
Да Новый пароль пользователя

Запрос на смену пароля

Метод позволяет отправить запрос на смену пароля для аккаунта

{
    "email": "test@email.ru",
    "password": "1234"
}

Параметры запроса

Атрибут Тип Обязательное Описание
email*
string
Да E-mail для проверки
password*
string
Да Новый пароль пользователя

Валидация аккаунта

Метод позволяет провалидировать проверочный код для смены пароля аккаунта перед его изменением

{
    "code": "4B9Hcobl5PQXEUFMOSG28Nm8VEG6KfsGhxiyIPdP1KTXV56v7a0HPaioCZzyuCxc"
}

Параметры запроса

Атрибут Тип Обязательное Описание
code*
string
Да Проверочный код

Обновление профиля

Метод обновляет информацию текущего авторизованного пользователя

{
    "id": 57,
    "age": 0,
    "exp": 685,
    "sex": null,
    "tel": "79277175179",
    "city": "\u0421\u0430\u043c\u0430\u0440\u0430",
    "exid": "dev@okcall.ru",
    "game": [
        {
            "id": 26,
            "title": "\u041f\u0440\u043e\u0432\u0435\u0440\u043a\u0430 \u043d\u043e\u0432\u043e\u0439 \u0432\u0430\u043b\u044e\u0442\u044b (\u043a\u043e\u043f\u0438\u044f)",
            "off_gift": 0
        },
        {
            "id": 27,
            "title": "\u0421\u0430\u043c\u044b\u0439 \u0434\u0443\u0448\u043d\u044b\u0439",
            "off_gift": 1
        },
        {
            "id": 31,
            "title": "\u0421\u043e\u0442\u0440\u0443\u0434\u043d\u0438\u043a \u043c\u0435\u0441\u044f\u0446\u0430",
            "off_gift": 0
        }
    ],
    "hero": {
        "id": 92,
        "exp": 685,
        "hero": 25,
        "user": 57,
        "level": 51
    },
    "tags": [
        {
            "name": "jy"
        }
    ],
    "team": {
        "id": 1,
        "acl": [
            {
                "groups": {
                    "roles": null,
                    "teams": null,
                    "departments": null
                }
            }
        ],
        "logo": "https:\/\/testapi.labgame.ru\/uploads\/20250201\/8b4acc71.png",
        "name": "\u0420\u0430\u0437\u0440\u0430\u0431\u044b",
        "extra": []
    },
    "about": "",
    "adate": "2025-07-07",
    "bdate": "2025-02-18",
    "cdate": "2025-01-14 15:34:17",
    "coins": 7662,
    "email": "dev@okcall.ru",
    "rating": 0,
    "second": 33,
    "status": "active",
    "contacts": [],
    "language": "ru",
    "lastname": "\u041a\u0430\u043b\u043c\u044b\u043a\u043e\u0432",
    "position": "",
    "firstname": "\u0410\u043b\u0435\u043a\u0441\u0435\u0439",
    "about_like": [],
    "currencies": {
        "2": 533,
        "3": 1000
    },
    "department": {
        "id": 1,
        "pid": null,
        "logo": "https:\/\/testapi.labgame.ru\/uploads\/20250201\/36bd807e.png",
        "name": "\u041e\u0442\u0434\u0435\u043b \u0440\u0430\u0437\u0432\u0438\u0442\u0438\u044f",
        "head_id": 17,
        "topHead": [],
        "head_avatar": "https:\/\/testapi.labgame.ru\/uploads\/20250128\/334821cf.png",
        "head_lastname": "\u0410\u043a\u0443\u043b\u043e\u0432",
        "head_firstname": "\u0412\u0430\u0441\u0438\u043b\u0438\u0439"
    },
    "achievements": [
        {
            "id": 27,
            "icon": "https:\/\/testapi.labgame.ru\/uploads\/20250214\/7719775d.png",
            "name": "\u0420\u044b\u0431\u043e\u0432",
            "multi": 1,
            "reached": 2,
            "tooltip": null,
            "description": "\u041a\u0440\u043e\u0441\u0438\u0432\u043e\u0435...",
            "reached_date": "2025-07-03 14:41:46"
        },
        {
            "id": 29,
            "icon": "https:\/\/testapi.labgame.ru\/uploads\/20250314\/00ba81c4.png",
            "name": "\u0420\u0435\u0448\u0430\u043b\u0430",
            "multi": 0,
            "reached": 1,
            "tooltip": null,
            "description": "\ud83d\udcaa \u0423\u043c\u0435\u0435\u0448\u044c \u0440\u0430\u0437\u0440\u0443\u043b\u0438\u0432\u0430\u0442\u044c \u0441\u043b\u043e\u0436\u043d\u044b\u0435 \u0432\u0435\u0449\u0438!",
            "reached_date": "2025-05-16 10:57:07"
        },
        {
            "id": 19,
            "icon": "https:\/\/testapi.labgame.ru\/uploads\/20250128\/a2967536.png",
            "name": "\u041c\u0430\u0441\u0442\u0435\u0440 \u043f\u0440\u043e\u0434\u0443\u043a\u0442\u0438\u0432\u043d\u043e\u0441\u0442\u0438",
            "multi": 1,
            "reached": 1,
            "tooltip": "\u0412\u044b\u043f\u043e\u043b\u043d\u0438\u0442\u0435 10 \u0440\u0430\u0431\u043e\u0447\u0438\u0445 \u0437\u0430\u0434\u0430\u0447 \u0437\u0430 \u043e\u0434\u043d\u0443 \u043d\u0435\u0434\u0435\u043b\u044e",
            "description": "\u0414\u0435\u0441\u044f\u0442\u044c \u0440\u0430\u0431\u043e\u0447\u0438\u0445 \u0437\u0430\u0434\u0430\u0447 \u0437\u0430 \u043d\u0435\u0434\u0435\u043b\u044e - \u043e\u0434\u043d\u043e\u0439 \u043b\u0435\u0432\u043e\u0439!",
            "reached_date": "2025-03-12 11:01:18"
        },
        {
            "id": 9,
            "icon": "https:\/\/testapi.labgame.ru\/uploads\/20250128\/31fa26b6.png",
            "name": "\u0412\u0441\u0435\u0432\u0438\u0434\u044f\u0449\u0438\u0439",
            "multi": 1,
            "reached": 2,
            "tooltip": "\u041f\u0440\u0438\u043d\u0438\u043c\u0430\u0439\u0442\u0435 \u0443\u0447\u0430\u0441\u0442\u0438\u0435 \u0432 \u0442\u0435\u0441\u0442\u0438\u0440\u043e\u0432\u0430\u043d\u0438\u0438",
            "description": "\u0410\u043a\u0442\u0438\u0432\u043d\u043e \u043f\u0440\u0438\u043d\u0438\u043c\u0430\u043b \u0443\u0447\u0430\u0441\u0442\u0438\u0435 \u0432 \u0442\u0435\u0441\u0442\u0438\u0440\u043e\u0432\u0430\u043d\u0438\u0438",
            "reached_date": "2025-04-12 00:00:03"
        },
        {
            "id": 5,
            "icon": "https:\/\/testapi.labgame.ru\/uploads\/20250314\/ccaa5b46.png",
            "name": "\u041c\u043e\u043b\u043e\u0434\u0435\u0446!",
            "multi": 1,
            "reached": 4,
            "tooltip": null,
            "description": "\ud83d\udc4d \u041a\u0440\u0443\u0442\u043e \u0441\u043f\u0440\u0430\u0432\u043b\u044f\u0435\u0448\u044c\u0441\u044f, \u043e\u0442\u043b\u0438\u0447\u043d\u0430\u044f \u0440\u0430\u0431\u043e\u0442\u0430!",
            "reached_date": "2025-07-04 10:58:36"
        }
    ],
    "public_status": "api",
    "headDepartments": [],
    "notifications_mobile": []
}

Параметры запроса

Атрибут Тип Обязательное Описание
email
string
Email-пользователя
password
string
Пароль пользователя
bdate
string
Дата рождения в формате YY-MM-DD
hdate
string
Дата принятия в компанию в формате YY-MM-DD
position
string
Подпись пользователя (В будущем будет переименована)
sex
male | female
Пол пользователя
firstname
string
Имя пользователя
lastname
string
Фамилия пользователя
public_status
string
Отображаемый статус пользователя
city
string
Город пользователя
about
string
Поле "О себе"
tel
string
Номер телефона полдьзователя
tags
array
Тег(и) пользователя
contacts
array{type | data}
Контакты пользователя

Пользователи

Содержит методы работы и взаимодействия с пользователями системы. Позволяет управлять созданием, редактированием и удалением пользователей, их профилями.

Список пользователей

Метод выведет список пользователей на основе указанных фильтров.

{
    "limit": "1"
}

Параметры запроса

Атрибут Тип Обязательное Описание
page
integer
Номер порции данных
limit
integer
Размер порции. Максимум 50 записей

Список пользователей

Метод выводит список пользователей по заданным фильтрам

{
    "page": 1,
    "sort": "lastname",
    "team": null,
    "limit": 20,
    "query": "",
    "status": null,
    "direction": "ASC",
    "department": null,
    "company_role": null
}

Параметры запроса

Атрибут Тип Обязательное Описание
page
integer
Номер порции данных
limit
integer
Размер порции (Максимум 1000)
sort
id | lastname
Тип сортировки (по id / по фамилии)
direction
ASC | DESC
Направление отображаемых данных (ASC - с начала / DESC - с конца)
exid
string
поиск по exid
role
admin | employee
фильтр по типу профиля
status
active | invited | blocked
фильтр по статусу профиля
company_role
integer
фильтр id по роли
department
integer
фильтр по id отдела
team
integer
фильтр по id команды
company_position
integer
фильтр по id должности
query
string
Фильтр по имени / фамилии / городу

Список пользователей

Метод выведет список пользователей на основе заданных фильтров

{
    "company_role": 36
}

Параметры запроса

Атрибут Тип Обязательное Описание
department
integer
id отдела
team
integer
id команды
company_role
integer
id роли
status
active | invite | blocked
Статус пользователя

Упрощённый список пользователей

Метод вернет упрощённый список пользователей без пагинации. Удобно использовать для списков и селекторов

{}

Пользователь

Метод выведет информацию о пользователе

{
    "by": "id",
    "id": 57,
    "team": true,
    "type": "obj",
    "contacts": true,
    "department": true
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
integer
Да id пользователя
contacts
boolean
Подробные данные о контактах
team
boolean
Подробные данные о команде
department
boolean
Подробные данные об отделе
by
id | exid | email | null
Поле, по которому произвести выборку

Создание пользователя

Метод позволяет создать нового пользователя в системе с заданными параметрами

{
    "data": {
        "id": null,
        "acl": "{}",
        "sex": null,
        "tel": "",
        "exid": null,
        "role": "employee",
        "email": "dev+999@okcall.ru",
        "params": {
            "md_approve": false,
            "md_validation": false
        },
        "status": "invite",
        "lastname": "999",
        "firstname": "999"
    }
}

Параметры запроса

Атрибут Тип Обязательное Описание
firstname
string
Имя пользователя
lastname
string
Фамилия пользователя
email*
string
Да E-mail пользователя
tel
string
Телефон пользователя
avatar
string
Идентификатор (uuid) изображения
coins
int | null
Количество очков валюты
exp
int | null
Количество очков опыта
position
string | null
Должность (подпись)
company_position
int | null
Идентификатор должности (справочник)
role*
admin | employee
Да Системная роль
second
int | null
Количество очков типсов
status
active | invite | blocked
Статус аккаунта пользователя
company_role
int | null
Идентификатор роли (справочник)
department
int | null
Идентификатор отдела
team
int | null
Идентификатор команды
tags
string[]
Массив тегов
about
string | null
Дополнительная информация о пользователе
bdate
string | null
Дата рождения (формат гггг-мм-дд)
hdate
string | null
Дата начала работы (формат гггг-мм-дд)
city
string | null
Город
sex
male | female | null
Пол пользователя
password*
string | null
Да Пароль для входа в аккаунт
public_status
string | null
Публичный статус пользователя
acl
array | null
Массив параметров прав доступов
exid
int | null
Внешний идентификатор для сторонних сервисов
ref_id
int | null
Идентификатор пользователя, рефералом которого является
currencies
array | null
Массив очков кастомных валют
params
array | null
Массив дополнительных параметров

Обновление пользователя

Метод позволяет произвести редактирование пользователя с целью изменения его параметров

{
    "data": {
        "id": 70,
        "ip": "109.124.232.52",
        "acl": {
            "kb": {
                "block": null,
                "manage": null
            },
            "adfs": {
                "manage": null
            },
            "docs": {
                "block": null,
                "manage": null
            },
            "game": {
                "block": null,
                "check": null,
                "manage": null
            },
            "hero": {
                "block": null,
                "manage": null
            },
            "logs": {
                "view": null
            },
            "news": {
                "block": null,
                "manage": null
            },
            "refs": {
                "block": null,
                "manage": null
            },
            "shop": {
                "block": null,
                "check": null,
                "manage": null
            },
            "tips": {
                "manage": null
            },
            "check": {
                "manage": null
            },
            "forms": {
                "block": null,
                "manage": null,
                "applications": null
            },
            "media": {
                "block": null,
                "manage": null
            },
            "polls": {
                "block": null,
                "check": null,
                "manage": null
            },
            "tasks": {
                "play": true,
                "block": null,
                "check": null,
                "create": null
            },
            "tests": {
                "block": null,
                "check": null,
                "manage": null
            },
            "custom": {
                "manage": null
            },
            "quests": {
                "play": null,
                "block": null,
                "check": null,
                "manage": null
            },
            "slides": {
                "manage": null
            },
            "profile": {
                "roles": true,
                "teams": null,
                "users": null,
                "departments": true
            },
            "calendar": {
                "block": null,
                "manage": null
            },
            "comments": {
                "manage": null
            },
            "contests": {
                "play": true,
                "block": null,
                "check": null,
                "create": null
            },
            "keycloak": {
                "manage": null
            },
            "programs": {
                "block": null,
                "check": null,
                "manage": null
            },
            "projects": {
                "block": null,
                "manage": null
            },
            "settings": {
                "manage": null
            },
            "materials": {
                "block": null,
                "manage": null
            },
            "structure": {
                "block": null,
                "manage": null
            },
            "integration": {
                "manage": null
            },
            "achievements": {
                "block": null,
                "manage": null
            },
            "announcements": {
                "block": null,
                "manage": null
            }
        },
        "age": null,
        "exp": 25,
        "sex": "male",
        "tel": null,
        "city": null,
        "exid": null,
        "role": "employee",
        "tags": [],
        "team": null,
        "about": null,
        "adate": "2025-02-04 12:13:18",
        "bdate": null,
        "cdate": "2025-02-04 12:06:45",
        "chief": null,
        "coins": 286,
        "email": "gf.kalmykov@gmail.com",
        "hdate": null,
        "score": 5,
        "params": null,
        "rating": 0,
        "ref_id": null,
        "second": 50,
        "status": "active",
        "deleted": null,
        "contacts": [],
        "language": "ru",
        "lastname": "Freeman777",
        "platform": null,
        "position": null,
        "firstname": "Gordon",
        "currencies": "{\"2\": 222}",
        "department": 40,
        "coins_buffer": 0,
        "company_role": 24,
        "public_status": null,
        "registration_id": null,
        "registration_type": null
    },
    "token": "g8Ig7AEEHbUfEF2ifZH8Ul9qJWkWL7ZHVwkE8velvYYyFvkLlYspM9f7PHNmEH31",
    "loading": true,
    "userSearchText": ""
}

Параметры запроса

Атрибут Тип Обязательное Описание
firstname
string
Имя пользователя
lastname
string
Фамилия пользователя
email*
string
Да E-mail пользователя
tel
string
Телефон пользователя
avatar
string
Идентификатор (uuid) изображения
coins
int | null
Количество очков валюты
exp
int | null
Количество очков опыта
position
string | null
Должность (подпись)
company_position
int | null
Идентификатор должности (справочник)
role*
admin | employee
Да Системная роль
second
int | null
Количество очков типсов
status
active | invite | blocked
Статус аккаунта пользователя
company_role
int | null
Идентификатор роли (справочник)
department
int | null
Идентификатор отдела
team
int | null
Идентификатор команды
tags
string[]
Массив тегов
about
string | null
Дополнительная информация о пользователе
bdate
string | null
Дата рождения (формат гггг-мм-дд)
hdate
string | null
Дата начала работы (формат гггг-мм-дд)
city
string | null
Город
sex
male | female | null
Пол пользователя
password*
string | null
Да Пароль для входа в аккаунт
public_status
string | null
Публичный статус пользователя
acl
array | null
Массив параметров прав доступов
exid
int | null
Внешний идентификатор для сторонних сервисов
ref_id
int | null
Идентификатор пользователя, рефералом которого является
currencies
array | null
Массив очков кастомных валют
params
array | null
Массив дополнительных параметров

Удаление пользователя

Метод позволяет удалить пользователя из системы

{}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор пользователя

Приглашение для пользователя

При вызове данного метода пользователю будет направлено специальное почтовое уведомление с приглашением и ссылкой на активацию аккаунта

{
    "id": 85
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
integer
Да id пользователя

Начисление валюты пользователю

Метод позволяет осуществить начисление выбранной валюты пользователю

{
    "type": "coins",
    "amount": 10,
    "comment": "test",
    "ratingId": null,
    "currencyId": null
}

Параметры запроса

Атрибут Тип Обязательное Описание
type
coins | score | second | exp | currency
Тип передаваемой валюты
comment
string
Комментарий к переводу
amount*
int
Да Количество передаваемой валюты
ratingId
int
id рейтинга для перевода, если выбран type 'score'
currencyId
int
id валюты для перевода, если выбран type 'currency'

Дарение типсов пользователю

Метод позволяет осуществить дарение типсов от одного пользователя другому

{
    "type": "second",
    "user": 5,
    "amount": 10,
    "comment": "\u041f\u043e\u0437\u0434\u0440\u0430\u0432\u043b\u044f\u044e!",
    "game_id": null
}

Параметры запроса

Атрибут Тип Обязательное Описание
user*
int
Да Идентификатор пользователя, которому предназначен подарок
type
coins | score | second | exp | currency | string | null
Тип передаваемой валюты
comment
string
Комментарий
amount*
int
Да Количество передаваемой валюты
game_id
int
id рейтинга для перевода, если выбран type 'score'

Создание контакта пользователя

Метод позволяет добавить контакт владельцу токена

{
    "id": null,
    "data": "o;uo",
    "type": "tel"
}

Параметры запроса

Атрибут Тип Обязательное Описание
type*
tel | skype | email | url | telegram | fb | vk | ok | location | linkedin | instagram
Да Тип контакта
data*
string
Да Вносимые данные

Обновление контакта пользователя

Метод позволяет изменить контакт владельцу токена

{
    "id": 8,
    "data": "o;uo",
    "type": "tel"
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор контакта
type*
tel | skype | email | url | telegram | fb | vk | ok | location | linkedin | instagram
Да Тип контакта
data*
string
Да Вносимые данные

Удаление контакта пользователя

Метод позволяет удалить контакт по id

{
    "id": 44
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
integer
Да Идентификатор контакта

Накопленные награды

Метод вернет список накопленных наград пользователя с последнего момента его активности

{}

Отметка награды как прочитанной

Метод позволит отметить просмотренную награду как прочитанную, чтобы более она не отображалась пользователю

{
    "objectId": 5,
    "objectType": "currencies"
}

Параметры запроса

Атрибут Тип Обязательное Описание
objectType
currencies | scores | seconds | products | competencies | null
Тип награды
objectId
int | null
Идентификатор конкретной награды

Роли

Содержит методы управления ролями компании, процессом создания и назначения

Список ролей

Метод вернет список ролей

{}

Информация о роли

Получение данных конкретной роли по идентификатору

{
    "id": 39
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор роли

Создание роли

Метод позволяет создать новую роль

{
    "id": null,
    "acl": {
        "refs": {
            "block": null,
            "manage": null
        },
        "tips": {
            "manage": true
        }
    },
    "name": "kkkk",
    "level": 0,
    "second_period": "none"
}

Параметры запроса

Атрибут Тип Обязательное Описание
name*
string
Да Наименование роли
level
int | null
Уровень роли (от 0 до 9)
second
int | null
Количество начисляемой подарочной валюты
second_period
daily | weekly | monthly | quarterly | none | null
Периодичность начисления подарочной валюты
acl
array | null
Массив параметров прав доступов

Обновление роли

Метод позволяет обновить роль

{
    "id": 36,
    "acl": {
        "refs": {
            "block": null,
            "manage": null
        },
        "tips": {
            "manage": true
        }
    },
    "name": "kkkk",
    "level": 0,
    "second": null,
    "score_param": null,
    "score_period": null,
    "second_period": "none"
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int | null
Да
name*
string
Да Наименование роли
level
int | null
Уровень роли (от 0 до 9)
second
int | null
Количество начисляемой подарочной валюты
second_period
daily | weekly | monthly | quarterly | none | null
Периодичность начисления подарочной валюты
acl
array | null
Массив параметров прав доступов

Удаление роли

Метод удаляет роль

{
    "id": 36
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор роли

Назначение пользователей на роль

Метод позволяет назначать группы пользователей на одну роль

{
    "id": "36",
    "users": [
        "136"
    ]
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор роли
users*
int[]
Да Массив идентификаторов пользователей для назначения на роль

Отделы

Содержит методы управления отделами компании, процессом создания и назначения

Список отделов

Метод возращает список отделов

{
    "exid": ""
}

Список отделов

Метод вернет список отделов с учётом структуры

{
    "exclude": null
}

Параметры запроса

Атрибут Тип Обязательное Описание
exclude
int | null
Идентификатор отдела для исключения из выборки

Структура отделов

Метод вернет структуру отделов согласно иерархии

{}

Параметры запроса

Атрибут Тип Обязательное Описание
pid
int | null
Идентификатор отдела от которого необходимо построить структуру

Информация об отделе

Получение данных конкретного отдела по идентификатору

{
    "id": 49
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор отдела

Создание отдела

Метод позволяет создать новый отдел

{
    "id": null,
    "acl": "{}",
    "name": "uukk",
    "level": 0
}

Параметры запроса

Атрибут Тип Обязательное Описание
name*
string
Да Наименование отдела
logo
string | null
Идентификатор (uuid) изображения
pid
int | null
Идентификатор родительского отдела
acl
array | null
Массив параметров прав доступов
head
int | null
Идентификатор пользователя, являющегося руководителем отдела

Обновление отдела

Метод позволяет обновить отдел

{
    "id": 49,
    "acl": {},
    "pid": null,
    "head": null,
    "name": "uukk",
    "extra": []
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор отдела
name*
string
Да Наименование отдела
logo
string | null
Идентификатор (uuid) изображения
pid
int | null
Идентификатор родительского отдела
acl
array | null
Массив параметров прав доступов
head
int | null
Идентификатор пользователя, являющегося руководителем отдела

Удаление отдела

Метод удаляет отдел

{
    "id": 49
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор отдела

Назначение пользователей в отдел

Метод позволяет назначать группы пользователей на один отдел

{
    "id": "49",
    "users": []
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор отдела
users*
int[]
Да Массив идентификаторов пользователей для назначения в отдел

Команды

Содержит методы управления командами пользователей, процессом создания и назначения

Список команд

Метод вернет список команд

{}

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

Получение данных конкретной команды по идентификатору

{
    "id": 9
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор команды

Создание команды

Метод позволяет создать новую команду

{
    "id": null,
    "acl": "{}",
    "name": "jjj",
    "extra": "{}"
}

Параметры запроса

Атрибут Тип Обязательное Описание
name*
string
Да Наименование команды
logo
string | null
Идентификатор (uuid) изображения
extra
array | null
Массив дополнительных параметров
acl
array | null
Массив параметров прав доступов

Обновление команды

Метод позволяет обновить команду

{
    "id": 9,
    "acl": {},
    "name": "jjj",
    "extra": "{}"
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор команды
name*
string
Да Наименование команды
logo
string | null
Идентификатор (uuid) изображения
extra
array | null
Массив дополнительных параметров
acl
array | null
Массив параметров прав доступов

Удаление команды

Метод удаляет команду

{
    "id": 9
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор команды

Назначение пользователей в команду

Метод позволяет назначать группы пользователей в одну команду

{
    "id": "6",
    "users": [
        "136"
    ]
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор команды
users*
int[]
Да Массив идентификаторов пользователей для назначения в команду

Должности

Содержит методы управления должностями внутри компании, процессом создания и назначения

Список должностей

Метод вернет список должностей на основе параметров фильтрации

{
    "publish": 1
}

Параметры запроса

Атрибут Тип Обязательное Описание
publish
boolean
Показать только опубликованные или не опубликованные

Информация о должности

Метод вернет полную информацию о конкретной должности по её идентификатору

{}

Создание должности

Метод позволяет создать новую должность на основе заданных параметров

{
    "id": null,
    "name": "\u0422\u0435\u0445\u043d\u043e\u043b\u043e\u0433",
    "image": "00c89a3b-0936-4f8c-95c0-32e74f2f3973",
    "publish": 0
}

Параметры запроса

Атрибут Тип Обязательное Описание
name*
string
Да Наименование должности
image
string | null
Идентификатор (uuid) изображения
publish*
int
Да Статус публикациии

Обновление должности

Метод позволяет изменить существующую должность

{
    "id": 1,
    "name": "\u0411\u0443\u0445\u0433\u0430\u043b\u0442\u0435\u0440",
    "image": "008b4bbc-d039-434f-8539-6d1f1ef1bf65",
    "publish": 1
}

Параметры запроса

Атрибут Тип Обязательное Описание
name*
string
Да Наименование должности
image
string | null
Идентификатор (uuid) изображения
publish*
int
Да Статус публикациии

Удаление должности

Метод позволяет удалить существующую должность. Должность будет отмечена датой удаления и более нигде не будет отображаться

{}

Назначение пользователей на должность

Метод позволяет назначать группы пользователей на одну должность

{
    "users": [
        86,
        87,
        88
    ]
}

Параметры запроса

Атрибут Тип Обязательное Описание
users*
int[]
Да Массив идентификаторов пользователей

Назначение компетенций на должность

Метод позволяет назначить группу компетенций на одну должность

{
    "competencies": [
        11,
        55,
        78
    ]
}

Параметры запроса

Атрибут Тип Обязательное Описание
competencies*
int[]
Да Массив идентификаторов компетенций

Достижения

Содержит методы управления достижениями, процессом их создания, редактирования, удаления, назначения и управлением их видимостью

Список достижений

Метод вернет список достижений по указанным фильтрам

{
    "sort": {
        "field": "name",
        "direction": "ASC"
    },
    "team": null,
    "text": "",
    "department": null
}

Параметры запроса

Атрибут Тип Обязательное Описание
sort
array{field | direction}
Метод сортировки данных
team
int
id команды, которым доступно достижение
department
int
id отдела, которым доступно достижение
position
int
id должности, которым доступно достижение
text
string
Поиск совпадений в названии, описании, тултипе, комментарии к достижению

Список достижений пользователя

Метод вернет список достижений пользователя по указанным фильтрам

{
    "sort": {
        "field": "name",
        "direction": "ASC"
    },
    "team": null,
    "text": "",
    "department": null
}

Параметры запроса

Атрибут Тип Обязательное Описание
text
string
Поисковая строка
sort
field: string | direction: string
Направление сортировки
department
int | null
Идентификатор отдела
team
int | null
Идентификатор команды

Получение достижения

Метод позволяет получить информацию о достижении

{
    "id": 1
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор достижения

Создание достижения

Метод позволяет создать достижение по заданным параметрам

{
    "exp": null,
    "hide": 1,
    "name": "\u0435\u0443\u0435\u0443\u0440",
    "coins": null,
    "comment": "\u0435\u0440\u0435\u043a\u0440\u043a\u0435\u0440",
    "event_args": {},
    "description": "\u0440\u0435\u043a\u0435\u0440\u0435"
}

Параметры запроса

Атрибут Тип Обязательное Описание
name*
string
Да Название достижения
coins*
int
Да Кол-во очков валюты, выдаваемых за получение достижения
exp*
int
Да Кол-во очков опыта, выдаваемых за получение достижения
description
string
Описание достижения
tooltip
string
Подсказка при наведении в панели администратора
event
onUserBirthday | onUserHireday | onQuestFinished | onQuestCreated | onTaskFinished | onTaskCreated
Событие, при котором выдаётся достижение
event_args
array{age | count}
Параметры событий
comment
string
Комментарий, который увидет получатель в уведомлении
currencies
array{id}
Валюта, выдаваемая при получении достижения
scores
array{id}
Очки рейтинга, выдаваемые за получение достижения

Обновление достижения

Метод позволяет произвести редактирование достижения с целью изменения его параметров

{
    "id": 1,
    "exp": 300,
    "hide": 1,
    "name": "GL 5.0   \ud83d\ude80",
    "coins": 5000,
    "event": null,
    "multi": 0,
    "scores": [],
    "comment": "\u0420\u0435\u0441\u043f\u0435\u043a\u0442 \u043f\u0430\u0440\u043d\u044f\u043c",
    "formula": "$user.coins > 0",
    "tooltip": null,
    "currencies": {},
    "deleted_at": null,
    "department": null,
    "event_args": {},
    "description": "\u0420\u0430\u0437\u0440\u0430\u0431\u043e\u0442\u0430\u043b \u0438 \u0432\u044b\u043f\u0443\u0441\u0442\u0438\u043b \u043d\u043e\u0432\u0443\u044e \u0432\u0435\u0440\u0441\u0438\u044e \u043f\u0440\u043e\u0434\u0443\u043a\u0442\u0430!"
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор достижения
name*
string
Да Название достижения
coins*
int
Да Кол-во очков валюты, выдаваемых за получение достижения
exp*
int
Да Кол-во очков опыта, выдаваемых за получение достижения
description
string
Описание достижения
tooltip
string
Подсказка при наведении в панели администратора
event
onUserBirthday | onUserHireday | onQuestFinished | onQuestCreated | onTaskFinished | onTaskCreated
Событие, при котором выдаётся достижение
event_args
array{age | count}
Параметры событий
comment
string
Комментарий, который увидет получатель в уведомлении
currencies
array{id}
Валюта, выдаваемая при получении достижения
scores
array{id}
Очки рейтинга, выдаваемые за получение достижения

Удаление достижения

Метод позволяет удалить достижение

{
    "id": 32
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор удаляемого достижения

Обновление списка доступов

Позволяет произвести изменение списка доступов к достижению для пользователей

{
    "id": 1,
    "list": [
        {
            "id": 136,
            "type": "users"
        },
        {
            "id": 1,
            "type": "departments"
        },
        {
            "id": 3,
            "type": "departments"
        },
        {
            "id": 40,
            "type": "departments"
        },
        {
            "id": 41,
            "type": "departments"
        },
        {
            "id": 42,
            "type": "departments"
        },
        {
            "id": 45,
            "type": "departments"
        },
        {
            "id": 46,
            "type": "departments"
        },
        {
            "id": 47,
            "type": "departments"
        },
        {
            "id": 48,
            "type": "departments"
        },
        {
            "id": 1,
            "type": "teams"
        },
        {
            "id": 2,
            "type": "teams"
        },
        {
            "id": 5,
            "type": "teams"
        },
        {
            "id": 6,
            "type": "teams"
        },
        {
            "id": 7,
            "type": "teams"
        },
        {
            "id": 8,
            "type": "teams"
        }
    ]
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор достижения
list
{id: int | type: users | departments | teams | positions}[]
Массив данных пользователей, отделов, команд, должностей для выдачи им доступа

Список событий

Метод вернет список возможных событий, обрабатываемых достижениями

{}

Список пользователей с достижением

Метод выводит список пользователей имеющих заданное достижение

{
    "id": 1,
    "per": 10,
    "page": 1,
    "text": ""
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор достижения
pag
int
Размер порции данных
page
int
Кол-во порций данных
text
string
Дополнительные параметры поиска (Имя, фамилия, email, номер телефона)

Присвоение достижения пользователям

Метод позволяет назначить достижения заданным группам пользователей

{
    "id": 1,
    "team": [],
    "user": [
        136
    ],
    "userText": "",
    "department": []
}

Параметры запроса

Атрибут Тип Обязательное Описание
id
int
Идентификатор Достижения
team
int[]
id Команд, которые получат достижение
department
int[]
id Отделов, которые получат достижение
user
int[]
id Пользователей, которые получат достижение
userTex
string
Комментарий к начислению

Удаление достижения у пользователя

Метод удалит выбранное достижение у выбранного пользователя

{
    "id": 1,
    "user": 136
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор достижения
user*
int
Да Идентификатор пользователя

Удаление достижения у всех пользователей

Метод удалит выбранное достижение у всех пользователей, у кого оно есть

{
    "id": 1
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор достижения

Отметка достижения как прочитанного

Метод позволяет пометить достижение как прочитанное, когда оно отображается в окне полученных наград

{
    "id": 481
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор достижения

Упрощенный список достижений

Метод вернет упрощенный список всех достижений без фильтрации. Подходит для селекторов и списков

{}

Групповая обработка

Метод позволяет производить групповые операции над несколькими достижениями одновременно

{
    "type": "assign",
    "members": {
        "teams": [
            4
        ],
        "users": [
            1,
            18
        ],
        "positions": [],
        "departments": [
            3,
            8
        ]
    },
    "selected": [
        1,
        5
    ]
}

Параметры запроса

Атрибут Тип Обязательное Описание
selected*
int[]
Да Массив идентификаторов достижений
members*
{users: int[] | departments: int[] | teams: int[] | positions: int[]}
Да Список участников, где users - массив идентификаторов пользователей, departments - массив идентификаторов отделов, teams - массив идентификаторов команд, positions - массив идентификаторов должностей
type*
assign
Да Тип операции, где assign - операция присвоения

Герой

Содержит методы управления героями и их уровнями

Список героев

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

{
    "page": 1,
    "sort": "name",
    "limit": 10,
    "direction": "ASC"
}

Параметры запроса

Атрибут Тип Обязательное Описание
page
int
Номер порции данных
limit
int
Размер порции данных (max 1000)
direction
ASC | DESC
Направление выборки данных

Данные героя

Метод вернет данные выбранного героя по переданному идентификатору

{}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор героя

Добавление героя

Метод добавляет героя

{
    "name": "Test",
    "image": "56dea1bc-d771-41e9-b8d1-7b06fc1f1c70",
    "is_exclusive": 1
}

Параметры запроса

Атрибут Тип Обязательное Описание
name*
string
Да Имя героя
image*
string
Да Адресс изображения
is_exclusive
bool
Эксклюзивность героя

Обновление героя

Метод позволяет произвести редактирование героя с целью изменения его параметров

{
    "name": "Test",
    "image": "56dea1bc-d771-41e9-b8d1-7b06fc1f1c70",
    "is_exclusive": 1
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
string
Да Идентификатор героя
name*
string
Да Имя героя
image*
string
Да Адресс изображения
is_exclusive
bool
Эксклюзивность героя

Удаление героя

Метод удаляет героя

{}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор героя

Список уровней героя

Метод вернет список доступных уровней, назначенных в героя

{}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор героя

Добавление уровня

Метод добавляет уровень герою. Оборачивается в тело level{}

{
    "level": {
        "id": null,
        "exp": 3,
        "hero": 25,
        "name": "newLevel",
        "image": "88d35f68-21c9-4932-8a15-f995d4aa4eca",
        "period_type": "none"
    }
}

Параметры запроса

Атрибут Тип Обязательное Описание
id
int
id уровня героя
exp*
int
Да Лимит опыта для получения уровня
hero*
int
Да id героя
name*
string
Да Название уровня
image*
string
Да Адресс изображения уровня
currencies
array
Кастомная валюта, начисляемая при получении уровня
period_type
'daily' | 'weekly' | 'monthly' | 'quarterly' | 'none' | null
Периодичность выдачи наград при наличии уровня
prize_coins
int
Кол-во очков валюты, начисляемых при получении уровня
prize_product
int
id товара, выдаваемого при получении уровня
period_currencies
array
Кастомная валюта, начисляемая периодически, при наличии уровня
prize_achievement
int
id Достижения, выдаваемого при получении уровня
period_reward_coins
int
Количество очков валюты, начисляемые периодически при наличии уровня
period_reward_product
int
id Товара, выдаваемый периодически при наличии уровня

Обновление уровня

Метод обновляет информацию заданного уровня героя. Оборачивается в тело level{}

{
    "level": {
        "id": 46,
        "exp": 0,
        "hero": {
            "id": 25,
            "name": "Test33",
            "image": {
                "id": "56dea1bc-d771-41e9-b8d1-7b06fc1f1c70",
                "ext": "png",
                "url": "https:\/\/testapi.labgame.ru\/uploads\/20250610\/56dea1bc.png",
                "mime": "image\/png",
                "name": "heroFileId.png",
                "size": 59704
            },
            "is_exclusive": 1,
            "exclusive_cost": null
        },
        "name": "Level22",
        "image": "8faa1743-2789-424e-82da-71fa7235140d",
        "currencies": {},
        "period_type": "none",
        "prize_coins": null,
        "prize_product": null,
        "period_currencies": {},
        "prize_achievement": null,
        "period_reward_coins": null,
        "period_reward_product": null
    }
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id уровня героя
exp*
int
Да Лимит опыта для получения уровня
name*
string
Да Название уровня
image
string
Адресс изображения уровня
currencies
array
Кастомная валюта, начисляемая при получении уровня
period_type
'daily' | 'weekly' | 'monthly' | 'quarterly' | 'none' | null
Периодичность выдачи наград при наличии уровня
prize_coins
int
Кол-во очков валюты, начисляемых при получении уровня
prize_product
int
id товара, выдаваемого при получении уровня
period_currencies
array
Кастомная валюта, начисляемая периодически, при наличии уровня
prize_achievement
int
id Достижения, выдаваемого при получении уровня
period_reward_coins
int
Количество очков валюты, начисляемые периодически при наличии уровня
period_reward_product
int
id Товара, выдаваемый периодически при наличии уровня

Удаление уровня

Метод удаляет уровень героя

{}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор героя
level*
int
Да Идентификатор уровня

Список пользователей

Метод вернет список пользователей, которым назначен выбранный герой

{
    "per": 10,
    "page": 1,
    "text": ""
}

Параметры запроса

Атрибут Тип Обязательное Описание
page
int
Номер порции данных
per
int
Размер порции данных (max 1000)
text
string | null
Поисковая фраза

Рейтинг героя

Метод вернет сортированный список пользователей на основе их уровня и опыта внутри героя

{}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор героя

Назначение героя

Метод назначает героя заданным группам пользователей

{
    "teams": [],
    "users": [
        85
    ],
    "delold": true,
    "departments": [
        1
    ]
}

Параметры запроса

Атрибут Тип Обязательное Описание
teams
array
Список команд
users
array
Список пользователей
departments
array
Список отделов
positions
array
Список должностей
delold
bool
Принудительное присвоение при наличии героя у пользователя

Присвоение героя по выбору

Метод назначает героя пользователю по его собственному выбору (самому себе)

{}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор героя

Удаление пользователя

Метод удаляет героя у заданного пользователя

{}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор героя
hero_user_id*
int
Да Идентификатор пользователя

Герой пользователя

Метод вернёт информацию о герое, установленного у пользователя

{
    "user": null
}

Параметры запроса

Атрибут Тип Обязательное Описание
user*
int
Да id пользователя

Магазин

Содержит методы управления магазином, заказами, атрибутами, категориями, товарами и их настройками

Список товаров

Метод вернет список товаров

{
    "per": "4",
    "page": 1,
    "sort": "sortnum",
    "text": "",
    "archive": false,
    "available": true,
    "direction": "DESC",
    "currencyId": null,
    "category_id": "all",
    "paymentType": null
}

Параметры запроса

Атрибут Тип Обязательное Описание
per
int
Размер порции данных
page
int
Номер порции данных
sort
id | sortnum | name | price | rand | rating
Метод сортировки
text
string
Поиск по тексту в названии/описании
archive
bool
Фильтр по статусу "в архиве"
available
bool
Фильтр по статусу "Доступен"
direction
ASC | DESC
Направление выдачи данных
paymentType
coins | currency
Фильтр по валюте, в которой продаётся товар
currencyId
int
Фильтр по id кастомной валюты (если paymentType = currency)
category_id
int
Фильтр по категории товара

Информация о товаре

Метод вернет подробную информацию о товаре по переданному идентификатору

{
    "id": "40"
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор товара

Создание товара

Метод позволяет создать новый товар по указанным параметрам

{
    "id": null,
    "name": "T1",
    "image": "aabc198a-375b-436f-aae3-c90dbf7ecf51",
    "price": 1,
    "available": null,
    "max_users": 100,
    "min_users": 1,
    "price_type": "users",
    "category_id": null,
    "currency_id": null,
    "description": "T1 T1 T1",
    "is_variable": 0,
    "payment_type": "coins"
}

Параметры запроса

Атрибут Тип Обязательное Описание
name*
string
Да Название товара
image
string
Адресс изображения
price
int
Стоимость в выбранной валюте
available
bool
Активность товара
max_users
int
Кол-во возможных покупателей одной позиции (max 100)
min_users
int
Кол-во минимального кол-ва покупателей одной позиции
price_type*
users | amount
Да Тип оплаты
category_id
int
Присвоение категории
payment_type
coins | currency
Валюта оплаты
currency_id
int
id валюты (если кастомная)
description*
string
Да Описание продукта
is_variable
bool
Вариативность продукта

Обновление товара

Метод позволяет обновить данные товара

{
    "id": 55,
    "name": "T1",
    "price": 1,
    "archive": 0,
    "deleted": 0,
    "sortnum": 55,
    "variants": [],
    "available": 5,
    "max_users": 99,
    "min_users": 2,
    "old_price": null,
    "price_type": "users",
    "category_id": null,
    "currency_id": 0,
    "description": "T1 T2 T3",
    "is_variable": 0,
    "payment_type": "coins",
    "auto_complete": 0,
    "category_name": null,
    "additional_images": [],
    "complete_description": "Yes"
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Товара
name
string
Название товара
price
int
Цена товара в выбранной валюте
archive
bool
Архивность товара
deleted
bool
Перемещение товара в корзину
sortnum
int
Позиция товара в списке
variants
array{}
Варианты товара
available
int
Кол-во товара в наличии
max_users
int
Максимальное количество покупателей одной позиции (max 100)
min_users
int
Минимальное количество покупателей одной позиции
old_price
int
Старая цена (отображение скидок)
price_type
users | amount
Тип продажи
category_id
int
Присвоение категории
currency_id
int
id валюты
description
string
Описание товара
is_variable
bool
Наличие вариаций
payment_type
coins | currency
Валюта оплаты
auto_complete
bool
Автоматическое завершение заказа после покупки
complete_description
string
Сообщение пользователю после покупки

Удаление товара

Метод позволяет удалить товар

{
    "id": 56
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Продукта

Смена сортировки товара

Метод позволяет изменить порядок сортировки для товара

{
    "ids": [
        43,
        41
    ]
}

Параметры запроса

Атрибут Тип Обязательное Описание
ids*
int[]
Да Массив идентификаторов товаров

Архивация товара

Метод позволяет перенести товар в архив

{
    "id": 56,
    "isReturn": false
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Товара
isReturn
bool
Разархивация товара

Добавление товара в избранное

Метод позволяет добавить товар в избранное, либо удалить из него

{
    "productId": 56
}

Параметры запроса

Атрибут Тип Обязательное Описание
productId*
int
Да Идентификатор товара

Список заказов администратора

Метод возвращает список заказов по заданным фильтрам для администратора

{
    "per": 20,
    "page": 1,
    "status": "actual",
    "product": null
}

Параметры запроса

Атрибут Тип Обязательное Описание
per
int
Размер порции данных
page
int
Номер порции данных
status
actual | new | processing | done | canceled | ready | null
Фильтр по статусу заказа
product
int
id товара
user
int
id пользователя
users
array[int]
id пользователей

Список заказов пользователя

Метод возвращает список заказов пользователя

{
    "per": 20,
    "page": 1,
    "status": "actual",
    "product": null
}

Параметры запроса

Атрибут Тип Обязательное Описание
per
int
Размер порции данных
page
int
Номер порции данных
status
init | new | actual | processing | done | canceled | ready
Фильтр по статусу
product
int
id продукта

Создание заказа

Метод позволяет создать новый заказ по указанным параметрам

{
    "users": [
        85
    ],
    "amount": 0,
    "comment": "testShop",
    "product": 42,
    "currency_id": null,
    "variants_id": null,
    "payment_type": "coins",
    "variants_sku": null,
    "variants_characteristics": null
}

Параметры запроса

Атрибут Тип Обязательное Описание
user*
int
Да id Пользователя
product*
int
Да id продукта
users
array[int]
Список пользователей
amount
int
Количество товара в заказе
comment
string
Комментарий к заказу
variants_characteristics
array
Характеристики товара
variants_id
int
id вариации товара
variants_sku
string
Артикул товара

Отклонение заказа

Метод позволяет отклонить заказ

{
    "id": 269
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id заказа

Отмена заказа

Метод позволяет отменить заказ

{
    "id": 269
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id заказа

Замена пользователя в заказе

Метод позволяет изменить пользователя в заказе, приглашенного к покупке

{
    "id": 13,
    "newUser": 8,
    "origUser": 3
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор заказа
origUser*
int
Да Идентификатор пользователя (исходного)
newUser*
int
Да Идентификатор пользователя (нового)

Подтверждение заказа

Метод позволяет подтвердить заказ

{
    "id": 269
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id заказа

Обновление статуса заказа

Метод позволяет установить статус заказа

{
    "id": 266,
    "status": "processing"
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id заказа
status*
new | actual | processing | done | canceled | ready
Да Устанавливаемый статус

Список атрибутов

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

{}

Добавление атрибута

Метод позволяет создать новый атрибут для товаров

{
    "id": null,
    "name": "TestAttr",
    "active": 1,
    "variants": [
        {
            "id": 0,
            "name": "Value1"
        },
        {
            "id": 0,
            "name": "Value2"
        }
    ]
}

Параметры запроса

Атрибут Тип Обязательное Описание
name*
string
Да Имя атрибута
active
bool
Активация аттрибута
variants
array[name]
Список вариантов аттрибута

Обновление атрибута

Метод позволяет обновить данные атрибута

{
    "id": 99,
    "name": "TestAttr2",
    "active": 1,
    "variants": [
        {
            "id": 170,
            "name": "Value13"
        }
    ]
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Атрибута
name
string
Имя атрибута
active
bool
Активность атрибута
variants
array{id | name}
Варианты атрибута

Удаление атрибута

Метод позволяет удалить атрибут

{
    "id": 99
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Аттрибута

Список категорий

Метод возвращает список всех категорий

{
    "category": null
}

Добавление категории

Метод позволяет создать новую категорию товаров

{
    "id": null,
    "name": "Test",
    "privat": 0,
    "sort_id": 0,
    "is_active": 1,
    "upload_id": null
}

Параметры запроса

Атрибут Тип Обязательное Описание
name*
string
Да Имя категории
is_active
bool
Активация категории
privat
bool
Приватность категории
sort_id
int
id категории, после которой поместится данная
available
users | departments | teams | positions
Группы пользователей, которым будут видны товары данной категории

Обновление категории

Метод позволяет обновить данные категории

{
    "id": 35,
    "name": "Test22",
    "privat": 0,
    "public": 1,
    "sort_id": 4,
    "available": [],
    "is_active": 1,
    "upload_id": null
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Категории
name
string
Имя категории
privat
bool
Приватность категории
public
bool
Публичность категории
sort_id
id
Позиция категории
is_active
Активация категории

Изменение порядка категорий

Метод позволяет изменить порядок категорий

{
    "id": 34,
    "direction": "up"
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Категории
direction
up | none
Направление перемещения категории

Присвоение категории

Метод присваивает категорию заданным товарам

{
    "product_id": [
        54
    ],
    "category_id": 34
}

Параметры запроса

Атрибут Тип Обязательное Описание
product_id*
array[int]
Да Список продуктов
category_id*
int
Да id категории

Удаление категории

Метод позволяет удалить категорию

{
    "id": 35
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Категории

Доступы к категории

Метод позволяет указать группы пользователей, которым будут отображаться товары в данной категории

{
    "user_id": [
        85,
        89
    ],
    "teams_id": [
        8
    ],
    "category_id": 9,
    "departments_id": [
        3
    ]
}

Параметры запроса

Атрибут Тип Обязательное Описание
user_id
array[int]
Список пользователей
teams_id
array[int]
Список команд
departments_id
array[int]
Список отделов
positions_id
array[int]
Список должностей
category_id*
int
Да id категории

Идентификаторы товаров в категории

Метод позволяет загрузить список идентификаторов товаров, присвоенных категории

{
    "id": 14
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор категории

Простой список товаров

Метод возвращает краткий список товаров

{
    "isAll": false
}

Параметры запроса

Атрибут Тип Обязательное Описание
isAll
bool
Отображение архивных товаров

Галерея

Содержит методы управления альбомами и их содержимым

Список альбомов

Метод вернет список альбомов

{
    "per": 12,
    "page": 1,
    "type": "photo"
}

Параметры запроса

Атрибут Тип Обязательное Описание
per
int
Размер порции данных
page
int
Номер порции данных
tag
int
Фильтр по id тега в альбоме

Содержание альбома

Метод возвращает информацию об альбоме и его содержании

{
    "id": 10,
    "per": 20,
    "page": 1,
    "media": true
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Альбома
per
int
Размер порции данных
page
int
Номер порции данных
media
bool
Отображение содержающихся медиа

Создание альбома

Метод создаёт альбом с заданными тегами

{
    "id": null,
    "name": "\u0433\u0435\u043b\u0433"
}

Параметры запроса

Атрибут Тип Обязательное Описание
name*
string
Да Название альбома
tags
array
Список тегов

Обновление альбома

Метод обновляет данные об альбоме

{
    "id": 27,
    "name": "asdasA",
    "tags": [],
    "type": "photo",
    "user": 57,
    "cdate": "2025-05-13 09:53:11",
    "files": 1,
    "order": 70,
    "rating": null,
    "description": "ASDASD ASD ASD ASD"
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Альбома
name
string
Название альбома
tags
array
Теги
type
photo | video
Тип альбома
user
id
владелец медиа
cdate
string
Дата создания альбома (В формате YY-MM-DD HH:MM:SS),
description
string
Описание альбома

Удаление альбома

Метод удаляет альбом

{
    "id": 28
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Альбома

Создание медиа

Метод добавляет медиа в выбранный альбом

{
    "album": "10",
    "media": [
        "a67952fb-4dca-44ea-8420-46b57f5085ea"
    ]
}

Параметры запроса

Атрибут Тип Обязательное Описание
album*
int
Да id Албома
media
string
Адресс медиа

Обновление медиа

Метод обновляет данные медиа

{
    "id": 33,
    "title": "\u0420\u0430\u0434\u0436\u0430 \u041f\u0443\u0442\u0440\u0430 \u043e\u0431\u0440\u0430\u0431\u0430\u0442\u044b\u0432\u0430\u0435\u0442 \u043c\u0447"
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Медиа
title
string
Описание медиа

Удаление медиа

Метод удаляет медиа

{
    "id": 55
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Медиа

Создание медиа по идентификатору

Метод добавляет медиа в выбранный альбом по заданному идентификатору из Youtube, Rutube, VKVideo

{
    "id": "10",
    "rt_id": "",
    "yt_id": "wvnVFn2GkTU"
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор альбома
yt_id
string
Идентификатор видео Youtube
rt_id
string
Идентификатор видео Rutube
vk_id
string
Идентификатор видео VKVideo

Обновление медиа по идентификатору

Метод позволяет изменить медиа по заданному идентификатору из Youtube, Rutube, VKVideo

{
    "id": "10",
    "title": "\u041e\u043f\u0438\u0441\u0430\u043d\u0438\u0435"
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор медиа
title*
string
Да Описание медиа

Удаление медиа по идентификатору

Метод позволяет удалить медиа по заданному идентификатору из Youtube, Rutube, VKVideo

{
    "id": "10"
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор медиа

Контент

Содержит методы управления контентными элементами, такими как: новости, статьи, проекты, объявления

Список контента

Метод вернёт все записи по выбранному типу контента

{
    "per": "3",
    "type": "announcement"
}

Параметры запроса

Атрибут Тип Обязательное Описание
per
int
Размер порции данных
page
int
Номер порции данных
type*
announcement | content | material | news | page | projects
Да Тип контента

Данные элемента контента

Метод вернет перечень данных одного выбранного элемента контента

{
    "slug": "about",
    "type": "page"
}

Параметры запроса

Атрибут Тип Обязательное Описание
type*
news | announcement | material | projects | vacancy | page
Да Тип элемента
slug
string
Алиас элемента
id
int
Идентификатор элемента
url
string
Ссылка элемента

Создание элемента

Метод позволяет создать новый элемент контента заданного типа

{
    "id": null,
    "text": "<p>3\u04353\u04353\u04354<\/p>",
    "type": "news",
    "brief": "\u043a34",
    "title": "\u043e\u0448",
    "publish": 1
}

Параметры запроса

Атрибут Тип Обязательное Описание
pid
int | null
Идентификатор родительского элемента
slug
string | null
Алиас
title*
string
Да Заголовок
brief
string | null
Краткое описание
text
string | null
Подробное описание
url
string | null
Дополнительная ссылка
preview
string | null
Идентификатор вложения (uuid)
date
string | null
Дата создания
plan_publish_at
string | null
Плановая дата публикация, когда автоматически нужно опубликовать
publish_at
string | null
Дата публикации
publish*
boolean
Да Статус публикации
type*
news | announcement | material | projects | vacancy | page
Да Тип элемента
album
int | null
Идентификатор альбома из галереи

Обновление элемента

Метод позволяет произвести редактирование существующего элемента с целью изменения его параметров

{
    "id": 174,
    "date": "2025-07-04 14:25:48",
    "tags": [],
    "type": "news",
    "brief": "\u043a34",
    "title": "\u043e\u0448",
    "rating": 0,
    "publish": 0,
    "is_notify": 1,
    "publish_at": "2025-07-04",
    "plan_publish_at": null
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор элемента
pid
int | null
Идентификатор родительского элемента
slug
string | null
Алиас
title*
string
Да Заголовок
brief
string | null
Краткое описание
text
string | null
Подробное описание
url
string | null
Дополнительная ссылка
preview
string | null
Идентификатор вложения (uuid)
date
string | null
Дата создания
plan_publish_at
string | null
Плановая дата публикация, когда автоматически нужно опубликовать
publish_at
string | null
Дата публикации
publish*
boolean
Да Статус публикации
type*
news | announcement | material | projects | vacancy | page
Да Тип элемента
album
int | null
Идентификатор альбома из галереи

Удаление элемента

Метод позволяет удалить элемент контента заданного типа

{
    "id": 174,
    "type": "news"
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор элемента
type*
news | announcement | material | projects | vacancy | page
Да Тип элемента

Рейтинг

Содержит методы управления рейтинговыми играми

Список игр

Метод возвращает список рейтинговых игр по указанным фильтрам

{
    "per": 20,
    "page": 1,
    "text": "",
    "draft": true,
    "status": "all"
}

Параметры запроса

Атрибут Тип Обязательное Описание
per
int
Размер порции данных
page
int
Номер порции данных
text
string
Поиск по названию рейтинговой игры
status
all | draft | active | finished
Фильтр по статусу рейтинговой игры

Список рейтингов пользователя

Метод вернет список рейтингов, в которых участвует пользователь

{
    "user": 2
}

Параметры запроса

Атрибут Тип Обязательное Описание
user
int | null
Идентификатор пользователя, для которого нужно показать список. По умолчанию текущий

Информация об игре

Метод возвращает информацию о рейтинговой игре

{
    "id": 31
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Рейтинговой игры

Создание игры

Метод позволяет создать рейтинговую игру с указанными параметрами

{
    "id": null,
    "image": "90d0dba8-37eb-4b8e-9e87-2985b2cef93d",
    "title": "Test",
    "token": "g8Ig7AEEHbUfEF2ifZH8Ul9qJWkWL7ZHVwkE8velvYYyFvkLlYspM9f7PHNmEH31",
    "status": "draft",
    "rewards": [],
    "date_end": "2025-06-30",
    "anonymous": 0,
    "date_begin": "2025-06-11",
    "color_prize": "#dfdfdf",
    "description": "<p>Test<\/p>",
    "rating_teams": 0,
    "rating_users": 1,
    "rating_departments": 0
}

Параметры запроса

Атрибут Тип Обязательное Описание
title*
string
Да Название игры
date_end*
string
Да Дата окончания игры в формате (YY-MM-DD)
date_begin*
string
Да Дата начала игры в формате (YY-MM-DD)
image
string
Адресс изображения
status
draft | active | finished
Статус рейтинговой игры
reward
array
Награды
color_prize
string
Цвет игры (Hex-код в формате #xxxxxx)
description
string
Описание игры
rating_teams
bool
Активация командного рейтинга
rating_users
bool
Активация рейтинга сотрудников
rating_departments
bool
Активация рейтинга отделов

Обновление игры

Метод позволяет обновить данные рейтинговой игры

{
    "id": 39,
    "title": "\u0421\u0438\u043d\u044c\u043e\u0440 (\u043a\u043e\u043f\u0438\u044f)",
    "status": "draft",
    "rewards": [],
    "date_end": "2025-10-01",
    "off_gift": 0,
    "anonymous": 0,
    "date_begin": "2025-08-02",
    "color_prize": "#dfdfdf",
    "description": "<p>\u0422\u0435\u0441\u0442<\/p>",
    "rating_teams": 0,
    "rating_users": 1,
    "rating_departments": 0
}

Параметры запроса

Атрибут Тип Обязательное Описание
title*
string
Да Название игры
date_end*
string
Да Дата окончания игры в формате (YY-MM-DD)
date_begin*
string
Да Дата начала игры в формате (YY-MM-DD)
image
string
Адресс изображения
status
draft | active | finished
Статус рейтинговой игры
reward
array
Награды
color_prize
string
Цвет игры (Hex-код в формате #xxxxxx)
description
string
Описание игры
rating_teams
bool
Активация командного рейтинга
rating_users
bool
Активация рейтинга сотрудников
rating_departments
bool
Активация рейтинга отделов
off_gift
bool
Отключение наград за игру
anonymous
bool
Скрытый список участников игры

Удаление игры

Метод удаляет рейтинговую игру

{
    "id": 39
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Рейтинговой игры

Удаление перечня игр

Метод удаляет набор игр

{
    "ids": [
        1,
        2
    ]
}

Параметры запроса

Атрибут Тип Обязательное Описание
ids*
int[]
Да Массив идентификаторов рейтингов

Клонирование игры

Метод создаёт копию рейтинговой игры

{
    "game": 37
}

Параметры запроса

Атрибут Тип Обязательное Описание
game*
int
Да id Рейтинговой игры

Начало игры

Метод начинает рейтинговую игру

{
    "game": 37
}

Параметры запроса

Атрибут Тип Обязательное Описание
game*
int
Да id Рейтинговой игры

Завершение игры

Метод позволяет закончить рейтинговую игру досрочно

{
    "game": 37
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Рейтинговой игры

Статистика игры

Метод возвращает информацию о показателях участников игры

{
    "game": 31,
    "type": "user",
    "limit": 10000,
    "disableAnonymous": false
}

Параметры запроса

Атрибут Тип Обязательное Описание
game*
int
Да id игры
type
user | department | team | null
Тип ответа
limit
int
Размер порции данных
disableAnonymous
bool
Отображение анонимных участников

Список участников

Метод возвращает список участников рейтинговой игры

{
    "id": 37
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Рейтинговой игры

Приглашение пользователей

Метод добавляет пользователей в рейтинговую игру

{
    "game": 37,
    "scope": {
        "teams": [],
        "users": [],
        "departments": []
    }
}

Параметры запроса

Атрибут Тип Обязательное Описание
game*
int
Да id рейтинговой игры
scope
array{teams[] | users[] | departments[] | positions[]}
Группы пользователей

Выдача приза

Метод позволяет выдать приз потенциальным победителям досрочно

{
    "data": []
}

Параметры запроса

Атрибут Тип Обязательное Описание
data
array
Корректировки выдачи приза

Простой список игр

Метод возвращает краткий список рейтинговых игр

{
    "status": null
}

Параметры запроса

Атрибут Тип Обязательное Описание
status
null | draft | active | finished
Фильтр по статусу рейтинговой игры

Информация о текущей игре пользователя

Метод вернет данные о последнем активном рейтинге текущего пользователя, в котором он участвует

{}

Групповая обработка

Метод позволяет производить групповые операции над несколькими рейтингами одновременно

{
    "type": "invite",
    "members": {
        "teams": [
            4
        ],
        "users": [
            1,
            18
        ],
        "positions": [],
        "departments": [
            3,
            8
        ]
    },
    "selected": [
        1,
        5
    ]
}

Параметры запроса

Атрибут Тип Обязательное Описание
selected*
int[]
Да Массив идентификаторов рейтингов
members*
{users: int[] | departments: int[] | teams: int[] | positions: int[]}
Да Список участников, где users - массив идентификаторов пользователей, departments - массив идентификаторов отделов, teams - массив идентификаторов команд, positions - массив идентификаторов должностей
type*
invite
Да Тип операции, где invite - операция назначения (приглашения)

Опросы

Содержит методы управления опросами, их постановкой и прохождением

Список опросов

Вернет список опросов на основе заданных фильтров

{
    "per": 12,
    "page": 1,
    "status": "active",
    "for_all": true,
    "hide_new": true,
    "displayOnly": true
}

Параметры запроса

Атрибут Тип Обязательное Описание
per
int | null
Количество на страницу
page
int | null
Номер страницы
for_all
boolean
Доступные всем
hide_new
boolean
Скрыть новые
displayOnly
boolean
Только для профиля
status
new | active | completed | finished | paused | null
Статус опроса

Данные опроса

Вернет данные одного конкретного опроса

{
    "id": 9,
    "questions": true
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор опроса
questions
boolean
Включить вопросы в перечень данных

Создание опроса

Метод позволяет создать новый опрос на основе переданных данных

{
    "id": null,
    "type": "poll",
    "title": "\u0435\u0440\u0435\u0440",
    "status": "new",
    "display": 0,
    "for_all": 1,
    "anonymous": 0,
    "questions": [
        {
            "id": null,
            "multi": 0,
            "order": 1,
            "title": "",
            "answers": []
        }
    ]
}

Параметры запроса

Атрибут Тип Обязательное Описание
image
string | null
Идентификатор вложения (uuid)
title*
string
Да Заголовок опроса
status
new | paused | active | completed
Статус
type
poll
Тип
date_start
string | null
Дата запуска
date_stop
string | null
Дата завершения
for_all
boolean
Доступно для всех
display
boolean
Показывать в профиле
anonymous
boolean
Анонимный

Обновление опроса

Метод позволяет произвести редактирование существующего опроса с целью изменения его параметров

{
    "id": 27,
    "type": "poll",
    "title": "\u0433\u043b\u043b\u0433",
    "result": null,
    "status": "new",
    "display": 0,
    "for_all": 1,
    "anonymous": 0,
    "date_stop": null,
    "questions": [],
    "date_start": null
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор опроса
image
string | null
Идентификатор вложения (uuid)
title*
string
Да Заголовок опроса
status
new | paused | active | completed
Статус
type
poll
Тип
date_start
string | null
Дата запуска
date_stop
string | null
Дата завершения
for_all
boolean
Доступно для всех
display
boolean
Показывать в профиле
anonymous
boolean
Анонимный

Смена статуса

Метод позволяет изменить статус опроса

{
    "id": 27,
    "status": "active"
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор опроса
status*
new | paused | active | completed
Да Статус

Удаление опроса

Метод позволяет удалить опрос - устанавливает отметку об удалении

{
    "id": 27
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор опроса

Сохранение результатов

Метод позволяет сохранить результаты прохождения опроса пользователем

{
    "poll": 9,
    "results": [
        {
            "answer": 20,
            "question": 8
        },
        {
            "answer": 22,
            "question": 9
        },
        {
            "answer": 64,
            "question": 24
        }
    ]
}

Параметры запроса

Атрибут Тип Обязательное Описание
poll*
int
Да Идентификатор опроса
results*
any
Да Объект результатов прохождения опроса пользователем

Результаты опроса

Метод вернет результаты выбранного опроса

{
    "id": 27
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор опроса

Упрощенный список

Метод вернет упрощенный список опросов. Удобно использовать для селекторов и списков

{}

Задания

Содержит методы управления, постановки и прохождения заданий

Список заданий

Метод вернет список всех заданий для администрирования

{
    "per": 20,
    "page": 1,
    "tags": [],
    "text": "",
    "active": true
}

Параметры запроса

Атрибут Тип Обязательное Описание
per
int | null
Количество на страницу
page
int | null
Номер страницы
active
boolean
Только активные или не активные задания
text
string
Поисковая фраза
tags
int[]
Массив идентификаторов тегов

Список заданий для пользователя

Метод вернет список всех заданий, назначенных и доступных пользователю

{
    "per": "5",
    "page": 1,
    "active": true,
    "status": "actual"
}

Параметры запроса

Атрибут Тип Обязательное Описание
per
int | null
Количество на страницу
page
int | null
Номер страницы
status
actual | invite | accept | reject | moderate | rework | complete | fail | null
Статус выполнения
active
boolean
Только активные или не активные

Список заданий на проверке

Метод вернет список заданий, которые находятся на проверке и требуют действий модератора

{
    "per": 20,
    "page": 1,
    "tags": [],
    "task": null,
    "user": null,
    "field": "task",
    "textUser": "",
    "direction": "ASC"
}

Параметры запроса

Атрибут Тип Обязательное Описание
per
int | null
Количество на страницу
page
int | null
Номер страницы
user
int | null
Идентификатор пользователя
department
int | null
Идентификатор отдела
position
int | null
Идентификатор должности
team
int | null
Идентификатор команды
task
int | null
Идентификатор задания
tags
int[]
Массив идентификаторов тегов

Упрощённый список заданий

Метод вернет упрощённый список заданий с минимальным количеством информации, для дальнейшего переиспользования, например, в списках или селекторах выбора

{}

Создание задания

Метод позволяет создать новое задание

{
    "id": null,
    "exp": null,
    "poll": null,
    "tags": [
        {
            "id": 1,
            "name": "\u041a\u043e\u0441\u043c\u043e\u0441",
            "is_active": 1
        }
    ],
    "test": null,
    "type": "text",
    "user": null,
    "coins": null,
    "edate": null,
    "title": "y5",
    "active": 1,
    "repeat": true,
    "game_id": null,
    "description": "",
    "responsible": 57,
    "repeat_delay": 0
}

Параметры запроса

Атрибут Тип Обязательное Описание
user
int | null
Идентификатор пользователя (автора), по умолчанию текущий
responsible
int | null
Идентификатор пользователя (ответственного), по умолчанию текущий
title*
string
Да Заголовок задания
description
string | null
Описание задания
image
string | null
Идентификатор (uuid) изображения (обложки)
coins
int | null
Количество наградной валюты
exp
int | null
Количество наградного опыта
product
int | null
Идентификатор наградного товара
scores
{rating: int | amount: int}[]
Массив с количеством наградных очков для каждого из рейтингов, здесь rating - идентификатор рейтинга, amount - количество очков
achievement
int | null
Идентификатор наградного достижения
active
int
Опубликовано или не опубликовано
edate
string | null
Дата автоматического завершения
timeout
int | null
Время в секундах до автоматического завершения
repeat
int
Повторяемое задание
repeat_delay
int | null
Задержка перед повтором в секундах
repeat_limit
int | null
Количество повторений
attachment
string | null
Идентификатор (uuid) вложения
type
text | test | poll | dialog
Тип задания, по умолчанию text
test
int | null
Идентификатор теста
poll
int | null
Идентификатор опроса
dialog
int | null
Идентификатор диалогового тренажера
currencies?: { [currencyId: number]: number }
null
tags
string[]
Массив названий тегов

Обновление задания

Метод позволяет обновить данные задания при его редактировании

{
    "id": 59,
    "exp": null,
    "poll": null,
    "tags": [
        {
            "id": 4,
            "name": "\u041f\u043b\u0430\u043d\u0435\u0442\u043d\u044b\u0439 \u044d\u043a\u0441\u043f\u0440\u0435\u0441\u0441",
            "is_active": 1
        },
        {
            "id": 5,
            "name": "\u0424\u0443\u0442\u0443\u0440\u0430\u043c\u0430",
            "is_active": 1
        }
    ],
    "test": null,
    "type": "text",
    "user": 77,
    "cdate": "2025-07-03 00:00:00",
    "coins": null,
    "edate": null,
    "score": null,
    "title": "test (\u043a\u043e\u043f\u0438\u044f)",
    "users": [],
    "active": 1,
    "rating": 0,
    "repeat": 0,
    "scores": [],
    "deleted": null,
    "game_id": null,
    "timeout": null,
    "attachment": null,
    "currencies": {},
    "achievement": null,
    "description": "<p>test<\/p>",
    "responsible": 77,
    "repeat_delay": null,
    "repeat_limit": null
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор задания
user
int | null
Идентификатор пользователя (автора), по умолчанию текущий
responsible
int | null
Идентификатор пользователя (ответственного), по умолчанию текущий
title*
string
Да Заголовок задания
description
string | null
Описание задания
image
string | null
Идентификатор (uuid) изображения (обложки)
coins
int | null
Количество наградной валюты
exp
int | null
Количество наградного опыта
product
int | null
Идентификатор наградного товара
scores
{rating: int | amount: int}[]
Массив с количеством наградных очков для каждого из рейтингов, здесь rating - идентификатор рейтинга, amount - количество очков
achievement
int | null
Идентификатор наградного достижения
active
int
Опубликовано или не опубликовано
edate
string | null
Дата автоматического завершения
timeout
int | null
Время в секундах до автоматического завершения
repeat
int
Повторяемое задание
repeat_delay
int | null
Задержка перед повтором в секундах
repeat_limit
int | null
Количество повторений
attachment
string | null
Идентификатор (uuid) вложения
type
text | test | poll | dialog
Тип задания, по умолчанию text
test
int | null
Идентификатор теста
poll
int | null
Идентификатор опроса
dialog
int | null
Идентификатор диалогового тренажера
currencies?: { [currencyId: number]: number }
null
tags
string[]
Массив названий тегов

Удаление задания

Метод удаляет задание из системы. Заданию присваивается дата удаления и более нигде не отображается

{
    "id": 59
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор задания

Удаление списка заданий

Метод удаляет набор заданий по их идентификатором. Каждому заданию устанавливается дата удаления и более эти задания нигде не отображаются

{
    "ids": [
        60
    ]
}

Параметры запроса

Атрибут Тип Обязательное Описание
ids*
int[]
Да Массив идентификаторов заданий

Клонирование задания

Метод позволяет сделать полную копию задания. Скопируются все атрибуты и поля задания. Если задание было в архиве, оно активируется автоматически.

{
    "id": 58
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор задания

Информация о задании

Метод вернет полную информацию о конкретном задании

{
    "id": 56,
    "user": 57
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор задания
user
number | null
Идентификатор пользователя (по умолчанию текущий)

Информация о задании из обучения

Метод вернет полную информацию о конкретном задании, находящемся в курсе

{
    "task": 58
}

Параметры запроса

Атрибут Тип Обязательное Описание
task*
int
Да Идентификатор задания

Список участников задания

Метод вернет список пользователей, которым назначено задание для выполнения

{
    "id": 58,
    "per": 10,
    "page": 1,
    "text": ""
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор задания
per
int | null
Количество на страницу
page
int | null
Номер страницы
text
string
Поисковая фраза
status
invite | accept | reject | moderate | rework | complete | fail | null
Статус выполнения

Приглашение участников в задание

Метод позволяет добавить пользователей/отделы/команды в список приглашенных для выполнения заданий

{
    "id": 58,
    "teams": [
        1
    ],
    "users": [],
    "departments": [
        45
    ]
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор задания
departments
int[]
Массив идентификаторов отделов
teams
int[]
Массив идентификаторов команд
users
int[]
Массив идентификаторов пользователей

Удаление участника

Метод удалит выбранного участника, приглашенного для выполнения задания

{
    "id": 58,
    "user": 1
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор задания
user*
int
Да Идентификатор пользователя

Удаление всех участников из задания

Метод удалил всех участников, приглашенных для выполнения задания

{
    "id": 58
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор задания

Смена статуса задачи администратором

Метод даёт возможность изменить статус задания со стороны модератора. В основном используется при возвращении на доработку или подтверждении выполнения задания

{
    "id": 56,
    "user": "57",
    "status": "complete",
    "comment": null,
    "game_id": null,
    "attachment": null
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор задания
user*
int
Да Идентификатор пользователя
status*
invite | accept | reject | moderate | rework | complete | fail | null
Да Статус выполнения
comment
string | null
Текст комментария
attachment
string | null
Идентификатор (uuid) вложения

Смена статуса задачи пользователем

Метод даёт возможность изменить статус задания со стороны пользователя. В основном необходим для таких действий пользователя, как: принять, отказаться, отправить на модерацию.

{
    "id": 56,
    "status": "accept",
    "comment": "",
    "attachment": ""
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор задания
status*
invite | accept | reject | moderate | rework | complete | fail
Да Статус задания
comment
string | null
Текст комментария
attachment
string | null
Идентификатор (uuid) вложения

Список историй выполнения заданий

Метод вернет список заданий, которые были назначены пользователям для отслеживания их выполнения

{
    "per": 20,
    "page": 1,
    "sort": {
        "field": "task",
        "direction": "ASC"
    },
    "tags": [],
    "task": null,
    "user": null,
    "status": null,
    "responsible": null
}

Параметры запроса

Атрибут Тип Обязательное Описание
per
int | null
Количество на страницу
page
int | null
Номер страницы
user
int | null
Идентификатор пользователя (исполнителя)
responsible
int | null
Идентификатор пользователя (ответственного)
task
int | null
Идентификатор задания
tags
int[]
Массив идентификаторов тегов
status
invite | accept | reject | moderate | rework | complete | fail | null
Статус выполнения

История выбранного задания

Метод вернет подробную информацию об истории прохождения задания пользователем

{
    "id": 766
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор задания

Групповая обработка

Метод позволяет производить групповые операции над несколькими заданиями одновременно

{
    "type": "invite",
    "members": {
        "teams": [
            4
        ],
        "users": [
            1,
            18
        ],
        "positions": [],
        "departments": [
            3,
            8
        ]
    },
    "selected": [
        1,
        5
    ]
}

Параметры запроса

Атрибут Тип Обязательное Описание
selected*
int[]
Да Массив идентификаторов заданий
members*
{users: int[] | departments: int[] | teams: int[] | positions: int[]}
Да Список участников, где users - массив идентификаторов пользователей, departments - массив идентификаторов отделов, teams - массив идентификаторов команд, positions - массив идентификаторов должностей
type*
invite
Да Тип операции, где invite - операция назначения (приглашения)

Конкурсы

Содержит методы управления, постановки и прохождения конкурсов

Список конкурсов

Метод вернет список всех конкурсов для администрирования

{
    "per": 20,
    "page": 1,
    "text": "",
    "active": true
}

Параметры запроса

Атрибут Тип Обязательное Описание
per
int | null
Количество на страницу
page
int | null
Номер страницы
active
boolean
Только активные или не активные
text
string
Поисковая фраза
tags
int[]
Массив идентификаторов тегов

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

Метод вернет список всех конкурсов, назначенных и доступных пользователю

{
    "per": "5",
    "page": 1,
    "active": true,
    "status": "actual"
}

Параметры запроса

Атрибут Тип Обязательное Описание
per
int | null
Количество на страницу
page
int | null
Номер страницы
status
actual | invite | accept | reject | moderate | rework | complete | fail | null
Статус выполнения
active
boolean
Только активные или не активные

Список конкурсов на проверке

Метод вернет список конкурсов, которые находятся на проверке и требуют действий модератора

{
    "per": 20,
    "page": 1,
    "user": null,
    "count": 5,
    "field": "contest",
    "pages": 1,
    "contest": null,
    "textUser": "",
    "dataCount": 5,
    "direction": "ASC"
}

Параметры запроса

Атрибут Тип Обязательное Описание
per
int | null
Количество на страницу
page
int | null
Номер страницы
user
int | null
Идентификатор пользователя
department
int | null
Идентификатор отдела
position
int | null
Идентификатор должности
team
int | null
Идентификатор команды
task
int | null
Идентификатор задания
tags
int[]
Массив идентификаторов тегов

Упрощённый список конкурсов

Метод вернет упрощённый список конкурсов с минимальным количеством информации, для дальнейшего переиспользования, например, в списках или селекторах выбора

{}

Создание конкурса

Метод позволяет создать новый конкурс

{
    "id": null,
    "exp": null,
    "user": null,
    "coins": null,
    "edate": null,
    "title": "f",
    "active": 1,
    "description": "",
    "responsible": 57
}

Параметры запроса

Атрибут Тип Обязательное Описание
user
int | null
Идентификатор пользователя (автора), по умолчанию текущий
responsible
int | null
Идентификатор пользователя (ответственного), по умолчанию текущий
title*
string
Да Заголовок
description
string | null
Описание
image
string | null
Идентификатор (uuid) изображения (обложки)
coins
int | null
Количество наградной валюты
exp
int | null
Количество наградного опыта
product
int | null
Идентификатор наградного товара
scores
{rating: int | amount: int}[]
Массив с количеством наградных очков для каждого из рейтингов, здесь rating - идентификатор рейтинга, amount - количество очков
achievement
int | null
Идентификатор наградного достижения
active
int
Опубликовано или не опубликовано
edate
string | null
Дата автоматического завершения
timeout
int | null
Время в секундах до автоматического завершения
attachment
string | null
Идентификатор (uuid) вложения
currencies?: { [currencyId: number]: number }
null
tags
string[]
Массив названий тегов

Обновление конкурса

Метод позволяет обновить данные конкурса при его редактировании

{
    "id": 31,
    "exp": null,
    "user": 57,
    "cdate": "2025-07-03 00:00:00",
    "coins": null,
    "edate": null,
    "score": null,
    "title": "f (\u043a\u043e\u043f\u0438\u044f)",
    "users": [],
    "active": 1,
    "rating": 0,
    "scores": [],
    "deleted": null,
    "game_id": null,
    "timeout": null,
    "attachment": null,
    "currencies": {},
    "achievement": null,
    "description": "",
    "responsible": 57
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор конкурса
user
int | null
Идентификатор пользователя (автора), по умолчанию текущий
responsible
int | null
Идентификатор пользователя (ответственного), по умолчанию текущий
title*
string
Да Заголовок
description
string | null
Описание
image
string | null
Идентификатор (uuid) изображения (обложки)
coins
int | null
Количество наградной валюты
exp
int | null
Количество наградного опыта
product
int | null
Идентификатор наградного товара
scores
{rating: int | amount: int}[]
Массив с количеством наградных очков для каждого из рейтингов, здесь rating - идентификатор рейтинга, amount - количество очков
achievement
int | null
Идентификатор наградного достижения
active
int
Опубликовано или не опубликовано
edate
string | null
Дата автоматического завершения
timeout
int | null
Время в секундах до автоматического завершения
attachment
string | null
Идентификатор (uuid) вложения
currencies?: { [currencyId: number]: number }
null
tags
string[]
Массив названий тегов

Удаление конкурса

Метод удаляет конкурс из системы. Конкурсу присваивается дата удаления и более нигде не отображается

{
    "id": 31
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор конкурса

Клонирование конкурса

Метод позволяет сделать полную копию конкурса. Скопируются все атрибуты и поля конкурса. Если конкурс был в архиве, он активируется автоматически.

{
    "id": 30
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор конкурса

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

Метод вернет полную информацию о конкретном конкурсе

{
    "id": 21
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор конкурса
user
number | null
Идентификатор пользователя (по умолчанию текущий)

Список участников конкурса

Метод вернет список пользователей, которым назначен конкурс для выполнения

{
    "id": 30,
    "per": 10,
    "page": 1,
    "text": ""
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор конкурса
per
int | null
Количество на страницу
page
int | null
Номер страницы
text
string
Поисковая фраза
status
invite | accept | reject | moderate | rework | complete | fail | null
Статус выполнения

Приглашение участников в конкурс

Метод позволяет добавить пользователей/отделы/команды в список приглашенных для выполнения конкурса

{
    "id": 30,
    "teams": [
        8
    ],
    "users": [],
    "departments": [
        45
    ]
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор конкурса
departments
int[]
Массив идентификаторов отделов
teams
int[]
Массив идентификаторов команд
users
int[]
Массив идентификаторов пользователей

Удаление участника

Метод удалит выбранного участника, приглашенного для выполнения конкурса

{
    "id": 30,
    "user": 12
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор конкурса
user*
int
Да Идентификатор пользователя

Удаление всех участников из конкурса

Метод удалил всех участников, приглашенных для выполнения конкурса

{
    "id": 30
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор конкурса

Смена статуса конкурса администратором

Метод даёт возможность изменить статус задания со стороны модератора. В основном используется при возвращении на доработку или подтверждении выполнения конкурса

{
    "id": 21,
    "status": "accept",
    "comment": "",
    "attachment": ""
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор конкурса
user*
int
Да Идентификатор пользователя
status*
invite | accept | reject | moderate | rework | complete | fail | null
Да Статус выполнения
comment
string | null
Текст комментария
attachment
string | null
Идентификатор (uuid) вложения

Смена статуса конкурса пользователем

Метод даёт возможность изменить статус конкурса со стороны пользователя. В основном необходим для таких действий пользователя, как: принять, отказаться, отправить на модерацию.

{
    "id": 21,
    "status": "accept",
    "comment": "",
    "attachment": ""
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор конкурса
status*
invite | accept | reject | moderate | rework | complete | fail
Да Статус
comment
string | null
Текст комментария
attachment
string | null
Идентификатор (uuid) вложения

Список историй выполнения конкурса

Метод вернет список конкурсов, которые были назначены пользователям для отслеживания их выполнения

{
    "per": 20,
    "page": 1,
    "sort": {
        "field": "contest",
        "direction": "ASC"
    },
    "user": null,
    "status": null,
    "contest": null,
    "responsible": null
}

Параметры запроса

Атрибут Тип Обязательное Описание
per
int | null
Количество на страницу
page
int | null
Номер страницы
user
int | null
Идентификатор пользователя (исполнителя)
responsible
int | null
Идентификатор пользователя (ответственного)
task
int | null
Идентификатор конкурса
tags
int[]
Массив идентификаторов тегов
status
invite | accept | reject | moderate | rework | complete | fail | null
Статус выполнения

История выбранного конкурса

Метод вернет подробную информацию об истории прохождения конкурса пользователем

{
    "id": 207
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор конкурса

Групповая обработка

Метод позволяет производить групповые операции над несколькими конкурсами одновременно

{
    "type": "invite",
    "members": {
        "teams": [
            4
        ],
        "users": [
            1,
            18
        ],
        "positions": [],
        "departments": [
            3,
            8
        ]
    },
    "selected": [
        1,
        5
    ]
}

Параметры запроса

Атрибут Тип Обязательное Описание
selected*
int[]
Да Массив идентификаторов конкурсов
members*
{users: int[] | departments: int[] | teams: int[] | positions: int[]}
Да Список участников, где users - массив идентификаторов пользователей, departments - массив идентификаторов отделов, teams - массив идентификаторов команд, positions - массив идентификаторов должностей
type*
invite
Да Тип операции, где invite - операция назначения (приглашения)

Квесты

Содержит методы управления квестами и квестовыми заданиями

Список квестов

Метод возвращает список квестов по заданым фильтрам

{
    "per": 20,
    "page": 1,
    "text": "",
    "deleted": false
}

Параметры запроса

Атрибут Тип Обязательное Описание
per
int
Размер порции данных
page
int
Номер порции данных
text
string
Поиск по названию
deleted
boolean
Поместить задание в корзину

Данные квеста

Метод вернет полную информацию о конкретном квесте по идентификатору

{
    "id": 5
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор квеста

Создание квеста

Метод позволяет создать квест с заданными параметрами

{
    "id": null,
    "user": 57,
    "title": "jjj",
    "active": 0,
    "prize_exp": null,
    "description": "",
    "prize_coins": null
}

Параметры запроса

Атрибут Тип Обязательное Описание
title*
string
Да Название квестового задания
quest*
int
Да id Квеста
active*
bool
Да Доступность квестового задания
description
string
Описание квестового задания
image
string
Адресс изображения
comment
string
Комментарий
prize_exp
int
Количество опыта героя за прохождение
prize_coins
int
Количество очков валюты за прохождение
prize_product
int
id Продукта за прохождение
prize_achievement
int
id Достижения за прохождение
rating
int
Количество очков рейтинга за прохождение
game_id
int
id Рейтинговой игры
currencies
array
Массив очков кастомных валют

Обновление квеста

Метод позволяет обновить информацию и данные квеста

{
    "id": 66,
    "user": 57,
    "title": "\u0426\u0435\u043f\u043e\u0447\u043a\u0430 \u0437\u0430\u0434\u0430\u043d\u0438\u0439 (\u043a\u043e\u043f\u0438\u044f)",
    "active": 0,
    "scores": [],
    "deleted": 0,
    "game_id": null,
    "prize_exp": 50,
    "attachment": null,
    "currencies": {},
    "attachments": [],
    "description": "<p>\u043f\u0440\u043e\u0432\u0435\u0440\u044f\u0435\u043c \u0441\u0442\u0430\u0442\u0443\u0441\u044b<\/p>",
    "prize_coins": 50,
    "prize_score": null,
    "prize_achievement": 5
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Задания
title*
string
Да Название квестового задания
quest*
int
Да id Квеста
active*
bool
Да Доступность квестового задания
deleted
bool
Перемещение в корзину
description
string
Описание квестового задания
comment
string
Комментарий
prize_exp
int
Количество опыта героя за прохождение
prize_coins
int
Количество очков валюты за прохождение
prize_product
int
id Продукта за прохождение
prize_achievement
int
id Достижения за прохождение
rating
int
Количество очков рейтинга за прохождение
game_id
int
id Рейтинговой игры
currencies
array
Массив очков кастомных валютъ
attachments
array
Вложения

Удаление квеста

Метод удаляет квест

{
    "id": 66
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Квеста

Восстановление квеста

Метод позволяет вернуть квест из архива

{
    "id": 50
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Квеста

Клонирование квеста

Метод позволяет создать копию квеста

{
    "id": 50
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Квеста

Список участников квеста

Метод вернет список участников, назначенных на квест

{
    "per": 20,
    "page": 1,
    "text": "",
    "quest": 1,
    "status": "invite"
}

Параметры запроса

Атрибут Тип Обязательное Описание
quest*
int
Да Идентификатор квеста
per
int
Размер порции данных
page
int
Номер порции данных
text
string
Поиск по имени участника
status
string | null
Поиск по статусу участника

Приглашение участников в квест

Метод приглашает группы пользователей к прохождению квеста

{
    "id": 50,
    "teams": [
        8
    ],
    "users": [],
    "departments": []
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Квеста
teams
array[int]
Список id команд
users
array[int]
Список id пользователей
departments
array[int]
Список id отделов

Удаление участника из квеста

Метод удаляет участника из заданного квеста

{
    "id": 50,
    "user": 9
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Квеста
user
int
id пользователя

Удаление всех участников квеста

Метод удаляет всех участников из заданного квеста

{
    "id": 50
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Квеста

Список заданий квеста

Метод возвращает список заданий квеста

{
    "quest": 10
}

Параметры запроса

Атрибут Тип Обязательное Описание
quest*
int
Да id Квеста

Создание квестового задания

Метод позволяет создать квестовое задание

{
    "id": null,
    "poll": null,
    "test": null,
    "type": "text",
    "user": null,
    "quest": 10,
    "title": "hht",
    "active": 1,
    "prize_exp": null,
    "prize_coins": null,
    "responsible": 57
}

Параметры запроса

Атрибут Тип Обязательное Описание
title*
string
Да Название квестового задания
quest*
int
Да id Квеста
active*
bool
Да Доступность квестового задания
description
string
Описание квестового задания
image
string
Адресс изображения
comment
string
Комментарий
prize_exp
int
Количество опыта героя за прохождение
prize_coins
int
Количество очков валюты за прохождение
prize_product
int
id Продукта за прохождение
prize_achievement
int
id Достижения за прохождение
rating
int
Количество очков рейтинга за прохождение
game_id
int
id Рейтинговой игры
currencies
array
Массив очков кастомных валют
responsible
int
id Ответственного
skip
boolean
Можно пропустить
no_check
boolean
Не требует проверки
status
await | work | rework | check | done | fail | skip | null
Статус квестового задания
timeout
int
Перерыв между выполнением задания в секундах
type
text | test | poll | dialog
Тип задания
test
int
id Задания
poll
int
id Опроса
dialog
int
id Тренажёра

Обновление квестового задания

Метод позволяет обновить квестовое задание и его данные

{
    "id": 35,
    "poll": null,
    "skip": 1,
    "test": 6,
    "type": "test",
    "order": 1,
    "quest": 49,
    "title": "\u041c\u043e\u0436\u043d\u043e \u0441\u043a\u0438\u043f\u043d\u0443\u0442\u044c, \u0430\u0432\u0442\u043e\u0437\u0430\u0432\u0435\u0440\u0448\u0435\u043d\u0438\u0435",
    "scores": null,
    "game_id": null,
    "timeout": 432000,
    "no_check": 1,
    "prize_exp": 1,
    "attachment": null,
    "currencies": {
        "2": 1,
        "3": 1,
        "4": 1
    },
    "attachments": [
        "d6ccfda1-342b-4395-9926-86e80bd9b5d6"
    ],
    "description": "<p><br><\/p>",
    "prize_coins": 1,
    "prize_score": null,
    "responsible": 9,
    "prize_achievement": null
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Квестового задания
title
string
Название квестового задания
active*
bool
Да Доступность квестового задания
description
string
Описание квестового задания
image
string
Адресс изображения
comment
string
Комментарий
prize_exp
int
Количество опыта героя за прохождение
prize_coins
int
Количество очков валюты за прохождение
prize_product
int
id Продукта за прохождение
prize_achievement
int
id Достижения за прохождение
rating
int
Количество очков рейтинга за прохождение
game_id
int
id Рейтинговой игры
currencies
array
Массив очков кастомных валют
responsible
int
id Ответственного
skip
boolean
Можно пропустить
no_check
boolean
Не требует проверки
status
await | work | rework | check | done | fail | skip | null
Статус квестового задания
timeout
int
Перерыв между выполнением задания в секундах
type
text | test | poll | dialog
Тип задания
test
int
id Задания
poll
int
id Опроса
dialog
int
id Тренажёра

Удаление квестового задания

Метод удаляет квестовое задание

{
    "id": 38
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Квестового задания

Изменение сортировки заданий

Метод позволяет изменить сортировку заданий внутри квеста

{
    "order": [
        5,
        13,
        1,
        8
    ],
    "quest": 38
}

Параметры запроса

Атрибут Тип Обязательное Описание
quest*
int
Да Идентификатор квестового задания
order*
int[]
Да Отсортированный массив квестовых заданий

Список квестов пользователя

Метод возвращает список квестов доступный определённому пользователю

{
    "per": "5",
    "page": 1
}

Параметры запроса

Атрибут Тип Обязательное Описание
quest*
int
Да Фильтр по id квеста
per
int
Размер порции данных
page
int
Номер порции данных
user
int
Фильтр по id пользователя
text
string
Фильтр по совпадению в Имени / Фамилии / E-mail / Телефон
status
invite | accept | reject | done | fail
Фильтр по статусу квеста

Список активных заданий

Метод возвращает список заданий, находящихся в работе у пользователей

{
    "quest": 38
}

Параметры запроса

Атрибут Тип Обязательное Описание
quest*
int
Да id Квеста

Принятие квеста

Метод позволяет принять участие в квесте

{
    "id": 76
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Квеста

Отказ от квеста

Метод позволяет отказаться от участия в квесте

{
    "id": 76
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор квеста

Отменить выполнение квеста

Метод позволяет отменить выполнение квеста

{
    "id": 76
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор квеста

Старт задания

Метод делает задание активным

{
    "id": 64
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Задания

Пропуск задания

Метод позволяет пропустить задание, если это возможно его настройками

{
    "id": 64
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор задания

Принятие задания

Метод позволяет принять выполнение задания

{
    "id": 64,
    "comment": null,
    "attachments": []
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Приглашения пользователя к прохождению
comment
string
Комментарий пользователю
attachments
array
Вложения к ответу пользователю

Список проверяемых заданий

Метод возвращает список квестовых заданий на проверке по указанным фильтрам

{
    "per": 1000,
    "task": null,
    "user": null,
    "quest": null,
    "textUser": ""
}

Параметры запроса

Атрибут Тип Обязательное Описание
per
int
Размер порции данных
task
int
id Задания
user
int
id Пользователя
quest
int
id Квестова
textUser
string
Поиск по сообщению пользователя

Отправка задания на доработку

Метод позволяет проверяющему отправить задание на доработку пользователю

{
    "id": 64,
    "comment": null,
    "timeout": null,
    "attachments": []
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор квестового задания
comment
string
Комментарий
timeout
int
Задержка перед повторным выполнением задания
attachments
array
Вложения

Подтверждение выполнения задания

Метод позволяет отметить квестовое задание как "выполненное"

{
    "id": 64,
    "comment": null,
    "timeout": null,
    "attachments": []
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Квестового задания
comment
string
Комментарий
timeout
int
Задержка перед повторным выполнением задания
attachments
array
Вложения

Провал задания

Метод позволяет отметить квестовое задание как "проваленное"

{
    "id": 64,
    "comment": null,
    "timeout": null,
    "attachments": []
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор квестового задания
comment
string
Комментарий
timeout
int
Задержка перед повторным выполнением задания
attachments
array
Вложения

История задания

Метод возвращает историю квестового задания

{
    "id": 64
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Квестового задания

История квеста

Метод возвращает историю о выполнении заданий квеста по указанным фильтрам

{
    "per": 20,
    "page": 1,
    "sort": {
        "field": "quest",
        "direction": "ASC"
    },
    "task": null,
    "user": null,
    "quest": null,
    "status": null,
    "textUser": "",
    "responsible": null,
    "textResponsible": ""
}

Параметры запроса

Атрибут Тип Обязательное Описание
per
int
Размер порции данных
page
int
Номер порции данных
sort
array{field | direction}
Сортировка данных
task
int
id Задания
user
int
id Пользователя
quest
int
id Квеста
status
invite | accept | reject | moderate | rework | complete | fail
Фильтр по статусу
textUser
string
Поиск по комментарию пользователя
responsible
int
id Ответственного
textResponsible
string
Поиск по комментарию проверяющего

Простой список квестов

Возвращает краткий список всех квестов

{}

Групповая обработка

Метод позволяет производить групповые операции над несколькими квестами одновременно

{
    "type": "invite",
    "members": {
        "teams": [
            4
        ],
        "users": [
            1,
            18
        ],
        "positions": [],
        "departments": [
            3,
            8
        ]
    },
    "selected": [
        1,
        5
    ]
}

Параметры запроса

Атрибут Тип Обязательное Описание
selected*
int[]
Да Массив идентификаторов квестов
members*
{users: int[] | departments: int[] | teams: int[] | positions: int[]}
Да Список участников, где users - массив идентификаторов пользователей, departments - массив идентификаторов отделов, teams - массив идентификаторов команд, positions - массив идентификаторов должностей
type*
invite
Да Тип операции, где invite - операция назначения (приглашения)

База знаний

Содержит методы управления базой знаний

Список материалов

Метод возвращает список материалов по заданным фильтрам

{
    "fav": 0,
    "per": 12,
    "page": 1,
    "sort": null,
    "tags": [],
    "type": null,
    "level": null,
    "limit": 12,
    "query": "",
    "published": 1,
    "profession": null
}

Параметры запроса

Атрибут Тип Обязательное Описание
per
int
Размер порции данных
page
int
Номер порции данных
fav
bool
Фильтр по избранным
sort
new | old | popular | rated
Метод сортировки ответа
tags
array[int]
Массив id тегов
type
news | announcement | material | projects | vacancy | page
Фильтр по типу материала
limit
int
Лимит ответа (Макс 1000)
query
string
Поиск по названию материала
published
bool
Фильтр по опубликованным
profession
Фильтр по профессии

Получить материал

Метод возвращает информацию о материале

{
    "id": 10
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Материала

Создание материала

Метод позволяет создать материал с заданными данными

{
    "id": null,
    "item": {
        "id": null,
        "data": {
            "html": ""
        },
        "type": "video",
        "title": "\u0435\u043e\u043d\u043e\u043d",
        "available": "course",
        "published": 0,
        "attachments": []
    }
}

Параметры запроса

Атрибут Тип Обязательное Описание
title*
string
Да Название материала
data*
array{html | youtube_id | rutube_id | vk_id | video_link | scormarray | scorm}
Да Содержимое материала (html, id youtube видео, id rutube видео, id vk видео, кастомная ссылка на видео)
type*
video | longread | card | scorm
Да Тип материала
video
string
Адресс видео
image
string
Адресс изображения
published
bool
Опубликовать материал
rate_required
bool
Требовать оценку после прохождения
attachments
array
Вложения
available
all | link | course
Формат доступа к материалу
tags
array[int]
Массив id тегов

Обновить материал

Метод позволяет обновить данные и информацию о материале

{
    "id": 1,
    "item": {
        "id": 1,
        "data": [],
        "tags": [],
        "type": "video",
        "image": "cce592a7-117e-4f84-81e9-ad16b19ae7c1",
        "title": "\u0422\u0435\u0441\u0442\u043e\u0432\u044b\u0439 \u043c\u0430\u0442\u0435\u0440\u0438\u0430\u043b 1",
        "video": null,
        "views": 7,
        "rating": 3,
        "available": "course",
        "published": 0,
        "attachments": [],
        "rate_required": 0
    }
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Материала
title
string
Название материала
data
array{html | youtube_id | rutube_id | vk_id | video_link | scormarray | scorm}
Ссылка на внешний ресурс
type
video | longread | card | scorm
Тип материала
video
string
Адресс видео
image
string
Адресс изображения
published
bool
Опубликовать материал
rate_required
bool
Требовать оценку после прохождения
attachments
array
Вложения
available
all | link | course
Формат доступа к материалу
tags
array[int]
Массив id тегов
view
int
Количество просмотров

Удаление материала

Метод позволяет удалить материал

{
    "id": 26
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Материала

Удаление списка материалов

Метод позволяет удалить несколько материалов сразу

{
    "ids": [
        1,
        2
    ]
}

Параметры запроса

Атрибут Тип Обязательное Описание
ids*
int[]
Да Массив идентификаторов материалов

Опубликовать материал

Метод позволяет сделать материал публичным

{
    "id": 1
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Материала

Добавить в избранное

Метод добавляет материал в избранное для владельца токена

{
    "id": 10
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Материала

Убрать из избранного

Метод убирает материал из избранных

{
    "id": 10
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Материала

Оценка материала

Метод позволяет произвести оценку материала от 1 до 5

{
    "id": 10,
    "rate": 5
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор материала
rate*
int
Да Оценка от 1 до 5

Простой список

Метод возвращает простой список материалов

{}

Обучение

Содержит методы управления курсами и его этапами, направлениями и уровнями

Список направлений обучения

Метод возвращает список направлений обучения

{
    "sort": "name",
    "direction": "ASC"
}

Параметры запроса

Атрибут Тип Обязательное Описание
sort
name
Сортировка по имени
direction
ASC | DESC
Направление сортировки

Создать направление

Метод позволяет создать новое направление обучения

{
    "id": null,
    "name": "\u043e\u043e\u043d"
}

Параметры запроса

Атрибут Тип Обязательное Описание
name*
string
Да Название направления

Обновить направление

Метод позволяет обновить информацию о направлении

{
    "id": 7,
    "name": "\u043e\u043e\u043d",
    "test": null
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Направления
name
string
Название направления

Удалить направление

Метод удаляет направление обучения

{
    "id": 7
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Направления

Список уровней обучения

Метод возвращает список уровней обучения и их данных

{
    "sort": "value",
    "direction": "ASC"
}

Параметры запроса

Атрибут Тип Обязательное Описание
sort
name | value
Тип сортировки
direction
ASC | DESC
Направление сортировки

Создание уровня

Метод позволяет создать новый уровень обучения

{
    "id": null,
    "name": "\u043a\u043f\u043a\u043f\u043a\u043f",
    "value": 2
}

Параметры запроса

Атрибут Тип Обязательное Описание
name*
string
Да Название уровня
value*
int
Да Значение уровня

Обновление уровня

Метод позволяет обновить данные уровня обучения

{
    "id": 15,
    "name": "\u043a\u043f\u043a\u043f\u043a\u043f",
    "value": 2
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Уровня
name
string
Название уровня
value
int
Значение уровня

Удаление уровня

Метод удаляет уровень обучения

{
    "id": 15
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Уровня

Список курсов

Метод возвращает список программ обучения по указанным фильтрам

{
    "level": null,
    "profession": null
}

Параметры запроса

Атрибут Тип Обязательное Описание
level
int | null
id Уровня
profession
int | null
id Направления

Список связей

Метод возвращает список связей созданных направлений и уровней

{
    "available": true
}

Параметры запроса

Атрибут Тип Обязательное Описание
available
bool
Фильтр по доступным

Данные курса

Метод возвращает данные программы обучения

{
    "id": 12
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Курса

Создание курса

Метод позволяет создать новую программу обучения

{}

Параметры запроса

Атрибут Тип Обязательное Описание
profession*
int
Да id Направления
level*
int
Да id Уровня
image
string
Адресс изображения
rating_required
bool
Обязательная оценка после прохождения

Обновление курса

Метод позволяет обновить содержимое программы обучения

{
    "id": 12,
    "level": 3,
    "active": 1,
    "profession": 1
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Курса
active
boolean
Активность курса
image
string
Адресс изображения
rating_required
boolean
Обязательная оценка после прохождения

Удаление курса

Метод удаляет программу обучения

{
    "id": 22
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Курса

Список пользователей

Метод возвращает список пользователей программы обучения

{
    "id": 12,
    "per": 10,
    "page": 1,
    "text": "",
    "limit": 10
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Курса
per
int
Размер порции данных
page
int
Номер порции данных
text
string
Поиск по имени, фамилии, email, телефону
limit
int
Ограничение на кол-во отображаемых данных

Приглашение пользователей

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

{
    "id": 12,
    "teams": [
        8
    ],
    "users": [],
    "departments": []
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Курса
teams
array[int]
Список id команд
users
array[int]
Список id пользователей
departments
array[int]
Список id отделов

Удаление пользователей

Метод исключает сотрудника из прохождения программы обучения

{
    "id": 12,
    "user": 69
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Курса
user*
int
Да id Пользователя

Удаление всех пользователей

Метод позволяет исключить всех участников программы обучения

{
    "id": 12
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Курса

Дерево этапов

Метод возвращает дерево этапов курса по фильтру

{
    "id": 12,
    "exclude": null
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Курса
exclude
int
id Этапа, который необходимо исключить (с дочерними этапами)

Список нод курса

Метод возвращает список этапов курса по заданным фильтрам

{
    "id": null,
    "program": 12
}

Параметры запроса

Атрибут Тип Обязательное Описание
id
int
id Этапа
program*
int
Да id Курса
pid
int
Родительский этап

Создание ноды

Метод позволяет создать этап курса по заданным параметрам

{
    "type": "stage",
    "title": "\u043f\u043a\u0443\u0440\u0435\u0440\u0435",
    "program": 12
}

Параметры запроса

Атрибут Тип Обязательное Описание
program*
int
Да id Программы обучения
title*
string
Да Название ноды
type*
stage | topic | block | material | test | task | dialog
Да Тип ноды
pid
int | null
id Родительской ноды
coins
int | null
Количество очков валюты за прохождение
exp
int | null
Количество опыта героя за прохождение
achievement
array
Достижение за прохождение
currencies
array
Кастомная валюта за прохождение
material
int
id Материала
test
int
id Теста
task
int
id Задания

Обновление ноды

Метод позволяет изменить этап в в программе обучения

{
    "id": 47,
    "exp": null,
    "pid": 45,
    "task": null,
    "test": null,
    "type": "material",
    "coins": null,
    "order": 1751616651,
    "score": null,
    "title": " \u0440\u0442",
    "scores": null,
    "program": 12,
    "material": 1,
    "currencies": null,
    "achievement": null
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Этапа
program
int
id Программы обучения
title
string
Название ноды
type
stage | topic | block | material | test | task | dialog
Тип ноды
pid
int | null
id Родительской ноды
coins
int | null
Количество очков валюты за прохождение
exp
int | null
Количество опыта героя за прохождение
score
int
scores
achievement
array
Достижение за прохождение
currencies
array
Кастомная валюта за прохождение
material
int
id Материала
test
int
id Теста
task
int
id Задания

Удаление ноды

Метод позволяет удалить этап курса

{
    "id": 47
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Ноды

Порядок этапов

Метод позволяет изменить расположение этапа в программе обучения

{
    "id": 46,
    "dir": "down"
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Этапа
dir
up | down
Направление переноса

Прогресс обучения

Метод возвращает прогресс пользователей по указанным фильтрам

{
    "page": 1,
    "limit": 20,
    "query": "",
    "program": null,
    "sortField": "user",
    "sortDirection": "ASC"
}

Параметры запроса

Атрибут Тип Обязательное Описание
user
int
id Пользователя
program
int
id Курса
date_start
string
Дата начала в формате YY-MM-DD
date_end
string
Дата начала в формате YY-MM-DD
query
string
Поиск по имени, фамилии, email, номеру телефона
limit
int
Ограничение на количество возвращаемых данных
page
int
Номер порции данных

Список доступных курсов

Метод возвращает список доступных курсов для владельца токена

{}

Статус прохождения

Метод возвращает статус прохождения по всем доступным владельцу токена курсам

{}

Список курсов

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

{}

Выбор курса

Метод назначает владельцу токена курс как "текущий"

{
    "id": 18
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Курса

Просмотр выбранного элемента курса

Метод помечает выбранную ноду как текущую, если это возможно

{
    "id": 22
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор узла курса

Текущий курс

Метод возвращает текущий курс владельца токена

{}

Переход к следующему этапу

Метод позволяет перейти на следующий этап курса

{
    "rating": 5,
    "comment": "\u041a\u0443\u0440\u0441 \u043e\u0442\u043b\u0438\u0447\u043d\u044b\u0439"
}

Параметры запроса

Атрибут Тип Обязательное Описание
rating
int | null
Оценка курса от 1 до 5, если финальный узел
comment
string | null
Комментарий к курсу, если финальный узел

Переход к предыдущему этапу

Метод позволяет перейти на предыдущий этап курса

{}

Обновление настроек курса

Метод позволяет обновить направление курса

{
    "level": 3,
    "program": 12,
    "profession": 1
}

Параметры запроса

Атрибут Тип Обязательное Описание
profession*
int
Да id Направления
level
int
id Уровня
image
string
Адресс изображения
rating_required
bool
Требование оценки после прохождения

Клонирование курса

Метод позволяет клонировать программу обучения с новыми параметрами

{
    "level": 3,
    "program": 12,
    "profession": 1
}

Параметры запроса

Атрибут Тип Обязательное Описание
program*
int
Да id Программы обучения
profession*
int
Да id Направления
level*
int
Да id Уровня

Статистика обучения

Метод вернет подробную статистику по курсам обучения на основе заданных фильтров

{
    "per": 10,
    "page": 1,
    "type": "user"
}

Параметры запроса

Атрибут Тип Обязательное Описание
per
int | null
Количество на страницу
page
int | null
Номер страницы
type
course | material | task | test | dialog | user
Тип статистики (по курсам, по материалам, по заданиям, по тестам, по тренажерам, по пользователям
course
int | null
Идентификатор курса
user
int | null
Идентификатор пользователя
position
int | null
Идентификатор должности
department
int | null
Идентификатор отдела
team
int | null
Идентификатор команды
date_start
string | null
Дата начала периода
date_end
string | null
Дата конца периода
sort
name | popular | involvement | timing | finished
Тип сортировки
order
asc | desc
Направление сортировки

Инфографика обучения

Метод вернет набор данных статистики для представления в инфографике

{
    "type": "course"
}

Параметры запроса

Атрибут Тип Обязательное Описание
type
course | material | task | test | dialog | user
Тип статистики (по курсам, по материалам, по заданиям, по тестам, по тренажерам, по пользователям
course
int | null
Идентификатор курса
position
int | null
Идентификатор должности
department
int | null
Идентификатор отдела
team
int | null
Идентификатор команды
date_start
string | null
Дата начала периода
date_end
string | null
Дата конца периода

Заявки

Содержит методы работы с формами заявок и их обработке

Список форм

Вернет список форм, доступных для управления менеджером и заполнения пользователем

{
    "per": 24,
    "page": 1
}

Параметры запроса

Атрибут Тип Обязательное Описание
per
int | null
Количество на страницу
page
int | null
Номер страницы

Данные формы

Вернет полный перечень данных формы заявки по заданному идентификатору

{
    "id": 3
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор формы заявки

Создание формы

Метод позволяет создать новую форму заявки для заполнения

{
    "title": "\u0435\u043f\u043f\u0435",
    "fields": [
        {
            "name": "\u0435\u043a\u0440\u0435\u043a\u0435",
            "type": "checkbox",
            "options": [],
            "required": 0
        }
    ],
    "moderate": 0,
    "moderator": null,
    "description": "",
    "responsible": 136
}

Параметры запроса

Атрибут Тип Обязательное Описание
title*
string
Да Наименование формы
description
string | null
Описание формы
image
string | null
Идентификатор вложения (uuid)
moderate
boolean
Требуется модерация или нет
moderator
int | null
Идентификатор пользователя (модератора)
responsible
int | null
Идентификатор пользователя (ответственного)
fields
{name: string | type: string | required: int | options: string[]}[]
Массив полей формы. name - заголовок поля, type - тип поля, required - обязательное, options - перечень дополнительных атрибутов поля

Обновление формы

Метод позволяет произвести редактирование существующей формы заявки с целью изменения её параметров

{
    "id": 3,
    "title": "\u041f\u043e\u043b\u0443\u0447\u0438\u0442\u044c \u0433\u0430\u0440\u043d\u0438\u0442\u0443\u0440\u0443",
    "fields": [
        {
            "name": "\u0422\u0435\u043a\u0441\u0442 \u0437\u0430\u044f\u0432\u043a\u0438",
            "type": "textarea",
            "value": "",
            "options": [],
            "required": false
        }
    ],
    "moderate": 1,
    "moderator": 20,
    "deleted_at": null,
    "achievement": null,
    "description": "\u041f\u0440\u043e\u0448\u0443 \u0432\u044b\u0434\u0430\u0442\u044c \u043d\u043e\u0432\u0443\u044e \u0433\u0430\u0440\u043d\u0438\u0442\u0443\u0440\u0443, \u0441\u0442\u0430\u0440\u0430\u044f \u0441\u043b\u043e\u043c\u0430\u043b\u0430\u0441\u044c \u0438 \u043d\u0435 \u043f\u043e\u0447\u0438\u043d\u0438\u0442\u044c",
    "responsible": 20
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор формы заявки
title*
string
Да Наименование формы
description
string | null
Описание формы
image
string | null
Идентификатор вложения (uuid)
moderate
boolean
Требуется модерация или нет
moderator
int | null
Идентификатор пользователя (модератора)
responsible
int | null
Идентификатор пользователя (ответственного)
fields
{name: string | type: string | required: int | options: string[]}[]
Массив полей формы. name - заголовок поля, type - тип поля, required - обязательное, options - перечень дополнительных атрибутов поля

Удаление формы

Метод позволяет удалить форму из системы - будет установлена отметка об удалении

{
    "id": 13
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор формы заявки

История заявок

Метод вернет список всех заявок пользователей на основе заданных фильтров

{
    "per": 20,
    "rel": "manage",
    "form": null,
    "page": 1,
    "limit": 20,
    "status": null,
    "deletedForms": false
}

Параметры запроса

Атрибут Тип Обязательное Описание
per
int | null
Количество на страницу
page
int | null
Номер страницы
rel
my | manage | null
my - свои, manage - все (под управлением)
status
string | null
Статус обработки
form
int | null
Идентификатор формы
deletedForms
boolean
Показывать удалённые формы

Информация о заявке

Метод вернет подробную информацию по конкретной заявке

{
    "id": 57
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор заявки

Смена статуса заявки

Метод позволяет произвести смену статуса выбранной заявки

{
    "id": 57,
    "force": true,
    "status": "accept",
    "comment": ""
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор заявки
status*
moderate | accept | work | reject | complete
Да Статус обработки
comment
string | null
Дополнительный комментарий
force
boolean
Не проверять статус (если необходимо нарушить последовательность статусов обработки)

Отправка данных заявки

Метод позволяет отправить заполненные данные заявки в систему и создать соответствующую запись в истории

{
    "id": 1,
    "fields": {
        "\u0412\u0438\u0434 \u043e\u0442\u043f\u0443\u0441\u043a\u0430": "\u041e\u043f\u043b\u0430\u0447\u0438\u0432\u0430\u0435\u043c\u044b\u0439 (\u0437\u0430 \u0441\u0447\u0435\u0442 \u043a\u043e\u043c\u043f\u0430\u043d\u0438\u0438)",
        "\u0414\u0430\u0442\u0430 \u043d\u0430\u0447\u0430\u043b\u0430": "2025-07-10",
        "\u0422\u0435\u043a\u0441\u0442 \u0437\u0430\u044f\u0432\u043b\u0435\u043d\u0438\u044f": "t1",
        "\u041a\u043e\u043b-\u0432\u043e \u043a\u0430\u043b\u0435\u043d\u0434\u0430\u0440\u043d\u044b\u0445 \u0434\u043d\u0435\u0439": 1
    }
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор заявки
fields*
{[fieldName: string]: any}
Да Объект заполненных полей, где ключ - наименование поля, значение - данные пользователя

Упрощённый список

Метод вернет упрощённый перечень форм заявок. Используется для селекторов и списков

{}

Тесты

Содержит методы управления тестами, его вопросами и ответами к ним

Ответы по тесту

Метод позволяет владельцу токена направить ответы на вопросы теста

{
    "id": 4,
    "answer": [
        38
    ]
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Теста
answer*
[array]
Да Массив ответов

Клонирование вопроса

Метод позволяет создать копию вопроса в тесте

{
    "id": 33
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Вопроса

Создание ответа

Метод позволяет создать ответ для вопроса теста

{
    "item": {
        "test": 14,
        "text": "\u0435\u0440\u0440\u0440",
        "correct": 1,
        "question": 33
    },
    "question": 33
}

Параметры запроса

Атрибут Тип Обязательное Описание
question*
int
Да id Вопроса
item*
array{test | text | image | correct | question}
Да Данные ответа

Создание вопроса

Метод позволяет создать вопрос для теста. Данные оборачиваются в item{}

{
    "item": {
        "test": 14,
        "text": "\u0435\u0440",
        "time": 0,
        "video_upload": null
    },
    "test": 14
}

Параметры запроса

Атрибут Тип Обязательное Описание
test*
int
Да id Теста
text*
string
Да Текст вопроса
multi*
boolean
Да Разрешить несколько правильных ответов
image
string
Адресс изображения
video_upload
string
Адресс видео
video_links
array{yb | rb}
Ссылка на видео Ютуб/Рутуб
rate_required
boolean
Требовать оценить после прохождения
time
int
Время на ответ (в секундах)
rating
int
Сложность вопроса

Создание теста

Метод позволяет создать тест с указанными настройками. Данные оборачиваются в item{}

{
    "id": null,
    "item": {
        "id": null,
        "type": "regular",
        "delay": 0,
        "extra": {},
        "title": "\u043d\u043e\u043e",
        "active": 0,
        "delay_type": "hours",
        "description": "",
        "show_results": 0,
        "shuffle_answers": 1,
        "shuffle_questions": 1
    }
}

Параметры запроса

Атрибут Тип Обязательное Описание
title*
string
Да Название теста
description
string
описание теста
active*
boolean
Да Активность
delay_type
minutes | hours | days
Тип задержки между попытками
delay
int
Время задержки
extra
array{parssing_percent}
Проходной процент
limit_questions
int
Лимит вопросов
show_results
boolean
Показывать результаты теста
shuffle_answers
boolean
Перемешивать ответы
shuffle_questions
boolean
Перемешивать вопросы
type
regular
Тип теста
competency_level
array{percent | competency | level}
Уровень компетенций

Удаление ответа

Метод удаляет ответ в вопросе теста

{
    "id": 95
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Ответа

Удаление вопроса

Метод позволяет удалить вопрос в тесте

{
    "id": 34
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Вопроса

Удаление теста

Метод позволяет удалить тест

{
    "id": 13
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Теста

Информация о тесте

Метод возвращает информацию о тесте

{
    "id": 4
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Теста

Список тестов

Метод возвращает список тестов по указанным фильтрам

{
    "pid": null,
    "page": 1,
    "text": "",
    "limit": 20,
    "program": null
}

Параметры запроса

Атрибут Тип Обязательное Описание
pid
int
Размер порции данных
page
int
Номер порции данных
text
string
Поиск по названию
limit
int
Лимит отображаемых данных

Список ответов

Метод возвращает список возможных ответов к вопросу

{
    "question": 33
}

Параметры запроса

Атрибут Тип Обязательное Описание
question*
int
Да id Вопроса

Список вопросов

Метод возвращает список вопросов к тесту

{
    "test": 14
}

Параметры запроса

Атрибут Тип Обязательное Описание
test*
int
Да id Теста

Следующий вопрос

Метод позволяет перейти к следующему вопросу в тесте

{
    "id": 4
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Теста

Результат теста

Метод возвращает результат прохождения теста владельца токена

{
    "id": 45
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Теста

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

Метод возвращает список результатов по тесту по заданным фильтрам

{
    "my": true,
    "page": 1,
    "test": null,
    "user": null,
    "count": 0,
    "limit": 20,
    "pages": 0,
    "status": null,
    "textUser": "",
    "dataCount": 0
}

Параметры запроса

Атрибут Тип Обязательное Описание
my
boolean
Фильтр результатов владельца токена
page
int
Номер порции данных
test
int
id Теста
user
int
id Пользователя
limit
int
Лимит порции данных
page
int
Номер порции данных
status
finish | fail
Статус прохождения

Простой список тестов

Метод возвращает краткий список тестов

{}

Начать тест

Метод позволяет начать тест

{
    "id": 4
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Теста

Обновить ответ

Метод позволяет обновить содержимое ответа к вопросу теста

{
    "id": 95,
    "item": {
        "id": 95,
        "test": 14,
        "text": "\u0435\u0440\u0440\u0440",
        "order": 0,
        "correct": 1,
        "question": 33
    },
    "question": 33
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Вопроса
question
int
id Вопроса
item
array{test | text | image | correct | question}
Данные ответа

Обновление вопроса

Метод позволяет обновить содержимое вопроса в тесте

{
    "id": 34,
    "item": {
        "id": 34,
        "test": 14,
        "text": "\u0435\u0440",
        "time": 0,
        "multi": 0,
        "order": 0,
        "rating": null,
        "video_links": [],
        "video_upload": null,
        "rate_required": 0
    },
    "test": 14
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Вопроса
test
int
id Теста
text
string
Текст вопроса
multi
boкolean
Разрешить несколько правильных ответов
image
string
Адресс изображения
video_upload
string
Адресс видео
video_links
array{yb | rb}
Ссылка на видео Ютуб/Рутуб
rate_required
boolean
Требовать оценить после прохождения
time
int
Время на ответ (в секундах)
rating
int
Сложность вопроса

Обновление теста

Метод позволяет обновить содержимое теста

{
    "id": 13,
    "item": {
        "id": 13,
        "type": "regular",
        "delay": 0,
        "extra": {},
        "title": "\u043d\u043e\u043e",
        "active": 1,
        "delay_type": "hours",
        "description": "",
        "show_results": 0,
        "limit_questions": null,
        "shuffle_answers": 1,
        "shuffle_questions": 1
    }
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да id Теста
title
string
Название теста
description
string
описание теста
active*
boolean
Да Активность
delay_type
minutes | hours | days
Тип задержки между попытками
delay
int
Время задержки
extra
array{parssing_percent}
Проходной процент
limit_questions
int
Лимит вопросов
show_results
boolean
Показывать результаты теста
shuffle_answers
boolean
Перемешивать ответы
shuffle_questions
boolean
Перемешивать вопросы
type
regular
Тип теста
competency_level
array{percent | competency | level}
Уровень компетенций

Календарь

Содержит методы управления событиями в календаре пользователя

Список событий

Метод вернет список активных событий за указанный период

{
    "type": null,
    "year": 2025,
    "month": 6
}

Параметры запроса

Атрибут Тип Обязательное Описание
type
all | event | birthday | holiday | shortday | deadline | null
Тип событий
year*
int
Да Год
month*
int
Да Месяц

Данные события

Метод вернет данные одного выбранного события

{
    "id": 35
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор события

Создание события

Метод позволяет создать новое событие в указанный период времени

{
    "id": null,
    "type": "event",
    "image": "5b36d5f5-c02a-4713-bb24-7d87ec3f310a",
    "title": "Test",
    "date_end": "2025-06-10",
    "date_begin": "2025-06-10",
    "description": "Test & test!"
}

Параметры запроса

Атрибут Тип Обязательное Описание
type*
event | birthday | holiday | shortday | deadline
Да Тип события
title*
string
Да Заголовок события
description
string | null
Описание события
image
string | null
Идентификатор вложения (uuid)
date_begin
string | null
Дата начала события
date_end
string | null
Дата завершения события

Обновление события

Метод позволяет произвести редактирование события с целью изменения его параметров

{
    "id": "53",
    "type": "event",
    "title": "Test2",
    "date_end": "2025-06-10 00:00:00",
    "date_begin": "2025-06-10 00:00:00",
    "description": "Test & test!"
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор события
type*
event | birthday | holiday | shortday | deadline
Да Тип события
title*
string
Да Заголовок события
description
string | null
Описание события
image
string | null
Идентификатор вложения (uuid)
date_begin
string | null
Дата начала события
date_end
string | null
Дата завершения события

Удаление события

Метод удаляет выбранное событие

{
    "id": "53"
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор события

Слайды

Содержит методы управления системными слайдами представлений

Список слайдов

Вернет список доступных слайдов системы

{}

Создание слайда

Метод позволяет создать новый слайд в системе для представления

{
    "text": "\u043f\u0435\u0440\u0432\u044b\u0439 \u0441\u043b\u0430\u0439\u0434",
    "image": "a3c0d5ee-fd53-4d94-b531-f419e375021b",
    "text_preview": ""
}

Параметры запроса

Атрибут Тип Обязательное Описание
text*
string
Да Описание слайда
text_preview
string | null
Краткое описание поверх слайда
image*
string
Да Идентификатор вложения (uuid)
order
int | null
Порядок сортировки

Обновление слайда

Метод позволяет произвести редактирование существующего слайда с целью изменения его параметров

{
    "id": 1,
    "text": "\u043f\u0435\u0440\u0432\u044b\u0439 \u0441\u043b\u0430\u0439\u0434",
    "image": "a3c0d5ee-fd53-4d94-b531-f419e375021b",
    "text_preview": ""
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор слайда
text*
string
Да Описание слайда
text_preview
string | null
Краткое описание поверх слайда
image*
string
Да Идентификатор вложения (uuid)
order
int | null
Порядок сортировки

Удаление слайда

Метод позволяет удалить существующий слайд

{
    "id": 1
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор слайда

Изменение сортировки

Метод позволяет изменить порядок между двумя слайдами

{
    "ids": [
        74,
        75
    ]
}

Параметры запроса

Атрибут Тип Обязательное Описание
ids*
int[]
Да Два идентификатора слайдов, между которыми необходимо произвести перестановку

Документы

Содержит методы работы с документами и их папками

Список документов

Метод вернет список документов на основе заданных параметров фильтра

{
    "text": "",
    "starred": false
}

Параметры запроса

Атрибут Тип Обязательное Описание
pid*
int | null
Да Идентификатор родительского каталога (папки)
text
string
Поисковая фраза
starred
boolean
Только документы, отмеченные для виджета

Список для виджета

Метод вернет специальный список документов для отображения в виджете. Это список только тех документов, которые помечены для отображения в виджете.

{}

Список папок

Метод вернет список папок документов

{
    "id": null
}

Параметры запроса

Атрибут Тип Обязательное Описание
id
int | null
Идентификатор родительского каталога (папки)
exclude
int | null
Идентификатор каталога (папки) для исключения из списка

Данные документа, папки

Метод вернет полный набор данных конкретной папки или документа в зависимости от типа на основе переданного идентификатора

{
    "id": 28
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор папки или документа

Создание папки

Метод позволяет создать новую папку для хранения документов

{
    "pid": null,
    "name": "\u0422\u0435\u0441\u0442API",
    "type": "folder"
}

Параметры запроса

Атрибут Тип Обязательное Описание
name*
string
Да Название
type*
folder
Да Тип
pid
int | null
Идентификатор родительской папки
departments
int[]
Массив идентификаторов отделов, которым будет предоставлен доступ в папку

Обновление папки

Метод позволяет произвести редактирование папки с целью изменения её параметров

{
    "id": 29,
    "pid": null,
    "name": "\u043e",
    "type": "folder"
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор папки
name*
string
Да Название
type*
folder
Да Тип
pid
int | null
Идентификатор родительской папки
departments
int[]
Массив идентификаторов отделов, которым будет предоставлен доступ в папку

Создание документа

Метод позволяет создать новый документ

{
    "pid": 31,
    "name": "\u043f8",
    "type": "file"
}

Параметры запроса

Атрибут Тип Обязательное Описание
name*
string
Да Название
type*
file
Да Тип
pid
int | null
Идентификатор родительской папки
upload*
string
Да Идентификатор вложения (uuid)

Обновление документа

Метод позволяет произвести редактирование документа с целью изменения его параметров

{
    "id": 32,
    "ext": "png",
    "pid": 31,
    "mime": "image\/png",
    "name": "\u043f8",
    "size": 2062,
    "type": "file",
    "starred": 1
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор документа
name*
string
Да Название
type*
file
Да Тип
pid
int | null
Идентификатор родительской папки
upload*
string
Да Идентификатор вложения (uuid)

Удаление документа или папки

Метод позволяет удалить документ или папку в зависимости от их типа на основе переданного идентификатора

{
    "id": 29
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор документа или папки

Интеграции

Содержит методы управления и работы с различными способами интеграций в системе

Список параметров

Метод вернет список всех созданных кастомных параметров

{
    "role": 3
}

Параметры запроса

Атрибут Тип Обязательное Описание
role
int | null
Идентификатор роли

Создание параметра

Метод позволяет добавить новый кастомный параметр

{
    "ttl": null,
    "name": "CEO",
    "role": null,
    "slug": "CEO",
    "formula": {
        "id": 1,
        "name": null,
        "source": "$user.coins > 0",
        "compiled": "return $user.coins > 0;"
    },
    "refresh": "monthly",
    "favorite": 0,
    "role_name": null
}

Параметры запроса

Атрибут Тип Обязательное Описание
role
int | null
Идентификатор роли
slug*
string
Да Слаг параметра
name*
string
Да Название параметра
formula
any | null
Содержимое расчета
ttl
int | null
Задержка перед выполнением
refresh
hourly | daily | weekly | monthly
Период выполнения
favorite
int
Показывать в профиле или нет

Обновление параметра

Метод позволяет произвести редактирование параметра с целью изменения его параметров

{
    "id": 2,
    "ttl": null,
    "name": "CEO",
    "role": null,
    "slug": "CEO",
    "formula": {
        "id": 1,
        "name": null,
        "source": "$user.coins > 0",
        "compiled": "return $user.coins > 0;"
    },
    "refresh": "monthly",
    "favorite": 0,
    "role_name": null
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор параметра
role
int | null
Идентификатор роли
slug*
string
Да Слаг параметра
name*
string
Да Название параметра
formula
any | null
Содержимое расчета
ttl
int | null
Задержка перед выполнением
refresh
hourly | daily | weekly | monthly
Период выполнения
favorite
int
Показывать в профиле или нет

Удаление параметра

Метод удаляет параметр из системы

{
    "id": 2
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор параметра

Список обработчиков

Метод вернет список всех созданных кастомных обработчиков

{}

Создание обработчика

Метод позволяет добавить новый кастомный обработчик

{
    "name": "NewUserFromBitrix24",
    "active": 1,
    "source": "print_r($value);"
}

Параметры запроса

Атрибут Тип Обязательное Описание
name*
string
Да Название обработчика
active*
number
Да Статус публикации
source*
string
Да Код обработчика

Обновление обработчика

Метод позволяет произвести редактирование обработчика с целью изменения его параметров

{
    "id": 1,
    "name": "NewUserFromBitrix24",
    "active": 1,
    "source": "print_r($value);"
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор обработчика
name*
string
Да Название обработчика
active*
number
Да Статус публикации
source*
string
Да Код обработчика

Удаление обработчика

Метод удаляет обработчик из системы

{
    "id": 2
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор обработчика

Список модулей

Метод вернет список всех созданных кастомных модулей

{}

Создание модуля

Метод позволяет добавить новый кастомный модуль

{
    "name": "\u0422\u0435\u0441\u0442",
    "source": "print_r($value);",
    "description": "\u041a\u0430\u043a\u043e\u0435-\u0442\u043e \u043e\u043f\u0438\u0441\u0430\u043d\u0438\u0435"
}

Параметры запроса

Атрибут Тип Обязательное Описание
name*
string
Да Название модуля
description
string
null
source*
string
Да Код модуля

Обновление модуля

Метод позволяет произвести редактирование модуля с целью изменения его параметров

{
    "id": 1,
    "name": "\u0422\u0435\u0441\u0442",
    "source": "print_r($value);",
    "description": "\u041a\u0430\u043a\u043e\u0435-\u0442\u043e \u043e\u043f\u0438\u0441\u0430\u043d\u0438\u0435"
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор модуля
name*
string
Да Название модуля
description
string
null
source*
string
Да Код модуля

Удаление модуля

Метод удаляет модуль из системы

{
    "id": 2
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор модуля

Список заданий cron

Метод вернет список всех созданных кастомных заданий cron

{}

Создание задания cron

Метод позволяет добавить новое кастомное задание cron

{
    "name": "test2",
    "active": 1,
    "source": "print('echo');",
    "condition": "date('H:i') == '12:00';"
}

Параметры запроса

Атрибут Тип Обязательное Описание
name*
string
Да Название задания
active*
number
Да Статус публикации
condition*
string
Да Условие выполнения
source*
string
Да Код задания

Обновление задания cron

Метод позволяет произвести редактирование задания cron с целью изменения его параметров

{
    "id": 4,
    "name": "test2",
    "active": 1,
    "source": "print('echo');",
    "condition": "date('H:i') == '12:00';"
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор задания
name*
string
Да Название задания
active*
number
Да Статус публикации
condition*
string
Да Условие выполнения
source*
string
Да Код задания

Удаление задания cron

Метод удаляет задание cron из системы

{
    "id": 2
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор задания

Список хуков

Метод вернет список всех созданных кастомных хуков

{}

Создание хука

Метод позволяет добавить новый кастомный хук

{
    "name": "sendEmail",
    "active": 1,
    "source": "file_put_contents('test.txt', '123', FILE_APPEND | LOCK_EX);"
}

Параметры запроса

Атрибут Тип Обязательное Описание
name*
string
Да Название хука
active*
int
Да Статус публикации
source*
string
Да Код хука

Обновление хука

Метод позволяет произвести редактирование хука с целью изменения его параметров

{
    "id": 1,
    "name": "sendEmail",
    "active": 1,
    "source": "file_put_contents('test.txt', '123', FILE_APPEND | LOCK_EX);"
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор хука
name*
string
Да Название хука
active*
int
Да Статус публикации
source*
string
Да Код хука

Удаление хука

Метод удаляет хук из системы

{
    "id": 2
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор хука

Лог

Содержит методы работы с различными логами событий системы

Список логов действий

Метод вернет список логов действий пользователей на основе заданных фильтров

{
    "per": 20,
    "page": 1,
    "type": null,
    "user": null,
    "module": null,
    "date_end": null,
    "textUser": "",
    "date_begin": null
}

Параметры запроса

Атрибут Тип Обязательное Описание
per
int | null
Количество на страницу
page
int | null
Номер страницы
textUser
string | null
Поисковая фраза
user
int | null
Идентификатор пользователя, совершившего действие
type
create | update | remove | auth | error | other | null
Тип действие
module
string | null
Тип модуля
date_begin
string | null
Дата начала периода
date_end
string | null
Дата конца периода

Список логов согласий на обработку ПД

Метод вернет список всех пользователей и дат согласий на обработку персональных данных на основе заданных фильтров

{
    "per": 20,
    "page": 1
}

Параметры запроса

Атрибут Тип Обязательное Описание
per
int | null
Количество на страницу
page
int | null
Номер страницы
query
string | null
Поисковая фраза

Отзыв согласия на обработку ПД

Метод позволяет произвести отзыв ранее данного согласия на обработку персональных данных. В этом случае пользователь будет обезличен и удален из системы - пользователю будет прекращен доступ в систему

{}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор пользователя

Мои документы

Содержит методы работы с папками документов и документами загружаемыми пользователем, а также возможностью их валидации

Список папок

Метод вернет список папок файлов для пользователя

{
    "pid": null,
    "rel": "user",
    "type": "folder",
    "publish": "1",
    "withFiles": true
}

Параметры запроса

Атрибут Тип Обязательное Описание
pid
int | null
Идентификатор родительской папки
user
int | nullИдентификатор пользователя | просматривающего папку
withFiles*
boolean
Да С загруженными файлами пользователя, если rel = user
type
folder | null
Тип
publish
int | null
Статус публикации
responsible_id
int | null
Идентификатор пользователя/отдела/команды (ответственного за обработку)
responsible_type
users | departments | teams | positions | null
Тип ответственного
rel
user | admin
Список отображения для пользователя или администратора. По умолчанию admin

Данные папки

Метод вернет данные папки пользователя по идентификатору

{
    "withFiles": true,
    "withNextFolder": true
}

Параметры запроса

Атрибут Тип Обязательное Описание
user
int | nullИдентификатор пользователя | просматривающего папку
withFiles
boolean
С загруженными файлами пользователя, если rel = user
withNextFolder
boolean
С определением следующей папки по порядку

Создание папки

Метод позволяет создать новую папку на основе переданных параметров

{
    "pid": null,
    "name": "\u041b\u0438\u0447\u043d\u044b\u0435 \u0434\u0430\u043d\u043d\u044b\u0435",
    "type": "folder",
    "fields": [
        {
            "name": "\u041f\u0430\u0441\u043f\u043e\u0440\u0442",
            "order": 1,
            "folder": null,
            "required": true,
            "description": "\u0417\u0430\u0433\u0440\u0443\u0437\u0438\u0442\u0435 \u0432\u0442\u043e\u0440\u0443\u044e \u0441\u0442\u0440\u0430\u043d\u0438\u0446\u0443 \u043f\u0430\u0441\u043f\u043e\u0440\u0442\u0430",
            "validation_profile": true
        }
    ],
    "publish": 1,
    "next_step": null,
    "description": "\u0417\u0430\u0433\u0440\u0443\u0437\u0438\u0442\u0435 \u0444\u0430\u0439\u043b\u044b \u0434\u043e\u043a\u0443\u043c\u0435\u043d\u0442\u043e\u0432, \u043f\u043e\u0434\u0442\u0432\u0435\u0440\u0436\u0434\u0430\u044e\u0449\u0438\u0445 \u043b\u0438\u0447\u043d\u043e\u0441\u0442\u044c",
    "responsible": [
        {
            "id": 3,
            "type": "users"
        }
    ],
    "required_privacy": 1,
    "validation_profile": false
}

Параметры запроса

Атрибут Тип Обязательное Описание
pid
int | null
Идентификатор родительской папки
name*
string
Да Название папки
description
string | null
Описание папки
type
folder
Тип папки
publish*
int
Да Статус публикации
required_privacy
boolean
Требуется согласие с политикой компанией перед отправкой
next_step
int | null
Идентификатор папки, к которой должен произойти переход после отправки на проверку
validation_profile
boolean
Отвечают ли файлы из этой папки за валидацию профиля
fields
{folder: int | null; required*: boolean; name*: string; description: string | null; validation_profile: boolean; order*: int}[]
Массив полей загрузки, если требуется четкая структура и требования к загружаемым документам: folder - идентификатор текущей папки, required - обязательное, name - название поля, description - описание поля, validation_profile - отвечает за валидацию профиля, order - порядок сортировки
responsible
{id: int; type: users | departments | teams | positions}[]
Массив пользователей/отделов/команд, кто может быть ответственным
order
int | null
Порядок сортировки

Обновление папки

Метод позволяет произвести редактирование папки с целью изменения её параметров

{
    "id": 2,
    "pid": null,
    "name": "\u041b\u0438\u0447\u043d\u044b\u0435 \u0434\u0430\u043d\u043d\u044b\u0435",
    "type": "folder",
    "fields": [
        {
            "id": 33,
            "name": "\u041f\u0430\u0441\u043f\u043e\u0440\u0442",
            "order": 1,
            "folder": 2,
            "required": true,
            "description": "\u0417\u0430\u0433\u0440\u0443\u0437\u0438\u0442\u0435 \u0432\u0442\u043e\u0440\u0443\u044e \u0441\u0442\u0440\u0430\u043d\u0438\u0446\u0443 \u043f\u0430\u0441\u043f\u043e\u0440\u0442\u0430",
            "validation_profile": true
        }
    ],
    "publish": 1,
    "next_step": null,
    "description": "\u0417\u0430\u0433\u0440\u0443\u0437\u0438\u0442\u0435 \u0444\u0430\u0439\u043b\u044b \u0434\u043e\u043a\u0443\u043c\u0435\u043d\u0442\u043e\u0432, \u043f\u043e\u0434\u0442\u0432\u0435\u0440\u0436\u0434\u0430\u044e\u0449\u0438\u0445 \u043b\u0438\u0447\u043d\u043e\u0441\u0442\u044c",
    "responsible": [
        {
            "id": 3,
            "type": "users"
        }
    ],
    "required_privacy": 1,
    "validation_profile": false
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор папки
pid
int | null
Идентификатор родительской папки
name*
string
Да Название папки
description
string | null
Описание папки
type
folder
Тип папки
publish*
int
Да Статус публикации
required_privacy
boolean
Требуется согласие с политикой компанией перед отправкой
next_step
int | null
Идентификатор папки, к которой должен произойти переход после отправки на проверку
validation_profile
boolean
Отвечают ли файлы из этой папки за валидацию профиля
fields
{folder: int | null; required*: boolean; name*: string; description: string | null; validation_profile: boolean; order*: int}[]
Массив полей загрузки, если требуется четкая структура и требования к загружаемым документам: folder - идентификатор текущей папки, required - обязательное, name - название поля, description - описание поля, validation_profile - отвечает за валидацию профиля, order - порядок сортировки
responsible
{id: int; type: users | departments | teams | positions}[]
Массив пользователей/отделов/команд, кто может быть ответственным
order
int | null
Порядок сортировки

Удаление папки

Метод позволяет удалить папку с документами из системы - пометит её как удалённую

{}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор папки

Смена статуса папки

Метод позволяет изменить статус обработки документов выбранной папки

{
    "policy": true,
    "status": "new",
    "userId": 5,
    "folderId": 3
}

Параметры запроса

Атрибут Тип Обязательное Описание
userId*
int
Да Идентификатор пользователя
status*
new | moderate | rework | complete | fail
Да Статус папки
policy
boolean
Согласие на обработку данных
folderId
int | null
Идентификатор папки

Список документов

Метод вернет список документов для пользователя

{
    "pid": null,
    "user": 5,
    "status": "moderate",
    "responsible": null
}

Параметры запроса

Атрибут Тип Обязательное Описание
pid
int | null
Идентификатор родительской папки
user
int | nullИдентификатор пользователя | для которого показать документы
status*
new | moderate | rework | complete | fail
Да Статус документов для просмотра
responsible
int | null
Идентификатор пользователя (ответственного)

Сохранение документа

Метод позволяет сохранить новый документ, загруженный пользователем

{
    "id": null,
    "pid": 2,
    "upload": "008b4bbc-d039-434f-8539-6d1f1ef1bf65",
    "field_id": 33
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор документа
pid
int | null
Идентификатор родительской папки
field_id
int | null
Идентификатор родительского поля
upload
string | null
Идентификатор вложения (uuid)

Удаление документа

Метод позволяет удалить загруженный документ - пометит его как удалённый

{}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор документа

Смена статуса документа

Метод позволяет изменить статус загруженного документа в процессе обработки

{
    "status": "rework",
    "comment": "\u041f\u0440\u0438\u043b\u043e\u0436\u0435\u043d \u0434\u043e\u043a\u0443\u043c\u0435\u043d\u0442 \u0431\u0435\u0437 \u043f\u0435\u0447\u0430\u0442\u0438"
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор документа
status*
new | moderate | rework | complete | fail
Да Статус обработки документа
comment
string | null
Комментарий к документу

Список пользователей на модерации

Метод вернет список пользователей, у которых есть документы на модерации

{
    "per": 10,
    "page": 1,
    "status": "moderate"
}

Параметры запроса

Атрибут Тип Обязательное Описание
per
int | null
Количество на страницу
page
int | null
Номер страницы
status
new | moderate | rework | complete | fail | null
Статус документа
responsible
int | null
Идентификатор пользователя (ответственного за проверку)

Список каталогов пользователя на модерации

Метод вернет список каталогов, находящихся на проверке от выбранного пользователя

{
    "status": "moderate"
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор пользователя
status
new | moderate | rework | complete | fail | null
Статус документа
responsible
int | null
Идентификатор пользователя (ответственного за проверку)

Одобрение всех документов пользователя

Метод позволяет произвести одобрение всех документов пользователя сразу и расширить его профиль до полного

{}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор пользователя

Порядок папок

Метод позволяет произвести изменение порядка папок документов

{
    "ids": [
        5,
        1,
        3,
        4,
        2
    ]
}

Параметры запроса

Атрибут Тип Обязательное Описание
ids*
int[]
Да Отсортированный массив идентификаторов папок

Диалоговый тренажер

Содержит методы работы диалоговыми тренажёрами с целью организации скриптов обучения сотрудников

Список тренажеров

Метод вернет список всех диалоговых тренажеров на основе заданных фильтров

{
    "per": 20,
    "page": 1,
    "query": ""
}

Параметры запроса

Атрибут Тип Обязательное Описание
per
number | null
Количество на страницу
page
number | null
Номер страницы
publish
boolean | null
Статус публикации
free
boolean | null
Только общедоступные или назначенные
query
string | null
Поисковая строка

Данные тренажера

Метод вернет полную детальную информацию по тренажеру на основе переданного идентификатора

{
    "isTraining": false
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор тренажера
isTraining
boolean
В формате модуля обучения

Создание тренажера

Метод позволяет создать новый тренажер на основе переданных данных

{
    "id": null,
    "free": true,
    "name": "\u041c\u043e\u0439 \u043f\u0435\u0440\u0432\u044b\u0439 \u0442\u0440\u0435\u043d\u0430\u0436\u0435\u0440, \u0445\u043e\u0442\u044c \u0438 \u043d\u0435 \u0441\u043f\u043e\u0440\u0442\u0438\u0432\u043d\u044b\u0439",
    "user": null,
    "image": "008b4bbc-d039-434f-8539-6d1f1ef1bf65",
    "publish": true,
    "questions": [
        {
            "id": null,
            "text": "\u0412\u044b \u043a\u043e\u0433\u0434\u0430-\u043d\u0438\u0431\u0443\u0434\u044c \u043c\u0435\u0447\u0442\u0430\u043b\u0438 \u0441\u0442\u0430\u0442\u044c \u043b\u0443\u0447\u0448\u0435\u0439 \u0432\u0435\u0440\u0441\u0438\u0435\u0439 \u0441\u0435\u0431\u044f?",
            "dialog": null,
            "answers": [
                {
                    "id": null,
                    "text": "",
                    "emotion": -1,
                    "message": "\u0421\u0435\u0440\u044c\u0435\u0437\u043d\u043e? \u041d\u0435 \u0441\u0430\u043c\u044b\u0439 \u043b\u0443\u0447\u0448\u0438\u0439 \u0432\u0430\u0440\u0438\u0430\u043d\u0442!",
                    "question": null,
                    "next_question": null
                },
                {
                    "id": null,
                    "text": "\u041a\u0440\u0430\u0441\u0438\u0432\u0435\u0435?",
                    "emotion": 0,
                    "message": "",
                    "question": null,
                    "next_question": null
                },
                {
                    "id": null,
                    "text": "\u0418\u0434\u0435\u0430\u043b\u044c\u043d\u0435\u0435?",
                    "emotion": 2,
                    "message": "\u041d\u0435\u043e\u0436\u0438\u0434\u0430\u043d\u043d\u044b\u0439 \u043e\u0442\u0432\u0435\u0442, \u043c\u043e\u043b\u043e\u0434\u0435\u0446!",
                    "question": null,
                    "next_question": null
                }
            ],
            "emotion": 0,
            "character": null,
            "background": 3,
            "image_type": "emotion",
            "is_success": true
        }
    ],
    "score_fail": -8,
    "description": "\u0417\u0434\u0435\u0441\u044c \u043a\u0430\u043a\u043e\u0435-\u0442\u043e \u043e\u043f\u0438\u0441\u0430\u043d\u0438\u0435 \u0442\u0440\u0435\u043d\u0430\u0436\u0435\u0440\u0430",
    "score_success": 6
}

Параметры запроса

Атрибут Тип Обязательное Описание
name*
string
Да Название тренажера
description
string | null
Описание тренажера
image
string | null
Идентификатор изображения (uuid)
publish
boolean
Статус публикации
free
boolean
Доступно для всех или только выборочно
score_success*
int
Да Количество очков для успеха (не может быть больше суммы всех максимально положительных ответов)
score_fail*
int
Да Количество очков для провала (не может быть меньше суммы всех максимально отрицательных ответов)
questions*
any[]
Да Массив данных вопросов и соответствующих ответов к ним

Обновление тренажера

Метод позволяет обновить уже существующий тренажер с целью изменения его параметров

{
    "free": false,
    "name": "\u041c\u043e\u0439 \u043f\u0435\u0440\u0432\u044b\u0439 \u0442\u0440\u0435\u043d\u0430\u0436\u0435\u0440, \u0445\u043e\u0442\u044c \u0438 \u043d\u0435 \u0441\u043f\u043e\u0440\u0442\u0438\u0432\u043d\u044b\u0439",
    "image": "8de43076-ebf9-419f-aaac-566f07903b81",
    "publish": true,
    "questions": [
        {
            "id": 9,
            "text": "\u0412\u044b 11\u043a\u043e\u0433\u0434\u0430-\u043d\u0438\u0431\u0443\u0434\u044c \u043c\u0435\u0447\u0442\u0430\u043b\u0438 \u0441\u0442\u0430\u0442\u044c \u043b\u0443\u0447\u0448\u0435\u0439 \u0432\u0435\u0440\u0441\u0438\u0435\u0439 \u0441\u0435\u0431\u044f?",
            "dialog": 11,
            "answers": [
                {
                    "id": 19,
                    "text": "\u041c\u043e\u043b\u043e\u0436\u0435?",
                    "emotion": -1,
                    "message": "\u0421\u0435\u0440\u044c\u0435\u0437\u043d\u043e? 123 \u041d\u0435 \u0441\u0430\u043c\u044b\u0439 \u043b\u0443\u0447\u0448\u0438\u0439 \u0432\u0430\u0440\u0438\u0430\u043d\u0442!",
                    "question": 9,
                    "next_question": null
                },
                {
                    "id": 20,
                    "text": "\u041a\u0440\u0430\u0441\u0438\u0432\u0435\u0435?",
                    "emotion": 0,
                    "message": "",
                    "question": 9,
                    "next_question": null
                },
                {
                    "id": 21,
                    "text": "\u0418\u0434\u0435\u0430\u043b\u044c\u043d\u0435\u0435aaaa?",
                    "emotion": 2,
                    "message": "\u041d\u0435\u043e\u0436\u0438\u0434\u0430\u043d\u043d\u044b\u0439 \u043e\u0442\u0432\u0435\u0442, \u043c\u043e\u043b\u043e\u0434\u0435\u0446!",
                    "question": 9,
                    "next_question": null
                }
            ],
            "emotion": 0,
            "is_fail": 1,
            "character": null,
            "background": 1,
            "image_type": "emotion",
            "is_success": 0
        }
    ],
    "score_fail": -8,
    "description": "\u0417\u0434\u0435\u0441\u044c \u043a\u0430\u043a\u043e\u0435-\u0442\u043e \u043e\u043f\u0438\u0441\u0430\u043d\u0438\u0435 \u0442\u0440\u0435\u043d\u0430\u0436\u0435\u0440\u0430",
    "score_success": 6
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор тренажера
name*
string
Да Название тренажера
description
string | null
Описание тренажера
image
string | null
Идентификатор изображения (uuid)
publish
boolean
Статус публикации
free
boolean
Доступно для всех или только выборочно
score_success*
int
Да Количество очков для успеха (не может быть больше суммы всех максимально положительных ответов)
score_fail*
int
Да Количество очков для провала (не может быть меньше суммы всех максимально отрицательных ответов)
questions*
any[]
Да Массив данных вопросов и соответствующих ответов к ним

Изменение участников тренажера

Метод позволяет изменить участников (пользователей), которым доступен тренажер для прохождения. Всем остальным тренажер будет недоступен

{
    "members": [
        {
            "id": 1,
            "type": "users"
        }
    ]
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор тренажера
members*
{id: number | type: users | departments | teams | positions}
Да Список участников тренажера, где id - идентификатор элемента (участника), type - тип участника

Публикация тренажера

Метод позволяет опубликовать диалоговый тренажер или наоборот - снять его с публикации

{
    "publish": true
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор тренажера
publish*
boolean
Да Статус публикации

Удаление тренажера

Метод удалит тренажер из системы - пометит датой удаления и исключит из выборок

{}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор тренажера

Запуск тренажера

Метод запускает тренажер на прохождение для текущего пользователя

{
    "isTraining": false
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор процесса прохождения
isTraining
boolean
В режиме обучения

Проверка состояния тренажера

Метод позволяет проверить наличие незавершенного тренажера с целью предложить продолжить прохождение

{
    "isTraining": false
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор процесса прохождения
isTraining*
boolean
Да В режиме обучения

Список персонажей

Метод вернет список доступных персонажей для назначения в тренажеры

{}

Данные персонажа

Метод вернет детальную информацию о персонаже по заданному идентификатору

{}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор персонажа

Создание персонажа

Метод позволяет создать нового персонажа с заданным набором параметров

{
    "name": "\u0415\u0449\u0435 \u043f\u0435\u0440\u0441\u043e\u043d\u0430\u0436",
    "tags": [
        {
            "tag": "\u0422\u0435\u0433"
        }
    ],
    "emotions": {
        "0": {
            "image": "fe0b2a42-34ca-41f3-bdb9-dade02a64a59"
        },
        "1": {
            "image": "3d8c1846-07f2-4273-af49-1ce8c78e74b9"
        },
        "2": {
            "image": "dd8c9ee4-acd2-407c-8c9f-f10ac8e72fb8"
        },
        "-1": {
            "image": "56cc9bf9-c878-4c52-a3e3-590e48127ec0"
        },
        "-2": {
            "image": "4d926937-5ddd-4f55-b67b-43829d97f8d5"
        }
    }
}

Параметры запроса

Атрибут Тип Обязательное Описание
name*
string
Да Название персонажа
emotions*
{-2: {image: string} | -1: {image: string} | 0: {image: string} | 1: {image: string} | 2: {image: string}}
Да Объект эмоций, ключами являются баллы от -2 до 2. image - идентификатор изображения (uuid)
tags
{tag: string}[]
Массив тегов

Обновление персонажа

Метод позволяет произвести редактирование персонажа с целью изменения его параметров

{
    "id": 1,
    "name": "\u0415\u0449\u0435 \u043f\u0435\u0440\u0441\u043e\u043d\u0430\u0436",
    "tags": [
        {
            "tag": "\u0422\u0435\u0433"
        }
    ],
    "emotions": {
        "0": {
            "image": "fe0b2a42-34ca-41f3-bdb9-dade02a64a59"
        },
        "1": {
            "image": "3d8c1846-07f2-4273-af49-1ce8c78e74b9"
        },
        "2": {
            "image": "dd8c9ee4-acd2-407c-8c9f-f10ac8e72fb8"
        },
        "-1": {
            "image": "56cc9bf9-c878-4c52-a3e3-590e48127ec0"
        },
        "-2": {
            "image": "4d926937-5ddd-4f55-b67b-43829d97f8d5"
        }
    }
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор персонажа
name*
string
Да Название персонажа
emotions*
{-2: {image: string} | -1: {image: string} | 0: {image: string} | 1: {image: string} | 2: {image: string}}
Да Объект эмоций, ключами являются баллы от -2 до 2. image - идентификатор изображения (uuid)
tags
{tag: string}[]
Массив тегов

Удаление персонажа

Метод позволяет удалить персонажа из системы - пометит датой удаления и исключит из выборки

{}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор персонажа

Список фонов

Метод вернет список доступных фонов для назначения в тренажеры

{}

Данные фона

Метод вернет детальную информацию о фоне по заданному идентификатору

{}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор фона

Создание фона

Метод позволяет создать новый фон с заданным набором параметров

{
    "name": "\u0412\u043e\u0434\u043e\u043f\u0430\u0434",
    "tags": []
}

Параметры запроса

Атрибут Тип Обязательное Описание
name*
string
Да Название фона
tags
{name: string}[]
Массив тегов

Обновление фона

Метод позволяет произвести редактирование фона с целью изменения его параметров

{
    "id": 2,
    "name": "\u0412\u043e\u0434\u043e\u043f\u0430\u0434",
    "tags": []
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор фона
name*
string
Да Название фона
tags
{name: string}[]
Массив тегов

Удаление фона

Метод позволяет удалить фон из системы - пометит датой удаления и исключит из выборки

{}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор фона

Смена статуса результата тренажера

Метод изменяет статус прохождения тренажера

{
    "status": "success"
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор процесса прохождения
status*
process | neutral | success | fail | reject
Да Статус прохождения

Сохранение результатов тренажера

Метод позволяет сохранять результаты ответов пользователя при прохождении тренажера

{
    "id": 44,
    "data": {
        "order": [
            7
        ],
        "answers": {
            "7": 6,
            "10": null,
            "11": null,
            "12": null,
            "13": null
        }
    },
    "user": 86,
    "dialog": "3",
    "result": 2,
    "isTraining": false
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор процесса прохождения
dialog*
int
Да Идентификатор тренажера
user*
int
Да Идентификатор исполнителя
data*
{answers: {questionId: result} | order: int[]}
Да Массив ответов пользователя. answers - объект ответов из идентификатора слайда и ответа в виде результата. order - отсортированный массив слайдов в порядке их прохождения
result
int | null
Итоговый результат
isTraining
boolean
В режиме обучения

Завершение прохождения тренажера

Метод позволяет завершить тренажер с пересчетом и сохранением результатов прохождения тренажера

{
    "status": "success",
    "isTraining": false
}

Параметры запроса

Атрибут Тип Обязательное Описание
status*
process | neutral | success | fail | reject | null
Да Статус
isTraining
boolean
В режиме обучения

Список историй прохождений

Метод вернет список результатов прохождений тренажеров пользователями на основе заданных фильтров

{
    "per": 20,
    "page": 1,
    "user": null,
    "dialog": null,
    "status": null
}

Параметры запроса

Атрибут Тип Обязательное Описание
per
number | null
Количество на страницу
page
number | null
Номер страницы
user
number | null
Идентификатор пользователя (исполнителя)
dialog
number | null
Идентификатор тренажера
status
string | null
Статус прохождения тренажера

Подробная история прохождения

Метод вернет подробную историю прохождения тренажера пользователем с возможностью отслеживания его результатов

{}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор процесса прохождения

Упрощённый список тренажеров

Метод вернет упрощённый список тренажеров для использования в селекторах и списках

{}

Комментарии

Содержит методы работы с комментариями и оценками пользователей

Список комментариев

Метод позволяет вернуть список комментариев из указанного модуля

{
    "per": 5,
    "rel": "user",
    "page": 1,
    "rel_id": 57
}

Параметры запроса

Атрибут Тип Обязательное Описание
per
id
Размер набора возвращаемых данных
page
id
Номер набора возвращаемых данных
rel*
media | media_links | media_albums | user | news | announcement | material | project | task | contest | kb
Да Источник, хранящий комментарий
rel_id*
int
Да id источника, хранящего комментарий

Создание комментария

Метод позволяет создать новый комментарий от пользователя в заданный модуль

{
    "pid": null,
    "rel": "news",
    "rel_id": 172,
    "message": "k"
}

Параметры запроса

Атрибут Тип Обязательное Описание
rel*
string
Да Тип модуля, в который добавляется комментарий
rel_id*
int
Да Идентификатор элемента модуля, в который добавляется комментарий
pid
int | null
Родительский комментарий
message*
string
Да Текст комментария
image
string | null
Идентификатор вложения файла изображения (uuid)
attachment
string | null
Идентификатор вложения (uuid)

Удаление комментария

Метод позволяет удалить комментарий. В зависимости от настроек системы, комментарий удалится сразу, либо в течение одного часа с момента пометки на удаление

{
    "id": 233
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор комментария

Восстановление комментария

Метод позволяет восстановить комментарий. Доступно только при настройках системы, когда комментарий удаляется через час после отметки

{
    "id": 233
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор комментария

Оценка комментария

Метод позволяет поставить оценку (лайк, дизлайк) за выбранный комментарий

{
    "rel": "news",
    "value": 1,
    "rel_id": 172
}

Параметры запроса

Атрибут Тип Обязательное Описание
rel*
string | comment
Да Тип модуля, который оценивается. comment - если оценивается комментарий
rel_id*
int
Да Идентификатор элемента оцениваемого модуля, либо идентификатор оцениваемого комментария, если rel = comment
value
int
Оценка (-1, 0, 1)

Уведомления

Содержит методы работы с уведомлениями пользователя

Список уведомлений

Вернет список всех доступных уведомлений на основе заданных фильтров

{
    "type": "task"
}

Параметры запроса

Атрибут Тип Обязательное Описание
type
string | new
Уведомления по конкретному модулю, либо все новые

Отметка о прочтении

Метод помечает выбранное уведомление как прочитанное пользователем

{
    "id": 2410
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор уведомления

Отметка о прочтении всех

Метод помечает все непрочитанные уведомления как прочитанные пользователем

{}

Удаление уведомления

Метод полностью удаляет выбранное уведомления из списка уведомлений пользователя

{
    "id": 2037
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор уведомления

Валюты

Содержит методы работы с кастомными валютами

Список валют

Метод вернет список доступных кастомных валют

{}

Создание валюты

Метод позволяет создать новую кастомную валюту в системе

{
    "id": null,
    "icon": null,
    "name": "\u0430",
    "order": 5,
    "active": 1,
    "is_ref": 0,
    "params": {},
    "is_gift": 0,
    "is_shop": 0,
    "is_reward": 0,
    "in_toolbar": 0,
    "description": ""
}

Параметры запроса

Атрибут Тип Обязательное Описание
name*
string
Да Наименование валюты
description
string | null
Описание валюты
icon
string | null
Идентификатор изображения (uuid)
params
any
Дополнительные параметры
active
boolean
Статус публикации
is_reward
boolean
Доступно в качестве наград
is_ref
boolean
Доступно в реферальной системе
is_shop
boolean
Доступно для оплаты в магазине
is_gift
boolean
Доступно для дарения сотрудникам
in_toolbar
boolean
Показывать в тулбаре
order
int
Порядок сортировки

Обновление валюты

Метод позволяет произвести редактирование существующей кастомной валюты и изменить её параметры

{
    "id": 6,
    "icon": null,
    "name": "\u0430",
    "order": 5,
    "active": 0,
    "is_ref": 0,
    "params": {},
    "is_gift": 0,
    "is_shop": 0,
    "is_reward": 0,
    "deleted_at": null,
    "in_toolbar": 0,
    "description": ""
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор валюты
name*
string
Да Наименование валюты
description
string | null
Описание валюты
icon
string | null
Идентификатор изображения (uuid)
params
any
Дополнительные параметры
active
boolean
Статус публикации
is_reward
boolean
Доступно в качестве наград
is_ref
boolean
Доступно в реферальной системе
is_shop
boolean
Доступно для оплаты в магазине
is_gift
boolean
Доступно для дарения сотрудникам
in_toolbar
boolean
Показывать в тулбаре
order
int
Порядок сортировки

Удаление валюты

Метод удалит кастомную валюту - установит отметку об удалении

{}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор валюты

Сортировка валют

Метод позволяет произвести изменение сортировки валют посредством передачи массива идентификаторов валют в отсортированном виде

{
    "ids": [
        29,
        2,
        1,
        31,
        3,
        4,
        5,
        6,
        7,
        8,
        9,
        10
    ]
}

Параметры запроса

Атрибут Тип Обязательное Описание
ids*
int[]
Да Отсортированный массив идентификаторов валют

Меню

Содержит методы работы с системным меню

Список меню

Метод вернет весь список доступных пунктов меню

{}

Создание пункта меню

Метод позволяет создать новый пункт меню или разделитель между пунктам меню

{
    "id": null,
    "url": "\u043a4",
    "name": "4\u043a",
    "type": "default",
    "order": 31,
    "active": 1,
    "params": {
        "acl": {
            "action": null,
            "module": null
        },
        "icon": null
    }
}

Параметры запроса

Атрибут Тип Обязательное Описание
pid
int | null
Идентификатор родительского пункта меню
name*
string
Да Наименование пункта меню
url
string
Конечная адресная ссылка, куда ведет пункт меню
type
default | divider
Тип пункта меню (обычный или разделитель)
params
Дополнительные параметры (см.ниже)
active
boolean
Статус публикации
order
int
Порядок сортировки
params.icon
string | null
Иконка пункта меню
params.external
boolean
Открывать ссылку в новом окне

Обновление пункта меню

Метод позволяет произвести редактирование существующего пукнта меню и изменить его параметры

{
    "id": 1,
    "url": "\/colleagues",
    "name": "\u041a\u043e\u043b\u043b\u0435\u0433\u0438",
    "type": "system",
    "order": 0,
    "active": 0,
    "params": {
        "acl": null,
        "icon": "colleagues"
    }
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор пункта меню
pid
int | null
Идентификатор родительского пункта меню
name*
string
Да Наименование пункта меню
url
string
Конечная адресная ссылка, куда ведет пункт меню
type
default | divider
Тип пункта меню (обычный или разделитель)
params
Дополнительные параметры (см.ниже)
active
boolean
Статус публикации
order
int
Порядок сортировки
params.icon
string | null
Иконка пункта меню
params.external
boolean
Открывать ссылку в новом окне

Удаление пункта меню

Метод позволяет удалить пункт меню из системы - будет установлена отметка об удалении. Системные пункты меню удалить нельзя.

{}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор пункт меню

Сортировка пунктов меню

Метод позволяет сохранить сортировку пунктов меню системы на основе переданного отсортированного массива их идентификаторов

{
    "ids": [
        29,
        2,
        1,
        31,
        3,
        4,
        5,
        6,
        7,
        8,
        9,
        10
    ]
}

Параметры запроса

Атрибут Тип Обязательное Описание
ids*
int[]
Да Массив идентификаторов пунктов меню в отсортированной последовательности

Переводы

Содержит методы работы с языковыми переводами интерфейса

Список переводов

Вернет языковые константы и переводы на основе выбранной локали

{
    "locale": "ru"
}

Параметры запроса

Атрибут Тип Обязательное Описание
locale
string
Искомый файл локализации

Сохранение переводов

Метод позволяет сохранить объект языковых строк пользовательских переводов

{
    "data": {
        "level": "\u0411\u0440\u0435\u043d\u0434",
        "levels": "\u0411\u0440\u0435\u043d\u0434\u044b",
        "addLevel": "\u0414\u043e\u0431\u0430\u0432\u0438\u0442\u044c \u0431\u0440\u0435\u043d\u0434",
        "directions": "\u0414\u0438\u0440\u0435\u043a\u0442\u043e\u0440\u0438\u0438",
        "profession": "\u0414\u0435\u043f\u0430\u0440\u0442\u0430\u043c\u0435\u043d\u0442",
        "levelsEmpty": "\u041d\u0435\u0442 \u0431\u0440\u0435\u043d\u0434\u043e\u0432",
        "achievements": "\u0410\u0447\u0438\u0432\u043a\u0438",
        "editingLevel": "\u0420\u0435\u0434\u0430\u043a\u0442\u0438\u0440\u043e\u0432\u0430\u043d\u0438\u0435 \u0431\u0440\u0435\u043d\u0434\u0430",
        "searchLevels": "\u041f\u043e\u0438\u0441\u043a \u0431\u0440\u0435\u043d\u0434\u043e\u0432",
        "creatingLevel": "\u0421\u043e\u0437\u0434\u0430\u043d\u0438\u0435 \u0431\u0440\u0435\u043d\u0434\u0430",
        "editingDirection": "\u0420\u0435\u0434\u0430\u043a\u0442\u0438\u0440\u043e\u0432\u0430\u0442\u044c \u0434\u0438\u0440\u0435\u043a\u0442\u043e\u0440\u0438\u044e",
        "levelSuccessSave": "\u0411\u0440\u0435\u043d\u0434 \u0441\u043e\u0445\u0440\u0430\u043d\u0451\u043d",
        "levelSuccessRemove": "\u0411\u0440\u0435\u043d\u0434 \u0443\u0434\u0430\u043b\u0451\u043d"
    },
    "locale": "ru"
}

Параметры запроса

Атрибут Тип Обязательное Описание
locale
string
Выбранный язык локализации
data
any
Объект данных строк переводов

Удаление переводов

Метод позволяет удалить весь пользовательский перевод выбранного языка

{
    "locale": "ru"
}

Параметры запроса

Атрибут Тип Обязательное Описание
locale
string
Выбранный язык локализации

Загрузки

Содержит методы загрузки файла на сервер системы, а также методы получения данных о файле

Загрузка файла

Метод позволяет загружать выбранный файл на сервер

{
    "file": null,
    "extra": 0,
    "private": 0,
    "immutable": 0
}

Параметры запроса

Атрибут Тип Обязательное Описание
file*
File
Да Объект загружаемого файла
private
boolean
Личный файл пользователя
immutable
boolean
Неудаляемый файл
extra
boolean
Вернуть данные в виде подробного объекта данных

Загрузка файла base64

Метод позволяет загружать выбранный файл на сервер в формате base64

{
    "extra": true,
    "uploads": {
        "image": {
            "data": "data:image\/png;base64,iVBORw0KGgoAAAANSUhEUgAAADMAAAAzCAYAAAA6oTAqAAAAAXNSR0IArs4c6QAADgJJREFUaEPtmguM1Md9x78z\/8e+b3dv7317cHfYcow54ADb2PjCwy8etgmt20pOValyTXpqHEyF+3CDShTHjeSqAdtKgLRSlDRNpaixkwLGdev4kQNMCZSnAfO4vRd3e7e799jd293\/\/z9Tzezu\/95gMFBV8kgn3X+ev8\/8fvOb38wsAYCdrU\/8KaHkB+L\/6ZLJGEorKnHvsmWYXd9gV+np7sLhAwfQE+n47qbd+\/56pvbXyv\/XVzb9XTwe\/ytFURAKBqBQApNx9PcPQFVVeP2Bzc+8tH37tfohBZAWAM8oqgZFVcE5ByEEppEDsywwzlHTOAd3NjVN6S9y\/jwunzn9DgV5a6bBNH8QXn8QGlWmrUIo\/4pp4XECSJBiEkDiS6Xk54zjvekaZ5kFwwIcigKy68+e5KKSAHG4PQC4BNCdLliGgWxmFGYue61JuWq5oyQIj79UCDVjPYsDjElRJiQBd5VmyJpcTrauEJDdz6\/nQhMOpwuKpiEzmkYuZ8DlckPVdHDLRDaThmVZchBRVyShOUpmFm68RALEEyidIORk4S2Ogxbjx8xM+kHOzIVU1Q6Aw6OqygJNd8i204EJ7Yk5EBNFfvD19VzIpAvb9PmgOxyIRDpQWloKl9OJoaEhgFKkk0lQSiBYikCqQiUQpRSqroNZTJpmMYkZE3W9gRB8wZDMLkKYHLAYP0QI+a3IzyUT0fRgf4xw8hVKySOUkl9YFg9oLs8q3Rv4DdGdJRol8xUyFUpoR2iP7Ni4huuaCsti8Li9aGhogMVMUKqgrzeK6EA\/XG4X0qmkFFzOjqpDGLOVy0lATVWliRKqIJtOIZfLSggBrmi6BHF7fRIkZ3EBIeQ\/RDj92z\/c+r3\/EB\/fb133XcZ5i8W4i1LSrBLSZjHuIZQsVCnd7K5u7ASwAsCXVUrmC7Mqmp8N89rX1nJmWqDOEhBvCI3hCjzy4CIcPX0Bh46fg84yyA32QtU1aZsiSZNUqFxLUjOEQNN1ONxeiCWbN9UsCLPgcLnh8PihOFwYp43\/BiN7iiCiz9efW\/0Uo0gxTnyUYBWz8BYl3K+pykqikF+0vrHnfVHvn1954WnO+FYBVNSSYRU08\/3WJ3g2m0P4niVoeOBR8FQCzfVBXOgbQTRDkek+jxPv7YXH44JpMRtIdCw0oqqKsDsJI5wGVTQJbGQzMHMZmGKiXD44SuSaOcQJtv3R3+x45\/N4FAEExls4sFKlpKnofaU3sxjDl+57EM2PrEMum0FFqRuDI1kYJkP3maNo27sHmkIlSMFEpBmJb5VSaXKEUmhaHqSYLNOCYRjQXL6PPeXVhzj4258XZHz\/P3550+8RQpYV88je72zk\/YkhGA4P7ijsI6HysuNNixb8WlQ60XYAH+39d2hC6EIK+v2LnS5Xix4IwVNeI3MFWCYexWisb8qkez3u\/TXVVbY2FM4O3PXVbx6eSTvciLfA4ovt8uwgWCoJy8jnaIryaxKed3xye3L2X17hpy9G8MGRk3YZIeSNHW+1PT\/TYJ\/89JUthODV0rsWoLxpqV0tdvYYBk7NKONYdxxbv\/TVl16eqX8jeeVVqihbqJLfZHl6CDydBM\/vDmDA83rd\/DduPszcRQDLAVRH7NPTNwUm3XfpVc3l3KI68\/sLG8nDFNOtg7nrHiA3DOg+xC5dvCkwxmD3q1RXt1BVHdNMKgnOPoNmBnMWekdNm9yt0rY6tzZjrDUQjy3PmeyJxnu\/jPrF9wNmBlAd6Dp1HJ+2\/SdcDh1Bf4ndXzqTw9DIiP09nEjsHx7N\/ZcFBgUUS9Y+jYYF98LMZuFwOaA6HU8AZLndwMyAi72rYGZUd7wJTT9gl1P1XaIHj8s1E6ibjcp7xoLIREc7omdOyboijBG7i1qwX5HX3tmF7v44Fj+8Dk3LH4OYQbFXnT30AQ7vfxNlfh\/ubJhtj9WXGMblSIeIgSDcyGhyGC6f3w5o5923DOGGOWCGCUVTQbW8RkRyl9fAGSyfsrzS0W5kBgfyZsh5a3nTwzvJ8R9t46H6BtTOb7YbxC5fRPfJvLNwlvihORzIDQ3a5ZGubvT0x3HnvGbc\/cBylFTVIRntwbmPP8TZE79Fud+LOfUTYS62R0REJ3dtAeMpCYAxJmO8WeFalPrcUwQWE+gPNyI0d7EEErAiCM7E+xA\/d1R6TtM0YVpW68I\/\/tZO0vn+j7knVIZgbdjuLBkbwGB3l\/z2lpWD53KInj1tl3d290iY2poahOsb4CqrkQP0tF9EZ88VlPt9aJhdZ9fvHYjjQnuksKFyCePzB2GYFoTtzG2+F+HGO\/LrQ4R2In7lwOhADzLJftQsbkHZXQthpEdhZnPoP3MYg5Gzsr6nIgy9pLR11kO\/s5Ow\/hOcTH\/MsIVJtF+eAtPV14\/Z4TBCAZ+cHYeuIzY0gssdnagsDU6A6e7tw8X2DqgOl5QyNTwEXyAo40HLyODBp\/4A97Q8mofJEqCwnwxFLyIZ70Kgbg68lbU2TLK7G5lkTProYP0d8NZUthK9fCdh8fOcIJMXnGqA6pyi7sSlc4ieOmrnd3R143JnF+rrwqiqKJfhjMPhwJVoVApdU1GBxvpZdn0BIyBFqMM4QyqZhNfry0cRzJwAUwQihAP6mCjCxIxMRq5NjYrYMO+2iYMDGsvD9J75kFfOypvEYP8A+jrz5jUhJePA4NjOnhgaRntHJ\/w+L2prqifADMQSqKmqQCgYHDPLniuISBhFxnejmQxcLqc0JcYsCdO0YvXUccflFE1MOAfN6QSxVBAqQESlAsw7u77FZ9+d92TxK124ciFvi+NTqMSLqlDAzkqm0+ju7Zfhf+Od8xCsnIPkQCfOf3IEOcNAXU0NfF5xas0nAR7p7JLBqAh7RkczcDgdoCAwjByWPvn7WPjwuulhiAZmGDBGk1Ir0tupeY9XjBBsmJ9te47rkwJE0auIdg3TlC5ZgIyHicYT6LwSRYnHhbrGufAEZyEd70L7+WPoGxjArHAY9XW1tnCXI51o7+yUpihSNpuVYOLoIP5f8vgGLHr0SVBVsT1WsTHVXeCMwRQRgDhLFbYIecYtnHQ5Y616ILyT\/GzbRnk4Gw8g\/hcghmHKEL+uskz+FVNPdAAD8QTqqsrhcrnkTDudDuRyOVyKdKDEV4I549aMyBNAmqbKPUs4DHF8EG5ZHNGXrN6A5pVr5HfxFFscS6EWKBGOwgAhVAKLZDEFjBeCX86LMHnNCE0IW84ZY5FAscPaihDmhKtsmMGhYQyOjKA04EeJ12vnj6RSEGVejxtBv9\/OFzDCMQizlOtEHB2UvCBiDS1dux6LVq2FxSiKwtuNrYw40k41QcUJKAUPwXkr8TXsJD\/Z+qw8PlqmOS2IKJsMI\/KSqbTc9Ep8E2HEzI4HFHXjg0NynxkaGraFKl6GBAJ+3P\/oY5iz5IG8cFZ2gvAyhJHnpTGeqXmslZQu3El2bXlm2\/Qrbyw3XF6GxnDltapNW+4rrVjucDhXRCLt7390sO2D8ZV0quKOhnosWrUSZYVNc3InIiAXMRAdi3BkkD4hj9E9pLzpyGe7K7ohjHwj\/umHy1nOWsGyxvvaoscmwHyObqdtesthbrbAV+vvC5jbOdvXM9YXmrme2bqddb\/QzO2c7esZ6wvNiNl67bk1yznlnk279u+7ntm7lXVvWDPbN65+kYCUbdr99l8WBXz9T9asYgrRN+3at\/9WCj1T3zcEI7VCyEpO8N4Lu\/Z9WOx8+8Y1LxHAvWn329\/8fwOz47k1WwghFd\/Yve8vxgu9fePa+wnYahD68f+Fdm5IMzta1y0mJlvHQI6+8MN9e4pAO762+mFw2sIs\/u7mf3q77XZrZ0aY59cvayFgGwB89NovD745WTABZBmm+8\/\/8Z2PimX\/8Ozj9ylUVTf9cO\/Y1eltJJoZZsNDC8CtlSA49vqbByeE7md\/+p2VIOSpopz\/88kFHDx+zhabE7z72i\/bZvRyPBNfC4XnL8rE3UpyGEjl76KpODxq9FckOE++D11PuiEzK77PFAc6+skFHDoxdqtDCF7e8daBrTMJwo3Yt8EhnYQ42\/PkCEhuVFaXJ0rKX1SqF\/z91UB4NvY0KOklWulvivUmwHxjw7KHmMWq3\/jVwZ9fraObCWOMZsBTI1AK53x5u6rwF5XKa8AY\/SvAlBhxlNqvZBNgvr7+gSZCUTrZrCaD3UwYcReGzDCQScsnC2FmROUvktDVYaab7M9kZjxxcgXAf7fYQd+pk82DnRH7YVS8ifYOJOz+Az7PkVnV5YeKGaG7lyA0d8m48bl4OxzLsHKw0mlYWROKU4PicrZBcR6zGxDyb0QLyqfzq6XPBhM7\/gII+V6xo\/jlS+g\/d0Z+yicFc+r1lPg1kvgTSTxJlM1dIteHuGoRt5LJnghSfeJ3CvkkNCSeK8S92NhNJeCrbYC7rHYzcYau\/auma9GKcj4Jpv\/CefScOiGbessr4KuqntJNMtqHkb5emV85fynK714EczQLRdeQSfQiduYIkv29006EaFOcDFeoCg5\/cHPV0g23BiY9mIB4wxHJHQjCGxq77SxSpRJxpOIx+emprIfur4KZyUJzOTFw7ij6Th6Gt6wRvurCa4GwEX3sV03DXZeQ6s1rjnO+ufnZb98aGDmAeCcyAeF9yLg7rWk1rftgWLoNk00lkYr1wVNSBrc3fx+Xf5oYaz3ScQWjg1GAE\/AsNlc9tPImwSQj+TUjbhvN\/H7AiQOgLoBlQXg+D+LKdJr3HcsiMHMMhBKoLieo7pXXtGCj9sPSeBDZl1F4eJJj8c1K8Npr5n8BormDhOKcgZgAAAAASUVORK5CYII=",
            "name": "Skin781.png"
        }
    }
}

Параметры запроса

Атрибут Тип Обязательное Описание
uploads*
any
Да Объект загружаемого файла в формате base64, должен включать в себя data и name
private
boolean
Личный файл пользователя
immutable
boolean
Неудаляемый файл
extra
boolean
Вернуть данные в виде подробного объекта данных

Данные файла

Метод вернет данные файла по идентификатору

{
    "id": "66e9736e-e205-47fc-a43c-246ee198307f"
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
string
Да Идентификатор (uuid) изображения

Скачивание файла

Метод вернет ссылку на итоговый файл и вызовет процесс скачивания

{
    "id": "00224964-fdbe-4add-aca4-d12a23a63a1c"
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
string
Да Идентификатор (uuid) изображения

Ссылка на файл

Метод вернет ссылку на итоговый файл и откроет её в новом окне

{
    "id": "00224964-fdbe-4add-aca4-d12a23a63a1c"
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
string
Да Идентификатор (uuid) изображения

Транзакции

Содержит методы работы с транзакциями внутри системы

Список транзакций

Метод вернет список транзакций на основе заданных фильтров для текущего пользователя, если не указан другой

{
    "per": 20,
    "page": 1,
    "type": "score",
    "user": null,
    "currencyId": null
}

Параметры запроса

Атрибут Тип Обязательное Описание
per
int | null
Количество на страницу
page
int | null
Номер страницы
type
coins | score | second | exp | currency | null
Тип транзакции
currencyId
int | null
Идентификатор кастомной валюты в случае, если type передан как currency
user
int | null
Идентификатор пользователя

Список всех транзакций

Метод вернет список всех транзакций на основе заданных фильтров

{
    "per": 20,
    "page": 1,
    "type": "score",
    "user": null,
    "currencyId": null
}

Параметры запроса

Атрибут Тип Обязательное Описание
per
int | null
Количество на страницу
page
int | null
Номер страницы
type
coins | score | second | exp | currency | null
Тип транзакции
currencyId
int | null
Идентификатор кастомной валюты в случае, если type передан как currency
user
int | null
Идентификатор пользователя
date_begin
string | null
Дата начала выборки
date_end
string | null
Дата конца выборки

Список рефералов

Метод вернет список рефералов текущего пользователя

{}

Теги

Содержит методы работы с тегами

Список тегов

Вернет список тегов на основе параметров фильтрации

{
    "objectType": "task"
}

Параметры запроса

Атрибут Тип Обязательное Описание
objectType*
user | task | knowledge | content | media | dt_character | dt_background | all
Да Тип связанного элемента, для которого необходимо получить теги
objectId
number | null
Идентификатор элемента

Добавление тега

Метод позволяет создать новый тег в списке

{
    "name": "\u043a\u0430\u043a"
}

Параметры запроса

Атрибут Тип Обязательное Описание
name
string
Наименование тега

Обновление тега

Метод позволяет изменить тег в списке

{
    "id": 32,
    "name": "\u043a\u0430\u043a"
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
number | null
Да Идентификатор тега
name
string
Наименование тега

Удаление тега

Метод удаляет тег из базы данных

{}

Чекин

Содержит методы работы с настройками CheckIn и отслеживанием посещений пользователя

Получение параметров

Метод вернет набор параметров для CheckIn

{}

Сохранение параметров

Метод позволяет сохранить новый набор параметров для CheckIn

{
    "ips": [],
    "active": true,
    "ignoreIP": true,
    "work_end": "17:45",
    "score_add": 5,
    "score_max": 25,
    "score_min": 5,
    "only_first": true,
    "rating_ids": [],
    "work_begin": "06:15",
    "reward_type": "currency:3"
}

Параметры запроса

Атрибут Тип Обязательное Описание
active*
boolean
Да Активность CheckIn
only_first*
boolean
Да Автоначисление за вход
ignoreIP*
boolean
Да Игнорировать проверку по IP
ips*
string[]
Да Массив допустимых IP адресов для проверки
score_add*
number
Да Количество ежедневных начислений
score_min*
number
Да Начальное количество начислений
score_max*
number
Да Максимальное количество начислений
work_begin*
string
Да Начало рабочего дня
work_end*
string
Да Конец рабочего дня
reward_type*
coins | score | exp | second | currency | string | null
Да Тип награды
rating_ids*
int[]
Да Массив идентификаторов рейтингов для начисления по рейтингам

Проверка посещения

Метод позволяет отметить посещение системы пользователем

{
    "confirm": false
}

Параметры запроса

Атрибут Тип Обязательное Описание
confirm
boolean
Подтверждение посещения

Идентификаторы

Внешние идентификаторы

Список внешних идентификаторов

Метод вернет список идентификаторов на основе параметров

{
    "obj_id": "1",
    "ext_name": "b25",
    "obj_name": "user"
}

Удаление внешнего идентификатора

Метод удаляет внешний идентификатор

{
    "id": "16"
}

Сеттер индификатора

Обновляем или создает новый

{
    "obj_id": "1",
    "ext_name": "b25",
    "obj_name": "user",
    "ext_value": "234"
}

Компетенции

Содержит методы работы с компетенциями пользователей

Список категорий

Метод вернет список категорий компетенций

{
    "per": 10,
    "pages": 1
}

Параметры запроса

Атрибут Тип Обязательное Описание
per
int | null
Количество на страницу
page
int | null
Номер страницы

Данные категории

Метод вернет полную информацию о категории на основе переданного идентификатора

{}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор категории

Создание категории

Метод позволяет создать новую категорию на основе переданных данных

{
    "name": "\u041d\u0430\u0431\u043e\u0440 \u043a\u043e\u043c\u043f\u0435\u0442\u0435\u043d\u0446\u0438\u0439 \u0442\u0435\u0445\u043d\u043e\u043b\u043e\u0433\u0430",
    "params": {
        "cl1": "#dfdfdf",
        "cl2": "#CB7D7D",
        "cl3": "#B6DFB6",
        "cl4": "#0000ff"
    },
    "publish": 1,
    "description": "\u041a\u0430\u043a\u043e\u0435-\u0442\u043e \u043e\u043f\u0438\u0441\u0430\u043d\u0438\u0435"
}

Параметры запроса

Атрибут Тип Обязательное Описание
name*
string
Да Название категории
description
string | null
Описание категории
publish
int
Статус публикации
params
{cl1: string | cl2: string | cl3: string | cl4: string}
Объект цветов статусов компетенций

Обновление категории

Метод позволяет произвести редактирование категории с целью изменения её параметров

{
    "id": 1,
    "name": "\u041d\u0430\u0431\u043e\u0440 \u043a\u043e\u043c\u043f\u0435\u0442\u0435\u043d\u0446\u0438\u0439 \u0442\u0435\u0445\u043d\u043e\u043b\u043e\u0433\u0430",
    "params": {
        "cl1": "#dfdfdf",
        "cl2": "#CB7D7D",
        "cl3": "#B6DFB6",
        "cl4": "#0000ff"
    },
    "publish": 1,
    "description": "\u041a\u0430\u043a\u043e\u0435-\u0442\u043e \u043e\u043f\u0438\u0441\u0430\u043d\u0438\u0435"
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор категории
name*
string
Да Название категории
description
string | null
Описание категории
publish
int
Статус публикации
params
{cl1: string | cl2: string | cl3: string | cl4: string}
Объект цветов статусов компетенций

Удаление категории

Метод позволяет удалить категорию компетенций и переместить все компетенции из неё в другую категорию

{
    "category": 1
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор категории
category*
int
Да Идентификатор категории, в которую следует перенести компетенции из удаляемой категории

Упрощенный список категорий

Метод вернет упрощенный список категорий компетенций, удобно использовать для списков и селекторов

{}

Список компетенций

Метод вернет список компетенций на основе заданных параметров

{
    "per": 20,
    "page": 1,
    "category": 2,
    "position": 1
}

Параметры запроса

Атрибут Тип Обязательное Описание
per
int | null
Количество на страницу
page
int | null
Номер страницы
category
int | null
Идентификатор категории
position
int | null
Идентификатор должности
publish
int | null
Статус публикации

Данные компетенции

Метод вернет полную информацию о компетенции по заданному идентификатору

{}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор компетенции

Создание компетенции

Метод позволяет создать новую компетенцию с заданными параметрами

{
    "name": " \u0423\u043f\u0440\u0430\u0432\u043b\u0435\u043d\u0438\u0435 \u043a\u043e\u043d\u0444\u043b\u0438\u043a\u0442\u0430\u043c\u0438",
    "publish": 1,
    "category": 2,
    "criteria": [
        {
            "text": "\u041b\u044e\u0431\u0438\u0442 \u0440\u0430\u0431\u043e\u0442\u0430\u0442\u044c \u0441 \u043f\u0435\u0440\u0441\u043e\u043d\u0430\u043b\u043e\u043c",
            "order": 1,
            "publish": 1
        },
        {
            "text": "\u0417\u043d\u0430\u0435\u0442 \u0442\u043e\u043b\u043a \u0432\u043e \u0432\u0441\u0451\u043c",
            "order": 2,
            "publish": 1
        }
    ],
    "positions": [
        {
            "id": 1,
            "level": 1
        }
    ],
    "description": "\u0421\u043f\u043e\u0441\u043e\u0431\u043d\u043e\u0441\u0442\u044c \u043f\u0440\u0435\u0434\u043e\u0442\u0432\u0440\u0430\u0449\u0430\u0442\u044c \u0432\u043e\u0437\u043d\u0438\u043a\u043d\u043e\u0432\u0435\u043d\u0438\u0435 \u043a\u043e\u043d\u0444\u043b\u0438\u043a\u0442\u043d\u044b\u0445 \u0441\u0438\u0442\u0443\u0430\u0446\u0438\u0439 \u0431\u0435\u0437 \u0443\u0449\u0435\u0440\u0431\u0430 \u0441\u043e\u0431\u0441\u0442\u0432\u0435\u043d\u043d\u044b\u043c \u0438\u043d\u0442\u0435\u0440\u0435\u0441\u0430\u043c. \u0421\u043f\u043e\u0441\u043e\u0431\u043d\u043e\u0441\u0442\u044c \u043f\u0440\u0438 \u043c\u0435\u0436\u043b\u0438\u0447\u043d\u043e\u0441\u0442\u043d\u043e\u043c \u0438\u043b\u0438 \u0433\u0440\u0443\u043f\u043f\u043e\u0432\u043e\u043c \u043a\u043e\u043d\u0444\u043b\u0438\u043a\u0442\u0435 \u043a\u043e\u043d\u0441\u0442\u0440\u0443\u043a\u0442\u0438\u0432\u043d\u043e \u0438 \u043f\u0440\u043e\u0434\u0443\u043a\u0442\u0438\u0432\u043d\u043e \u0432\u044b\u0441\u0442\u0440\u0430\u0438\u0432\u0430\u0442\u044c \u0442\u0430\u043a\u0442\u0438\u043a\u0443 \u0432\u0437\u0430\u0438\u043c\u043e\u0434\u0435\u0439\u0441\u0442\u0432\u0438\u044f \u0441 \u043e\u043f\u043f\u043e\u043d\u0435\u043d\u0442\u043e\u043c, \u043d\u0430\u043f\u0440\u0430\u0432\u043b\u0435\u043d\u043d\u0443\u044e \u043d\u0430 \u0434\u043e\u0441\u0442\u0438\u0436\u0435\u043d\u0438\u0435 \u0446\u0435\u043b\u0435\u0439 \u043e\u0440\u0433\u0430\u043d\u0438\u0437\u0430\u0446\u0438\u0438 \u0431\u0435\u0437 \u0443\u0449\u0435\u0440\u0431\u0430 \u043f\u043e\u0442\u0440\u0435\u0431\u043d\u043e\u0441\u0442\u0435\u0439 \u0434\u0440\u0443\u0433\u043e\u0439 \u0441\u0442\u043e\u0440\u043e\u043d\u044b."
}

Параметры запроса

Атрибут Тип Обязательное Описание
category*
int
Да Идентификатор категории
name*
string
Да Название компетенции
description
string | null
Описание компетенции
image
string | null
Идентификатор вложения изображения (uuid)
publish*
int
Да Статус публикации
criteria
{text: string; publish: int; order: int}[]
Массив критериев (описание, статус публикации, порядок)
positions
{id: int; level: int}[]
Массив соответствующих должностей (идентификатор должности, соответствующий ей уровень от 1 до 4)

Обновление компетенции

Метод позволяет произвести редактирование компетенции с целью изменения её параметров

{
    "id": 10,
    "name": " \u0423\u043f\u0440\u0430\u0432\u043b\u0435\u043d\u0438\u0435 \u043a\u043e\u043d\u0444\u043b\u0438\u043a\u0442\u0430\u043c\u0438",
    "publish": 1,
    "category": 2,
    "criteria": [
        {
            "id": 13,
            "text": "\u041b\u044e\u0431\u0438\u0442 \u0440\u0430\u0431\u043e\u0442\u0430\u0442\u044c \u0441 \u043f\u0435\u0440\u0441\u043e\u043d\u0430\u043b\u043e\u043c",
            "order": 1,
            "publish": 1
        },
        {
            "id": 15,
            "text": "\u0417\u043d\u0430\u0435\u0442 \u0442\u043e\u043b\u043a \u0432\u043e \u0432\u0441\u0451\u043c",
            "order": 2,
            "publish": 1
        }
    ],
    "positions": [
        {
            "id": 1,
            "level": 1
        }
    ],
    "description": "\u0421\u043f\u043e\u0441\u043e\u0431\u043d\u043e\u0441\u0442\u044c \u043f\u0440\u0435\u0434\u043e\u0442\u0432\u0440\u0430\u0449\u0430\u0442\u044c \u0432\u043e\u0437\u043d\u0438\u043a\u043d\u043e\u0432\u0435\u043d\u0438\u0435 \u043a\u043e\u043d\u0444\u043b\u0438\u043a\u0442\u043d\u044b\u0445 \u0441\u0438\u0442\u0443\u0430\u0446\u0438\u0439 \u0431\u0435\u0437 \u0443\u0449\u0435\u0440\u0431\u0430 \u0441\u043e\u0431\u0441\u0442\u0432\u0435\u043d\u043d\u044b\u043c \u0438\u043d\u0442\u0435\u0440\u0435\u0441\u0430\u043c. \u0421\u043f\u043e\u0441\u043e\u0431\u043d\u043e\u0441\u0442\u044c \u043f\u0440\u0438 \u043c\u0435\u0436\u043b\u0438\u0447\u043d\u043e\u0441\u0442\u043d\u043e\u043c \u0438\u043b\u0438 \u0433\u0440\u0443\u043f\u043f\u043e\u0432\u043e\u043c \u043a\u043e\u043d\u0444\u043b\u0438\u043a\u0442\u0435 \u043a\u043e\u043d\u0441\u0442\u0440\u0443\u043a\u0442\u0438\u0432\u043d\u043e \u0438 \u043f\u0440\u043e\u0434\u0443\u043a\u0442\u0438\u0432\u043d\u043e \u0432\u044b\u0441\u0442\u0440\u0430\u0438\u0432\u0430\u0442\u044c \u0442\u0430\u043a\u0442\u0438\u043a\u0443 \u0432\u0437\u0430\u0438\u043c\u043e\u0434\u0435\u0439\u0441\u0442\u0432\u0438\u044f \u0441 \u043e\u043f\u043f\u043e\u043d\u0435\u043d\u0442\u043e\u043c, \u043d\u0430\u043f\u0440\u0430\u0432\u043b\u0435\u043d\u043d\u0443\u044e \u043d\u0430 \u0434\u043e\u0441\u0442\u0438\u0436\u0435\u043d\u0438\u0435 \u0446\u0435\u043b\u0435\u0439 \u043e\u0440\u0433\u0430\u043d\u0438\u0437\u0430\u0446\u0438\u0438 \u0431\u0435\u0437 \u0443\u0449\u0435\u0440\u0431\u0430 \u043f\u043e\u0442\u0440\u0435\u0431\u043d\u043e\u0441\u0442\u0435\u0439 \u0434\u0440\u0443\u0433\u043e\u0439 \u0441\u0442\u043e\u0440\u043e\u043d\u044b."
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор компетенции
category*
int
Да Идентификатор категории
name*
string
Да Название компетенции
description
string | null
Описание компетенции
image
string | null
Идентификатор вложения изображения (uuid)
publish*
int
Да Статус публикации
criteria
{id: int; text: string; publish: int; order: int}[]
Массив критериев (идентификатор критерия, описание, статус публикации, порядок)
positions
{id: int; level: int}[]
Массив соответствующих должностей (идентификатор должности, соответствующий ей уровень от 1 до 4)

Удаление компетенции

Метод позволяет удалить компетенцию из системы

{}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор компетенции

Публикация компетенции

Метод позволяет изменить статус публикации компетенции

{
    "publish": 1
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор компетенции
publish*
int
Да Статус публикации

Матрицы компетенций

Метод вернет список пользователей, которым назначены компетенции на основе заданных фильтров

{
    "per": 20,
    "page": 1,
    "query": ""
}

Параметры запроса

Атрибут Тип Обязательное Описание
per
int | null
Количество на страницу
page
int | null
Номер страницы
company_role
int | null
Идентификатор роли
department
int | null
Идентификатор отдела
team
int | null
Идентификатор команды
company_position
int | null
Идентификатор должности
query
string | null
Поисковая фраза

Матрица компетенций пользователя

Метод вернет результирующие данные матрицы компетенций для конкретного пользователя

{}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор пользователя

Матрица компетенций должности

Метод вернет результирующие данные матрицы компетенций для конкретной должности

{}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор должности

Изменение уровня компетенции пользователя

Метод позволяет изменять текущий уровень владения компетенцией для конкретного пользователя

{
    "level": 4,
    "competency": 10,
    "isNotifyClaim": false
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор пользователя
competency*
int
Да Идентификатор компетенции
level*
int
Да Новый уровень владения (от 1 до 4)
isNotifyClaim*
boolean
Да Уведомить пользователя об изменении уровня

Оценка 360

Содержит методы работы с оценкой 360 внутри компании

Список периодов

Метод вернет список всех созданных периодов

{
    "per": 10,
    "page": 1,
    "status": null
}

Параметры запроса

Атрибут Тип Обязательное Описание
per
int | null
Количество на страницу
page
int | null
Номер страницы
status
draft | started | finished | null
Статус

Данные периода

Метод вернет детальную информацию о периоде по заданному идентификатору

{}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор периода

Создание периода

Метод позволяет создать новый период на основе заданных параметров

{
    "name": "\u041e\u0446\u0435\u043d\u043a\u0430 \u0441 \u0434\u043e\u043f\u043e\u043b\u043d\u0438\u0442\u0435\u043b\u044c\u043d\u044b\u043c\u0438 \u043f\u0430\u0440\u0430\u043c\u0435\u0442\u0440\u0430\u043c\u0438",
    "params": {
        "amount": 3,
        "period": "monthly",
        "typeInvite": "user",
        "durationAwait": 172800,
        "maxSelectAssoc": 8,
        "minSelectAssoc": 3
    },
    "members": [
        {
            "id": 86,
            "type": "user"
        },
        {
            "id": 41,
            "type": "department"
        }
    ],
    "duration": 345600,
    "started_at": "2025-10-30"
}

Параметры запроса

Атрибут Тип Обязательное Описание
name*
string
Да Название периода
duration*
int
Да Длительность процесса оценки
started_at
string | null
Дата автоматического запуска
params
any
Объект параметров периода. period - периодичность (ежемесячно monthly, ежеквартально quarterly, ежегодно yearly), amount - количество (сколько месяцев, кварталов, лет между оценками), typeInvite - тип назначения оценщиков (автоматически auto, пользователем user, оба варианта both), minSelectAssoc - минимальное количество оценщиков, maxSelectAssoc - максимальное количество оценщиков, durationAwait - количество времени отведенное на назначение оценщиков
members
{id: int | type: user | department | team | position}[]
Массив оцениваемых, где id - идентификатор элемента (оцениваемого), type - тип элемента

Обновление периода

Метод позволяет изменить цикл с целью редактирования его параметров

{
    "id": 1,
    "name": "\u041e\u0446\u0435\u043d\u043a\u0430 \u0441 \u0434\u043e\u043f\u043e\u043b\u043d\u0438\u0442\u0435\u043b\u044c\u043d\u044b\u043c\u0438 \u043f\u0430\u0440\u0430\u043c\u0435\u0442\u0440\u0430\u043c\u0438",
    "params": {
        "amount": 3,
        "period": "monthly",
        "typeInvite": "user",
        "durationAwait": 172800,
        "maxSelectAssoc": 8,
        "minSelectAssoc": 3
    },
    "members": [
        {
            "id": 86,
            "type": "user"
        },
        {
            "id": 41,
            "type": "department"
        }
    ],
    "duration": 345600,
    "started_at": "2025-10-30"
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор периода
name*
string
Да Название периода
duration*
int
Да Длительность процесса оценки
started_at
string | null
Дата автоматического запуска
params
any
Объект параметров периода. period - периодичность (ежемесячно monthly, ежеквартально quarterly, ежегодно yearly), amount - количество (сколько месяцев, кварталов, лет между оценками), typeInvite - тип назначения оценщиков (автоматически auto, пользователем user, оба варианта both), minSelectAssoc - минимальное количество оценщиков, maxSelectAssoc - максимальное количество оценщиков, durationAwait - количество времени отведенное на назначение оценщиков
members
{id: int | type: user | department | team | position}[]
Массив оцениваемых, где id - идентификатор элемента (оцениваемого), type - тип элемента

Удаление периода

Метод позволяет удалить период - пометит датой удаления и исключит из выборки

{}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор периода

Смена статуса периода

Метод позволяет произвести изменение статуса периода по его идентификатору

{
    "status": "start"
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор периода
status*
start | stop | archive | skip
Да Статус

Список циклов

Метод вернем список заведенных циклов на основе созданных периодов

{
    "per": 20,
    "page": 1,
    "status": "started"
}

Параметры запроса

Атрибут Тип Обязательное Описание
status
started | finished | null
Статус
executor
int | null
Идентификатор оценщика (по умолчанию текущий пользователь)

Упрощенный список циклов

Метод вернет упрощенный список заведенных циклов для селекторов и списков

{}

Список своих циклов

Метод вернет список циклов, в которых текущий пользователь является оцениваемым

{
    "per": 20,
    "page": 1,
    "status": "started"
}

Параметры запроса

Атрибут Тип Обязательное Описание
per
int | null
Количество на страницу
page
int | null
Номер страницы
status
started | finished | null
Статус
user
int | null
Идентификатор оцениваемого (по умолчанию текущий пользователь)

Данные собственного цикла

Метод вернет детальную информацию о выбранном цикле текущего оцениваемого пользователя

{
    "per": 20,
    "page": 1
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор цикла
status
started | finished | null
Статус
user
int | null
Идентификатор оцениваемого (по умолчанию текущий пользователь)
per
int | null
Количество на страницу
page
int | null
Номер страницы

Назначение оценщиков оцениваемым

Метод позволяет задать список оценщиков для выбранного цикла самим оцениваемым

{
    "ids": [
        87,
        88,
        89
    ]
}

Параметры запроса

Атрибут Тип Обязательное Описание
ids*
int[]
Да Массив идентификаторов оценщиков (пользователей)
user
int | null
Идентификатор оцениваемого (по умолчанию текущий пользователь)

Данные цикла оценки

Метод вернет детальную информацию о выбранном цикле оценки

{}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор оценки

Список оцениваемых в оценке

Метод вернет список оцениваемых в рамках выбранного цикла для текущего оценщика

{
    "per": 20,
    "page": 1
}

Параметры запроса

Атрибут Тип Обязательное Описание
user
int | null
Идентификатор оцениваемого
executor
int | null
Идентификатор оценщика
status
new | start | complete | skip | null
Статус
per
int | null
Количество на страницу
page
int | null
Номер страницы

Данные процесса оценки

Метод вернет состояние оценки для выбранного процесса оценки

{}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор процесса оценки

Смена статуса процесса оценки

Метод позволяет изменить статус выбранного процесса оценки для текущего пользователя

{
    "data": [
        {
            "id": 10,
            "name": " \u0423\u043f\u0440\u0430\u0432\u043b\u0435\u043d\u0438\u0435 \u043a\u043e\u043d\u0444\u043b\u0438\u043a\u0442\u0430\u043c\u0438",
            "criteria": [
                {
                    "id": 13,
                    "name": "\u041b\u044e\u0431\u0438\u0442 \u0440\u0430\u0431\u043e\u0442\u0430\u0442\u044c \u0441 \u043f\u0435\u0440\u0441\u043e\u043d\u0430\u043b\u043e\u043c",
                    "value": 3
                },
                {
                    "id": 15,
                    "name": "\u0417\u043d\u0430\u0435\u0442 \u0442\u043e\u043b\u043a \u0432\u043e \u0432\u0441\u0451\u043c",
                    "value": 2
                }
            ]
        },
        {
            "id": 11,
            "name": " \u0423\u043c\u0435\u043d\u0438\u0435 \u0440\u0430\u0431\u043e\u0442\u0430\u0442\u044c \u0432 \u043a\u043e\u043c\u0430\u043d\u0434\u0435",
            "criteria": [
                {
                    "id": 16,
                    "name": "\u0423\u043c\u0435\u0435\u0442 \u0440\u0430\u0431\u043e\u0442\u0430\u0442\u044c \u0441 \u043f\u0435\u0440\u0441\u043e\u043d\u0430\u043b\u043e\u043c",
                    "value": 3
                },
                {
                    "id": 17,
                    "name": "\u0418\u043c\u0435\u0435\u0442 \u0430\u0432\u0442\u043e\u0440\u0438\u0442\u0435\u0442",
                    "value": 1
                }
            ]
        },
        {
            "id": 12,
            "name": " \u0423\u043c\u0435\u043d\u0438\u0435 \u043e\u043a\u0430\u0437\u044b\u0432\u0430\u0442\u044c \u0432\u043b\u0438\u044f\u043d\u0438\u0435 \u043d\u0430 \u043b\u044e\u0434\u0435\u0439",
            "criteria": [
                {
                    "id": 18,
                    "name": "\u0423\u043c\u0435\u0435\u0442 \u0440\u0430\u0431\u043e\u0442\u0430\u0442\u044c \u0441 \u043f\u0435\u0440\u0441\u043e\u043d\u0430\u043b\u043e\u043c",
                    "value": 2
                },
                {
                    "id": 19,
                    "name": "\u0418\u043c\u0435\u0435\u0442 \u0430\u0432\u0442\u043e\u0440\u0438\u0442\u0435\u0442",
                    "value": 0
                }
            ]
        },
        {
            "id": 14,
            "name": " \u041c\u0435\u0436\u0444\u0443\u043d\u043a\u0446\u0438\u043e\u043d\u0430\u043b\u044c\u043d\u043e\u0435 \u0432\u0437\u0430\u0438\u043c\u043e\u0434\u0435\u0439\u0441\u0442\u0432\u0438\u0435",
            "criteria": [
                {
                    "id": 20,
                    "name": "\u0423\u043c\u0435\u0435\u0442 \u0440\u0430\u0431\u043e\u0442\u0430\u0442\u044c \u0441 \u043f\u0435\u0440\u0441\u043e\u043d\u0430\u043b\u043e\u043c",
                    "value": 4
                },
                {
                    "id": 21,
                    "name": "\u0418\u043c\u0435\u0435\u0442 \u0430\u0432\u0442\u043e\u0440\u0438\u0442\u0435\u0442",
                    "value": 4
                }
            ]
        },
        {
            "id": 15,
            "name": " \u0422\u0430\u0439\u043c-\u043c\u0435\u043d\u0435\u0434\u0436\u043c\u0435\u043d\u0442",
            "criteria": [
                {
                    "id": 22,
                    "name": "\u0423\u043c\u0435\u0435\u0442 \u0440\u0430\u0431\u043e\u0442\u0430\u0442\u044c \u0441 \u043f\u0435\u0440\u0441\u043e\u043d\u0430\u043b\u043e\u043c",
                    "value": 1
                },
                {
                    "id": 23,
                    "name": "\u0418\u043c\u0435\u0435\u0442 \u0430\u0432\u0442\u043e\u0440\u0438\u0442\u0435\u0442",
                    "value": 3
                }
            ]
        }
    ],
    "status": "complete"
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор процесса оценки
status*
new | start | complete | skip
Да Статус
data
any[]
Массив данных результата оценки

Список историй оценок

Метод вернет список историй оценок

{
    "per": 20,
    "page": 1
}

Параметры запроса

Атрибут Тип Обязательное Описание
status
started | finished | null
Статус
loop
int | null
Идентификатор цикла
user
int | null
Идентификатор оцениваемого

Детали истории оценки

Метод вернет детальную информацию по выбранному элементу истории оценки

{}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор элемента истории

Список результатов оценок

Метод вернет список результатов оценок

{
    "per": 20,
    "page": 1,
    "status": "started"
}

Параметры запроса

Атрибут Тип Обязательное Описание
status
started | finished | null
Статус
loop
int | null
Идентификатор цикла
user
int | null
Идентификатор оцениваемого

Детали результата оценки

Метод вернет детальную информацию по выбранному элементу результата оценки

{}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор элемента результата

Индивидуальный план развития

Содержит методы работы с функционалом постановки индивидуальных планов развития сотрудников

Список планов

Вернет список планов на основе заданных фильтров

{
    "per": 20,
    "rel": "my",
    "page": 1,
    "status": null,
    "executor": 13,
    "competency": null
}

Параметры запроса

Атрибут Тип Обязательное Описание
per
int | null
Количество на страницу
page
int | null
Номер страницы
status
draft | approval | revision | active | work | complete | null
Статус плана
executor
int | null
Идентификатор исполнителя плана
competency
int | null
Идентификатор компетенции
rel*
my | manage | approve | check
Да Тип отображения (мои, управление, согласование, проверка)

Информация о плане

Вернет детализированную информацию о выбранном плане по его идентификатору

{}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор плана

Создание плана

Метод позволяет создать план на основе заданных параметров

{
    "name": "\u041f\u043b\u0430\u043d \u043d\u0430 \u0440\u0430\u0437\u0432\u0438\u0442\u0438\u0435 \u043a\u043e\u043c\u043c\u0443\u043d\u0438\u043a\u0430\u0446\u0438\u0439 \u0441 \u043a\u043e\u0442\u0451\u043d\u043a\u0430\u043c\u0438",
    "goals": [
        {
            "id": null,
            "idp": null,
            "name": null,
            "order": 1,
            "status": "new",
            "actions": [
                {
                    "id": null,
                    "goal": null,
                    "name": "\u041f\u043e\u0433\u043b\u0430\u0434\u044c \u043a\u043e\u0442\u0451\u043d\u043a\u0430",
                    "order": 1,
                    "status": "new",
                    "rewards": {
                        "exp": 30,
                        "coins": 25
                    },
                    "object_id": null,
                    "resources": "\u041f\u043e\u0438\u0449\u0438 \u0432 \u0438\u043d\u0435\u0442\u0435 \u043a\u0430\u043a \u044d\u0442\u043e \u0441\u0434\u0435\u043b\u0430\u0442\u044c",
                    "deadline_at": "2025-11-30",
                    "object_type": null,
                    "expected_result": "\u0423\u043c\u0435\u0435\u0442 \u0433\u043b\u0430\u0434\u0438\u0442\u044c \u043a\u043e\u0442\u0451\u043d\u043a\u0430 \u0440\u0443\u043a\u043e\u0439"
                },
                {
                    "id": null,
                    "goal": null,
                    "name": "\u041e\u0431\u043d\u0438\u043c\u0438 \u043a\u043e\u0442\u0451\u043d\u043a\u0430",
                    "order": 2,
                    "status": "new",
                    "rewards": {
                        "exp": 100,
                        "coins": 50
                    },
                    "object_id": null,
                    "resources": "\u041e\u0431\u043d\u0438\u043c\u0438 \u0441\u0438\u043b\u044c\u043d\u043e, \u0441\u0438\u043b\u044c\u043d\u043e, \u043d\u043e \u043d\u0435\u0436\u043d\u043e, \u043d\u0435\u0436\u043d\u043e",
                    "deadline_at": "2025-11-25",
                    "object_type": null,
                    "expected_result": "\u041d\u0435 \u0431\u043e\u0438\u0442\u0441\u044f \u043f\u0440\u0438\u043a\u043e\u0441\u043d\u0443\u0442\u044c\u0441\u044f \u043b\u0438\u0446\u043e\u043c \u043a \u043a\u043e\u0442\u0451\u043d\u043a\u0443"
                }
            ],
            "competency": 10,
            "deadline_at": "2025-12-05",
            "description": "\u0421\u0442\u0430\u043d\u044c \u0447\u0430\u0441\u0442\u044c\u044e \u043a\u043e\u0442\u0451\u043d\u043a\u043e\u0432\u043e\u0441\u0442\u0438"
        },
        {
            "id": null,
            "idp": null,
            "name": null,
            "order": 1,
            "status": "new",
            "actions": [
                {
                    "id": null,
                    "goal": null,
                    "name": "\u041e\u0442\u0434\u0430\u0439 \u043a\u043e\u0442\u0451\u043d\u043a\u0443 \u0441\u0432\u043e\u044e \u043f\u043e\u0441\u043b\u0435\u0434\u043d\u044e\u044e \u0435\u0434\u0443",
                    "order": 1,
                    "status": "new",
                    "rewards": {
                        "exp": 150,
                        "coins": 75
                    },
                    "object_id": null,
                    "resources": "",
                    "deadline_at": "2025-11-28",
                    "object_type": null,
                    "expected_result": "\u041a\u043e\u0440\u043c\u0438\u0442 \u0432\u0441\u0435\u0445 \u043a\u043e\u0442\u0451\u043d\u043a\u043e\u0432 \u043d\u0430 \u0443\u043b\u0438\u0446\u0435"
                },
                {
                    "id": null,
                    "goal": null,
                    "name": "\u041d\u0435 \u0436\u0430\u043b\u0435\u0439 \u0441\u0432\u043e\u044e \u043a\u0440\u043e\u0432\u0430\u0442\u044c \u043a\u043e\u0442\u0451\u043d\u043a\u0443",
                    "order": 2,
                    "status": "new",
                    "rewards": {
                        "exp": 300,
                        "coins": 150
                    },
                    "object_id": null,
                    "resources": "",
                    "deadline_at": "2025-12-08",
                    "object_type": null,
                    "expected_result": "\u0413\u043e\u0442\u043e\u0432 \u0441\u043f\u0430\u0442\u044c \u043d\u0430 \u043f\u043e\u043b\u0443, \u0447\u0442\u043e\u0431\u044b \u043a\u043e\u0442\u0451\u043d\u043e\u043a \u0441\u043f\u0430\u043b \u043d\u0430 \u043a\u0440\u043e\u0432\u0430\u0442\u0438"
                }
            ],
            "competency": 11,
            "deadline_at": "2025-12-15",
            "description": "\u041e\u0442\u0434\u0430\u0439 \u043f\u043e\u0441\u043b\u0435\u0434\u043d\u0435\u0435"
        }
    ],
    "status": "draft",
    "comment": "\u041f\u0440\u043e\u0441\u0442\u043e \u0432\u044b\u043f\u043e\u043b\u043d\u0438 \u044d\u0442\u043e\u0442 \u043f\u043b\u0430\u043d, \u0431\u0443\u0434\u044c \u0447\u0435\u043b\u043e\u0432\u0435\u043a\u043e\u043c",
    "executor": 86,
    "approval_at": "2025-11-18",
    "description": "\u0421\u043e\u0442\u0440\u0443\u0434\u043d\u0438\u043a \u0434\u043e\u043b\u0436\u0435\u043d \u043f\u0440\u043e\u044f\u0432\u043b\u044f\u0442\u044c \u0438\u043d\u0442\u0435\u0440\u0435\u0441 \u043a \u043a\u043e\u0442\u0451\u043d\u043a\u0430\u043c, \u0443\u043c\u0438\u043b\u044f\u0442\u044c\u0441\u044f \u0438\u043c \u0438 \u0432\u0441\u044f\u0447\u0435\u0441\u043a\u0438 \u043f\u043e\u043e\u0449\u0440\u044f\u0442\u044c \u0438\u0445 \u0431\u0435\u0441\u044f\u0447\u0435\u0441\u0442\u0432\u043e"
}

Параметры запроса

Атрибут Тип Обязательное Описание
name*
string
Да Название плана
description
string | null
Описание плана
comment
string | null
Дополнительный комментарий для исполнителя
executor
int | null
Идентификатор исполнителя (по умолчанию текущий)
approval_at
string
Дата, до которой необходимо согласовать план
goals*
any[]
Да Массив целей и соответствующих действий к ним

Обновление плана

Метод позволяет произвести обновление плана с целью редактирования его параметров

{
    "id": 6,
    "name": "\u041f\u043b\u0430\u043d \u043d\u0430 \u0440\u0430\u0437\u0432\u0438\u0442\u0438\u0435 \u043a\u043e\u043c\u043c\u0443\u043d\u0438\u043a\u0430\u0446\u0438\u0439 \u0441 \u043a\u043e\u0442\u0451\u043d\u043a\u0430\u043c\u0438",
    "goals": [
        {
            "id": 1,
            "idp": 6,
            "name": null,
            "order": 1,
            "status": "new",
            "actions": [
                {
                    "id": 1,
                    "goal": 1,
                    "name": "\u041f\u043e\u0433\u043b\u0430\u0434\u044c \u043a\u043e\u0442\u0451\u043d\u043a\u0430",
                    "order": 1,
                    "status": "new",
                    "rewards": {
                        "exp": 30,
                        "coins": 25
                    },
                    "object_id": null,
                    "resources": "\u041f\u043e\u0438\u0449\u0438 \u0432 \u0438\u043d\u0435\u0442\u0435 \u043a\u0430\u043a \u044d\u0442\u043e \u0441\u0434\u0435\u043b\u0430\u0442\u044c",
                    "deadline_at": "2025-11-30",
                    "object_type": null,
                    "expected_result": "\u0423\u043c\u0435\u0435\u0442 \u0433\u043b\u0430\u0434\u0438\u0442\u044c \u043a\u043e\u0442\u0451\u043d\u043a\u0430 \u0440\u0443\u043a\u043e\u0439"
                },
                {
                    "id": 2,
                    "goal": 1,
                    "name": "\u041e\u0431\u043d\u0438\u043c\u0438 \u043a\u043e\u0442\u0451\u043d\u043a\u0430",
                    "order": 2,
                    "status": "new",
                    "rewards": {
                        "exp": 100,
                        "coins": 50
                    },
                    "object_id": null,
                    "resources": "\u041e\u0431\u043d\u0438\u043c\u0438 \u0441\u0438\u043b\u044c\u043d\u043e, \u0441\u0438\u043b\u044c\u043d\u043e, \u043d\u043e \u043d\u0435\u0436\u043d\u043e, \u043d\u0435\u0436\u043d\u043e",
                    "deadline_at": "2025-11-25",
                    "object_type": null,
                    "expected_result": "\u041d\u0435 \u0431\u043e\u0438\u0442\u0441\u044f \u043f\u0440\u0438\u043a\u043e\u0441\u043d\u0443\u0442\u044c\u0441\u044f \u043b\u0438\u0446\u043e\u043c \u043a \u043a\u043e\u0442\u0451\u043d\u043a\u0443"
                }
            ],
            "competency": 10,
            "deadline_at": "2025-12-05",
            "description": "\u0421\u0442\u0430\u043d\u044c \u0447\u0430\u0441\u0442\u044c\u044e \u043a\u043e\u0442\u0451\u043d\u043a\u043e\u0432\u043e\u0441\u0442\u0438"
        },
        {
            "id": 2,
            "idp": 6,
            "name": null,
            "order": 1,
            "status": "new",
            "actions": [
                {
                    "id": 3,
                    "goal": 2,
                    "name": "\u041e\u0442\u0434\u0430\u0439 \u043a\u043e\u0442\u0451\u043d\u043a\u0443 \u0441\u0432\u043e\u044e \u043f\u043e\u0441\u043b\u0435\u0434\u043d\u044e\u044e \u0435\u0434\u0443",
                    "order": 1,
                    "status": "new",
                    "rewards": {
                        "exp": 150,
                        "coins": 75
                    },
                    "object_id": null,
                    "resources": "",
                    "deadline_at": "2025-11-28",
                    "object_type": null,
                    "expected_result": "\u041a\u043e\u0440\u043c\u0438\u0442 \u0432\u0441\u0435\u0445 \u043a\u043e\u0442\u0451\u043d\u043a\u043e\u0432 \u043d\u0430 \u0443\u043b\u0438\u0446\u0435"
                },
                {
                    "id": 4,
                    "goal": 2,
                    "name": "\u041d\u0435 \u0436\u0430\u043b\u0435\u0439 \u0441\u0432\u043e\u044e \u043a\u0440\u043e\u0432\u0430\u0442\u044c \u043a\u043e\u0442\u0451\u043d\u043a\u0443",
                    "order": 2,
                    "status": "new",
                    "rewards": {
                        "exp": 300,
                        "coins": 150
                    },
                    "object_id": null,
                    "resources": "",
                    "deadline_at": "2025-12-08",
                    "object_type": null,
                    "expected_result": "\u0413\u043e\u0442\u043e\u0432 \u0441\u043f\u0430\u0442\u044c \u043d\u0430 \u043f\u043e\u043b\u0443, \u0447\u0442\u043e\u0431\u044b \u043a\u043e\u0442\u0451\u043d\u043e\u043a \u0441\u043f\u0430\u043b \u043d\u0430 \u043a\u0440\u043e\u0432\u0430\u0442\u0438"
                }
            ],
            "competency": 11,
            "deadline_at": "2025-12-15",
            "description": "\u041e\u0442\u0434\u0430\u0439 \u043f\u043e\u0441\u043b\u0435\u0434\u043d\u0435\u0435"
        }
    ],
    "status": "draft",
    "comment": "\u041f\u0440\u043e\u0441\u0442\u043e \u0432\u044b\u043f\u043e\u043b\u043d\u0438 \u044d\u0442\u043e\u0442 \u043f\u043b\u0430\u043d, \u0431\u0443\u0434\u044c \u0447\u0435\u043b\u043e\u0432\u0435\u043a\u043e\u043c",
    "executor": 86,
    "approval_at": "2025-11-18",
    "description": "\u0421\u043e\u0442\u0440\u0443\u0434\u043d\u0438\u043a \u0434\u043e\u043b\u0436\u0435\u043d \u043f\u0440\u043e\u044f\u0432\u043b\u044f\u0442\u044c \u0438\u043d\u0442\u0435\u0440\u0435\u0441 \u043a \u043a\u043e\u0442\u0451\u043d\u043a\u0430\u043c, \u0443\u043c\u0438\u043b\u044f\u0442\u044c\u0441\u044f \u0438\u043c \u0438 \u0432\u0441\u044f\u0447\u0435\u0441\u043a\u0438 \u043f\u043e\u043e\u0449\u0440\u044f\u0442\u044c \u0438\u0445 \u0431\u0435\u0441\u044f\u0447\u0435\u0441\u0442\u0432\u043e"
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор плана
name*
string
Да Название плана
description
string | null
Описание плана
comment
string | null
Дополнительный комментарий для исполнителя
executor
int | null
Идентификатор исполнителя (по умолчанию текущий)
approval_at
string
Дата, до которой необходимо согласовать план
goals*
any[]
Да Массив целей и соответствующих действий к ним

Удаление плана

Метод позволяет удалять планы из системы - установить дату удаления и исключит из выборки

{}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор плана

Клонирование плана

Метод позволяет произвести полное копирование плана

{}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор плана

Смена статуса плана

Метод позволяет изменить текущий статус плана на новый

{
    "status": "approval",
    "comment": "\u0412\u0441\u0451 \u0445\u043e\u0440\u043e\u0448\u043e, \u0441\u043e\u0433\u043b\u0430\u0441\u0443\u044e",
    "attachment": "00c89a3b-0936-4f8c-95c0-32e74f2f3973"
}

Параметры запроса

Атрибут Тип Обязательное Описание
status*
draft | approval | revision | active | work | moderate | rework | complete
Да Статус плана
comment
string | null
Комментарий к действию
attachment
string | null
Идентификатор вложения (uuid)

Смена статуса действия плана

Метод позволяет изменить текущий статус действия цели внутри плана

{
    "status": "moderate",
    "comment": "\u0412\u044b\u043f\u043e\u043b\u043d\u0438\u043b, \u043f\u0440\u043e\u0432\u0435\u0440\u044c\u0442\u0435 \u043f\u043e\u0436\u0430\u043b\u0443\u0439\u0441\u0442\u0430",
    "attachment": "00c89a3b-0936-4f8c-95c0-32e74f2f3973"
}

Параметры запроса

Атрибут Тип Обязательное Описание
status*
new | skip | work | moderate | rework | complete
Да Статус действия
comment
string | null
Комментарий к действию
attachment
string | null
Идентификатор вложения (uuid)

Смена дедлайна действия плана

Метод позволяет изменить текущий дедлайн действия цели внутри плана

{
    "deadline": "2025-12-09 00:00:00"
}

Параметры запроса

Атрибут Тип Обязательное Описание
deadline*
string
Да Новая дата дедлайна

История обработки плана

Метод вернет список историй изменения, обработки и движения плана

{}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор плана

Статистика общая

Метод вернет аналитические данные со статистикой по ИПР на основе заданных фильтров

{}

Параметры запроса

Атрибут Тип Обязательное Описание
id
int | null
Идентификатор элемента для подробностей
per
int | null
Количество на страницу
page
int | null
Номер страницы
type*
user | department | idp | competency
Да Тип статистики (по пользователям, по отделам, по ИПР, по компетенциям)
date_start
string | null
Дата начала
date_end
string | null
Дата завершения

Статистика пользователя

Метод вернет упрощенную статистику по ИПР текущего пользователя

{}

Список шаблонов

Вернет список шаблонов ИПР на основе заданных фильтров

{
    "per": 20,
    "page": 1,
    "publish": 1,
    "competency": null
}

Параметры запроса

Атрибут Тип Обязательное Описание
per
int | null
Количество на страницу
page
int | null
Номер страницы
publish
int | null
Статус публикации
competency
int | null
Идентификатор компетенции

Информация о шаблоне

Вернет детализированную информацию о выбранном шаблоне ИПР по его идентификатору

{}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор шаблона

Создание шаблона

Метод позволяет создать шаблон ИПР на основе заданных параметров

{
    "id": null,
    "name": "\u041f\u043b\u0430\u043d \u043d\u0430 \u0440\u0430\u0437\u0432\u0438\u0442\u0438\u0435",
    "goals": [
        {
            "id": null,
            "name": null,
            "order": 1,
            "actions": [
                {
                    "id": null,
                    "goal": null,
                    "name": "\u041f\u0435\u0440\u0432\u043e\u0435 \u0434\u0435\u0439\u0441\u0442\u0432\u0438\u0435",
                    "order": 1,
                    "rewards": {
                        "exp": 30,
                        "coins": 25
                    },
                    "resources": "\u041a\u0430\u043a\u0438\u0435-\u0442\u043e \u0440\u0435\u0441\u0443\u0440\u0441\u044b",
                    "object_type": null,
                    "expected_result": "\u041d\u0430\u0443\u0447\u0438\u043b\u0441\u044f \u0438\u043b\u0438 \u043d\u0435 \u043d\u0430\u0443\u0447\u0438\u043b\u0441\u044f"
                },
                {
                    "id": null,
                    "goal": null,
                    "name": "\u0412\u0442\u043e\u0440\u043e\u0435 \u0434\u0435\u0439\u0441\u0442\u0432\u0438\u0435",
                    "order": 2,
                    "rewards": {
                        "exp": 100,
                        "coins": 50
                    },
                    "object_id": 1,
                    "resources": null,
                    "object_type": "training",
                    "expected_result": "\u041a\u0430\u043a\u043e\u0439-\u0442\u043e \u0440\u0435\u0437\u0443\u043b\u044c\u0442\u0430\u0442"
                }
            ],
            "template": null,
            "competency": 10,
            "description": "\u041f\u0435\u0440\u0432\u043e\u0441\u0442\u0435\u043f\u0435\u043d\u043d\u0430\u044f \u0446\u0435\u043b\u044c"
        },
        {
            "id": null,
            "name": null,
            "order": 1,
            "actions": [
                {
                    "id": null,
                    "goal": null,
                    "name": "\u041f\u043e\u0441\u043b\u0435\u0434\u043d\u0435\u0435 \u0434\u0435\u0439\u0441\u0442\u0432\u0438\u0435",
                    "order": 1,
                    "rewards": {
                        "exp": 150,
                        "coins": 75
                    },
                    "resources": "",
                    "object_type": null,
                    "expected_result": null
                }
            ],
            "template": null,
            "competency": 11,
            "description": "\u041e\u0447\u0435\u0440\u0435\u0434\u043d\u0430\u044f \u0446\u0435\u043b\u044c"
        }
    ],
    "comment": "\u041f\u0440\u043e\u0441\u0442\u043e \u0432\u044b\u043f\u043e\u043b\u043d\u0438 \u044d\u0442\u043e\u0442 \u043f\u043b\u0430\u043d",
    "description": "\u0421\u043e\u0442\u0440\u0443\u0434\u043d\u0438\u043a \u0434\u043e\u043b\u0436\u0435\u043d \u043f\u0440\u043e\u044f\u0432\u043b\u044f\u0442\u044c \u0438\u043d\u0442\u0435\u0440\u0435\u0441"
}

Параметры запроса

Атрибут Тип Обязательное Описание
name*
string
Да Название плана
description
string | null
Описание плана
comment
string | null
Дополнительный комментарий для исполнителя
goals*
any[]
Да Массив целей и соответствующих действий к ним

Обновление шаблона

Метод позволяет произвести обновление шаблона ИПР с целью редактирования его параметров

{
    "id": 4,
    "name": "\u041f\u043b\u0430\u043d \u043d\u0430 \u0440\u0430\u0437\u0432\u0438\u0442\u0438\u0435",
    "goals": [
        {
            "id": 6,
            "name": null,
            "order": 1,
            "actions": [
                {
                    "id": 4,
                    "goal": 6,
                    "name": "\u041f\u0435\u0440\u0432\u043e\u0435 \u0434\u0435\u0439\u0441\u0442\u0432\u0438\u0435",
                    "order": 1,
                    "rewards": {
                        "exp": 30,
                        "coins": 25
                    },
                    "resources": "\u041a\u0430\u043a\u0438\u0435-\u0442\u043e \u0440\u0435\u0441\u0443\u0440\u0441\u044b",
                    "object_type": null,
                    "expected_result": "\u041d\u0430\u0443\u0447\u0438\u043b\u0441\u044f \u0438\u043b\u0438 \u043d\u0435 \u043d\u0430\u0443\u0447\u0438\u043b\u0441\u044f"
                },
                {
                    "id": 5,
                    "goal": 6,
                    "name": "\u0412\u0442\u043e\u0440\u043e\u0435 \u0434\u0435\u0439\u0441\u0442\u0432\u0438\u0435",
                    "order": 2,
                    "rewards": {
                        "exp": 100,
                        "coins": 50
                    },
                    "object_id": 1,
                    "resources": null,
                    "object_type": "training",
                    "expected_result": "\u041a\u0430\u043a\u043e\u0439-\u0442\u043e \u0440\u0435\u0437\u0443\u043b\u044c\u0442\u0430\u0442"
                }
            ],
            "template": 4,
            "competency": 10,
            "description": "\u041f\u0435\u0440\u0432\u043e\u0441\u0442\u0435\u043f\u0435\u043d\u043d\u0430\u044f \u0446\u0435\u043b\u044c"
        },
        {
            "id": 7,
            "name": null,
            "order": 1,
            "actions": [
                {
                    "id": 6,
                    "goal": 7,
                    "name": "\u041f\u043e\u0441\u043b\u0435\u0434\u043d\u0435\u0435 \u0434\u0435\u0439\u0441\u0442\u0432\u0438\u0435",
                    "order": 1,
                    "rewards": {
                        "exp": 150,
                        "coins": 75
                    },
                    "resources": "",
                    "object_type": null,
                    "expected_result": null
                }
            ],
            "template": 4,
            "competency": 11,
            "description": "\u041e\u0447\u0435\u0440\u0435\u0434\u043d\u0430\u044f \u0446\u0435\u043b\u044c"
        }
    ],
    "comment": "\u041f\u0440\u043e\u0441\u0442\u043e \u0432\u044b\u043f\u043e\u043b\u043d\u0438 \u044d\u0442\u043e\u0442 \u043f\u043b\u0430\u043d",
    "description": "\u0421\u043e\u0442\u0440\u0443\u0434\u043d\u0438\u043a \u0434\u043e\u043b\u0436\u0435\u043d \u043f\u0440\u043e\u044f\u0432\u043b\u044f\u0442\u044c \u0438\u043d\u0442\u0435\u0440\u0435\u0441"
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор плана
name*
string
Да Название плана
description
string | null
Описание плана
comment
string | null
Дополнительный комментарий для исполнителя
goals*
any[]
Да Массив целей и соответствующих действий к ним

Удаление шаблона

Метод позволяет удалять шаблоны ИПР из системы - установить дату удаления и исключит из выборки

{}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор шаблона ИПР

Клонирование шаблона

Метод позволяет сделать полную копию шаблона ИПР

{}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор шаблона ИПР

Публикация шаблона

Метод позволяет опубликовать или снять с публикации шаблон ИПР

{
    "publish": 1
}

Параметры запроса

Атрибут Тип Обязательное Описание
id*
int
Да Идентификатор шаблона ИПР
publish*
int
Да Статус публикации

Упрощенный список шаблонов

Вернет упрощенный список шаблонов ИПР без пагинации

{}

Другое

Дополнительные методы взаимодействия с системой, настройками и другое.

Параметры системы

Вернет перечень актуальных параметров настроек системы для поддержания её работоспособности

{}

Настройки

Содержит методы работы с настройками системы

Список настроек системы

Метод вернет перечень имеющихся настроек системы

{}

Список настроек системы

Метод сохранит перечень новых настроек для системы

{
    "public": {},
    "private": {}
}

Параметры запроса

Атрибут Тип Обязательное Описание
public*
any
Да Набор публичных настроек (ключ: значение)
private*
any
Да Набор приватных настроек (ключ: значение)