Service Directory > v31.2 > Performance_Management > Get_Goal_Payout_Bands
 

Operation: Get_Goal_Payout_Bands

This operation allows the getting of Payout Bands


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

The request that gets Goal Payout Bands
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Goal_Payout_Band_Request_References  [0..1]  Element Container for Goal Payout Band Request References   
Response_Filter  Response_Filter  [0..1]  Element Container for Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Goal_Payout_Bands_Response

Get the Goal Payout Bands
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Goal_Payout_Band_Request_References  [0..1]  Element container for Goal Payout Band Request References   
Response_Filter  Response_Filter  [0..1]  Element container for Response Filter. Parameters that let you filter the data returned in the response. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..1]  Element container for Response Results. This contains summary information about the data that has been returned from your request.   
Response_Data  Goal_Payout_Band_Response_Data  [0..1]  Element container for the response element of the Goal Payout Bands   
top
 

Goal_Payout_Band_Request_References

part of: Get_Goal_Payout_Bands_Request, Get_Goal_Payout_Bands_Response
Element for Goal Payout Band Request Reference
 
Parameter name Type/Value Cardinality Description Validations
Goal_Payout_Band_Reference  Goal_Payout_BandObject  [1..*]  The Goal Payout Band Reference   
top
 

Goal_Payout_BandObject

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

Goal_Payout_BandObjectID

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

Goal_Payout_Band_Response_Data

part of: Get_Goal_Payout_Bands_Response
The response element for the Get Goal Payout Band Web Service
 
Parameter name Type/Value Cardinality Description Validations
Goal_Payout_Band  Goal_Payout_Band  [0..*]  The Goal Payout Band that contains the Goal Payout Band reference and Goal Payout Band Data object   
top
 

Goal_Payout_Band

part of: Goal_Payout_Band_Response_Data
Element containing the response for the Goal Payout Band instance that was created or edited
 
Parameter name Type/Value Cardinality Description Validations
Goal_Payout_Band_Reference  Goal_Payout_BandObject  [0..1]  The workset containing the Goal Payout Band that was created or edited   
Goal_Payout_Band_Data  Goal_Payout_Band_Data  [0..*]  Element which contains all the components that define a Goal Payout Band.   
top
 

Goal_Payout_Band_Data

part of: Goal_Payout_Band
Element which contains all the components that define a Goal Payout Band.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  The ID of a Goal Payout Band.   
Goal_Payout_Band_Name  string  [0..1]  The Name for a Goal Payout Band. 
Validation Description
You cannot create a Goal Payout Band with the same name as another Goal Payout Band.   
The field Payout Band is required and must have a value.   
 
Calculation_Reference  CalculationObject  [1..1]  The Calculation Type used by the Goal Payout Band. 
Validation Description
You cannot edit or delete a Goal Payout Band if it is in use.   
 
Minimum_Payout_Percent  decimal (22, 10) >0   [0..1]  The Minimum Payout Percent of the Goal Payout Band. This field may not be editable depending on the Calculation Type selected. 
Validation Description
Minimum must be less than or equal to target, and target must be less than or equal to maximum.   
The Maximum must be greater than the Minimum.   
You may not load a Goal Payout Band with a Minimum Percent, Target Percent or Maximum Percent if that field is not utilized by the Calculation Type of the Goal Payout Band.   
You cannot edit or delete a Goal Payout Band if it is in use.   
 
Target_Payout_Percent  decimal (22, 10) >0   [0..1]  The Target Payout Percent of the Goal Payout Band. This field may not be editable depending on the Calculation Type selected. 
Validation Description
You may not load a Goal Payout Band with a Minimum Percent, Target Percent or Maximum Percent if that field is not utilized by the Calculation Type of the Goal Payout Band.   
Minimum must be less than or equal to target, and target must be less than or equal to maximum.   
You cannot edit or delete a Goal Payout Band if it is in use.   
The Target may not be zero.   
 
Maximum_Payout_Percent  decimal (22, 10) >0   [0..1]  The Maximum Payout Percent of the Goal Payout Band. This field may not be editable depending on the Calculation Type selected. 
Validation Description
You may not load a Goal Payout Band with a Minimum Percent, Target Percent or Maximum Percent if that field is not utilized by the Calculation Type of the Goal Payout Band.   
Minimum must be less than or equal to target, and target must be less than or equal to maximum.   
The Maximum must be greater than the Minimum.   
You cannot edit or delete a Goal Payout Band if it is in use.   
 
Inactive  boolean  [0..1]  The inactive boolean for a Goal Payout Band which allows the user to determine whether or not this Goal Payout Band should be inactive.   
top
 

CalculationObject

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

CalculationObjectID

part of: CalculationObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Absence_Balance_ID, Absence_Component_Related_Calculation_ID, Absence_Plan_ID, Accrual_Code, Aggregate_Calculation_ID, Arithmetic_Calculation_ID, Build_Date_Calculation_ID, Calculation_Compensation_Basis_ID, Compensation_Basis_ID, Compensation_Plan_ID, Conditional_Calculation_ID, Constant_Date_Calculation_ID, Constant_Value_Calculation_ID, Date_Difference_Calculation_ID, Date_Extract_Calculation_ID, Date_Increment_Decrement_Calculation_ID, Deduction_Code, Earning_Code, Instance_Set_Comparison_Calculation, Instance_Value_Calculation_ID, Logic_Calculation_ID, Lookup_Calculation_ID, Pay_Accumulation_Code, Pay_Balance_Code, Pay_Component_Group_Code, Pay_Component_Related_Calculation_Code, Related_Calculation_ID, Time_Off_Code, Value_Comparison_Calculation_ID, Workday_Absence_Balance_ID, Workday_Absence_Code, Workday_Absence_Component_Related_Calculation_ID, Workday_Absence_Plan_ID, Workday_Accrual_Code, Workday_Deduction_Code, Workday_Earning_Code, Workday_Pay_Accumulation_Code, Workday_Pay_Balance_Code, Workday_Pay_Component_Group_Code, Workday_Pay_Component_Related_Calculation_Code, Workday_Related_Calculation_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
 

Goal_Payout_BandReferenceEnumeration

part of: Goal_Payout_BandObjectID
Base Type
string
top
 

CalculationReferenceEnumeration

part of: CalculationObjectID
Base Type
string
top