Service Directory > v31.2 > Compensation > Get_Stock_Participation_Rate_Tables
 

Operation: Get_Stock_Participation_Rate_Tables

This operation allows you to retrieve Stock Participation Rate Table information.


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

Request element to get stock participation rate table information. If no criteria is specified in the request references or request criteria elements, then all stock participation rate tables will be returned.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Stock_Participation_Rate_Table_Request_References  [0..1]  Request References   
Request_Criteria [Choice]   Stock_Participation_Rate_Table_Request_Criteria  [0..1]  Request Criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Stock_Participation_Rate_Table_Response_Group  [0..1]  Response Group   
top
 

Response Element: Get_Stock_Participation_Rate_Tables_Response

Response element containing instances of stock participation rate tables and their associated data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Stock_Participation_Rate_Table_Request_References  [0..1]  Request References   
Request_Criteria  Stock_Participation_Rate_Table_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_Group  Stock_Participation_Rate_Table_Response_Group  [0..1]  Response Group   
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  Stock_Participation_Rate_Table_Response_Data  [0..1]  Response Data   
top
 

Stock_Participation_Rate_Table_Request_References

part of: Get_Stock_Participation_Rate_Tables_Request, Get_Stock_Participation_Rate_Tables_Response
Request References
 
Parameter name Type/Value Cardinality Description Validations
Stock_Participation_Rate_Table_Reference  Stock_Participation_Rate_TableObject  [1..*]  Stock Participation Rate Table Reference   
top
 

Stock_Participation_Rate_TableObject

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

Stock_Participation_Rate_TableObjectID

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

Stock_Participation_Rate_Table_Request_Criteria

part of: Get_Stock_Participation_Rate_Tables_Request, Get_Stock_Participation_Rate_Tables_Response
Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
@Include_Inactive  boolean  [1..1]  Flag to indicate whether or not to include inactive Stock Participation Rate Tables.   
top
 

Response_Filter

part of: Get_Stock_Participation_Rate_Tables_Request, Get_Stock_Participation_Rate_Tables_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
 

Stock_Participation_Rate_Table_Response_Group

part of: Get_Stock_Participation_Rate_Tables_Request, Get_Stock_Participation_Rate_Tables_Response
Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

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

Stock_Participation_Rate_Table_Response_Data

part of: Get_Stock_Participation_Rate_Tables_Response
Stock Participation Rate Table Response Data
 
Parameter name Type/Value Cardinality Description Validations
Stock_Participation_Rate_Table  Stock_Participation_Rate_Table_Sub_Response_Data  [0..*]  Stock Participation Rate Table   
top
 

Stock_Participation_Rate_Table_Sub_Response_Data

part of: Stock_Participation_Rate_Table_Response_Data
Stock Participation Rate Table Data
 
Parameter name Type/Value Cardinality Description Validations
Stock_Participation_Rate_Table_Reference  Stock_Participation_Rate_TableObject  [0..1]  Stock Participation Rate Table Reference   
Stock_Participation_Rate_Table_Data  Stock_Participation_Rate_Table_Data_2.0  [0..*]  Stock Participation Rate Table Data 
Validation Description
The default percentage rate must be a number between 0 and 100.  The default percentage rate must be a number between 0 and 100. 
 
top
 

Stock_Participation_Rate_Table_Data_2.0

part of: Stock_Participation_Rate_Table_Sub_Response_Data
Stock Participation Rate Table Data
 
Parameter name Type/Value Cardinality Description Validations
Stock_Participation_Rate_Table_ID  string  [0..1]  Reference ID for this Stock Participation Rate Table.   
Inactive  boolean  [0..1]  Inactive status indicator for this Stock Participation Rate Table.   
Name  string  [0..1]  The name of this Stock Participation Rate Table. 
Validation Description
Enter a Stock Participation Rate Table Name that isn't already in use.  Enter a Stock Participation Rate Table Name that isn't already in use. 
Element Content 'Name' is required on internal element 'Stock Participation Rate Table Data' when you are creating a table.  Element Content 'Name' is required on internal element 'Stock Participation Rate Table Data' when you are creating a table. 
 
Description  string  [0..1]  The description of this Stock Participation Rate Table.   
Default_Percentage_Rate  decimal (10, 4) >0   [0..1]  The default stock participation percentage rate of this Stock Participation Rate Table.   
Stock_Participation_Rate_Table_Entry_Data  Stock_Participation_Rate_Table_Entry_Data_2.0  [0..*]  Stock Participation Rate Table Entry Data 
Validation Description
There are multiple Stock_Participation_Rate_Table_Entry_Data elements with an Entry_Sort_Order = [sort order]. Enter a unique entry sort order for these entries.  There are multiple Stock_Participation_Rate_Table_Entry_Data elements with the same entry sort order attribute. Enter unique entry sort order values across the request. 
Stock Participation Rate Table Entry (sort order = [entry]) must have at least one dimension specified.  Every rate row added to the table must have at least one dimension specified. 
Percentage rate for Stock Participation Table Entry (sort order = [entry]) must be a number between 0 and 100.  Percentage must be a number between 0 and 100. 
 
Validation Description
The default percentage rate must be a number between 0 and 100.  The default percentage rate must be a number between 0 and 100. 
top
 

Stock_Participation_Rate_Table_Entry_Data_2.0

part of: Stock_Participation_Rate_Table_Data_2.0
Stock Participation Rate Table Entry Data
 
Parameter name Type/Value Cardinality Description Validations
Delete  boolean  [0..1]  If True is entered, the Stock Participation Rate Table Entry will be deleted.   
Entry_Sort_Order  string  [1..1]  The sort order for the Stock Participation Rate Table Entry.   
Management_Level_Reference  Management_LevelObject  [0..*]  Reference element representing a unique instance of Management Level.   
Job_Profile_Reference  Job_ProfileObject  [0..*]  Reference element representing a unique instance of Job Profile.   
Country_Reference  CountryObject  [0..*]  Reference element representing a unique instance of Country.   
Compensation_Grade_Reference  Compensation_GradeObject  [0..*]  Reference element representing a unique instance of Compensation Grade.   
Percentage_Rate  decimal (10, 4) >0   [0..1]  The stock participation percentage rate for the Stock Participation Rate Table Entry.   
Validation Description
There are multiple Stock_Participation_Rate_Table_Entry_Data elements with an Entry_Sort_Order = [sort order]. Enter a unique entry sort order for these entries.  There are multiple Stock_Participation_Rate_Table_Entry_Data elements with the same entry sort order attribute. Enter unique entry sort order values across the request. 
Stock Participation Rate Table Entry (sort order = [entry]) must have at least one dimension specified.  Every rate row added to the table must have at least one dimension specified. 
Percentage rate for Stock Participation Table Entry (sort order = [entry]) must be a number between 0 and 100.  Percentage must be a number between 0 and 100. 
top
 

Management_LevelObject

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

Management_LevelObjectID

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

Job_ProfileObject

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

Job_ProfileObjectID

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

CountryObject

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

CountryObjectID

part of: CountryObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_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
 

Compensation_GradeObject

part of: Stock_Participation_Rate_Table_Entry_Data_2.0
 
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
 

Stock_Participation_Rate_TableReferenceEnumeration

part of: Stock_Participation_Rate_TableObjectID
Base Type
string
top
 

Management_LevelReferenceEnumeration

part of: Management_LevelObjectID
Base Type
string
top
 

Job_ProfileReferenceEnumeration

part of: Job_ProfileObjectID
Base Type
string
top
 

CountryReferenceEnumeration

part of: CountryObjectID
Base Type
string
top
 

Compensation_GradeReferenceEnumeration

part of: Compensation_GradeObjectID
Base Type
string
top