getAllPartyAlerts
- Description
- This inquiry transaction returns the recorded Alert information associated with a specific party, either person or organization based on a filter value.
- Web Services
- Operation name: getAllPartyAlerts
- Example
- Retrieve all party alerts for John Smith.
- Usage information
- The input to this transaction is the party ID for the party whose
alerts are being queried as well as a filter.
The filter controls whether all active Alert information only, all inactive Alert information only or all Alert information (both active and inactive) is returned.
Alert categories and types are user definable through a code table.
This transaction supports the Pagination feature.
- Preconditions
- Not applicable
- Mandatory input
- PartyId
- Filter
- Inquiry levels
- Not applicable
- Filter values
- A filter value must be supplied. Valid values are:
- ACTIVE – returns only active alerts.
- INACTIVE – returns only inactive alerts.
- ALL – returns both active and inactive alerts.
Filter values are case sensitive and must be provided in upper case.
- Transaction behavior
- Alerts with an end date greater than the system date are considered to be Active. Alerts with an end date less than or equal to the system date are deemed to be Inactive.
- Request message
- <InquiryType> getAllPartyAlerts
<tcrmParam name= "partyId">
<tcrmParam name= "filter">
- Response objects
- List of TCRMAlertBObj business objects
- Special note
- Not applicable