Service Directory > v32.1 > Compensation > Get_One-Time_Payment_Plan_Configurable_Categories
 

Operation: Get_One-Time_Payment_Plan_Configurable_Categories

Web Service for Get One-Time Payment Plan Configurable Categories


@ - 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_One-Time_Payment_Plan_Configurable_Categories_Request

Request element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   One-Time_Payment_Plan_Configurable_Category_Request_References  [0..1]  Request References   
Request_Criteria [Choice]   One-Time_Payment_Plan_Configurable_Category_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  One-Time_Payment_Plan_Configurable_Category_Response_Group  [0..1]  Response Group   
top
 

Response Element: Get_One-Time_Payment_Plan_Configurable_Categories_Response

Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  One-Time_Payment_Plan_Configurable_Category_Request_References  [0..1]  Request Reference   
Request_Criteria  One-Time_Payment_Plan_Configurable_Category_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  One-Time_Payment_Plan_Configurable_Category_Response_Group  [0..1]  Response Group   
Response_Results  Response_Results  [0..1]  Response Result   
Response_Data  One-Time_Payment_Plan_Configurable_Category_Response_Data  [0..1]  Data Element   
top
 

One-Time_Payment_Plan_Configurable_Category_Request_References

part of: Get_One-Time_Payment_Plan_Configurable_Categories_Request, Get_One-Time_Payment_Plan_Configurable_Categories_Response
Request References
 
Parameter name Type/Value Cardinality Description Validations
One-Time_Payment_Plan_Configurable_Category_Reference  One-Time_Payment_Plan_Configurable_CategoryObject  [1..*]  Workset used in One-Time Payment Plan Configurable Category Request References. The workset is part of the One-Time Payment Plan Configurable Categories Request & One-Time Payment Plan Configurable Categories elements.   
top
 

One-Time_Payment_Plan_Configurable_CategoryObject

part of: One-Time_Payment_Plan_Configurable_Category_Request_References, One-Time_Payment_Plan_Configurable_Category
 
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  One-Time_Payment_Plan_Configurable_CategoryObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

One-Time_Payment_Plan_Configurable_CategoryObjectID

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

One-Time_Payment_Plan_Configurable_Category_Request_Criteria

part of: Get_One-Time_Payment_Plan_Configurable_Categories_Request, Get_One-Time_Payment_Plan_Configurable_Categories_Response
Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_One-Time_Payment_Plan_Configurable_Categories_Request, Get_One-Time_Payment_Plan_Configurable_Categories_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
 

One-Time_Payment_Plan_Configurable_Category_Response_Group

part of: Get_One-Time_Payment_Plan_Configurable_Categories_Request, Get_One-Time_Payment_Plan_Configurable_Categories_Response
Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Reference Boolean   
top
 

Response_Results

part of: Get_One-Time_Payment_Plan_Configurable_Categories_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
 

One-Time_Payment_Plan_Configurable_Category_Response_Data

part of: Get_One-Time_Payment_Plan_Configurable_Categories_Response
Response Element
 
Parameter name Type/Value Cardinality Description Validations
One-Time_Payment_Plan_Configurable_Category  One-Time_Payment_Plan_Configurable_Category  [0..*]  Contains One-Time Payment Plan Class & Data Element   
top
 

One-Time_Payment_Plan_Configurable_Category

part of: One-Time_Payment_Plan_Configurable_Category_Response_Data
Response Data
 
Parameter name Type/Value Cardinality Description Validations
One-Time_Payment_Plan_Configurable_Category_Reference  One-Time_Payment_Plan_Configurable_CategoryObject  [0..1]  Class   
One-Time_Payment_Plan_Configurable_Category_Data  One-Time_Payment_Plan_Configurable_Category_Data  [0..1]  Contains ID & Name 
Validation Description
The Category name is already in use.   
 
top
 

One-Time_Payment_Plan_Configurable_Category_Data

part of: One-Time_Payment_Plan_Configurable_Category
Data that is persisted
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  ID   
Category  string  [1..1]  Category Name   
Validation Description
The Category name is already in use.   
top
 

One-Time_Payment_Plan_Configurable_CategoryReferenceEnumeration

part of: One-Time_Payment_Plan_Configurable_CategoryObjectID
Base Type
string
top