Service Directory > v32.1 > Compensation > Get_Compensation_Grade_Hierarchy
 

Operation: Get_Compensation_Grade_Hierarchy

This operation allows the retrieval of compensation grade hierarchy information. You must have access to the "Set Up: Compensation General" domain to access this operation.


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

Request element to get compensation grade hierarchy information. If no criteria are specified in either the compensation grade hierarchy request references or compensation grade hierarchy request criteria elements, all instances will be returned.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Compensation_Grade_Hierarchy_Request_References  [0..1]  Request References   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Compensation_Grade_Hierarchy_Response

Response element containing instances of compensation grade hierarchies and their associated data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Compensation_Grade_Hierarchy_Request_References  [0..1]  Utilize the compensation grade hierarchy element to retrieve specific instance(s) of compensation grade hierarchy data.   
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  Compensation_Grade_Hierarchy_Response_Data  [0..*]  Contains compensation grade hierarchy information based on request references or request criteria.   
top
 

Compensation_Grade_Hierarchy_Request_References

part of: Get_Compensation_Grade_Hierarchy_Request, Get_Compensation_Grade_Hierarchy_Response
Utilize the compensation grade hierarchy element to retrieve specific instance(s) of compensation grade hierarchy data.
 
Parameter name Type/Value Cardinality Description Validations
Effective_Date  date  [1..1]  Effective Date   
top
 

Response_Filter

part of: Get_Compensation_Grade_Hierarchy_Request, Get_Compensation_Grade_Hierarchy_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_Compensation_Grade_Hierarchy_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
 

Compensation_Grade_Hierarchy_Response_Data

part of: Get_Compensation_Grade_Hierarchy_Response
Contains compensation grade hierarchy information based on request references or request criteria.
 
Parameter name Type/Value Cardinality Description Validations
Compensation_Grade_Hierarchy  Compensation_Grade_Hierarchy  [0..*]  Compensation grade hierarchy.   
top
 

Compensation_Grade_Hierarchy

part of: Compensation_Grade_Hierarchy_Response_Data
Contains compensation grade hierarchy and its associated data.
 
Parameter name Type/Value Cardinality Description Validations
Compensation_Grade_Hierarchy_Data  Compensation_Grade_Hierarchy_Data  [0..1]  Contains compensation grade hierarchy data   
top
 

Compensation_Grade_Hierarchy_Data

part of: Compensation_Grade_Hierarchy
Contains compensation grade hierarchy data
 
Parameter name Type/Value Cardinality Description Validations
Effective_Date  date  [1..1]  Effective Date of the compensation grade hierarchy.   
Compensation_Grade_Level  Compensation_Grade_Level  [0..*]  This is a wrapper for compensation grade level .   
top
 

Compensation_Grade_Level

part of: Compensation_Grade_Hierarchy_Data
Contains compensation grade level and its associated data.
 
Parameter name Type/Value Cardinality Description Validations
Compensation_Grade_Level_Reference  Compensation_Grade_LevelObject  [0..1]  Compensation Grade Level Reference   
Compensation_Grade_Level_Data  Compensation_Grade_Level_Data  [0..1]  Compensation Grade Level Data   
top
 

Compensation_Grade_LevelObject

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

Compensation_Grade_LevelObjectID

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

Compensation_Grade_Level_Data

part of: Compensation_Grade_Level
Contains compensation grade level data.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Compensation Grade Level ID.   
Rank  decimal (12, 0) >0   [1..1]  Rank   
Name  string  [1..1]  The unique grade level name. 
Validation Description
Each Compensation Grade Level must have a unique name.   
 
Compensation_Grade_Reference  Compensation_GradeObject  [1..*]  Compensation Grade reference 
Validation Description
Compensation Grade [grade] is assigned to another level as of the following date: [date]. Modify the hierarchy so that Compensation Grade [grade] won't belong to multiple levels.   
Compensation Grades must be unique accress all Compensation Grade Levels in the Compensation Grade Level Hierarchy   
 
top
 

Compensation_GradeObject

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

Compensation_GradeObjectID

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

Compensation_Grade_LevelReferenceEnumeration

part of: Compensation_Grade_LevelObjectID
Base Type
string
top
 

Compensation_GradeReferenceEnumeration

part of: Compensation_GradeObjectID
Base Type
string
top