Документация для разработчиков
Темная тема

timeman.timecontrol.settings.get

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

Описание

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

Параметры

Без параметров.

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

JavaScript

BX24.callMethod('timeman.timecontrol.settings.get', {}, function(result){
	if(result.error())
	{
		console.error(result.error().ex);
	}
	else
	{
		console.log(result.data());
	}
});

PHP

$result = restCommand('timeman.timecontrol.settings.get', Array(), $_REQUEST["auth"]);	

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

{
	"result":{
		"active":true,
		"minimum_idle_for_report":1,
		"register_offline":true,
		"register_idle":true,
		"register_desktop":true,
		"report_request_type":"all",
		"report_request_users":[],
		"report_simple_type":"all",
		"report_simple_users":[],
		"report_full_type":"all",
		"report_full_users":[]
	}
}

Описание ключей

  • active - доступность инструмента контроля времени.
  • minimum_idle_for_report - минимальное кол-во времени для запроса отчета (в минутах).
  • register_offline - фиксировать факт перехода пользователя в режим офлайн.
  • register_idle - фиксировать факт перехода пользователя в режим отошел.
  • register_desktop - фиксировать факт включения и отключения десктоп приложения.
  • report_request_type - у кого запрашивать отчет (all - у всех, user - только у указанных пользователей, none - ни у кого).
  • report_request_users - список пользователей у кого запрашивать отчет (если report_request_type == user).
  • report_simple_type - кому доступен упрощенный отчет (all - всем, user - только указанным пользователям).
  • report_simple_users - список пользователей кому доступен упрощенный отчет (если report_simple_type == user).
  • report_full_type - кому доступен расширенный отчет (all - всем, user - только указанным пользователям).
  • report_full_users - список пользователей кому доступен расширенный отчет (если report_simple_type == user).

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

{
	"error": "ACCESS_ERROR",
	"error_description": "You don't have access to user this method"
}
  • Ключ error - код возникшей ошибки.
  • Ключ error_description - краткое описание возникшей ошибки.

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

КодОписание
ACCESS_ERRORУказанный метод доступен только администраторам.


Пользовательские комментарии

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

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2024, «1С-Битрикс», 2024