Service Directory > v25.1 > Human_Resources > Get_Work_Schedule_Calendars
 

Operation: Get_Work_Schedule_Calendars

View Work Schedule Calendars.


@ - 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: Get_Work_Schedule_Calendars_Request

Request to get Work Schedule Calendar.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Work_Schedule_Calendar_Request_References  [0..1]  Wrapper for Work Schedule Calendar references.   
Request_Criteria [Choice]   Work_Schedule_Calendar_Request_Criteria  [0..1]  Request criteria for Work Schedule Calendar response.   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Work_Schedule_Calendar_Response_Group  [0..1]  Options for responded Work Schedule Calendar.   
top
 

Response Element: Get_Work_Schedule_Calendars_Response

Response for Get Work Schedule Calendar.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Work_Schedule_Calendar_Request_References  [0..1]  Wrapper for Work Schedule Calendar references.   
Request_Criteria  Work_Schedule_Calendar_Request_Criteria  [0..1]  Request criteria for Work Schedule Calendar response.   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Work_Schedule_Calendar_Response_Group  [0..1]  Options for responded Work Schedule Calendar.   
Response_Results  Response_Results  [0..1]  The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.   
Response_Data  Work_Schedule_Calendar_Response_Data  [0..1]  Retrieved Work Schedule Calendar.   
top
 

Work_Schedule_Calendar_Request_References

part of: Get_Work_Schedule_Calendars_Request, Get_Work_Schedule_Calendars_Response
Wrapper for Work Schedule Calendar references.
 
Parameter name Type/Value Cardinality Description Validations
Work_Schedule_Calendar_Request_Reference  Work_Schedule_CalendarObject  [1..*]  Reference for Work Schedule Calendar.   
top
 

Work_Schedule_CalendarObject

part of: Work_Schedule_Calendar_Request_References, Work_Schedule_Calendar
 
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_Request_Criteria

part of: Get_Work_Schedule_Calendars_Request, Get_Work_Schedule_Calendars_Response
Request criteria for Work Schedule Calendar response.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Work_Schedule_Calendars_Request, Get_Work_Schedule_Calendars_Response
Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.
 
Parameter name Type/Value Cardinality Description Validations
As_Of_Effective_Date  date  [0..1]  Indicates the date when application data, such as benefits and compensation, are deemed effective in the Workday system. (Also referred to as the "Effective Moment".) If not specified, this date defaults to TODAY.   
As_Of_Entry_DateTime  dateTime  [0..1]  Indicates the date and time that data was entered into the system. (This field is also referred to as the "Entry Moment".) If not specified, defaults to the CURRENT DATE/TIME.   
Page  decimal (12, 0) >0   [0..1]  Indicates the page of data to return in the response, and defaults to the first page (Page = 1). For responses that contain more than one page of data, use this parameter to retrieve the additional pages of data. For example, set Page = 2 to retrieve the second page of data. Note: If you set the page parameter, you must also specify the "As_Of_Entry_Date" to ensure that the result set remains the same between your requests.   
Count  decimal (3, 0) >0   [0..1]  Sets the number of objects to return within each response page (Min = 1, Max = 999, Default = 100 if not set). Any values you set must be between 1-999.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Work_Schedule_Calendar_Response_Group

part of: Get_Work_Schedule_Calendars_Request, Get_Work_Schedule_Calendars_Response
Options for responded Work Schedule Calendar.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Boolean value to include references for Work Schedule Calendar.   
Include_Work_Schedule_Calendar_Data  boolean  [0..1]  Boolean value to include holiday calendar data for Work Schedule Calendar.   
top
 

Response_Results

part of: Get_Work_Schedule_Calendars_Response
The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.
 
Parameter name Type/Value Cardinality Description Validations
Total_Results  decimal (12, 0) >0   [0..1]  The total number of results that have been returned from your request.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages that exist for your request. A page of data in WWS contains a maximum of 100 entries. So, if you have exactly 1,000 employees returned in a request, then you will have 10 pages of data that will need to be retrieved to build your complete dataset. Each page contains a maximum of 100 entries.   
Page_Results  decimal (12, 0) >0   [0..1]  Number of Results in current page.   
Page  decimal (12, 0) >0   [0..1]  The page of data that has been returned for the given request.   
top
 

Work_Schedule_Calendar_Response_Data

part of: Get_Work_Schedule_Calendars_Response
Retrieved Work Schedule Calendar.
 
Parameter name Type/Value Cardinality Description Validations
Work_Schedule_Calendar  Work_Schedule_Calendar  [0..*]  Reference for Work Schedule Calendar and data.   
top
 

Work_Schedule_Calendar

part of: Work_Schedule_Calendar_Response_Data
Requested Work Schedule Calendar data.
 
Parameter name Type/Value Cardinality Description Validations
Work_Schedule_Calendar_Reference  Work_Schedule_CalendarObject  [0..1]  Reference for Work Schedule Calendar.   
Work_Schedule_Calendar_Data  Work_Schedule_Calendar_Data  [0..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] ).   
 
top
 

Work_Schedule_Calendar_Data

part of: Work_Schedule_Calendar
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.   
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 for Work Schedule Calendar work week begin day.   
Biweekly_Calculation_Start_Date_Reference  date  [0..1]  Reference to Biweekly Calculation Start Date for Work Schedule Calendar.   
Work_Schedule_Calendar_Event_Data  Work_Schedule_Calendar_Event_Data  [0..*]  Work Schedule Calendar Event data. 
Validation Description
Cannot have more than two meal times.   
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.   
 
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] ).   
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  [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, Start_End_Minute_Support_Data, Start_End_Minute_Support_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, 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_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.   
You may populate either time reference or time, but not both.   
 
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.   
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 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.   
 
Validation Description
Cannot have more than two meal times.   
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.   
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_Reference  Twenty_Four_Hour_TimeObject  [0..1]  Time reference 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_Reference  Twenty_Four_Hour_TimeObject  [0..1]  Time reference 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.   
You may populate either time reference or time, but not both.   
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_Time_Reference  Unique_IdentifierObject  [0..1]  Reference for Meal Time for Work Schedule Calendar Event.   
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
 

Unique_IdentifierObject

part of: Calendar_Event_Non_Work_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  Unique_IdentifierObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Unique_IdentifierObjectID

part of: Unique_IdentifierObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  IID, WID  [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
 

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.   
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.   
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 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.   
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
 

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
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
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