getAllEntityHierarchyRoles
- Description
- This inquiry transaction returns the recorded roles associated with a specified Hierarchy Node, based on a filter value.
- Web Services
- Operation name: getAllEntityHierarchyRoles
- Example
- Retrieve all the active Entity Hierarchy Roles associated with the Finance department in the organization hierarchy.
- Usage information
- This transaction receives as input a Hierarchy Node Id and a filter
value.
The filter value controls whether only active, only inactive or all active and inactive Entity Hierarchy Roles are returned.
This transaction does not support the Pagination feature.
- Preconditions
- Not applicable
- Mandatory input
- HierarchyNodeId
- Filter
- Inquiry levels
- Not applicable
- Filter values
- ACTIVE, INACTIVE, or ALL
Filter values must be provided in upper case.
- Transaction behavior
- Entity Hierarchy Roles with an End Date less than equal with the
system date are considered inactive.
Entity Hierarchy Roles without End Date or with End Date greater than the system date are considered active.
If filter value is not provided or is provided but invalid, the transaction will consider the default "ALL" value and both active and inactive Entity Hierarchy Roles are returned.
- Request message
- <InquiryType> getAllEntityHierarchyRoles
<tcrmParam name= "partyHierarchyNodeId">
<tcrmParam name= "filter">
- Response objects
- One or many DWLEntityHierarchyRoleBObj business objects
- Special note
- Not applicable