searchNodeInPartyHierarchy
- Description
- This transaction searches for one or more hierarchy nodes within a given hierarchy using the organization role or name as search criteria. You can use a filter with this transaction.
- Web Services
- Operation name: searchNodeInPartyHierarchy
- Example
- Find the Chief Executive Officer in the "Inter City" hierarchy.
- Usage information
- This transaction searches for hierarchy nodes by RoleType.
This transaction supports the Pagination feature.
- Preconditions
- Not applicable
- Mandatory input
- HierarchyId
- RoleType
- Inquiry levels
- Not applicable
- Filter values
- This transaction supports filters. Valid values are:
- ACTIVE - returns only active hierarchy nodes.
- INACTIVE - returns only inactive hierarchy nodes.
- ALL - returns all hierarchy nodes, both active and inactive.
Filter values are not case sensitive.
If no filter value is provided in the request, all records are returned by default.
- Transaction behavior
- If the RoleType is not provided, the transaction fails and returns an error message.
- Request message
- <TCRMTxType> searchNodeInPartyHierarchy
<TCRMTxObject> HierarchyNodePartySearchBObj
<TCRMObject> HierarchyNodePartySearchBObj
- Response objects
- HierarchyNodePartySearchResultBObj
- Special note
- When a point in time inquiry is requested, the NumberOfChildNodes and NumberOfParentNodes attributes within DWLHierarchyNodeBObj respectively return the number of 'active' child and parent relationships at the requested point in time, regardless of the filter parameter.