timeman.timecontrol.settings.get
Получить настройки контроля времени
Описание
Метод 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
// 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 TimecontrolSettingsGetResult = {
active: boolean
minimum_idle_for_report: number
register_offline: boolean
register_idle: boolean
register_desktop: boolean
report_request_type: string
report_request_users: number[]
report_simple_type: string
report_simple_users: number[]
report_full_type: string
report_full_users: number[]
}
try {
const response = await $b24.actions.v2.call.make<TimecontrolSettingsGetResult>({
method: 'timeman.timecontrol.settings.get',
params: {},
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('active:', result.active, 'report_request_type:', result.report_request_type)
}
} 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 getTimecontrolSettings() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'timeman.timecontrol.settings.get',
params: {},
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('active:', result.active, 'report_request_type:', result.report_request_type)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getTimecontrolSettings)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.timeman.timecontrol.settings.get().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.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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "timeman.timecontrol.settings.get", nil, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("timeman.timecontrol.settings.get: %w", err)
}
var item struct {
Active bool `json:"active"`
MinimumIdleForReport int `json:"minimum_idle_for_report"`
RegisterOffline bool `json:"register_offline"`
RegisterIdle bool `json:"register_idle"`
RegisterDesktop bool `json:"register_desktop"`
ReportRequestType string `json:"report_request_type"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.Active, item.MinimumIdleForReport)
Ответ
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"
}
| Код | Описание | Значение |
|---|---|---|
ACCESS_ERROR |
You don't have access to use this method | У вас нет доступа к этому методу |

