Приостановить текущий рабочий день timeman.pause

Scope: timeman

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

Метод timeman.pause приостанавливает текущий рабочий день.

Если рабочий день завершен, метод возобновит его и добавит в длительность время, которое прошло после завершения.

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

Название
тип

Описание

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

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

HTTP-статус: 200

{
            "result": {
                "STATUS": "PAUSED",
                "TIME_START": "2025-03-27T08:00:01+02:00",
                "TIME_FINISH": null,
                "DURATION": "00:00:00",
                "TIME_LEAKS": "00:00:00",
                "ACTIVE": false,
                "IP_OPEN": "",
                "IP_CLOSE": "",
                "LAT_OPEN": 53.548841000000003,
                "LON_OPEN": 9.9872739999999993,
                "LAT_CLOSE": 0,
                "LON_CLOSE": 0,
                "TZ_OFFSET": 7200
            },
            "time": {
                "start": 1743057425.9403241,
                "finish": 1743057426.0597129,
                "duration": 0.11938881874084473,
                "processing": 0.08620214462280273,
                "date_start": "2025-03-27T09:37:05+03:00",
                "date_finish": "2025-03-27T09:37:06+03:00",
                "operating_reset_at": 1743058025,
                "operating": 0
            }
        }

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

Название
тип

Описание

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 не найден

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

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

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

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

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