Service Directory > v31.2 > Revenue_Management > Get_Project_Rate_Categories
 

Operation: Get_Project_Rate_Categories

Service to get Project Rate Categories and Project Rate Category Members


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

Get Project Rate Categories Request Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Project_Rate_Category_Request_References  [0..1]  Project Rate Category Request References Element   
Request_Criteria [Choice]   Project_Rate_Category_Request_Criteria  [0..1]  Project Rate Category Request Criteria Element   
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  Project_Rate_Category_Response_Group  [0..1]  Project Rate Category Response Group Element   
top
 

Response Element: Get_Project_Rate_Categories_Response

Get Project Rate Categories Response Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Project_Rate_Category_Request_References  [0..1]  Project Rate Category Request References Element   
Request_Criteria  Project_Rate_Category_Request_Criteria  [0..1]  Project Rate Category Request Criteria Element   
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  Project_Rate_Category_Response_Group  [0..1]  Project Rate Category Response Group Element   
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  Project_Rate_Category_Response_Data  [0..1]  Project Rate Category Response Data Element   
top
 

Project_Rate_Category_Request_References

part of: Get_Project_Rate_Categories_Request, Get_Project_Rate_Categories_Response
Project Rate Category Request References Element
 
Parameter name Type/Value Cardinality Description Validations
Project_Rate_Category_Reference  Project_Rate_CategoryObject  [1..*]  Project Rate Category Reference   
top
 

Project_Rate_CategoryObject

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

Project_Rate_CategoryObjectID

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

Project_Rate_Category_Request_Criteria

part of: Get_Project_Rate_Categories_Request, Get_Project_Rate_Categories_Response
Project Rate Category Request Criteria Element
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Project_Rate_Categories_Request, Get_Project_Rate_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
 

Project_Rate_Category_Response_Group

part of: Get_Project_Rate_Categories_Request, Get_Project_Rate_Categories_Response
Project Rate Category Response Group Element
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

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

Project_Rate_Category_Response_Data

part of: Get_Project_Rate_Categories_Response
Project Rate Category Response Data Element
 
Parameter name Type/Value Cardinality Description Validations
Project_Rate_Category  Project_Rate_Category  [0..*]  Project Rate Category Element   
top
 

Project_Rate_Category

part of: Project_Rate_Category_Response_Data
Project Rate Category Element
 
Parameter name Type/Value Cardinality Description Validations
Project_Rate_Category_Reference  Project_Rate_CategoryObject  [0..1]  Project Rate Category Reference   
Project_Rate_Category_Data  Project_Rate_Category_Data  [0..1]  Project Rate Category Data Element 
Validation Description
Enter a Project Rate Category Member to save this Project Rate Category.   
 
top
 

Project_Rate_Category_Data

part of: Project_Rate_Category
Project Rate Category Data
 
Parameter name Type/Value Cardinality Description Validations
Project_Rate_Category_ID  string  [0..1]  Reference Id for Project Rate Category   
Project_Rate_Category_Name  string  [1..1]  Project Rate Category Name 
Validation Description
Enter a unique Project Rate Category Name, [name] is already in use.   
 
Description  string  [0..1]  Project Category Description   
Project_Rate_Category_Members  Project_Rate_Category_Member_Data  [0..*]  Project Rate Category Member Data 
Validation Description
Enter a unique Project Rate Category Member Name, [name] is already in use.   
 
Validation Description
Enter a Project Rate Category Member to save this Project Rate Category.   
top
 

Project_Rate_Category_Member_Data

part of: Project_Rate_Category_Data
Project Rate Category Members Data
 
Parameter name Type/Value Cardinality Description Validations
Project_Rate_Category_Member_ID  string  [0..1]  Reference Id for Project Rate Category Member   
Project_Rate_Category_Member_Name  string  [1..1]  Project Rate Category Member Name   
In_Use  boolean  [0..1]  In Use flag   
Validation Description
Enter a unique Project Rate Category Member Name, [name] is already in use.   
top
 

Project_Rate_CategoryReferenceEnumeration

part of: Project_Rate_CategoryObjectID
Base Type
string
top