Service Directory > v32.1 > Human_Resources > Get_Frequencies
 

Operation: Get_Frequencies

This operation retrieves data related to Frequencies.


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

Root request element for the operation
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Frequency_Request_References  [0..1]  "References" element allowing the specification of specific object instances to be returned based on ID values.   
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_Frequencies_Response

Root element for the Response on the Get operation. Contains the instances returned by the Get operation and their accompanying data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Frequency_Request_References  [0..1]  "References" element allowing the specification of specific object instances to be returned based on ID values.   
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  Frequency_Response_Data  [0..1]  Contains the core response data based on the request submitted   
top
 

Frequency_Request_References

part of: Get_Frequencies_Request, Get_Frequencies_Response
"References" element allowing the specification of specific object instances to be returned based on ID values.
 
Parameter name Type/Value Cardinality Description Validations
Frequency_Reference  FrequencyObject  [1..*]  A reference to a specific Frequency based on its unique ID (Frequency ID or Workday ID).   
top
 

FrequencyObject

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

FrequencyObjectID

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

Frequency_Response_Data

part of: Get_Frequencies_Response
Contains the core response data based on the request submitted
 
Parameter name Type/Value Cardinality Description Validations
Frequency  Frequency  [0..*]  Contains the data for a single frequency   
top
 

Frequency

part of: Frequency_Response_Data
Contains the data for a single frequency
 
Parameter name Type/Value Cardinality Description Validations
Frequency_Reference  FrequencyObject  [0..1]  A reference to a specific Frequency based on its unique ID (Frequency ID or Workday ID).   
Frequency_Data  Frequency_Data  [0..1]  Container for the core frequency data   
top
 

Frequency_Data

part of: Frequency
Container for the core frequency data
 
Parameter name Type/Value Cardinality Description Validations
Frequency_ID  string  [0..1]  The unique identifier for the frequency   
Name  string  [1..1]  The functional name for the frequency   
Annualization_Factor  decimal (10, 6) >0   [1..1]  The number of occurrences within a year for a frequency (e.g. Yearly = 1, Monthly = 12, etc...)   
Frequency_Behavior_Reference  Frequency_BehaviorObject  [0..1]  A mapping to the internal Workday frequencies functionality. The values for this reference can be found using the "Integration IDs" task within the Workday application (Business Object = Frequency Behavior)   
Use_Weekly_Hours  boolean  [0..1]  A boolean flag indicating whether a worker's weekly hours should be used instead of a normal conversion rate when converting to/from hourly-based rates in Workday Compensation. 
Validation Description
Use Weekly Hours only applies to Hourly Frequencies (Frequency Behavior = HOURLY).   
 
Used_in_Payroll_Interface  boolean  [0..1]  Identifies that the frequency is used in Payroll Interface   
top
 

Frequency_BehaviorObject

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

Frequency_BehaviorObjectID

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

FrequencyReferenceEnumeration

part of: FrequencyObjectID
Base Type
string
top
 

Frequency_BehaviorReferenceEnumeration

part of: Frequency_BehaviorObjectID
Base Type
string
top