Service Directory > v31.2 > Student_Records > Get_Meeting_Day_Patterns
 

Operation: Get_Meeting_Day_Patterns

Returns Meeting Day Pattern based on Name or Days of the Week Criteria, or returns all instances of Meeting Day Pattern if no criteria is specified.


@ - 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_Meeting_Day_Patterns_Request

Get Meeting Day Patterns Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Meeting_Day_Pattern_Request_References  [0..1]  Meeting Day Pattern Request References   
Request_Criteria [Choice]   Meeting_Day_Pattern_Request_Criteria  [0..1]  Meeting Day Pattern Request Criteria   
Response_Filter  Response_Filter  [0..1]  Meeting Day Pattern Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Meeting_Day_Patterns_Response

Get Meeting Day Pattern Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Meeting_Day_Pattern_Request_References  [0..1]  Meeting Day Pattern Request Reference   
Request_Criteria  Meeting_Day_Pattern_Request_Criteria  [0..1]  Meeting Day Pattern Get Request Criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..1]  Response Results   
Response_Data  Meeting_Day_Pattern_Response_Data  [0..1]  Meeting Day Pattern Response Data   
top
 

Meeting_Day_Pattern_Request_References

part of: Get_Meeting_Day_Patterns_Request, Get_Meeting_Day_Patterns_Response
Meeting Day Pattern Request References
 
Parameter name Type/Value Cardinality Description Validations
Meeting_Day_Pattern_Reference  Meeting_Day_PatternObject  [1..1]  Meeting Day Pattern Reference   
top
 

Meeting_Day_PatternObject

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

Meeting_Day_PatternObjectID

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

Meeting_Day_Pattern_Request_Criteria

part of: Get_Meeting_Day_Patterns_Request, Get_Meeting_Day_Patterns_Response
Meeting Day Pattern Request Criteria, Will return if either criteria is met. Name or Day of Week is Subset
 
Parameter name Type/Value Cardinality Description Validations
Meets_Days_of_the_Week_Reference  Day_of_the_WeekObject  [0..*]  Meeting Day Pattern Meets Days of the Week   
top
 

Day_of_the_WeekObject

part of: Meeting_Day_Pattern_Request_Criteria, Meeting_Day_Pattern_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
 

Response_Filter

part of: Get_Meeting_Day_Patterns_Request, Get_Meeting_Day_Patterns_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
 

Response_Results

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

Meeting_Day_Pattern_Response_Data

part of: Get_Meeting_Day_Patterns_Response
Meeting Day Pattern Response Data
 
Parameter name Type/Value Cardinality Description Validations
Meeting_Day_Pattern  Meeting_Day_Pattern  [0..*]  Meeting Day Pattern Wrapper   
top
 

Meeting_Day_Pattern

part of: Meeting_Day_Pattern_Response_Data
Meeting Day Pattern Wrapper
 
Parameter name Type/Value Cardinality Description Validations
Meeting_Day_Pattern_Reference  Meeting_Day_PatternObject  [0..1]  Meeting Day Pattern Instance   
Meeting_Day_Pattern_Data  Meeting_Day_Pattern_Data  [0..*]  Meeting Day Pattern Data   
top
 

Meeting_Day_Pattern_Data

part of: Meeting_Day_Pattern
Meeting Day Pattern Data Wrapper
 
Parameter name Type/Value Cardinality Description Validations
Sort_Order  string  [1..1]  Order of Meeting Day Pattern to Appear in Prompt 
Validation Description
Enter A Meeting Day Pattern Order value not already in use.   
 
Pattern_Name  string  [1..1]  Unique Meeting Day Pattern Name 
Validation Description
Enter a Meeting Day Pattern Name that isn't already in use.   
 
Day_of_the_Week_Reference  Day_of_the_WeekObject  [1..*]  Days of Week Meeting Day Pattern Meets   
Recurrence_in_Weeks  decimal (3, 0) >0   [1..1]  Recurrence of Meeting Day Pattern in Weeks   
top
 

Meeting_Day_PatternReferenceEnumeration

part of: Meeting_Day_PatternObjectID
Base Type
string
top
 

Day_of_the_WeekReferenceEnumeration

part of: Day_of_the_WeekObjectID
Base Type
string
top