getAllContractAlerts
- Description
- This inquiry transaction returns all the recorded alert information associated with a contract, based on a filter value.
- Web Services
- Operation name: getAllContractAlerts
- Service name: FinancialServices
- Example
- Retrieve all alerts for a given contract.
- Usage information
- The input to this transaction is the ContractId for the contract
whose alerts are being queried, as well as a filter.
The filter controls the level of alert information that is returned: active alert information, inactive alert information, or all alert information, both active and inactive.
This transaction supports the Pagination feature.
- Preconditions
- Not applicable
- Mandatory input
- ContractId
- Filter
- Inquiry levels
- Not applicable
- Filter values
- A filter value is mandatory. Valid values are:
- ACTIVE - returns active records only.
- INACTIVE - returns inactive records only.
- ALL - returns all records that match the search criteria, both active and inactive.
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 active. Alerts with an end date less than or equal to the system date are considered inactive.
- Request message
- <InquiryType> getAllContractAlerts
<InquiryParam>
<tcrmParam name= "ContractId">
<tcrmParam name= "filter">
- Response objects
- List of TCRMAlertBObj
- Special note
- Not applicable