getAllPartyMacroRoleAssociations

Description
This inquiry transaction returns all recorded PartyMacroRoleAssociations for a specified PartyMacroRole based on a filter value.
Web Services
Operation name: getAllPartyMacroRoleAssociations
Service name: Party
Example
Retrieve all the active PartyMacroRoleAssociations for Party Macro Role Id = 1234.
Usage information
This transaction receives as input a PartyMacroRoleId and a filter value.

The filter value controls whether only active, only inactive or all active and inactive PartyMacroRoleAssociations are returned.

This transaction supports the Pagination feature.

Preconditions
Not applicable
Mandatory input
  • PartyMacroRoleId
  • Filter
Inquiry levels
Not applicable
Filter
Filter applies to the PartyMacroRoleAssociation level.
Filter values are ACTIVE, INACTIVE, or ALL.

Filter values must be provided in upper case.

Transaction behavior
PartyMacroRoleAssociations with an EndDate less than the system date are considered inactive.

PartyMacroRoleAssociations without an EndDate or with End Date greater than the system date are considered active.

If filter value is not provided or is provided but invalid, the transaction use the default "ALL" value and both active and inactive PartyMacroRoleAssociations are returned.

Request message
<InquiryType> getAllPartyMacroRoleAssociations

<tcrmParam name= "partyMacroRoleId">

<tcrmParam name= "filter">

Response objects
One or many TCRMPartyMacroRoleAssociationBObj objects
Special note
Not applicable