Получить настройки рабочего времени пользователя timeman.settings

Scope: timeman

Кто может выполнять метод: любой пользователь

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

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

Название
тип

Описание

USER_ID
integer

Идентификатор пользователя.

По умолчанию — идентификатор текущего пользователя

Примеры кода

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

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

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

HTTP-статус: 200

{
            "result": {
                "UF_TIMEMAN": true,
                "UF_TM_FREE": false,
                "UF_TM_MAX_START": "09:15:00",
                "UF_TM_MIN_FINISH": "17:45:00",
                "UF_TM_MIN_DURATION": "08:00:00",
                "UF_TM_ALLOWED_DELTA": "00:15:00",
                "ADMIN": true
            },
            "time": {
                "start": 1742994169.701416,
                "finish": 1742994169.7355511,
                "duration": 0.03413510322570801,
                "processing": 0.0076749324798583984,
                "date_start": "2025-03-26T16:02:49+03:00",
                "date_finish": "2025-03-26T16:02:49+03:00",
                "operating_reset_at": 1742994769,
                "operating": 0
            }
        }

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

Название
тип

Описание

result
object

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

Содержит объект c описанием настроек рабочего времени пользователя

UF_TIMEMAN
boolean

Включен ли учет рабочего времени для пользователя.

Имеет значение true если включен

UF_TM_FREE
boolean

Включен ли для пользователя свободный график работы.

Имеет значение true если включен.

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

UF_TM_MAX_START
string

Максимальное время начала рабочего дня в формате HH:MM:SS.

Начало рабочего дня позже установленного времени считается нарушением

UF_TM_MIN_FINISH
string

Минимальное время завершения рабочего дня в формате HH:MM:SS.

Завершение рабочего дня раньше установленного времени считается нарушением

UF_TM_MIN_DURATION
string

Минимальная длительность рабочего дня в формате HH:MM:SS.

Рабочий день, длительность которого меньше установленной, считается нарушением

UF_TM_ALLOWED_DELTA
string

Допустимый промежуток изменения рабочего времени в формате HH:MM:SS.

Изменение рабочего дня на период меньше установленного не требует подтверждения руководителя

ADMIN
boolean

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

Имеет значение true если права есть

time
time

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

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

HTTP-статус: 400

{
            "error":"",
            "error_description":"User not found"
        }

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

Значение

пустая строка

User not found

Пользователь с указанным USER_ID не найден

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

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

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

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

Предыдущая
Получить информацию о текущем рабочем дне
Следующая
Обзор методов