Get Time Control Settings timeman.timecontrol.settings.get

Scope: timeman

Who can execute the method: administrator

The method timeman.timecontrol.settings.get retrieves the settings of the time control module.

Method Parameters

No parameters.

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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>';

Response Handling

HTTP status: 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+02:00",
                "date_finish": "2025-05-29T16:41:29+02:00",
                "operating_reset_at": 1748526689,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	Root element of the response
active `boolean`	Activity of the time control module
minimum_idle_for_report `integer`	Minimum idle time in minutes after which a report is required
register_offline `boolean`	Register offline status
register_idle `boolean`	Register away status
register_desktop `boolean`	Register desktop application status
report_request_type `string`	Type of report requests. Possible values: `all` — for everyone `user` — for specific users `none` — for no one
report_request_users `array`	Array of user IDs for whom report requests are required. Filled if `report_request_type` is set to `user`
report_simple_type `string`	Type of simple report. Possible values: `all` — for everyone `user` — for specific users `none` — for no one
report_simple_users `array`	Array of user IDs with access to the simple report. Filled if `report_simple_type` is set to `user`
report_full_type `string`	Type of full report. Possible values: `all` — for everyone `user` — for specific users `none` — for no one
report_full_users `array`	Array of user IDs with access to the full report. Filled if `report_full_type` is set to `user`
time `time`	Information about the request execution time

Error Handling

HTTP status: 400

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

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code	Description	Value
`ACCESS_ERROR`	You don't have access to use this method	You do not have access to this method

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Get Absence Reports

Set Time Control Tool Settings

Get Time Control Settings timeman.timecontrol.settings.get

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning