Agent Estatement API

Overview

The e-Statements is a functionality that allows Agents to enable or disable e-statements, meaning email statements for the transaction done at the Contract Level that belong to a associated agency. The existing Correspondence Override setting which generate Confirms will be used to enable of disable e-statements option.

The Agent will be able to view the selections of e-statements on all the Agents’ agency in the Summary Information of the agent.

When an agent checks/selects (3-Email and 4-Regular Mail) the e-Statements option for an agency, the backend system searches for all the Active contracts of the agents’ agency and updates the Mailing Type of the particular Correspondence Override to Email.

When a agent unchecks the e-Statements option for agency or wants to unsubscribe from the E-Statements, the Mailing type is reverted to the previous setting that was persisted earlier.

When an Agent has 2 contracts, one with Correpondence agains the Agent role and other with no Correspondance against Agent role, then the contarct with no correspondence for Agent Role is deemed “Not Applicable” and the processing ignores the same.

Technical Requirements

Business Requirements

Process Flow

• The external system would fire the REST URL with the JSON message containing input parameters on the request queue.

• ALIP webadapters would pick up, process the message, convert it into XML format, and posts it onto the ALIP request queue.

• ALIP process server will pick up the message, convert from ACORD to the canonical format, perform the necessary XSD validations, and other basic validations on the completeness of the correspondence information, existence of the CRM id/External agent ID in ALIP.

• Post the necessary validations, it would invoke the necessary ALIP APIs/workflows to update or retrieve the necessary correspondence information from the database.

• The licensing information in case of a “GET” request, would be generated in XML format, converted to ACORD format, and sent back to the REST layer.

• Here, it would be further converted back into the final JSON output format and returned back to the external system.

Impact on ALIP system for e-Statements(applicable for get operations)

• This interface provides the ability for viewing if the customer has any correspondence settings available for the Conract against a particular role.

• Upon receiving the request,based on the CRMID or External ID, ALIP system checks for the list of contracts where correspondence is set to role specified fo the role and provides the Mailing Type for the contract.

• If the validations are successful the the request is forwarded to appropriate API/workflow which converts the response to ACCORD and then into the JSON format.

• If the validations fail the appropriate error messages will be displayed on ALIP system next to the licensing request. The status of licensing will reflect the same as in “Error”.

Impact on ALIP system for e-Statements(applicable for post operations)

• This interface provides the ability to set the Mailing Type to Email or any previous setting for a Agent of the customer.

• Upon receiving the request,based on the CRMID or External ID, ALIP system gets the contracts for an agent’s agency. On receiving the list of contracts, the system changes Mailing Type of the existing Correspondences to Email if e-statements is to be enabled or to the previous setting if e-statements is to be disabled.

• If the validations are successful the the request is forwarded to appropriate API/workflow which converts the response to ACCORD and then into the JSON format.

• If the validations fail the appropriate error messages will be displayed on ALIP system next to the appointments request. The status of licensing will reflect the same as in “Error”.

Assumptions

N/A

Dependencies

N/A

Request Data Elements

Response Date Elements

NA

Success/Error Handling