NextGen APIs

POST /workforce/calendars/r1/work-shift-exceptions


Http Verb

POST

Url

/workforce/calendars/r1/work-shift-exceptions

Permissions required


Personally Identifiable Information (PII)

No

Sensitive Information

No

Last Modified Version

r1

Released since

2024 W2 (FSM 17.0)

Deprecated since


Removed since


Tech Tags

 

Business Logic

This business task orchestrates the insertion of work shift exceptions, through a comprehensive workflow that ensures data integrity and business rule compliance.

The process involves:

  • Validating the work shift exception by checking required fields, date consistency, maximum one-day coverage, and ensuring that hourly presence exceptions do not overlap multiple shifts or crew shell shifts.

  • Handling work shift exception types:

    • For extra presence, enables assigning outside regular shifts

    • For absence, reduces the assignable portion of the shift

  • Saving the work shift exception

  • Updates relationships between the work shift exception and the affected work shifts

Please note that the API currently (2024 W2 (FSM 17.0)) does not manage the addition of work shift exceptions on crew shell’s work shifts.

Header Parameters

Default.

Request Body Parameters

Field

Validations

Note

resourceId

Max Lenght: 10
Mandatory

 

startDate

Format: ISO-8601
Mandatory

Max range between start and end date is 24 hours


endDate

Format: ISO-8601

Mandatory

Max range between start and end date is 24 hours


workShiftExceptionTypeId

Max Lenght: 10
Mandatory


note

Max Lenght: 1000

Not mandatory


Response documentation

Response payload fields

Field

Note

id

 

Response error codes

CALENDAR_009, CALENDAR_006, CALENDAR_004, CALENDAR_005