Service Directory > v32.1 > Benefits_Administration > Get_Benefit_Individual_Rates
 

Operation: Get_Benefit_Individual_Rates

This service operation retrieves Benefits Individual Rates 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_Benefit_Individual_Rates_Request

This service operation retrieves Benefits Individual Rates for one or more employees.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Benefit_Individual_Rate_Request_References  [0..1]  A list of references to retrieve using the get operation.   
Request_Criteria [Choice]   Benefit_Individual_Rate_Request_Criteria  [0..1]  Request criteria for this web service.   
Response_Filter  Response_Filter  [0..1]  The "Response_Filter" element contains common WWS information that allows you control the response data that you will be provided including As_Of_Date, As_Of_Entry_Moment, and Page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Benefit_Individual_Rates_Response

Response for a Get Benefit Individual Rate web service request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Benefit_Individual_Rate_Request_References  [0..1]  A list of references to retrieve using the get operation.   
Request_Criteria  Benefit_Individual_Rate_Request_Criteria  [0..1]  The "Request Criteria" element for the web service operation contains the filtering logic to limit the data that is returned in the response.   
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  Benefit_Individual_Rate_Response_Data  [0..1]  Response for a Get Benefits Individual Rate web service request   
top
 

Benefit_Individual_Rate_Request_References

part of: Get_Benefit_Individual_Rates_Request, Get_Benefit_Individual_Rates_Response
A list of references to retrieve using the get operation.
 
Parameter name Type/Value Cardinality Description Validations
Benefit_Individual_Rate_Reference  Benefit_Individual_RateObject  [1..*]  Set of Individual Rate references to retrieve.   
top
 

Benefit_Individual_RateObject

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

Benefit_Individual_RateObjectID

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

Benefit_Individual_Rate_Request_Criteria

part of: Get_Benefit_Individual_Rates_Request, Get_Benefit_Individual_Rates_Response
The "Request Criteria" element for the web service operation contains the filtering logic to limit the data that is returned in the response.
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [0..*]  Retrieve individual rate for the workers defined in this set.   
top
 

WorkerObject

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

WorkerObjectID

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

Benefit_Individual_Rate_Response_Data

part of: Get_Benefit_Individual_Rates_Response
Response for a Get Benefits Individual Rate web service request
 
Parameter name Type/Value Cardinality Description Validations
Benefit_Individual_Rate  Benefit_Individual_Rate  [0..*]  Response for a Get Benefits Individual Rate web service request   
top
 

Benefit_Individual_Rate

part of: Benefit_Individual_Rate_Response_Data
Benefit Individual Rate
 
Parameter name Type/Value Cardinality Description Validations
Benefit_Individual_Rate_Reference  Benefit_Individual_RateObject  [1..1]  Benefit Individual Rate Reference   
Benefit_Individual_Rate_Data  Benefit_Individual_Rate_Data  [1..1]  Benefit Individual Rate Data contains all cost values for an individual rate.   
top
 

Benefit_Individual_Rate_Data

part of: Benefit_Individual_Rate
Benefit Individual Rate Data contains all cost values for an individual rate.
 
Parameter name Type/Value Cardinality Description Validations
Benefit_Individual_Rate_ID  string  [1..1]  Benefit Individual Rate ID 
Validation Description
This web service can only be used to update existing Individual Rates. Please make sure the Benefit Individual Rate ID is a valid one. [ID]  Individual Rate Reference ID is required. 
 
Employee_Cost_PreTax  decimal (21, 6)   [0..1]  Employee Cost PreTax   
Employee_PostTax_Amount  decimal (21, 6)   [0..1]  Employee PostTax Amount   
Employer_Cost_NonTaxable  decimal (21, 6) >0   [0..1]  Employer Cost NonTaxable   
Employer_Cost_Taxable  decimal (21, 6) >0   [0..1]  Employer Cost Taxable   
top
 

Benefit_Individual_RateReferenceEnumeration

part of: Benefit_Individual_RateObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top