Документация для разработчиков
Темная тема

timeman.open

Scope: timeman Права на выполнение: для всех

Описание и пример

Метод начинает новый рабочий день либо возобновляет закрытый или приостановленный.

Пример

Пример вызова:

https://portal.bitrix24.com/rest/timeman.open?auth=xxxxxx&time=2017-04-21T07%3A30%3A00%2B08%3A00&report=Forgot&lat=54.7199881&lon=20.4879224&user_id=5

Пример ответа:

{
	"result": {
		"STATUS": "OPENED", 
		"TIME_START": "2017-04-21T07:30:00+08:00", 
		"TIME_FINISH": null, 
		"DURATION": "00:00:00", 
		"TIME_LEAKS": "00:00:00", 
		"ACTIVE": false, 
		"IP_OPEN": "192.168.1.1", 
		"IP_CLOSE": "", 
		"LAT_OPEN": 54.7199881, 
		"LON_OPEN": 20.4879224, 
		"LAT_CLOSE": 0, 
		"LON_CLOSE": 0, 
		"TZ_OFFSET": 28800
	}
}

Параметры

ПараметрОписание
USER_IDИдентификатор пользователя. Не обязателен, по умолчанию возвращаются настройки текущего пользователя.
TIMEВремя начала рабочего дня. Не обязателен, по умолчанию рабочий день открывается текущим моментом с сохраненным часовым поясом сотрудника. Дата должна совпадать с текущей календарной датой.
REPORTПричина изменения рабочего дня. Обязателен при указании параметра TIME и отключенном для сотрудника свободном графике.
LATГеографическая широта начала рабочего дня. Не обязателен.
LONГеографическая долгота начала рабочего дня. Не обязателен

Временная зона из параметра TIME считается временной зоной текущего рабочего дня. Сотруднику выводится время в этой временной зоне, а время завершения дня приводится к этой временной зоне, даже если указано в другой. Параметр TIME принимается только если рабочий день находится в статусе CLOSED, во всех остальных случаях вернется ошибка.

Поля ответа

Поле ТипОписаниеПримечание
STATUSstringСтатус текущего рабочего дня.Варианты значений:
  • OPENED - рабочий день идет
  • CLOSED - рабочий день закрыт
  • PAUSED - рабочий день приостановлен
  • EXPIRED - рабочий день истек (был открыт до начала текущих календарных суток и не закрыт)
TIME_START datetime Дата-время начала рабочего дня.Часовой пояс соответствует часовому поясу начала рабочего дня
TIME_FINISHdatetimeДата-время заверения рабочего дняДля незавершенного рабочего дня возвращается null
DURATIONHH:MM:SSДлительность рабочего дняДля незавершенного рабочего дня возвращается 00:00:00
TIME_LEAKSHH:MM:SSСуммарная длительность перерыва за день
ACTIVEtrue|falseПодтвержденность рабочего дняЗначение false означает, что изменение рабочего дня ожидает подтверждения руководителем
IP_OPENstringIP-адрес, с которого был начат рабочий день
IP_CLOSEstringIP-адрес, с которого был завершен рабочий деньДля незавершенного рабочего дня возвращается null
LAT_OPENdoubleГеографическая широта точки начала рабочего дня
LON_OPENdoubleГеографическая долгота точки начала рабочего дня
LAT_CLOSEdoubleГеографическая широта точки завершения рабочего дня
LON_CLOSEdoubleГеографическая долгота точки завершения рабочего дня
TZ_OFFSETintСмещение часового пояса сотрудникаПодразумевается часовой пояс, в котором день начат. При завершении дня время завершения приводится к часовому поясу начала дня.
TIME_FINISH_DEFAULTdatetimeВремя завершения дня по умолчаниюВыводится только для рабочих дней в статусе EXPIRED. "Рекомендуемое" значение завершения дня, которое можно выводить пользователю в качестве значения по умолчанию.


Пользовательские комментарии

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

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2024, «1С-Битрикс», 2024