getPartyGroupingByGroupId
- Description
- This inquiry transaction returns the information recorded for a PartyGrouping and its PartyGroupingAssociations.
- Web Services
- Operation name: getPartyGroupingByGroupId
- Example
- Retrieves the 'Over 50' PartyGrouping details, all of its PartyGroupingAssociations and details about the Parties that belong to this PartyGrouping.
- Usage information
- The inquiry levels and the filter control the type and extent of information returned for a PartyGrouping.
- Preconditions
- Not applicable
- Mandatory input
- PartyGroupingId
- InquiryLevel
- Filter
- Inquiry levels
- InquiryLevel:
- Level 0 - returns PartyGrouping details, including Name, Type, Description, PartyGroupingStartDate, and PartyGroupingEndDate.
- Level 1 - returns level 0 data plus PartyGroupingAssociation details, including PartyGroupAssociationId, GroupingAssocationDescription, GroupingAssociationEffectiveStartDate, and GroupingAssociationEffectiveEndDate.
- Level 2 - returns level 1 data plus, for each PartyGroupingAssociation, the Party details as in PartyInquiry level 0.
- Filter values
The filter applies to the party grouping associations.
Valid filter values are:- ACTIVE—returns records where the PartyGroupingAssociation is active
- INACTIVE—returns records where the PartyGroupingAssociation is inactive
- ALL—returns all active and inactive PartyGroupingAssociation records
Note: Filter values must be provided in upper case.- Transaction behavior
- If the filter value is not provided, or is provided but is invalid,
the transaction uses a default filter value of "ALL", and returns
both active and inactive party grouping associations.
Inquiry level supported values are 0, 1, and 2.
- Request message
- <InquiryType> getPartyGroupingbyGroupId
<tcrmParam name= "groupingId">
<tcrmParam name= "inquiryLevel">
<tcrmParam name= "groupingAssocFilter">
- Response objects
- TCRMpartyGrouping details based on the inquiry level:
- 0 - returns TCRMPartyGroupingBObj
- 1 - returns TCRMPartyGroupingBObj and TCRMPartyGroupingAssociationBObj
- 2 - returns TCRMPartyGroupingBObj, TCRMPartyGroupingAssociationBObj, and TCRMPartyBObj
- Special note
- Not applicable