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

timeman.status

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

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

Метод возвращает информацию о текущем рабочем дне.

Примеры

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

https://portal.bitrix24.com/rest/timeman.status/?auth=xxxxxx&user_id=1

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

{
	"result": {
		"STATUS": "PAUSED", 
		"TIME_START": "2017-04-21T02:33:44+02:00", 
		"TIME_FINISH": "2017-04-21T15:11:26+02:00", 
		"DURATION": "00:00:00", 
		"TIME_LEAKS": "00:00:00", 
		"ACTIVE": false, 
		"IP_OPEN": "192.168.0.1", 
		"IP_CLOSE": "192.168.0.100", 
		"LAT_OPEN": 55.33, 
		"LON_OPEN": 20.5, 
		"LAT_CLOSE": 0, 
		"LON_CLOSE": 0, 
		"TZ_OFFSET": 7200
	}
}

Параметры

ПараметрОписание
USER_IDИдентификатор пользователя. Не обязателен, по умолчанию возвращаются настройки текущего пользователя.

Поля ответа

Поле ТипОписаниеПримечание
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. "Рекомендуемое" значение завершения дня, которое можно выводить пользователю в качестве значения по умолчанию.

Если пользователь ни разу не начинал рабочий день, будет отдан сокращенный ответ, содержащий только поле STATUS со значением CLOSED.



© «Битрикс», 2001-2024, «1С-Битрикс», 2024