Service Directory > v31.2 > Benefits_Administration > Get_Benefit_Annual_Rates
 

Operation: Get_Benefit_Annual_Rates

This service operation retrieves Benefits Annual 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_Annual_Rates_Request

Wrapper element for Get Benefit Annual Rates Request.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  Benefit_Annual_Rate_Request_Criteria  [0..*]  Wrapper element containing the list of Benefit Annual Rates for which data is requested.   
Response_Filter  Response_Filter  [0..*]  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_Benefit_Annual_Rates_Response

Wrapper element for Get Benefit Annual Rates Response.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Benefit_Annual_Rate_Request_Criteria  [0..*]  The Benefit Annual Rates being requested. The values are either Benefit Annual Rate IDs or Workday IDs.   
Response_Filter  Response_Filter  [0..*]  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..*]  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_Annual_Rate_Response_Data  [0..*]  Wrapper element for Benefit Annual Rates Response.   
top
 

Benefit_Annual_Rate_Request_Criteria

part of: Get_Benefit_Annual_Rates_Request, Get_Benefit_Annual_Rates_Response
Wrapper element containing the list of Benefit Annual Rates for which data is requested.
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [0..*]  The Benefit Annual Rates being requested. The values are either Benefit Annual Rate IDs or Workday IDs.   
top
 

WorkerObject

part of: Benefit_Annual_Rate_Data, Benefit_Annual_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_Annual_Rates_Request, Get_Benefit_Annual_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_Annual_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_Annual_Rate_Response_Data

part of: Get_Benefit_Annual_Rates_Response
Wrapper element for Benefit Annual Rates Response.
 
Parameter name Type/Value Cardinality Description Validations
Benefit_Annual_Rate  Benefit_Annual_Rate  [0..*]  Wrapper element for Benefit Annual Rate.   
top
 

Benefit_Annual_Rate

part of: Benefit_Annual_Rate_Response_Data
Wrapper element for Benefit Annual Rate.
 
Parameter name Type/Value Cardinality Description Validations
Benefit_Annual_Rate_Reference  Unique_IdentifierObject  [1..1]  A unique identifier for a Benefit Annual Rate.   
Benefit_Annual_Rate_Data  Benefit_Annual_Rate_Data  [1..1]  Contains the Benefit Annual Rate data.   
top
 

Unique_IdentifierObject

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

Unique_IdentifierObjectID

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

part of: Benefit_Annual_Rate
Contains the Benefit Annual Rate data.
 
Parameter name Type/Value Cardinality Description Validations
Effective_Date  date  [1..1]  The effective date for the Benefit Annual Rate.   
Worker_Reference  WorkerObject  [1..1]  The Worker for the Benefit Annual Rate.   
Benefit_Annual_Rate  decimal (21, 6) >0   [0..1]  The amount value for the Benefit Annual Rate.   
Currency_Reference  CurrencyObject  [1..1]  The currency for the Benefit Annual Rate.   
Benefit_Annual_Rate_Type_Reference  Benefit_Annual_Rate_TypeObject  [0..1]  The type for the Benefit Annual Rate.   
top
 

CurrencyObject

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

Benefit_Annual_Rate_TypeObject

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

Benefit_Annual_Rate_TypeObjectID

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

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Benefit_Annual_Rate_TypeReferenceEnumeration

part of: Benefit_Annual_Rate_TypeObjectID
Base Type
string
top