getAllPartyGroupingContactMethods
- Description
- This inquiry transaction returns the details of all the contact methods of a specific type derived from the party that plays a specific role within the grouping.
- Web Services
- Operation name: getAllPartyGroupingContactMethods
- Example
- You can retrieve all contact methods derived from the primary contact for the Patterson household.
- Usage information
- Party Grouping Contact Methods are derived from a particular contact
method usage type, or types, associated with a party or parties that
participate in a party grouping and that play a particular active
party grouping role types.
The party grouping contact methods can be configured to return only those for a derived from particular party grouping roles and address types, for example, the primary address, which is the address usage type, for the head of household, which is the role type. These values are currently configured in the TCRM.properties file under the following keys:
/Party/Grouping/ContactMethod/contactMethodTpCds/Party/Grouping/ContactMethod/groupingRoleTpCdsThis transaction does not support the Pagination feature.
- Preconditions
- Not applicable
- Mandatory input
- PartyGroupingId
- Inquiry levels
- Not applicable
- Filter values
- Not applicable
- Transaction behavior
- The response returns a list of all ACTIVE contact methods matching
the usage type defined in the external business rules for those party
or parties that play an ACTIVE role matching the party grouping role
types defined in the external business rules.
Contact Methods with an end date greater than the system date are considered to be Active. Contact Methods with an end date less than or equal to the system date are considered to be Inactive.
- Request message
- <InquiryType> getAllPartyGroupingContactMethods
<tcrmParam name= "partyGroupingId">
- Response objects
- List of TCRMPartyContactMethodBObj with associated TCRMContactMethodBObj
- Special note
- Not applicable