getAllAlerts
- Description
- This inquiry transaction returns the recorded Alert information associated with a specific entity, based on a filter.
- Web Services
- Operation name: getAllAlerts
- Example
- Retrieve all active alerts for a given campaign.
- 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 for this transaction controls the extent and type of information that is returned:- all active Alert information only
- all inactive Alert information only
- all Alert information
Alert categories and types are user-definable though a code table.
This transaction supports the Pagination feature.
- Preconditions
- Not applicable
- Mandatory input
- EntityName
- InstancePK
- 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> getAllAlerts
<tcrmParam name= "entityName">
<tcrmParam name= "instancePk">
<tcrmParam name= "filter">
entityName: CONTACT (Party) or CONTRACT
instancePk: The primary key of the particular instance of that entity you are interested in: that is, partyId or contractId.
- Response objects
- List of TCRMAlertBObj
- Special note
- Not applicable