Получить информацию о текущем рабочем дне timeman.status

Scope: timeman

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

Метод timeman.status получает информацию о текущем рабочем дне.

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

Название
тип

Описание

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.status
        
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.status
        
try
        {
        	const response = await $b24.callMethod(
        		'timeman.status',
        		{
        			'USER_ID' : 503
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'timeman.status',
                    [
                        'USER_ID' => 503
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
                echo 'Error: ' . $result->error();
            } else {
                echo 'Info: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error calling timeman.status: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'timeman.status',
            {
                '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.status',
            [
                'USER_ID' => 503
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": {
                "STATUS": "EXPIRED",
                "TIME_START": "2025-03-27T08:00:01+02:00",
                "TIME_FINISH": null,
                "DURATION": "00:00:00",
                "TIME_LEAKS": "00:17:53",
                "ACTIVE": false,
                "IP_OPEN": "",
                "IP_CLOSE": "",
                "LAT_OPEN": 53.548841000000003,
                "LON_OPEN": 9.9872739999999993,
                "LAT_CLOSE": 0,
                "LON_CLOSE": 0,
                "TZ_OFFSET": 7200,
                "TIME_FINISH_DEFAULT": "2025-03-27T17:00:00+02:00"
            },
            "time": {
                "start": 1743057653.725821,
                "finish": 1743057654.0894129,
                "duration": 0.36359190940856934,
                "processing": 0.3278491497039795,
                "date_start": "2025-03-27T09:40:53+03:00",
                "date_finish": "2025-03-27T09:40:54+03:00",
                "operating_reset_at": 1743058253,
                "operating": 0.32782983779907227
            }
        }

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

Название
тип

Описание

result
object

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

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

STATUS
string

Статус текущего рабочего дня.

Варианты значений:

  • OPENED — открыт
  • CLOSED — закрыт
  • PAUSED — приостановлен
  • EXPIRED — истек, то есть открыт до начала текущих календарных суток и не закрыт

TIME_START
datetime

Дата и время начала рабочего дня.

Часовой пояс соответствует часовому поясу начала рабочего дня

TIME_FINISH
datetime

Дата и время заверения рабочего дня.

Для незавершенного рабочего дня возвращается null

DURATION
string

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

Для незавершенного рабочего дня возвращается 00:00:00

TIME_LEAKS
string

Суммарная длительность перерыва за день в формате HH:MM:SS

ACTIVE
boolean

Подтвержденность рабочего дня.

Значение false означает, что изменение рабочего дня ожидает подтверждения руководителем

IP_OPEN
string

IP-адрес, с которого начат рабочий день

IP_CLOSE
string

IP-адрес, с которого завершен рабочий день.

Для незавершенного рабочего дня возвращается null

LAT_OPEN
double

Географическая широта точки начала рабочего дня

LON_OPEN
double

Географическая долгота точки начала рабочего дня

LAT_CLOSE
double

Географическая широта точки завершения рабочего дня

LON_CLOSE
double

Географическая долгота точки завершения рабочего дня

TZ_OFFSET
integer

Смещение часового пояса сотрудника в котором начат рабочий день.

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

TIME_FINISH_DEFAULT
datetime

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

Выводится только для рабочих дней в статусе истек EXPIRED

time
time

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

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

HTTP-статус: 400

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

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

Значение

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

User not found

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

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

Предыдущая
Завершить текущий день
Следующая
Получить настройки рабочего времени