Service Directory > v31.2 > Human_Resources > Put_Frequency
 

Operation: Put_Frequency

This operation adds or updates a Frequency.


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

Root request element for the operation
 
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.   
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  [1..1]  Container for the core frequency data   
Validation Description
Frequency already exists.  When "Add Only" is used, the Frequency ID must not already exist. 
Frequency Name already exists. Please use a unique name.   
top
 

Response Element: Put_Frequency_Response

Response for Put Frequency service
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Frequency_Reference  FrequencyObject  [0..1]  Reference for Frequency object   
top
 

FrequencyObject

part of: Put_Frequency_Request, Put_Frequency_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  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
 

Frequency_Data

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