timeman.timecontrol.settings.set

Scope: timeman Права на выполнение: администратор

Описание и параметры

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

Параметры

Параметр	По умолчанию	Обязательный	Описание
ACTIVE	false	Нет	Доступность инструмента контроля времени. Включается через `active: true`. Отключать через active: false в случае, если данные отправляются как bool. Если данные отправляются как текст false в виде текста это true , то отключается только через `active: 0`.
MINIMUM_IDLE_FOR_REPORT	15	Нет	Минимальное количество времени для запроса отчета в минутах.
REGISTER_OFFLINE	true	Нет	Фиксировать факт перехода пользователя в режим офлайн.
REGISTER_IDLE	true	Нет	Фиксировать факт перехода пользователя в режим отошел.
REGISTER_DESKTOP	true	Нет	Фиксировать факт включения и отключения десктоп приложения.
REPORT_REQUEST_TYPE	none	Нет	У кого запрашивать отчет (`all` - у всех, `user` - только у указанных пользователей, none - ни у кого).
REPORT_REQUEST_USERS	[]	Нет*	Список пользователей у кого запрашивать отчет (если `report_request_type == user`).
REPORT_SIMPLE_TYPE	all	Нет	Кому доступен упрощенный отчет (`all` - всем, `user` - только указанным пользователям).
REPORT_SIMPLE_USERS	[]	Нет*	Список пользователей кому доступен упрощенный отчет (если `report_simple_type == user`).
REPORT_FULL_TYPE	user	Нет	Кому доступен расширенный отчет (`all` - всем, `user` - только указанным пользователям).
REPORT_FULL_USERS	[]	Нет*	Список пользователей кому доступен расширенный отчет (если `report_simple_type == user`).

* - если вы передаете параметр REPORT_REQUEST_TYPE = user (или REPORT_SIMPLE_TYPE = user, или REPORT_FULL_TYPE = user), вы обязательно должны передать соответственно REPORT_REQUEST_USERS (или REPORT_SIMPLE_USERS, или REPORT_FULL_USERS).

Пример вызова

JavaScript

BX24.callMethod('timeman.timecontrol.settings.set', {
	active: true,
	report_request_type: 'user',
	report_request_users: [1,2,3],
}, function(result){
	if(result.error())
	{
		console.error(result.error().ex);
	}
	else
	{
		console.log(result.data());
	}
});

PHP

$result = restCommand('timeman.timecontrol.settings.set', Array(
	active: true,
	report_request_type: 'user',
	report_request_users: [1,2,3],
), $_REQUEST["auth"]);

Пример ответа

{
	"result": true
}

Пример ответа при возникновения ошибки

{
	"error": "ACCESS_ERROR",
	"error_description": "You don't have access to user this method"
}

Ключ error - код возникшей ошибки.
Ключ error_description - краткое описание возникшей ошибки.

Возможные коды ошибок

Код	Описание
ACCESS_ERROR	Указанный метод доступен только администраторам.
INVALID_FORMAT	Передан некорректный формат в поле `RANGE`.