API справочника «График рабочего времени»

Параметр
* — обязательный
** — условно-обязательный

Тип

Описание

id*

строка
UUID

идентификатор графика рабочего времени. При создании укажите null — система сгенерирует новый идентификатор, которым в дальнейшем необходимо пользоваться для его обновления, чтения или удаления

name*

строка

название графика. Должно быть уникальное в рамках аккаунта. Регистр учитывается, может быть любой

description

строка

комментарий, например описание графика

isHidden

логический

признак, который указывает, что график скрыт (помещен в архив). На архивный график нельзя принимать сотрудников. Доступен только для чтения

isMain

логический

признак, который указывает, что график является основным. Может быть только один основной график. Основной график подставляется по умолчанию в документ «Прием на работу» при его создании. Доступен только для чтения

settingsRevisions*

массив

настройки графика по периодам — ревизии. Одна ревизия — один элемент массива. Минимальный период — календарный месяц. Периоды не могут пересекаться

dateFrom*

строка
«ГГГГ-ММ-ДД»

дата начала (первое число месяца) действия настроек графика. Если ревизии не нужны, укажите null. Действие настройки в прошлое не ограничено. Может быть только одна ревизия с нулевым полем

dateTo

строка
«ГГГГ-ММ-ДД»

дата окончания (последнее число месяца) действия настроек. Параметр доступен только для чтения. Если действие настройки в будущее не ограничено, в результате вернется null.

businessCalendarName*

строка

название производственного календаря. Определяется по точному наименованию календаря. Справочник можно просмотреть в настройках. Если не задан или не найден, будет использован основной производственный календарь РФ. Если передана строка «по календарю подразделения», то будет использоваться производственный календарь, установленный на подразделении, в которое принимают сотрудника

ignoreCalendar*

логический

при значении true производственный календарь не учитывается

timeControl*

число

устанавливает режим контроля рабочего времени для графика. Возможные значения

Если timeControl = 2, то параметры: workStartFrom, workStartTo, workEndFrom, workEndTo, workStartStaff не передаются. При значении timeControl — 1 или 3, передайте workStartStaff

controlPeriod*

число

тип учета рабочего времени, указанный в вашей системе. Возможные значения

Если controlPeriod = 0, то параметр planTime не передается

planTime**

число

плановая норма часов работы в неделю, в минутах

workStartFrom**

число

начало рабочего дня, указывается количество минут от начала суток до начала рабочего дня. Например, для жесткого графика (timeControl = 0) должно совпадать с правой границей окончания («workStartTo»)

workStartTo**

число

начало рабочего дня, указывается количество минут от начала суток до начала рабочего дня. Например, для жесткого графика совпадает с левой границей (workStartFrom)

workEndFrom**

число

окончание рабочего дня, указывается количество минут от начала суток до окончания рабочего дня. Например, для жесткого графика (timeControl = 0) должно совпадать с правой границей окончания (workEndTo)

workEndTo**

число

окончание рабочего дня, указывается количество минут от начала суток до окончания рабочего дня. Например, для жесткого графика совпадает с левой границей (workEndFrom)

workStartStaff**

число

штатное время начала работы, указывается количество минут от начала суток до начала смены. Например, если смена начинается в 08:00, то workStartStaff = 480. Для гибкого графика события на день (отпуск, командировка, больничный) будут отмечены в календаре по времени штатного рабочего дня

dinners**

массив

интервал обеденного перерыва. Значение используется при новом подключении API. Если у вас уже есть подключение, то для указания обеденного перерыва используются поля «dinnerStart», «dinnerEnd», «dinnerDuration».

Можно передать не более 2 объектов. Если передано пустое значение или null, то обед не задан на графике

start

число

начало обеда, указывается количество минут от начала суток до начала обеденного перерыва. Например, если обед начинается в 12:30, то start = 750

end

число

окончание обеда, указывается количество минут от начала суток до обеденного перерыва. Например, если обед заканчивается в 13:30, то end = 810

minDuration

число

минимальная продолжительность обеда, указывается количество минут от начала обеденного перерыва до его окончания. Используется для гибких графиков. Для остальных может отсутствовать или быть равно null

maxDuration

число

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

dinnerStart

число

начало перерыва на обед, указывается количество минут от начала обеденного перерыва до его окончания. Например, если обед начинается в 12:30, то dinnerStart = 750. Если обеда нет или задано значение «dinners», можно не указывать

dinnerEnd

число

окончание перерыва на обед, указывается количество минут от начала обеденного перерыва до его окончания. Например, если обед заканчивается в 13:30, то dinnerEnd = 810. Если обеда нет или задано значение «dinners», можно не указывать

dinnerDuration

число

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

workDuration*

число

продолжительность рабочего дня (включая обед), указывается количество минут от начала рабочего дня до его окончания

planDaysType*

число

привязка плановых дней к неделе или к циклу. Возможные значения: «1» — с привязкой к неделе, «2» — по произвольному циклу

planDaysTemplates*

массив

шаблон распределения времени работы для плановых дней. Если PlanDaysType = 1, то в PlanDaysTemplates должно быть 7 элементов. Иначе — количество дней в цикле (максимальная продолжительность 31). Для каждого элемента укажите количество рабочих часов в минутах без учета обеда. Если значение 0, значит, день выходной

violationsControl*

число

типы нарушений, которые нужно контролировать. Битовая маска, возможны комбинации из значений

allowableDelay*

число

допустимое опоздание в минутах, в течении этого промежутка времени нарушение формироваться не будет

timeMarks*

массив объектов

метки в табеле, привязанные к ревизии

name*

строка

название метки для текущей ревизии графика

timeMarkName

строка

краткое название метки табеля

begin*

число

начало действия метки, указывается количество минут от начала суток до начала действия метки

end*

число

окончание действия метки, начало действия метки, указывается количество минут от начала суток до конца действия метки

dayType*

число

тип дня, в который действует метка. Возможные значения: «0» — рабочий, «1» — выходной, «2» — праздничный

isIndividualTimeControl*

логический

устанавливает сменный режим работы. Используется только для жесткого контроля рабочего времени timeControl = 0. Возможные значения: true — сменный график, смены задаются через массив «shifts», и false — работа в одинаковое время

shiftNotificationBefore*

число

указывает, за сколько дней до начала периода shiftNotificationPeriod нужно уведомлять сотрудников о расстановке рабочих дней на графике. Обязательный, если «isIndividualTimeControl»: true. Значение передается в минутах, кратных дню (в диапазоне от 1440 до 7200). Используется только для графика с жестким контролем рабочего времени с установленными сменами («isIndividualTimeControl»: true)

shiftNotificationPeriod*

число

устанавливает, какой период рабочих смен будет отображаться в уведомлении для сотрудников. Значение передается в минутах, кратных дню. Используется только для графика с жестким контролем рабочего времени с установленными сменами (isIndividualTimeControl: true) Возможные значения

shifts

массив объектов

список смен, связанных с графиком. Первая смена в списке — базовая, используется как смена по умолчанию. Используется для жесткого графика со сменами (isIndividualTimeControl = true). В остальных случаях указывайте значение true

name

строка

название смены

begin

число

начало смены, указывается количество минут от начала суток до начала смены. Например, если смена начинается в 08:00, begin = 480

end

число

окончание смены, указывается количество минут от начала суток до окончания смены. Например, если смена заканчивается в 17:00, end = 1020

dinners

массив

интервал обеденного перерыва при сменном графике работ. Если указан null или параметр не задан, настройки соответствуют общим настройкам обеда. Если задано пустое значение, обед на смене отсутствует.

start

число

начало обеда, указывается количество минут от начала суток до начала обеда

end

число

окончание обеда, указывается количество минут от начала суток до окончания обеда

duration

число

продолжительность обеда, в минутах