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, во всех остальных случаях вернется ошибка.

Поля ответа

Поле	Тип	Описание	Примечание
STATUS	string	Статус текущего рабочего дня.	Варианты значений: OPENED - рабочий день идет CLOSED - рабочий день закрыт PAUSED - рабочий день приостановлен EXPIRED - рабочий день истек (был открыт до начала текущих календарных суток и не закрыт)
TIME_START	datetime	Дата-время начала рабочего дня.	Часовой пояс соответствует часовому поясу начала рабочего дня
TIME_FINISH	datetime	Дата-время заверения рабочего дня	Для незавершенного рабочего дня возвращается null
DURATION	HH:MM:SS	Длительность рабочего дня	Для незавершенного рабочего дня возвращается 00:00:00
TIME_LEAKS	HH:MM:SS	Суммарная длительность перерыва за день
ACTIVE	true\|false	Подтвержденность рабочего дня	Значение false означает, что изменение рабочего дня ожидает подтверждения руководителем
IP_OPEN	string	IP-адрес, с которого был начат рабочий день
IP_CLOSE	string	IP-адрес, с которого был завершен рабочий день	Для незавершенного рабочего дня возвращается null
LAT_OPEN	double	Географическая широта точки начала рабочего дня
LON_OPEN	double	Географическая долгота точки начала рабочего дня
LAT_CLOSE	double	Географическая широта точки завершения рабочего дня
LON_CLOSE	double	Географическая долгота точки завершения рабочего дня
TZ_OFFSET	int	Смещение часового пояса сотрудника	Подразумевается часовой пояс, в котором день начат. При завершении дня время завершения приводится к часовому поясу начала дня.
TIME_FINISH_DEFAULT	datetime	Время завершения дня по умолчанию	Выводится только для рабочих дней в статусе EXPIRED. "Рекомендуемое" значение завершения дня, которое можно выводить пользователю в качестве значения по умолчанию.