getPartyHierarchyDetails
- Description
- This inquiry transaction returns the information recorded for a given hierarchy. Depending upon the inquiry level provided, the hierarchy, nodes, relationships, ultimate parent, roles, and some party details will be returned.
- Web Services
- Operation name: getPartyHierarchyDetails
- Example
- Retrieve a corporate hierarchy.
Retrieve a marketing (type) hierarchy for a corporation (category) hierarchy structure, including all nodes, relationships, node roles, party entity type, node names, and ultimate parent.
- Usage information
- Depending on the inquiry level provided, this transaction returns
the hierarchy details, nodes, relationships, roles, and party names
associated with each party type entity node.
This transaction supports the Pagination feature.
- Preconditions
- Not applicable
- Mandatory input
- HierarchyId
- InquiryLevel
- PartyInquiryLevel
- Inquiry levels
- InquiryLevel:
- Level 0 - returns Party Hierarchy Details Result, Hierarchy Node, and if an ultimate parent exists, Ultimate Parent business objects.
- Level 1 - returns level 0 data plus all Hierarchy Node Relationships business objects.
- Level 2 - returns level 1 data plus all Entity Hierarchy Role business objects.
PartyInquiryLevel:- Level 0 - returns Party data including names, identifications, party privacy preferences, line of business relationships, and either personal data, if a Person, or organizational data, if an Organization.
- Level 1 - returns level 0 data plus all party addresses and contact methods.
- Level 2 - returns level 1 data plus all party relationship data.
- Level 3 - returns level 2 data plus all party bank account, party charge card, and income source data.
- Level 4 - returns level 3 data plus all party value data.
- Filter values
- This transaction supports filters. Valid values are:
- ACTIVE - returns only active child objects for inquiry levels 0, 1, and 2.
- INACTIVE - returns only inactive child objects for inquiry levels 0, 1, and 2.
- ALL - returns all child objects, active or inactive, for inquiry levels 0, 1, and 2.
Filter values are not case sensitive.
If the filter value is not provided, all records are returned by default.
- Transaction behavior
- Non CONTACT entity type nodes, if they exist, are returned in
the response, but do not include additional entity information.
If the InquiryLevel and PartyInquiryLevel are not supplied, the transaction fails and returns an error message.
When the optional StartingHierarchyNodeId is supplied, this transaction returns only the starting Hierarchy Node and its immediate children. When StartingHierarchyNodeId is not supplied, this transaction returns all nodes within the specified Hierarchy.
Each DWLHierarchyRelationshipBObj is returned only once inside the child Hierarchy Node in the response. It will not be returned in the parent Hierarchy Node.
- Request message
- <TCRMTxType> getPartyHierarchyDetails
<TCRMTxObject> PartyHierarchyDetailsRequestBObj
<TCRMObject> PartyHierarchyDetailsRequestBObj
- Response objects
- Party Hierarchy Details based on the inquiry levels.
Hierarchy details based on the InquiryLevel value:
- 0 - returns PartyHierarchyDetailsResultBObj, DWLHierarchyNodeBObj, and DWLHierarchyUltimateParentBObj
- 1 - returns level 0 data plus DWLHierarchyRelationshipBObj
- 2 - returns level 1 data plus DWLEntityHierarchyRoleBObj
And Party details based on the PartyInquiryLevel value:
- 0 includes:
- 1 includes level 0 plus:
- TCRMPartyAddressBObj list, each with associated TCRMAddressBObj
- TCRMPartyContactMethodBObj list, each with associated TCRMContactMethodBObj
- 2 returns level 1 plus TCRMPartyRelationshipBObj list, each with associated TCRMPartyBObj
- 3 includes level 2 plus:
- TCRMPartyBankAccountBObj list
- TCRMPartyChargeCardBObj list
- TCRMIncomeSourceBObj list
- 4 includes level 3 plus TCRMPartyValueBObj
- 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.