Service Directory > v32.1 > Student_Records > Get_Meeting_Patterns
 

Operation: Get_Meeting_Patterns

Retrieves a single Meeting Pattern by it's Reference ID or returns all Meeting Patterns


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

Get Meeting Pattern Request Web Service Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Meeting_Pattern_Request_References  [0..1]  The web service element containing the Reference ID of the requested Meeting Pattern   
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. 
 
top
 

Response Element: Get_Meeting_Patterns_Response

Get Meeting Pattern Web Service Response Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Meeting_Pattern_Request_References  [0..1]  The web service element containing the Reference ID of the requested Meeting Pattern   
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_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  Meeting_Pattern_Response_Data  [0..1]  Web Service Element containing the requested data.   
top
 

Meeting_Pattern_Request_References

part of: Get_Meeting_Patterns_Request, Get_Meeting_Patterns_Response
The web service element containing the Reference ID of the requested Meeting Pattern
 
Parameter name Type/Value Cardinality Description Validations
Meeting_Pattern_Reference  Standard_Meeting_PatternObject  [1..1]  The reference ID of the requested Meeting Pattern   
top
 

Standard_Meeting_PatternObject

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

Standard_Meeting_PatternObjectID

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

Response_Filter

part of: Get_Meeting_Patterns_Request, Get_Meeting_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_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_Pattern_Response_Data

part of: Get_Meeting_Patterns_Response
Web Service Element containing the requested data.
 
Parameter name Type/Value Cardinality Description Validations
Meeting_Pattern  Meeting_Pattern  [0..*]  Web Service Element containing a Meeting Pattern.   
top
 

Meeting_Pattern

part of: Meeting_Pattern_Response_Data
Web Service Element containing a Meeting Pattern.
 
Parameter name Type/Value Cardinality Description Validations
Meeting_Pattern_Reference  Standard_Meeting_PatternObject  [0..1]  The Reference ID of the Meeting Pattern   
Meeting_Pattern_Data  Meeting_Pattern_Data  [0..*]  The Web Service element containing Meeting Pattern data. 
Validation Description
Choose a combination of Meeting Day Pattern Days of the Week, Recurrence, Start Time, and End Time not already in use.   
End time must not be before start time.   
Enter a Meeting Pattern Order value not already in use.   
You cannot edit a Meeting Pattern that is in use.   
 
top
 

Meeting_Pattern_Data

part of: Meeting_Pattern
The Web Service element containing Meeting Pattern data.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  The Meeting Day Pattern Reference ID   
Sort_Order  string  [1..1]  Specifies the order of the Meeting Pattern to appear in prompts.   
Meeting_Day_Pattern_Reference  Meeting_Day_PatternObject  [1..1]  The Meeting Day Pattern specifying the days of the week for the Meeting Pattern.   
Start_Time  time  [1..1]  When this meeting pattern starts.   
End_Time  time  [1..1]  When this meeting pattern ends.   
Validation Description
Choose a combination of Meeting Day Pattern Days of the Week, Recurrence, Start Time, and End Time not already in use.   
End time must not be before start time.   
Enter a Meeting Pattern Order value not already in use.   
You cannot edit a Meeting Pattern that is in use.   
top
 

Meeting_Day_PatternObject

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

Standard_Meeting_PatternReferenceEnumeration

part of: Standard_Meeting_PatternObjectID
Base Type
string
top
 

Meeting_Day_PatternReferenceEnumeration

part of: Meeting_Day_PatternObjectID
Base Type
string
top