Service Directory > v32.1 > Compensation > Get_Period_Activity_Rate_Matrices
 

Operation: Get_Period_Activity_Rate_Matrices

This operation returns the Period Activity Rate Matrices created


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

Request element to get period activity rate matrix information. If no criteria is specified in either the period activity rate matrix request references or period activity rate matrix request criteria elements, all active instances will be returned.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Period_Activity_Rate_Matrix_Request_References  [0..1]  Request References   
Request_Criteria  Period_Activity_Rate_Matrix_Request_Criteria  [0..1]  Request Criteria   
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_Period_Activity_Rate_Matrices_Response

Period Activity Rate Matrices response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Period_Activity_Rate_Matrix_Request_References  [0..1]  Utilize the period activity rate matrix to retrieve specific instance(s) of period activity rate matrix and its associated data.   
Request_Criteria  Period_Activity_Rate_Matrix_Request_Criteria  [0..1]  Request criteria   
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  Period_Activity_Rate_Matrix_Response_Data  [0..1]  Contains Period Activity Rate Matrix information   
top
 

Period_Activity_Rate_Matrix_Request_References

part of: Get_Period_Activity_Rate_Matrices_Request, Get_Period_Activity_Rate_Matrices_Response
Utilize the period activity rate matrix to retrieve specific instance(s) of period activity rate matrix and its associated data.
 
Parameter name Type/Value Cardinality Description Validations
Period_Activity_Rate_Matrix_Reference  Period_Activity_Rate_MatrixObject  [1..*]  Period Activity Rate Matrix reference   
top
 

Period_Activity_Rate_MatrixObject

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

Period_Activity_Rate_MatrixObjectID

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

Period_Activity_Rate_Matrix_Request_Criteria

part of: Get_Period_Activity_Rate_Matrices_Request, Get_Period_Activity_Rate_Matrices_Response
Request criteria
 
Parameter name Type/Value Cardinality Description Validations
Include_Inactive  boolean  [0..1]  Include Inactive indicates the response will also include inactive period activity rate matrices.   
top
 

Response_Filter

part of: Get_Period_Activity_Rate_Matrices_Request, Get_Period_Activity_Rate_Matrices_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_Period_Activity_Rate_Matrices_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
 

Period_Activity_Rate_Matrix_Response_Data

part of: Get_Period_Activity_Rate_Matrices_Response
Contains Period Activity Rate Matrix information
 
Parameter name Type/Value Cardinality Description Validations
Period_Activity_Rate_Matrix  Period_Activity_Rate_Matrix  [0..*]  A Period Activity Rate Matrix   
top
 

Period_Activity_Rate_Matrix

part of: Period_Activity_Rate_Matrix_Response_Data
A Period Activity Rate Matrix
 
Parameter name Type/Value Cardinality Description Validations
Period_Activity_Rate_Matrix_Reference  Period_Activity_Rate_MatrixObject  [0..1]  Period Activity Rate Matrix reference   
Period_Activity_Rate_Matrix_Data  Period_Activity_Rate_Matrix_Data  [1..*]  Period Activity Rate Matrix data   
top
 

Period_Activity_Rate_Matrix_Data

part of: Period_Activity_Rate_Matrix
Period Activity Rate Matrix data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  ID   
Period_Activity_Rate_Table_Name  string  [1..1]  Name of the period activity rate matrix 
Validation Description
The Period Activity Rate Matrix Name is currently in use by another Period Activity Rate Matrix.  Period Activity Rate Matrix name must not already be in use. To update an existing matrix, you must provide a the reference or ID to the matrix. 
 
Effective_Date  date  [0..1]  Effective Date of the period activity rate matrix changes   
Condition_Rule_Reference  Condition_RuleObject  [0..*]  Associated condition rules   
Currency_Reference  CurrencyObject  [1..1]  Associated currency   
Inactive  boolean  [0..1]  Indicates whether the period activity rate matrix is inactive or not   
Period_Activity_Rate_Matrix_Entry_Data  Period_Activity_Rate_Matrix_Entry_Data  [1..*]  Period Activity Rate Matrix entry data for each row in the matrix   
top
 

Condition_RuleObject

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

Condition_RuleObjectID

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

Period_Activity_Rate_Matrix_Entry_Data

part of: Period_Activity_Rate_Matrix_Data
Period Activity Rate Matrix entry data for each row in the matrix
 
Parameter name Type/Value Cardinality Description Validations
Period_Activity_Category_Reference  Period_Activity_CategoryObject  [1..1]  Period Activity Category reference   
Period_Activity_Unit_Reference  Period_Activity_UnitObject  [1..1]  Period Activity Unit reference 
Validation Description
The Period Activity Category and Period Activity Unit combination may only be used once for a Period Activity Rate Matrix.  Period Activity Category and Unit must only be used once in combination for a single Period Activity Rate Matrix. 
 
Period_Activity_Rate_Matrix_Entry_Sequence_Data  Period_Activity_Rate_Matrix_Entry_Sequence_Data  [1..1]  Period Activity Rate Matrix entry data for rate and accelerator   
top
 

Period_Activity_CategoryObject

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

Period_Activity_CategoryObjectID

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

Period_Activity_UnitObject

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

Period_Activity_UnitObjectID

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

Period_Activity_Rate_Matrix_Entry_Sequence_Data

part of: Period_Activity_Rate_Matrix_Entry_Data
Period Activity Rate Matrix entry data for rate and accelerator
 
Parameter name Type/Value Cardinality Description Validations
Default_Unit_Rate  decimal (26, 6) >0   [0..1]  The default unit rate for rate matrix entry   
Accelerator_Amount [Choice]   decimal (26, 6) >0   [0..1]  The accelerator amoutn for rate matrix entry   
Accelerator_Percent [Choice]   decimal (12, 6) >0   [0..1]  The accelerator percent for rate matrix entry   
Accelerator_Base_Reference  Unique_IdentifierObject  [0..1]  Accelerator Base Reference   
top
 

Unique_IdentifierObject

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

Period_Activity_Rate_MatrixReferenceEnumeration

part of: Period_Activity_Rate_MatrixObjectID
Base Type
string
top
 

Condition_RuleReferenceEnumeration

part of: Condition_RuleObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Period_Activity_CategoryReferenceEnumeration

part of: Period_Activity_CategoryObjectID
Base Type
string
top
 

Period_Activity_UnitReferenceEnumeration

part of: Period_Activity_UnitObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top