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

timeman.timecontrol.reports.get

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

Метод для получения отчета о выявленных отсутствиях.

Параметры

ПараметрПримерОбязательныйОписание
USER_ID 2 Да Идентификатор пользователя.
YEAR 2018 Да Год для формирования отчета.
MONTH 8 Да Месяц для формирования отчета.
WORKDAY_HOURS 8 Нет Необходимая продолжительность рабочего дня в часах (по-умолчанию 8 часов).
IDLE_MINUTES 15 Нет Максимальное время отсутствия на рабочем месте, которое не будет учитываться как отсутствие.

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

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

JavaScript

BX24.callMethod('timeman.timecontrol.reports.get', {
	user_id: 2,
	year: 2018,
	month: 8,
	workday_hours: 8,
	idle_minutes: 15
}, function(result){
	if(result.error())
	{
		console.error(result.error().ex);
	}
	else
	{
		console.log(result.data());
	}
});

PHP

$result = restCommand('timeman.timecontrol.reports.get', Array(
	'USER_ID => 2,
	'YEAR' => 2018,
	'MONTH' => 8,
	'WORKDAY_HOURS' => 8,
	'IDLE_MINUTES' => 15
), $_REQUEST["auth"]);

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

{
	"result": {
		report: {
			month_title: 'Август',
			date_start: "2018-08-01T00:00:00+03:00",
			date_finish: "2018-08-31T23:59:59+03:00",
			days: [
				{
					index: "20180816",
					day_title: "16.08.2018",
					workday_complete: false,
					workday_date_start: "2018-08-16T14:08:35+03:00",
					workday_date_finish: "2018-08-16T11:20:00+03:00",
					workday_duration: 10115,
					workday_duration_config: 28800,
					workday_duration_final: 6914,
					workday_time_leaks_user: 0,
					workday_time_leaks_real: 3201,
					workday_time_leaks_final: 21886,
					reports: [
						{
							id: 459,
							type: "TM_START",
							date_start: "2018-08-16T14:08:35+03:00",
							date_finish: "2018-08-16T14:08:35+03:00",
							duration: 0,
							active: false,
							entry_id: 35,
							report_type: "NONE",
							report_text: null,
							system_text: "",
							source_start: "TM_EVENT",
							source_finish: "TM_EVENT",
							ip_start: "93.60.295.11",
							ip_finish: "10.10.255.255",
							ip_start_network: false,
							ip_finish_network: {
								ip: "10.10.255.255",
								range: "10.0.0.0-10.255.255.255",
								name: "Офисная сеть 10.x.x.x"
							}
						}
					]
				}
			]
		},
		user: {
			id:2,
			name:"Мария Ившина",
			first_name:"Мария",
			last_name:"Ившина",
			work_position:"IT-специалист",
			avatar:"http://test.bitrix24.com/upload/resize_cache/main/072/100_100_2/42-17948709.gif",
			last_activity_date:"2018-08-15T16:25:34+03:00"
		}

	}
}

Описание ключей

  • report - информация об отчете.
    • month_title - название месяца.
    • date_start - дата начала периода выборки в формате АТОМ.
    • date_finish - дата окончания периода выборки в формате АТОМ.
    • days - список отработанных дней.
      • index - индекс дня недели.
      • day_title - дата (в формате сайте).
      • workday_complete - рабочий день завершен (true / false).
      • workday_date_start - дата начала рабочего дня в формате АТОМ.
      • workday_date_finish - дата окончания рабочего дня в формате АТОМ (если workday_complete = false, в данном поле указывается дата на момент формирования отчета).
      • workday_duration - продолжительность рабочего дня по табелю в секундах (с учетом установленного пользователем перерыва).
      • workday_duration_final - продолжительность рабочего дня по фактической выработке в секундах (с учетом установленного пользователем перерыва, не подтвержденных отсутствий и отсутствий по личным делам).
      • workday_duration_config - необходимая продолжительность рабочего дня в секундах.
      • workday_time_leaks_user - продолжительность перерыва установленного пользователем в секундах.
      • workday_time_leaks_real - продолжительность перерыва установленного автоматической системой фиксации (не подтвержденные отсутствий и отсутствий по личным делам).
      • workday_time_leaks_final - если число положительное: количество не доработанного времени в секундах; если число отрицательное: количество времени отработанных сверх положенного времени (переработка).
      • reports - список записей выявленных отсутствий (значения доступны только на уровне детализации head и full).
        • id - идентификатор записи, необходим для использования метода timeman.timecontrol.report.add.
        • type - тип записи (справочник типов описан ниже).
        • active - активность записи.
        • date_start- дата начала фиксации в формате АТОМ.
        • date_finish - дата окончания фиксации в формате АТОМ (если active = true в данном поле указывается дата на момент формирования отчета).
        • report_type - тип отсутствия (work - по рабочим вопросам, private - личные дела, none - не задан, приравнивается к private).
        • report_text - описание причины отсутствия.
        • system_text - системное описание причины отсутствия (параметр доступен только на уровне детализации head).
        • source_start - поставщик данных начала записи (справочник типов описан ниже).
        • source_finish - поставщик данных окончания записи (справочник типов описан ниже).
        • ip_start - ip-адрес на момент начала записи (параметр доступен только на уровне детализации head).
        • ip_start_network - расшифровка ip-адреса на момент начала записи, если ip-адрес не входит в офисную сеть - false (параметр доступен только на уровне детализации head).
          • ip - ip-адрес на момент начала записи .
          • range - диапазон, в который входит указанный IP-адрес.
          • name - название диапазона, в который входит указанный IP-адрес.
        • ip_finish - ip-адрес на момент окончания записи (параметр доступен только на уровне детализации head).
        • ip_finish_network - расшифровка ip-адрес на момент окончания записи, если ip-адрес не входит в офисную сеть - false (параметр доступен только на уровне детализации head).
          • ip - ip-адрес на момент окончания записи.
          • range - диапазон, в который входит указанный IP-адрес.
          • name - название диапазона, в который входит указанный IP-адрес.
  • user - информация о пользователе.
    • id - идентификатор пользователя.
    • name - имя и фамилия пользователя.
    • first_name - имя пользователя.
    • last_name - фамилия пользователя.
    • work_position - должность.
    • avatar - ссылка на аватар (если пусто, значит аватар не задан).
    • personal_gender - пол пользователя.
    • last_activity_date - дата последнего действия пользователя в формате АТОМ.

Возможные типы записей (type)

  • IDLE - Отошел (фиксируется с помощью десктоп приложения).
  • OFFLINE - Офлайн.
  • DESKTOP_ONLINE - Зафиксирован запуск десктоп приложения (тип доступен только на уровне детализации head).
  • DESKTOP_OFFLINE - Зафиксирован выключенное десктоп приложение (тип доступен только на уровне детализации head).
  • DESKTOP_START - Зафиксирован запуск десктоп приложения (тип доступен только на уровне детализации head).
  • TM_START - Начал рабочий день.
  • TM_PAUSE - Ушел на перерыв.
  • TM_CONTINUE - Продолжил день.
  • TM_END - Завершил рабочий день.

Возможные источники записей (source_start, source_finish)

  • ONLINE_EVENT - Событие авторизации пользователя.
  • OFFLINE_AGENT - Агент проставляющий статус оффлайн.
  • DESKTOP_OFFLINE_AGENT - Агент проставляющий признак выключенного десктоп приложения.
  • DESKTOP_ONLINE_EVENT - Событие проставляющий признак включенного десктоп приложения.
  • DESKTOP_START_EVENT - Событие проставляющий признак включенного десктоп приложения.
  • IDLE_EVENT - Событие изменение стаса отошел (фиксируется с помощью десктоп приложения).
  • TM_EVENT - Событие изменения рабочего дня (начало, перерыв, окончание).

Пример ответа при возникновении ошибки

{
    "error": "ACCESS_ERROR",
    "error_description": "You don't have access to this method"
}
  • Ключ error - код возникшей ошибки.
  • Ключ error_description - краткое описание возникшей ошибки.

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

КодОписание
ACCESS_ERRORУказанный метод не доступен пользователю.
USER_ACCESS_ERRORНет доступа к указанному пользователю.


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

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

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

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

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