Service Directory > v31.2 > Financial_Management > Get_Revenue_Category_Hierarchies
 

Operation: Get_Revenue_Category_Hierarchies

Returns Revenue Category Hierarchies according to its reference id, name, or all of them should no search criteria be provided.


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

Get Revenue Category Hierarchies Request Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Revenue_Category_Hierarchy_Request_References  [0..1]  Revenue Category Hierarchy Request References Element   
Request_Criteria [Choice]   Revenue_Category_Hierarchy_Request_Criteria  [0..1]  Revenue Category Hierarchy Request Criteria Element   
Response_Filter  Response_Filter  [0..1]  Response Filter Element 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Revenue_Category_Hierarchy_Response_Group  [0..1]  Revenue Category Hierarchy Response Group Element   
top
 

Response Element: Get_Revenue_Category_Hierarchies_Response

Get Revenue Category Hierarchies Response Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Revenue_Category_Hierarchy_Request_References  [0..1]  Revenue Category Hierarchy Request References   
Request_Criteria  Revenue_Category_Hierarchy_Request_Criteria  [0..1]  Revenue Category Hierarchy 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  Revenue_Category_Hierarchy_Response_Group  [0..1]  Revenue Category Hierarchy 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  Revenue_Category_Hierarchy_Response_Data  [0..1]  Revenue Category Hierarchy Response Data Element   
top
 

Revenue_Category_Hierarchy_Request_References

part of: Get_Revenue_Category_Hierarchies_Request, Get_Revenue_Category_Hierarchies_Response
Revenue Category Hierarchy Request References
 
Parameter name Type/Value Cardinality Description Validations
Revenue_Category_Hierarchy_Reference  Revenue_Category_HierarchyObject  [1..*]  Revenue Category Hierarchy Request References   
top
 

Revenue_Category_HierarchyObject

part of: Revenue_Category_Hierarchy_Request_References, Revenue_Category_Hierarchy, Revenue_Category_Hierarchy_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  Revenue_Category_HierarchyObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Revenue_Category_HierarchyObjectID

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

Revenue_Category_Hierarchy_Request_Criteria

part of: Get_Revenue_Category_Hierarchies_Request, Get_Revenue_Category_Hierarchies_Response
Revenue Category Hierarchy Request Criteria Element
 
Parameter name Type/Value Cardinality Description Validations
Revenue_Category_Hierarchy_Name  string  [0..1]  Revenue Category Hierarchy Name to match against   
top
 

Response_Filter

part of: Get_Revenue_Category_Hierarchies_Request, Get_Revenue_Category_Hierarchies_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
 

Revenue_Category_Hierarchy_Response_Group

part of: Get_Revenue_Category_Hierarchies_Request, Get_Revenue_Category_Hierarchies_Response
Revenue Category Hierarchy Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

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

Revenue_Category_Hierarchy_Response_Data

part of: Get_Revenue_Category_Hierarchies_Response
Revenue Category Hierarchy Response Data Element
 
Parameter name Type/Value Cardinality Description Validations
Revenue_Category_Hierarchy  Revenue_Category_Hierarchy  [0..*]  Contains Revenue Category Hierarchy Data Element   
top
 

Revenue_Category_Hierarchy

part of: Revenue_Category_Hierarchy_Response_Data
Contains Revenue Category Hierarchy Data Element
 
Parameter name Type/Value Cardinality Description Validations
Revenue_Category_Hierarchy_Reference  Revenue_Category_HierarchyObject  [0..1]  Revenue Category Hierarchy Reference   
Revenue_Category_Hierarchy_Data  Revenue_Category_Hierarchy_Data  [0..*]  Revenue Category Hierarchy Data 
Validation Description
Revenue Category Hierarchy Name already exists. Please specify a unique Revenue Category Hierarchy Name.   
Entered Revenue Category Hierarchy Parent is one of Revenue Category Hierarchy's children.   
A hierarchy structure is defined for this revenue category hierarchy. Please delete the hierarchy structure before assigning a parent.   
A top-level Hierarchy Structure exists and is enforced for this hierarchy. Please unenforce the top-level Hierarchy Structure first before changing the Hierarchy Level for this hierarchy.   
A top-level Hierarchy Structure exists and is enforced for this hierarchy. Please unenforce the top-level Hierarchy Structure first before changing the parent hierarchy.   
A top-level hierarchy structure exists and is enforced for this parent hierarchy. Please unenforce the top-level hierarchy structure first before selecting this as a parent hierarchy.   
 
top
 

Revenue_Category_Hierarchy_Data

part of: Revenue_Category_Hierarchy
Revenue Category Hierarchy Data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Revenue Category Hierarchy ID   
Revenue_Category_Hierarchy_Name  string  [1..1]  Revenue Category Hierarchy Name   
Hierarchy_Level_Reference  Hierarchy_LevelObject  [0..1]  Reference to an existing Hierarchy Level valid for Revenue Category Hierarchies. 
Validation Description
Hierarchy Level is not valid for Revenue Category Hierarchy.  Hierarchy Level needs to be valid for Revenue Category Hierarchy. 
 
Parent_Revenue_Category_Hierarchy_Reference  Revenue_Category_HierarchyObject  [0..1]  Revenue Category Hierarchy's Parent Revenue Category Hierarchy   
Revenue_Categories_Included_Reference  Revenue_CategoryObject  [0..*]  Revenue Categories Included in this Revenue Category Hierarchy   
Validation Description
Revenue Category Hierarchy Name already exists. Please specify a unique Revenue Category Hierarchy Name.   
Entered Revenue Category Hierarchy Parent is one of Revenue Category Hierarchy's children.   
A hierarchy structure is defined for this revenue category hierarchy. Please delete the hierarchy structure before assigning a parent.   
A top-level Hierarchy Structure exists and is enforced for this hierarchy. Please unenforce the top-level Hierarchy Structure first before changing the Hierarchy Level for this hierarchy.   
A top-level Hierarchy Structure exists and is enforced for this hierarchy. Please unenforce the top-level Hierarchy Structure first before changing the parent hierarchy.   
A top-level hierarchy structure exists and is enforced for this parent hierarchy. Please unenforce the top-level hierarchy structure first before selecting this as a parent hierarchy.   
top
 

Hierarchy_LevelObject

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

Hierarchy_LevelObjectID

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

Revenue_CategoryObject

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

Revenue_CategoryObjectID

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

Revenue_Category_HierarchyReferenceEnumeration

part of: Revenue_Category_HierarchyObjectID
Base Type
string
top
 

Hierarchy_LevelReferenceEnumeration

part of: Hierarchy_LevelObjectID
Base Type
string
top
 

Revenue_CategoryReferenceEnumeration

part of: Revenue_CategoryObjectID
Base Type
string
top