workScheduleAccessService

workScheduleAccessService

• workScheduleAccessService
  • GetManyByUser(userId) ⇒ Promise.<ApiResult.<GetWorkSchedulesByUserResponseDto>>
  • GetActiveByUser(userId, [date]) ⇒ Promise.<ApiResult.<GetActiveWorkScheduleResponseDto>>
  • GetActive(params) ⇒ Promise.<ApiResult.<GetActiveWorkSchedulesResponseDto>>
  • Get(id) ⇒ Promise.<ApiResult.<GetWorkScheduleResponseDto>>
  • Create(params) ⇒ Promise.<ApiResult.<CreateWorkScheduleResponseDto>>
  • Update(params) ⇒ Promise.<ApiResult>
  • Close(params) ⇒ Promise.<ApiResult>
  • Remove(id) ⇒ Promise.<ApiResult>

WorkScheduleAccessService ⏏

Расписания работы офис-менеджеров (ManagerTimeTrackerService) — каркас планового рабочего времени, источник нормы для пары "план vs факт" и недельной нормы.

Kind: Exported class

---

GetManyByUser(userId) ⇒ Promise.<ApiResult.<GetWorkSchedulesByUserResponseDto>>

Возвращает всю историю расписаний пользователя (от новых к старым).

Принимаемые параметры

Param	Type	Description
userId	number	ID пользователя

Возвращаемые данные

Returns: Promise.<ApiResult.<GetWorkSchedulesByUserResponseDto>> - Список расписаний (GetWorkSchedulesByUserResponseDto)

---

GetActiveByUser(userId, [date]) ⇒ Promise.<ApiResult.<GetActiveWorkScheduleResponseDto>>

Возвращает расписание, действующее у пользователя на указанную дату (по умолчанию — сегодня UTC)

Принимаемые параметры

Param	Type	Description
userId	number	ID пользователя
[date]	string	Дата ISO YYYY-MM-DD; не передавайте, чтобы получить расписание на сегодня

Возвращаемые данные

Returns: Promise.<ApiResult.<GetActiveWorkScheduleResponseDto>> - Активное расписание под полем schedule (GetActiveWorkScheduleResponseDto)

INFO

schedule = null, если на эту дату нет активного расписания.

---

GetActive(params) ⇒ Promise.<ApiResult.<GetActiveWorkSchedulesResponseDto>>

Возвращает активные расписания всех менеджеров на указанную дату с пагинацией

Принимаемые параметры

Param	Type	Description
params	GetActiveWorkSchedulesRequestDto	Фильтры и параметры пагинации. См. GetActiveWorkSchedulesRequestDto

Возвращаемые данные

Returns: Promise.<ApiResult.<GetActiveWorkSchedulesResponseDto>> - Страница расписаний под полем pagination (GetActiveWorkSchedulesResponseDto)

INFO

userIds — null/не передан: фильтр не применяется; пустой массив: ничего не возвращается; массив с id: только перечисленные менеджеры. date — по умолчанию сегодня (UTC).

---

Get(id) ⇒ Promise.<ApiResult.<GetWorkScheduleResponseDto>>

Возвращает расписание по идентификатору.

Принимаемые параметры

Param	Type	Description
id	number	Идентификатор расписания

Возвращаемые данные

Returns: Promise.<ApiResult.<GetWorkScheduleResponseDto>> - Расписание под полем schedule (GetWorkScheduleResponseDto)

---

Create(params) ⇒ Promise.<ApiResult.<CreateWorkScheduleResponseDto>>

Создаёт новое расписание для пользователя

Принимаемые параметры

Param	Type	Description
params	CreateWorkScheduleRequestDto	Поля нового расписания. См. CreateWorkScheduleRequestDto

Возвращаемые данные

Returns: Promise.<ApiResult.<CreateWorkScheduleResponseDto>> - Идентификатор созданного расписания (CreateWorkScheduleResponseDto)

WARNING

Перекрытие с существующим открытым расписанием отклоняется (см. метод Close).

---

Update(params) ⇒ Promise.<ApiResult>

Обновляет существующее расписание. Идентификатор передаётся в теле.

Принимаемые параметры

Param	Type	Description
params	UpdateWorkScheduleRequestDto	Новое состояние расписания (включая id). См. UpdateWorkScheduleRequestDto

Возвращаемые данные

Returns: Promise.<ApiResult> - Подтверждение операции (successfully: true)

---

Close(params) ⇒ Promise.<ApiResult>

Закрывает расписание указанной датой — устанавливает validTo, чтобы было можно создать новое расписание со следующего дня.

Принимаемые параметры

Param	Type	Description
params	CloseWorkScheduleRequestDto	Идентификатор расписания и дата закрытия. См. CloseWorkScheduleRequestDto

Возвращаемые данные

Returns: Promise.<ApiResult> - Подтверждение операции (successfully: true)

---

Remove(id) ⇒ Promise.<ApiResult>

Soft-удаление расписания.

Принимаемые параметры

Param	Type	Description
id	number	Идентификатор расписания

Возвращаемые данные

Returns: Promise.<ApiResult> - Подтверждение операции (successfully: true)

---