Service Directory > v31.2 > Human_Resources > Put_Work_Schedule_Calendar
 

Operation: Put_Work_Schedule_Calendar

Adds or updates Work Schedule Calendar


@ - A parameter name with this symbol denotes an XML attribute within the document instead of an XML element.


Contents

 

Web Service

 

Request

 

Response

 

Element(s)

 

Request Element: Put_Work_Schedule_Calendar_Request

Put Work Schedule Calendar and Events.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only Flag. Indicates that the service is an add only, not an update.   
Work_Schedule_Calendar_Reference  Work_Schedule_CalendarObject  [0..1]  Reference for Work Schedule Calendar.   
Work_Schedule_Calendar_Data  Work_Schedule_Calendar_Data  [1..1]  Instance data for Work Schedule Calendar. 
Validation Description
An option must be chosen as the day breaker divider when the day breaker is not 12:00 AM. When the day breaker is 12:00 AM, day breaker divider must be left blank.   
Select a Biweekly Calculation Start Date that falls on the Work Week Start Day ( [Work Week Start Day] ).   
Only one schedule pattern is allowed per day. Edit the schedule patterns so that they do not start on the same day. The work schedule calendar in error is: [wsc]   
Combine schedule patterns on the same week that have identical Start Times, End Times, and meal times or schedule patterns on the same week that are 24-Hour Shifts and submit them as a single schedule pattern. The work schedule calendar in error is: [wsc]   
Schedule patterns cannot overlap with each other. Edit the pattern Start Times, End Times, Days of the Week, or Week Numbers so that the events do not overlap. Note: A schedule pattern may overlap with an event on another day if it crosses midnight. The work schedule calendar in error is: [wsc]   
Edit the schedule pattern so that the total number of hours for each day is greater than or equal to: [min number of hours per day]. Alternatively, edit the Minimum Number of Hours per Day so that it is less than or equal to the total number of hours for each day. The work schedule calendar is: [wsc]   
Edit the schedule pattern so that the total number of hours for each day is less than or equal to: [max number of hours per day]. Alternatively, edit the Maximum Number of Hours per Day so that it is greater than or equal to the total number of hours for each day. The work schedule calendar is: [wsc]   
Edit the meal duration so that it is greater than or equal to: [min meal duration]. Alternatively, edit the Minimum Meal Duration so that it is less than or equal to the meal duration for each schedule pattern. The schedule pattern in error belongs to this work schedule calendar: [wsc]   
Edit the meal duration so that it is less than or equal to: [max meal duration]. Alternatively, edit the Maximum Meal Duration so that it is greater than or equal to the meal duration for each schedule pattern. The schedule pattern in error belongs to this work schedule calendar: [wsc]   
Edit the schedule patterns so that the Start Times occur on or after the Flexible Start Times and the End Times occur on or before the Flexible End Times and the Start Times occur before the End Times. The schedule pattern in error belongs to this work schedule calendar [wsc].   
To add meals to patterns, the Enable Worker Editing Options field and the Allow Meals field must either be both selected or both cleared. Either select the fields, clear the fields, or remove the meals. The work schedule calendar in error is: [wsc]   
A work schedule calendar with Worker Editing Options enabled must have schedule patterns. Either add schedule patterns or clear the Enable Worker Editing Options field. The work schedule calendar in error is: [wsc]   
You must submit worker editing options for a work schedule calendar that has schedule patterns. Either add worker editing options or remove the schedule patterns. You can submit worker editing options that are disabled. The work schedule calendar in error is: [wsc]   
Because the Uniform Start and End Times field is selected, you must have no more than one schedule pattern per Week Number. Either clear the Uniform Start and End Times field or submit only one schedule pattern for each Week Number. The work schedule calendar in error is: [wsc]   
Edit the schedule patterns so that the total number of hours for each Week Number is greater than or equal to: [min number of hours per week]. Alternatively, edit the Minimum Number of Hours per Week so that it is less than or equal to the total number of hours for each week. The work schedule calendar is: [wsc]   
Edit the schedule patterns so that the total number of hours for each Week Number is less than or equal to: [max number of hours per week]. Alternatively, edit the Maximum Number of Hours per Week so that it is greater than or equal to the total number of hours for each week. The work schedule calendar is: [wsc]   
Edit the work schedule calendar so that it has only schedule patterns or only calendar events. The work schedule calendar in error is: [wsc]   
Add schedule patterns or clear the Number of Weeks and Pattern Start Date fields. The work schedule calendar in error is: [wsc]   
Enter a Number of Weeks and a Pattern Start Date or remove the schedule patterns. These fields are required when a work schedule calendar has schedule patterns. The work schedule calendar in error is: [wsc]   
Edit the work schedule calendar so that the Number of Weeks is 1 or 2, or remove the schedule patterns and clear the Pattern Start Date field. The work schedule calendar in error is: [wsc]   
 
Validation Description
Work Schedule Calendar ID already exists.   
top
 

Response Element: Put_Work_Schedule_Calendar_Response

Put Work Schedule Calendar response.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Work_Schedule_Calendar_Reference  Work_Schedule_CalendarObject  [0..1]  Reference for Work Schedule Calendar.   
top
 

Work_Schedule_CalendarObject

part of: Put_Work_Schedule_Calendar_Request, Put_Work_Schedule_Calendar_Response
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Work_Schedule_CalendarObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Work_Schedule_CalendarObjectID

part of: Work_Schedule_CalendarObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Work_Schedule_Calendar_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Work_Schedule_Calendar_Data

part of: Put_Work_Schedule_Calendar_Request
Instance data for Work Schedule Calendar.
 
Parameter name Type/Value Cardinality Description Validations
@ID  string  [1..1]  Text value for reference ID for Work Schedule Calendar.   
Name  string  [1..1]  Text name for Work Schedule Calendar.   
Schedule_Summary  string  [0..1]  A short description of the work schedule calendar or its restrictions to display to workers when they edit their work schedules.   
Description  string  [0..1]  Text description of Work Schedule Calendar.   
Condition_Rule_Reference  Condition_RuleObject  [0..1]  Reference to the Calendar Rule for the Work Schedule Calendar.   
Day_Breaker_Reference  Twenty_Four_Hour_TimeObject  [1..1]  Reference to Day Breaker for Work Schedule Calendar as Twenty Four Hour.   
Day_Breaker_Divides_Reference  Day_Breaker_DividerObject  [0..1]  Reference to Day Breaker Divider for Work Schedule Calendar.   
Work_Week_Start_Day_Reference  Day_of_the_WeekObject  [1..1]  Reference to day of the week which begins the work week. This setting only applies to time entry and does not affect the start day of a worker's schedule shown in My Schedule report.   
Biweekly_Calculation_Start_Date  date  [0..1]  Reference to Biweekly Calculation Start Date for Work Schedule Calendar.   
Pattern_Start_Date  date  [0..1]  The date on which the patterns begin cycling, if using Pattern Schedule Events. This setting does not affect the week start day of the My Schedule report.   
Number_of_Weeks  decimal (2, 0) >0   [0..1]  Number of Weeks for Work Schedule Calendar, if using Pattern Schedule Events. 
Validation Description
Enter a number of weeks that is less than or equal to 2.   
Remove weeks from the pattern. The maximum number of weeks for a pattern is 53.   
 
Work_Schedule_Calendar_Event_Data  Work_Schedule_Calendar_Event_Data  [0..*]  Work Schedule Calendar Event data. 
Validation Description
Meal times only allowed for calendar events spanning up to 24 hours.   
You can't include meals in a non-timed event. Remove the meal(s) from the event.   
Calendar events cannot have more than two meals.   
 
Worker_Edit_Options_Data  Worker_Editing_Options_Data  [0..1]  Instance data for Worker Editing Options for Work Schedule Calendar. 
Validation Description
Enter either 0 or 1 for the Enable Worker Editing Options field or remove any pattern schedule events along with all worker editing options. The work schedule calendar in error is: [wsc]   
Enter either 0 or 1 for the Change Scheduled and Non Scheduled Days field or clear the Enable Worker Editing Options field. The work schedule calendar in error is: [wsc]   
Enter either 0 or 1 for the Change Number of Scheduled Days field or clear the Change Scheduled and Non Scheduled Days field. The work schedule calendar in error is: [wsc]   
Enter either 0 or 1 for the Enable Hours Restrictions field or clear the Enable Worker Editing Options field. The work schedule calendar in error is: [wsc]   
Enter either 0 or 1 for the Change Daily Start and End Times field or clear the Enable Worker Editing Options field. The work schedule calendar in error is: [wsc]   
Enter either 0 or 1 for the Allow Meals field or clear the Enable Worker Editing Options field. The work schedule calendar in error is: [wsc]   
Enter either 0 or 1 for the Change Meal Start and End Times field or clear the Allow Meals field. The work schedule calendar in error is: [wsc]   
Enter either 0 or 1 for the Uniform Start and End Times field or clear the Change Daily Start and End Times field. The work schedule calendar in error is: [wsc]   
Submit a Maximum Meal Duration or clear the Minimum Meal Duration and Allow Meals field. The work schedule calendar in error is: [wsc]   
Submit a Minimum Meal Duration or clear the Maximum Meal Duration and Allow Meals field. The work schedule calendar in error is: [wsc]   
Submit a Flexible End Time or clear the Flexible Start Time and Change Daily Start and End Times fields. The work schedule calendar in error is: [wsc]   
Submit a Flexible Start Time or clear the Flexible End Time and Change Daily Start and End Times fields. The work schedule calendar in error is: [wsc]   
If selecting the Enable Worker Editing Options field, also select at least one of these options: Change Daily Start and End Times, Change Meal Start and End Times, or Change Scheduled and Non Scheduled Days. Otherwise, clear the Enable Worker Editing Options field. The work schedule calendar in error is: [wsc]   
 
Pattern_Schedule_Event_Data  Pattern_Schedule_Event_Data  [0..*]  Instance data for Schedule Pattern. This schedule pattern may be linked to schedule changes that a manager made. If you update this schedule pattern, you will also be deleting the manager's changes. 
Validation Description
A schedule pattern cannot have Meal Start or Meal End times if it is a 24-Hour Shift. Either clear the 24-Hour Shift field or remove the Meal Start and Meal End times. The schedule pattern belongs to this work schedule calendar: [wsc]   
One or more Meal Start and Meal End times is in error for a schedule pattern. Edit the schedule pattern so that Meal Start times occur after schedule pattern Start Times, Meal End times occur before schedule pattern End Times, and Meal Start times occur before Meal End times. The schedule pattern belongs to this work schedule calendar: [wsc]   
Either enter a Start Time and End Time or select 24-Hour Shift for the schedule pattern. The schedule pattern belongs to this work schedule calendar: [wsc]   
A schedule pattern cannot have Start or End Times if it is a 24-Hour Shift. Either clear the 24-Hour Shift field or remove the Start and End Times. The schedule pattern belongs to this work schedule calendar: [wsc]   
 
Validation Description
An option must be chosen as the day breaker divider when the day breaker is not 12:00 AM. When the day breaker is 12:00 AM, day breaker divider must be left blank.   
Select a Biweekly Calculation Start Date that falls on the Work Week Start Day ( [Work Week Start Day] ).   
Only one schedule pattern is allowed per day. Edit the schedule patterns so that they do not start on the same day. The work schedule calendar in error is: [wsc]   
Combine schedule patterns on the same week that have identical Start Times, End Times, and meal times or schedule patterns on the same week that are 24-Hour Shifts and submit them as a single schedule pattern. The work schedule calendar in error is: [wsc]   
Schedule patterns cannot overlap with each other. Edit the pattern Start Times, End Times, Days of the Week, or Week Numbers so that the events do not overlap. Note: A schedule pattern may overlap with an event on another day if it crosses midnight. The work schedule calendar in error is: [wsc]   
Edit the schedule pattern so that the total number of hours for each day is greater than or equal to: [min number of hours per day]. Alternatively, edit the Minimum Number of Hours per Day so that it is less than or equal to the total number of hours for each day. The work schedule calendar is: [wsc]   
Edit the schedule pattern so that the total number of hours for each day is less than or equal to: [max number of hours per day]. Alternatively, edit the Maximum Number of Hours per Day so that it is greater than or equal to the total number of hours for each day. The work schedule calendar is: [wsc]   
Edit the meal duration so that it is greater than or equal to: [min meal duration]. Alternatively, edit the Minimum Meal Duration so that it is less than or equal to the meal duration for each schedule pattern. The schedule pattern in error belongs to this work schedule calendar: [wsc]   
Edit the meal duration so that it is less than or equal to: [max meal duration]. Alternatively, edit the Maximum Meal Duration so that it is greater than or equal to the meal duration for each schedule pattern. The schedule pattern in error belongs to this work schedule calendar: [wsc]   
Edit the schedule patterns so that the Start Times occur on or after the Flexible Start Times and the End Times occur on or before the Flexible End Times and the Start Times occur before the End Times. The schedule pattern in error belongs to this work schedule calendar [wsc].   
To add meals to patterns, the Enable Worker Editing Options field and the Allow Meals field must either be both selected or both cleared. Either select the fields, clear the fields, or remove the meals. The work schedule calendar in error is: [wsc]   
A work schedule calendar with Worker Editing Options enabled must have schedule patterns. Either add schedule patterns or clear the Enable Worker Editing Options field. The work schedule calendar in error is: [wsc]   
You must submit worker editing options for a work schedule calendar that has schedule patterns. Either add worker editing options or remove the schedule patterns. You can submit worker editing options that are disabled. The work schedule calendar in error is: [wsc]   
Because the Uniform Start and End Times field is selected, you must have no more than one schedule pattern per Week Number. Either clear the Uniform Start and End Times field or submit only one schedule pattern for each Week Number. The work schedule calendar in error is: [wsc]   
Edit the schedule patterns so that the total number of hours for each Week Number is greater than or equal to: [min number of hours per week]. Alternatively, edit the Minimum Number of Hours per Week so that it is less than or equal to the total number of hours for each week. The work schedule calendar is: [wsc]   
Edit the schedule patterns so that the total number of hours for each Week Number is less than or equal to: [max number of hours per week]. Alternatively, edit the Maximum Number of Hours per Week so that it is greater than or equal to the total number of hours for each week. The work schedule calendar is: [wsc]   
Edit the work schedule calendar so that it has only schedule patterns or only calendar events. The work schedule calendar in error is: [wsc]   
Add schedule patterns or clear the Number of Weeks and Pattern Start Date fields. The work schedule calendar in error is: [wsc]   
Enter a Number of Weeks and a Pattern Start Date or remove the schedule patterns. These fields are required when a work schedule calendar has schedule patterns. The work schedule calendar in error is: [wsc]   
Edit the work schedule calendar so that the Number of Weeks is 1 or 2, or remove the schedule patterns and clear the Pattern Start Date field. The work schedule calendar in error is: [wsc]   
top
 

Condition_RuleObject

part of: Work_Schedule_Calendar_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Condition_RuleObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Condition_RuleObjectID

part of: Condition_RuleObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Condition_Rule_ID, WCP_Component_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Twenty_Four_Hour_TimeObject

part of: Work_Schedule_Calendar_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Twenty_Four_Hour_TimeObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Twenty_Four_Hour_TimeObjectID

part of: Twenty_Four_Hour_TimeObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Twenty_Four_Hour_Time_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Day_Breaker_DividerObject

part of: Work_Schedule_Calendar_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Day_Breaker_DividerObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Day_Breaker_DividerObjectID

part of: Day_Breaker_DividerObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Day_Breaker_Divider_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Day_of_the_WeekObject

part of: Recurrence_Data, Recurrence_Data, Work_Schedule_Calendar_Data, Pattern_Schedule_Event_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Day_of_the_WeekObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Day_of_the_WeekObjectID

part of: Day_of_the_WeekObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Day_of_the_Week_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Work_Schedule_Calendar_Event_Data

part of: Work_Schedule_Calendar_Data
Work Schedule Calendar Event data.
 
Parameter name Type/Value Cardinality Description Validations
@ID  string  [1..1]  Text value for reference ID for Work Schedule Calendar Event.   
Name  string  [1..1]  Text value for the name of the Work Schedule Calendar Event.   
Display_Name  string  [0..1]  Display Name of the Work Schedule Calendar Event.   
Start_End_Data  Start_End_Minute_Support_Data  [1..1]  Wrapper element containing date and times for the Calendar Event. 
Validation Description
The End Date must occur on or after the Start Date.   
The End Date/Time must be on or after the Start Date/Time.   
Start Date, Start Time, End Date and End Time are required if the event is not an all day event.   
 
Meal_Data  Calendar_Event_Non_Work_Data  [0..*]  Wrapper element containing meal times for the Work Schedule Calendar Event. 
Validation Description
Meal time cannot overlap with other meal time.   
Meal times must be within the calendar event range, and the meal start time must occur before the meal end time.   
 
Recurrence_Data  Recurrence_Data  [0..1]  Wrapper element containing recurrence data for the Calendar Event. 
Validation Description
Only Daily Recurrence, Weekly Recurrence, or Monthly Recurrence is allowed.   
Either 'Recurs Every Weekday' or 'Recurrence Interval Multiplier' must be specified.   
"Last Day of the Month" cannot be selected in conjunction with other Days of the Month.   
At least one value specified for "Day of the Week" must be the day of the week associated with the "Start Date".   
The End Date must occur on or after the Start Date.   
"Recurs Every x Week(s)" must be greater than 0 and less than 53 weeks.   
'Day of Month' must be specified and neither 'Day of Week' nor 'Week of Month' are specified OR 'Day of Month' is not specified but both 'Day of Week' and 'Week of Month' are specified.   
'Month' is required.   
'Day of the Week' is required.   
The Start Date for the recurrence range must be on the Start Date of the event.   
The start date must be on a weekday for events that recur every weekday.   
First Day of the Week can only be selected if also selecting Weekly Recurrence.   
 
Validation Description
Meal times only allowed for calendar events spanning up to 24 hours.   
You can't include meals in a non-timed event. Remove the meal(s) from the event.   
Calendar events cannot have more than two meals.   
top
 

Start_End_Minute_Support_Data

part of: Work_Schedule_Calendar_Event_Data
Wrapper element containing date and times for the Calendar Event.
 
Parameter name Type/Value Cardinality Description Validations
All_Day_Event  boolean  [0..1]  Boolean value for all day event for Calendar Event. If true, this event will occur all day. If false, this event will occur in the start to end date range.   
Start_Date  date  [1..1]  Date value for the start time for Calendar Event.   
Start_Time  time  [0..1]  Time value for the start time for Calendar Event.   
End_Date  date  [0..1]  Date value for the End Time for Calendar Event.   
End_Time  time  [0..1]  Time value for the end time for Calendar Event.   
Validation Description
The End Date must occur on or after the Start Date.   
The End Date/Time must be on or after the Start Date/Time.   
Start Date, Start Time, End Date and End Time are required if the event is not an all day event.   
top
 

Calendar_Event_Non_Work_Data

part of: Work_Schedule_Calendar_Event_Data
Wrapper element containing meal times for the Work Schedule Calendar Event.
 
Parameter name Type/Value Cardinality Description Validations
Meal_In  time  [1..1]  Meal In Time for the Work Schedule Calendar Event.   
Meal_Out  time  [1..1]  Meal Out Time for the Work Schedule Calendar Event.   
Validation Description
Meal time cannot overlap with other meal time.   
Meal times must be within the calendar event range, and the meal start time must occur before the meal end time.   
top
 

Recurrence_Data

part of: Work_Schedule_Calendar_Event_Data
Wrapper element containing recurrence data for the Calendar Event.
 
Parameter name Type/Value Cardinality Description Validations
Recurrence_Type_Reference  Schedule_Request_TypeObject  [1..1]  Reference for Run Frequency for Calendar Event.   
Recurrence_Interval_Multiplier  decimal (5, 2) >0   [0..1]  Numeric value for Recurrence Interval Multiplier for Calendar Event.   
Recurs_Every_Weekday  boolean  [0..1]  If true, calendar event recurs every weekday.   
Day_of_the_Week_Reference  Day_of_the_WeekObject  [0..*]  Reference for Day of the Week for Calendar Event.   
First_Day_of_the_Week_Reference  Day_of_the_WeekObject  [0..1]  First Day of the Week for Weekly Recurrences. Defaults to Sunday if not set.   
Month_Reference  MonthObject  [0..*]  Reference for Month for Calendar Event.   
Day_of_the_Month_Reference  Day_of_the_MonthObject  [0..*]  Reference for Day of the Month for Calendar Event.   
Week_of_the_Month_Reference  Week_of_the_MonthObject  [0..1]  Reference for Week of the Month for Calendar Event.   
Recurrence_Start_Date  date  [1..1]  Date value for Trigger Start Date for Calendar Event.   
Recurrence_End_Date  date  [0..1]  Date value for Trigger End Date for Calendar Event.   
Validation Description
Only Daily Recurrence, Weekly Recurrence, or Monthly Recurrence is allowed.   
Either 'Recurs Every Weekday' or 'Recurrence Interval Multiplier' must be specified.   
"Last Day of the Month" cannot be selected in conjunction with other Days of the Month.   
At least one value specified for "Day of the Week" must be the day of the week associated with the "Start Date".   
The End Date must occur on or after the Start Date.   
"Recurs Every x Week(s)" must be greater than 0 and less than 53 weeks.   
'Day of Month' must be specified and neither 'Day of Week' nor 'Week of Month' are specified OR 'Day of Month' is not specified but both 'Day of Week' and 'Week of Month' are specified.   
'Month' is required.   
'Day of the Week' is required.   
The Start Date for the recurrence range must be on the Start Date of the event.   
The start date must be on a weekday for events that recur every weekday.   
First Day of the Week can only be selected if also selecting Weekly Recurrence.   
top
 

Schedule_Request_TypeObject

part of: Recurrence_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Schedule_Request_TypeObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Schedule_Request_TypeObjectID

part of: Schedule_Request_TypeObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Schedule_Request_Type_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

MonthObject

part of: Recurrence_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  MonthObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

MonthObjectID

part of: MonthObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Month_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Day_of_the_MonthObject

part of: Recurrence_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Day_of_the_MonthObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Day_of_the_MonthObjectID

part of: Day_of_the_MonthObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Day_of_the_Month_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Week_of_the_MonthObject

part of: Recurrence_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Week_of_the_MonthObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Week_of_the_MonthObjectID

part of: Week_of_the_MonthObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Week_of_the_Month_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Worker_Editing_Options_Data

part of: Work_Schedule_Calendar_Data
Instance data for Worker Editing Options for Work Schedule Calendar.
 
Parameter name Type/Value Cardinality Description Validations
Enable_Worker_Editing_Options  boolean  [0..1]  Boolean value for enabling Worker Editing Options.   
Change_Scheduled_and_Non_Scheduled_Days  boolean  [0..1]  Boolean value for allowing Worker to Change Scheduled and Non-Scheduled Days for schedule pattern. 
Validation Description
Either select the Enable Worker Editing Options field or clear the Change Scheduled/Non-Scheduled Days field. The work schedule calendar in error is: [wsc]   
 
Change_Number_of_Scheduled_Days  boolean  [0..1]  Boolean value for allowing Worker to Change Number of Scheduled Days for schedule pattern. 
Validation Description
Either select the Enable Worker Editing Options field or clear the Change Number of Scheduled Days field. The work schedule calendar in error is: [wsc]   
Either select the Change Scheduled and Non Scheduled Days option if selecting the Change Number of Scheduled Days field, or clear the Change Number of Scheduled Days field. The work schedule calendar in error is: [wsc]   
Either select the Change Daily Start and End Times option if selecting the Change Number of Scheduled Days field, or clear the Change Number of Scheduled Days field. The work schedule calendar in error is: [wsc]   
 
Enable_Hours_Restrictions  boolean  [0..1]  Boolean value to enable Minimum/Maximum Number of Hours per Day and Minimum/Maximum Number of Hours per Week for schedule pattern. 
Validation Description
Either select the Enable Worker Editing Options field or clear the Enable Hours Restrictions field. The work schedule calendar in error is: [wsc]   
 
Minimum_Number_of_Hours_per_Day  decimal (4, 2) >0   [0..1]  Numeric value for Minimum Number of Hours per Day for schedule pattern. 
Validation Description
Enter a Minimum Number of Hours per Day that is between 1 and 24 hours. The work schedule calendar in error is: [wsc]   
Either select the Enable Hours Restrictions field or clear the Minimum Number of Hours per Day field. The work schedule calendar in error is: [wsc]   
 
Maximum_Number_of_Hours_per_Day  decimal (4, 2) >0   [0..1]  Numeric value for Maximum Number of Hours per Day for schedule pattern. 
Validation Description
Edit the work schedule calendar so that the Maximum Number of Hours per Day is greater than or equal to the Minimum Number of Hours per Day. The work schedule calendar in error is: [wsc]   
Enter a Maximum Number of Hours per Day that is between 1 and 24 hours. The work schedule calendar in error is: [wsc]   
Either select the Enable Hours Restrictions field or clear the Maximum Number of Hours per Day field. The work schedule calendar in error is: [wsc]   
 
Minimum_Number_of_Hours_per_Week  decimal (5, 2) >0   [0..1]  Numeric value for Minimum Number of Hours per Week for schedule pattern. 
Validation Description
Enter a Minimum Number of Hours per Week that is between 1 and 168 hours. The work schedule calendar in error is: [wsc]   
Either select the Enable Hours Restrictions field or clear the Minimum Number of Hours per Week field. The work schedule calendar in error is: [wsc]   
 
Maximum_Number_of_Hours_per_Week  decimal (5, 2) >0   [0..1]  Numeric value for Maximum Number of Hours per Week for schedule pattern. 
Validation Description
Edit the work schedule calendar so that the Maximum Number of Hours per Week is greater than or equal to the Minimum Number of Hours per Week. The work schedule calendar in error is: [wsc]   
Enter a Maximum Number of Hours per Week that is between 1 and 168 hours. The work schedule calendar in error is: [wsc]   
Either select the Enable Hours Restrictions field or clear the Maximum Number of Hours per Week field. The work schedule calendar in error is: [wsc]   
 
Change_Daily_Start_and_End_Times  boolean  [0..1]  Boolean value for allowing Worker to Change Daily Start and End Times for schedule pattern. 
Validation Description
Either select the Enable Worker Editing Options field or clear the Change Daily Start and End Times field. The work schedule calendar in error is: [wsc]   
 
Uniform_Start_and_End_Times  boolean  [0..1]  Boolean value for enforcing Uniform Start and End Times for schedule pattern. 
Validation Description
Either select the Change Daily Start and End Times field or clear the Uniform Start and End Times field. The work schedule calendar in error is: [wsc]   
 
Flexible_Start_Time  time  [0..1]  Minute-precision Time value for Flexible Start Time for schedule pattern. 
Validation Description
Either select the Change Daily Start and End Times field or clear the Flexible Start Time field. The work schedule calendar in error is: [wsc]   
Submit a Flexible Start Time or clear the Flexible End Time and Change Daily Start and End Times fields. The work schedule calendar in error is: [wsc]   
Enter a Flexible Start Time or clear the Flexible End Time field. The work schedule calendar in error is: [wsc]   
 
Flexible_End_Time  time  [0..1]  Minute-precision Time value for Flexible End Time for schedule pattern. 
Validation Description
Either select the Change Daily Start and End Times field or clear the Flexible End Time field. The work schedule calendar in error is: [wsc]   
Submit a Flexible End Time or clear the Flexible Start Time and Change Daily Start and End Times fields. The work schedule calendar in error is: [wsc]   
Enter a Flexible End Time or clear the Flexible Start Time field. The work schedule calendar in error is: [wsc]   
 
Allow_Meals  boolean  [0..1]  Boolean value for allowing Worker to have Meals for schedule pattern. 
Validation Description
Either select the Enable Worker Editing Options field or clear the Allow Meals field. The work schedule calendar in error is: [wsc]   
 
Change_Meal_Start_and_End_Times  boolean  [0..1]  Boolean value for allowing Worker to Change Meal Start and End Times for schedule pattern. 
Validation Description
Either select the Allow Meals field or clear the Change Meal Start and End Times field. The work schedule calendar in error is: [wsc]   
 
Minimum_Meal_Duration  decimal (3, 0) >0   [0..1]  Numeric value for Minimum Meal Duration in minutes for schedule pattern. 
Validation Description
Either select the Allow Meals field or clear the Minimum Meal Duration field. The work schedule calendar in error is: [wsc]   
Submit a Minimum Meal Duration or clear the Maximum Meal Duration and Allow Meals field. The work schedule calendar in error is: [wsc]   
Enter a Minimum Meal Duration or clear the Maximum Meal Duration field. The work schedule calendar in error is: [wsc]   
 
Maximum_Meal_Duration  decimal (3, 0) >0   [0..1]  Numeric value for Maximum Meal Duration in minutes for schedule pattern. 
Validation Description
Either select the Allow Meals field or clear the Maximum Meal Duration field. The work schedule calendar in error is: [wsc]   
Edit the work schedule calendar so that the Maximum Meal Duration is greater than or equal to the Minimum Meal Duration. The work schedule calendar in error is: [wsc]   
Submit a Maximum Meal Duration or clear the Minimum Meal Duration and Allow Meals field. The work schedule calendar in error is: [wsc]   
Enter a Maximum Meal Duration or clear the Minimum Meal Duration field. The work schedule calendar in error is: [wsc]   
 
Validation Description
Enter either 0 or 1 for the Enable Worker Editing Options field or remove any pattern schedule events along with all worker editing options. The work schedule calendar in error is: [wsc]   
Enter either 0 or 1 for the Change Scheduled and Non Scheduled Days field or clear the Enable Worker Editing Options field. The work schedule calendar in error is: [wsc]   
Enter either 0 or 1 for the Change Number of Scheduled Days field or clear the Change Scheduled and Non Scheduled Days field. The work schedule calendar in error is: [wsc]   
Enter either 0 or 1 for the Enable Hours Restrictions field or clear the Enable Worker Editing Options field. The work schedule calendar in error is: [wsc]   
Enter either 0 or 1 for the Change Daily Start and End Times field or clear the Enable Worker Editing Options field. The work schedule calendar in error is: [wsc]   
Enter either 0 or 1 for the Allow Meals field or clear the Enable Worker Editing Options field. The work schedule calendar in error is: [wsc]   
Enter either 0 or 1 for the Change Meal Start and End Times field or clear the Allow Meals field. The work schedule calendar in error is: [wsc]   
Enter either 0 or 1 for the Uniform Start and End Times field or clear the Change Daily Start and End Times field. The work schedule calendar in error is: [wsc]   
Submit a Maximum Meal Duration or clear the Minimum Meal Duration and Allow Meals field. The work schedule calendar in error is: [wsc]   
Submit a Minimum Meal Duration or clear the Maximum Meal Duration and Allow Meals field. The work schedule calendar in error is: [wsc]   
Submit a Flexible End Time or clear the Flexible Start Time and Change Daily Start and End Times fields. The work schedule calendar in error is: [wsc]   
Submit a Flexible Start Time or clear the Flexible End Time and Change Daily Start and End Times fields. The work schedule calendar in error is: [wsc]   
If selecting the Enable Worker Editing Options field, also select at least one of these options: Change Daily Start and End Times, Change Meal Start and End Times, or Change Scheduled and Non Scheduled Days. Otherwise, clear the Enable Worker Editing Options field. The work schedule calendar in error is: [wsc]   
top
 

Pattern_Schedule_Event_Data

part of: Work_Schedule_Calendar_Data
Instance data for Schedule Pattern. This schedule pattern may be linked to schedule changes that a manager made. If you update this schedule pattern, you will also be deleting the manager's changes.
 
Parameter name Type/Value Cardinality Description Validations
@ID  string  [1..1]  Text value for reference ID for Pattern Schedule Event.   
Week_Number  decimal (2, 0) >0   [1..1]  Numeric value for Pattern Week Number for Pattern Schedule Event. 
Validation Description
Edit the schedule pattern so that the Week Number is 1 or 2. The pattern in error belongs to this work schedule calendar: [wsc]   
Edit the schedule pattern so that the Week Number is 1. The pattern in error belongs to this work schedule calendar: [wsc]   
The number of weeks you entered is greater than the number of weeks defined for this work schedule calendar. Enter a value less than or equal to [number of weeks] weeks. The pattern in error belongs to this work schedule calendar: [wsc]   
 
Day_of_the_Week_Reference  Day_of_the_WeekObject  [1..*]  Day(s) of the Week for Pattern Schedule Event.   
Start_Time  time  [0..1]  Minute-precision Start Time for Pattern Schedule Event. Note: This is also referred to as the In time for the schedule pattern.   
End_Time  time  [0..1]  Minute-precision End Time for Pattern Schedule Event. Note: This is also referred to as the Out time for the schedule pattern.   
_24_Hour_Shift  boolean  [0..1]  Boolean value specifying whether the Pattern Schedule Event is a 24-Hour Shift. 
Validation Description
A schedule pattern cannot have Start or End Times if it is a 24-Hour Shift. Either clear the 24-Hour Shift field or remove the Start and End Times. The schedule pattern belongs to this work schedule calendar: [wsc]   
 
Meal_Start  time  [0..1]  Minute-precision Meal Start Time for Pattern Schedule Event. 
Validation Description
Enter a Meal Start or clear the Meal End field. The work schedule calendar in error is: [wsc]   
 
Meal_End  time  [0..1]  Minute-precision Meal End Time for Pattern Schedule Event. 
Validation Description
Enter a Meal End or clear the Meal Start field. The work schedule calendar in error is: [wsc]   
 
Validation Description
A schedule pattern cannot have Meal Start or Meal End times if it is a 24-Hour Shift. Either clear the 24-Hour Shift field or remove the Meal Start and Meal End times. The schedule pattern belongs to this work schedule calendar: [wsc]   
One or more Meal Start and Meal End times is in error for a schedule pattern. Edit the schedule pattern so that Meal Start times occur after schedule pattern Start Times, Meal End times occur before schedule pattern End Times, and Meal Start times occur before Meal End times. The schedule pattern belongs to this work schedule calendar: [wsc]   
Either enter a Start Time and End Time or select 24-Hour Shift for the schedule pattern. The schedule pattern belongs to this work schedule calendar: [wsc]   
A schedule pattern cannot have Start or End Times if it is a 24-Hour Shift. Either clear the 24-Hour Shift field or remove the Start and End Times. The schedule pattern belongs to this work schedule calendar: [wsc]   
top
 

Work_Schedule_CalendarReferenceEnumeration

part of: Work_Schedule_CalendarObjectID
Base Type
string
top
 

Condition_RuleReferenceEnumeration

part of: Condition_RuleObjectID
Base Type
string
top
 

Twenty_Four_Hour_TimeReferenceEnumeration

part of: Twenty_Four_Hour_TimeObjectID
Base Type
string
top
 

Day_Breaker_DividerReferenceEnumeration

part of: Day_Breaker_DividerObjectID
Base Type
string
top
 

Day_of_the_WeekReferenceEnumeration

part of: Day_of_the_WeekObjectID
Base Type
string
top
 

Schedule_Request_TypeReferenceEnumeration

part of: Schedule_Request_TypeObjectID
Base Type
string
top
 

MonthReferenceEnumeration

part of: MonthObjectID
Base Type
string
top
 

Day_of_the_MonthReferenceEnumeration

part of: Day_of_the_MonthObjectID
Base Type
string
top
 

Week_of_the_MonthReferenceEnumeration

part of: Week_of_the_MonthObjectID
Base Type
string
top