Service Directory > v31.2 > Benefits_Administration > Get_Employee_Defined_Contribution_Elections
 

Operation: Get_Employee_Defined_Contribution_Elections DEPRECATED

DEPRECATED: The functionality within this operation has been replaced by new functionality within the "Get Change Benefits for Life Event" operation. This service operation previously retrieved Defined Contribution Elections for one or more employees.


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

Request for Retirement Savings Elections
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  Employee_Defined_Contribution_Elections_Request_Criteria  [0..1]  Employee Request References   
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_Employee_Defined_Contribution_Elections_Response

Response Data for Retirement Savings Elections
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  Employee_Defined_Contribution_Elections_Request_Criteria  [0..1]  Employee Request References   
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  Employee_Defined_Contribution_Elections_Response_Data  [0..1]  Retirement Savings Elections Response Data   
top
 

Employee_Defined_Contribution_Elections_Request_Criteria

part of: Get_Employee_Defined_Contribution_Elections_Request, Get_Employee_Defined_Contribution_Elections_Response
Employee Request References
 
Parameter name Type/Value Cardinality Description Validations
Employee_Reference  EmployeeObject  [0..*]  Employee Request References   
top
 

EmployeeObject

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

EmployeeObjectID

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

Employee_Defined_Contribution_Elections_Response_Data

part of: Get_Employee_Defined_Contribution_Elections_Response
Retirement Savings Elections Response Data
 
Parameter name Type/Value Cardinality Description Validations
Employee_Defined_Contribution_Election  Defined_Contribution_Package  [0..*]  Contains the retirement savings election package reference and it's detailed information.   
top
 

Defined_Contribution_Package

part of: Employee_Defined_Contribution_Elections_Response_Data
Contains the retirement savings election package reference and it's detailed information.
 
Parameter name Type/Value Cardinality Description Validations
Employee_Defined_Contribution_Election_Data  Employee_Defined_Contribution_Election_Data  [0..1]  Retirement Savings Elections to be added, updated or deleted.   
top
 

Employee_Defined_Contribution_Election_Data

part of: Defined_Contribution_Package
Retirement Savings Elections to be added, updated or deleted.
 
Parameter name Type/Value Cardinality Description Validations
Employee_Reference  EmployeeObject  [1..1]  A unique identifier for an employee.   
Takes_Effect_On_Date  date  [1..1]  The date the retirement savings elections take effect for the employee.   
Defined_Contribution_Election_Data  Defined_Contribution_Election_Data  [0..*]  Contains election percent or amount and beneficiary allocation information. If the Election Percentage and Election Amount are left blank, then an existing election is removed. If there is no existing election for the benefit plan and the Election Percentage and Election Amount are left blank, then no election will be created. 
Validation Description
You must elect one or more Primary Beneficiaries totaling 100%.  You must elect one or more Primary Beneficiaries totaling 100%. 
Contingent Beneficiary percentage must total 0% or 100%  Contingent Beneficiary percentage must total 0% or 100% 
[benefit plan] requires beneficiaries. Please add beneficiaries for this election.  One or more benefit plans require at least one beneficiary designation. You must enter a beneficiary or change your election. You may be required to enter a beneficiary if you were automatically enrolled in this benefit plan. 
Election Percentage can't be entered as [benefit plan] is Amount-Based.  Election Percentage can't be entered when Retirement Savings Plan is Amount-Based. 
Election Amount can't be entered as [benefit plan] is Percentage-Based.  Election Amount can't be entered when Retirement Savings Plan is Percentage-Based. 
The [benefit plan] can only be specified once for an election.  The benefit plan can only be specified once for an election. Please remove one of the elections for the benefit plan. 
 
top
 

Defined_Contribution_Election_Data

part of: Employee_Defined_Contribution_Election_Data
Contains election percent or amount and beneficiary allocation information. If the Election Percentage and Election Amount are left blank, then an existing election is removed. If there is no existing election for the benefit plan and the Election Percentage and Election Amount are left blank, then no election will be created.
 
Parameter name Type/Value Cardinality Description Validations
Defined_Contribution_Plan_Reference  Retirement_Savings_PlanObject  [1..1]  A unique identifier for the retirement savings plan. 
Validation Description
The employee [employee] is not eligible for [plan] as of [date].   
 
Election_Percentage [Choice]   decimal (5, 2) >0   [0..1]  Percentage of salary for retirement savings election. Pick either percentage or amount. 
Validation Description
Election Percentage is greater than the allowed Contribution Percentage Maximum for [benefit plan]. Please correct the Election Percentage so that it is less than or equal to the Contribution Percentage Maximum.  Election Percentage is greater than the allowed Contribution Percentage Maximum for the benefit plan. 
 
Election_Amount [Choice]   decimal (21, 6) >0   [0..1]  Contains the contribution amount for the retirement savings election. 
Validation Description
Election Amount is greater than the allowed Contribution Amount Maximum for [benefit plan]. Please correct the Election Percentage so that it is less than or equal to the Contribution Percentage Maximum.  The Election Amount cannot be greater than the allowed Contribution Amount Maximum for the benefit plan. 
 
Currency_Reference  CurrencyObject  [0..1]  A unique identifier for the currency. This can only be populated when the benefit plan is amount based. If the currency is not provided, the it is defaulted from the benefit plan.   
Frequency_Reference  FrequencyObject  [0..1]  A unique identifier for the frequency. This can only be populated when the benefit plan is amount based. If the frequency is not provided, the it is defaulted from the benefit plan.   
Beneficiary_Allocation_Data  Defined_Contribution_Beneficiary_Allocation_Data  [0..*]  Defines the Beneficiary recipient and the allocation percentage for the Retirement Savings Election. This is required when the retirement savings plan requires beneficiaries and the election amount or election percentage is populated (i.e. greater than 0).   
Validation Description
You must elect one or more Primary Beneficiaries totaling 100%.  You must elect one or more Primary Beneficiaries totaling 100%. 
Contingent Beneficiary percentage must total 0% or 100%  Contingent Beneficiary percentage must total 0% or 100% 
[benefit plan] requires beneficiaries. Please add beneficiaries for this election.  One or more benefit plans require at least one beneficiary designation. You must enter a beneficiary or change your election. You may be required to enter a beneficiary if you were automatically enrolled in this benefit plan. 
Election Percentage can't be entered as [benefit plan] is Amount-Based.  Election Percentage can't be entered when Retirement Savings Plan is Amount-Based. 
Election Amount can't be entered as [benefit plan] is Percentage-Based.  Election Amount can't be entered when Retirement Savings Plan is Percentage-Based. 
The [benefit plan] can only be specified once for an election.  The benefit plan can only be specified once for an election. Please remove one of the elections for the benefit plan. 
top
 

Retirement_Savings_PlanObject

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

Retirement_Savings_PlanObjectID

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

CurrencyObject

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

CurrencyObjectID

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

FrequencyObject

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

Defined_Contribution_Beneficiary_Allocation_Data

part of: Defined_Contribution_Election_Data
Defines the Beneficiary recipient and the allocation percentage for the Retirement Savings Election. This is required when the retirement savings plan requires beneficiaries and the election amount or election percentage is populated (i.e. greater than 0).
 
Parameter name Type/Value Cardinality Description Validations
Beneficiary_Reference  BeneficiaryObject  [1..1]  A reference to the beneficiary. 
Validation Description
[beneficiary] is not a valid beneficiary for [employee].   
 
Beneficiary_Allocation_Percentage_Data  Beneficary_Allocation_Percentage_Data  [0..*]  Percentage allocation for primary or contingent beneficiary.   
top
 

BeneficiaryObject

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

BeneficiaryObjectID

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

Beneficary_Allocation_Percentage_Data

part of: Defined_Contribution_Beneficiary_Allocation_Data
Contains the Primary or Contingent percentage to be allocated to the Beneficiary.
 
Parameter name Type/Value Cardinality Description Validations
Primary_Percentage [Choice]   decimal (5, 2) >0   [1..1]  Percentage allocation for primary beneficiary. Mutually exclusive with Contingent Percentage.   
Contingent_Percentage [Choice]   decimal (5, 2) >0   [1..1]  Percentage allocation for contingent beneficiary.   
top
 

EmployeeReferenceEnumeration

part of: EmployeeObjectID
Base Type
string
top
 

Retirement_Savings_PlanReferenceEnumeration

part of: Retirement_Savings_PlanObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

FrequencyReferenceEnumeration

part of: FrequencyObjectID
Base Type
string
top
 

BeneficiaryReferenceEnumeration

part of: BeneficiaryObjectID
Base Type
string
top