publicHolidayAccessService
publicHolidayAccessService
- publicHolidayAccessService
- GetManyByYear(year, [regionCodeId]) ⇒
Promise.<ApiResult.<GetPublicHolidaysResponseDto>> - Get(id) ⇒
Promise.<ApiResult.<GetPublicHolidayResponseDto>> - Create(params) ⇒
Promise.<ApiResult.<CreatePublicHolidayResponseDto>> - Update(params) ⇒
Promise.<ApiResult> - Remove(id) ⇒
Promise.<ApiResult>
- GetManyByYear(year, [regionCodeId]) ⇒
PublicHolidayAccessService ⏏
Доступ к справочнику государственных и региональных праздников Германии (BusinessLogicService). Используется при построении планового расписания — в день праздника план = 0 минут.
Kind: Exported class
GetManyByYear(year, [regionCodeId]) ⇒ Promise.<ApiResult.<GetPublicHolidaysResponseDto>>
Получает список праздников за указанный год. Если задан regionCodeId, в выдачу попадают федеральные (regionCodeId == null) и праздники указанной федеральной земли.
Принимаемые параметры
| Param | Type | Description |
|---|---|---|
| year | number | Год праздников (например, 2026) |
| [regionCodeId] | number | Идентификатор федеральной земли. Если не передан, возвращаются все праздники года. |
Возвращаемые данные
Returns: Promise.<ApiResult.<GetPublicHolidaysResponseDto>> - Список праздников (GetPublicHolidaysResponseDto)
Get(id) ⇒ Promise.<ApiResult.<GetPublicHolidayResponseDto>>
Получает праздник по его идентификатору.
Принимаемые параметры
| Param | Type | Description |
|---|---|---|
| id | number | Идентификатор праздника |
Возвращаемые данные
Returns: Promise.<ApiResult.<GetPublicHolidayResponseDto>> - Запись праздника под полем holiday (GetPublicHolidayResponseDto)
Create(params) ⇒ Promise.<ApiResult.<CreatePublicHolidayResponseDto>>
Добавляет новую запись праздника. Уникален по паре (date, regionCodeId).
Принимаемые параметры
| Param | Type | Description |
|---|---|---|
| params | CreatePublicHolidayRequestDto | Поля нового праздника. См. CreatePublicHolidayRequestDto |
Возвращаемые данные
Returns: Promise.<ApiResult.<CreatePublicHolidayResponseDto>> - Идентификатор созданной записи (CreatePublicHolidayResponseDto)
Update(params) ⇒ Promise.<ApiResult>
Обновляет существующую запись праздника. Идентификатор передаётся в теле запроса.
Принимаемые параметры
| Param | Type | Description |
|---|---|---|
| params | UpdatePublicHolidayRequestDto | Новое состояние праздника (включая id). См. UpdatePublicHolidayRequestDto |
Возвращаемые данные
Returns: Promise.<ApiResult> - Подтверждение операции (successfully: true)
Remove(id) ⇒ Promise.<ApiResult>
Soft-удаление праздника. Запись помечается как удалённая.
Принимаемые параметры
| Param | Type | Description |
|---|---|---|
| id | number | Идентификатор праздника |
Возвращаемые данные
Returns: Promise.<ApiResult> - Подтверждение операции (successfully: true)