getAllPartyGroupingAddresses
- Description
- This inquiry transaction returns the details of all the addresses of a specific type derived from the party that plays a specific role within the grouping.
- Web Services
- Operation name: getAllPartyGroupingAddresses
- Example
- Retrieve all addresses derived from the "primary contact" for the Patterson's household.
- Usage information
- Party Grouping Addresses are derived from a particular address
usage types associated with a party or parties that participate in
a party grouping AND play a particular active party grouping role
types.
The party grouping addresses can be configured to return only those for a derived from particular party grouping roles and address types (that is, the primary address (address usage type) for the head of household (role type). These values are currently configured in the TCRM.properties file under the following keys:
/Party/Grouping/Address/addressUsageTpCds /Party/Grouping/Address/groupingRoleTpCds
This transaction does not support the Pagination feature.
- Preconditions
- Party Grouping must exist.
Party Grouping Association must exist.
- Mandatory input
- PartyGroupingId
- Inquiry levels
- Not applicable
- Filter values
- Not applicable
- Transaction behavior
- The response will return a list of all ACTIVE addresses 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.
Addresses with an end date greater than the system date are considered to be Active. Addresses with an end date less than or equal to the system date are considered to be Inactive.
- Request message
- <InquiryType> getAllPartyGroupingAddresses
<tcrmParam name= "partyGroupingId">
- Response objects
- List of TCRMPartyAddressBObj with associated TCRMAddressBObj.
- Special note
- Not applicable