Получить настройки контроля времени timeman.timecontrol.settings.get

Scope: timeman

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

Метод timeman.timecontrol.settings.get получает настройки модуля контроля времени.

Параметры метода

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

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/timeman.timecontrol.settings.get
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/timeman.timecontrol.settings.get
        
try
        {
        	const response = await $b24.callMethod(
        		'timeman.timecontrol.settings.get',
        		{}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'timeman.timecontrol.settings.get',
                    []
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
                echo 'Error: ' . $result->error();
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting time control settings: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'timeman.timecontrol.settings.get',
            {},
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'timeman.timecontrol.settings.get',
            []
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Обработка ответа

HTTP-статус: 200

{
            "result": {
                "active": true,
                "minimum_idle_for_report": 15,
                "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": []
            },
            "time": {
                "start": 1748526089.625516,
                "finish": 1748526089.656787,
                "duration": 0.03127098083496094,
                "processing": 0.008746147155761719,
                "date_start": "2025-05-29T16:41:29+03:00",
                "date_finish": "2025-05-29T16:41:29+03:00",
                "operating_reset_at": 1748526689,
                "operating": 0
            }
        }

Возвращаемые данные

Название
тип

Описание

result
object

Корневой элемент ответа

active
boolean

Активность модуля контроля времени

minimum_idle_for_report
integer

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

register_offline
boolean

Регистрировать офлайн статус

register_idle
boolean

Регистрировать статус Отошел

register_desktop
boolean

Регистрировать статус десктоп приложения

report_request_type
string

Тип запроса отчетов. Возможные значения:

  • all — для всех
  • user — для конкретных пользователей
  • none — ни для кого

report_request_users
array

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

Заполнен, если report_request_type имеет значение user

report_simple_type
string

Тип простого отчета. Возможные значения:

  • all — для всех
  • user — для конкретных пользователей
  • none — ни для кого

report_simple_users
array

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

Заполнен, если report_simple_users имеет значение user

report_full_type
string

Тип полного отчета. Возможные значения:

  • all — для всех
  • user — для конкретных пользователей
  • none — ни для кого

report_full_users
array

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

Заполнен, если report_full_type имеет значение user

time
time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

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

Название
тип

Описание

error
string

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

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код

Описание

Значение

ACCESS_ERROR

You don't have access to use this method

У вас нет доступа к этому методу

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

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

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

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

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Предыдущая
Получить отчет о выявленных отсутствиях
Следующая
Установить настройки инструмента контроля времени