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

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

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
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of the payload returned in result (match the "response handling" section of the page)
type TimemanSettingsResult = {
  UF_TIMEMAN: boolean
  UF_TM_FREE: boolean
  UF_TM_MAX_START: string
  UF_TM_MIN_FINISH: string
  UF_TM_MIN_DURATION: string
  UF_TM_ALLOWED_DELTA: string
  ADMIN: boolean
}

try {
  const response = await $b24.actions.v2.call.make<TimemanSettingsResult>({
    method: 'timeman.settings',
    params: {
      USER_ID: 503,
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Time tracking enabled:', result.UF_TIMEMAN, 'Free schedule:', result.UF_TM_FREE, 'Admin:', result.ADMIN)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function fetchTimemanSettings() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'timeman.settings',
        params: {
          USER_ID: 503,
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Time tracking enabled:', result.UF_TIMEMAN, 'Free schedule:', result.UF_TM_FREE, 'Admin:', result.ADMIN)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', fetchTimemanSettings)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.timeman.settings(user_id=503).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "timeman.settings", b24.Params{
	"USER_ID": 503,
})
if err != nil {
	return fmt.Errorf("timeman.settings: %w", err)
}

var item struct {
	UFTimeman        bool   `json:"UF_TIMEMAN"`
	UFTmFree         bool   `json:"UF_TM_FREE"`
	UFTmMaxStart     string `json:"UF_TM_MAX_START"`
	UFTmMinFinish    string `json:"UF_TM_MIN_FINISH"`
	UFTmMinDuration  string `json:"UF_TM_MIN_DURATION"`
	UFTmAllowedDelta string `json:"UF_TM_ALLOWED_DELTA"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.UFTimeman, item.UFTmFree)

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

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

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

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

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
string

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

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

Код

Описание

Значение

TIMEMAN_TOOL_DISABLED

Учет рабочего времени отключен.

Инструмент Учет рабочего времени отключен

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

User not found

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

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

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

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

Описание

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

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

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

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

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

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

401

OVERLOAD_LIMIT
REST API is blocked due to overload

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

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

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

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

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

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

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

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