Add Update DeleteEmail Interface

Request/Response & Json Schema

Overview

Add/Update/DeleteEmail interface will add or update Client Email Address for given client ID. If for an email type, corresponding values are not provided, it will update those email addresses with blank values.The interface takes a unique Customer ID as an input. On completion of the transaction a confirmation message for success is returned. The effective date of the transaction will default to the current system date.

Technical Requirements

TR ID# Technical Requirements
TR1 ACORDv2.36 will be used to communicate between ALIP and Client systems
TR2 ACORD Tx183 “Add/Update/Delete Emailtc=183” Service will provide the ability to add/update/delete the e-mail address in ALIP, party id

Business Requirements

BR ID# Business Requirements
BR1 This interface allows for adding/updating/deleting the primary or secondary e-mail address for a client in ALIP.
BR2 Any changes made by this interface, will be associated with a user called ‘Interface User’ in the ALIP database.

Process Flow

The external system would post the message containing the e-mail information to be updated on the request queue.

ALIP process server will pick up the message, perform the necessary XSD validations, and other basic validations on the existence of the client id in ALIP etc.

Post the necessary validations, it would invoke a workflow to update the e-mail for the client id with the provided information.

The status of the e-mail update would be posted back to the response queue.

The same process applies for the update/delete of e-mail information as well.

Impact on ALIP system (applicable for add/update operations)

None

Assumptions

N/A

Dependencies

N/A

Request Data Elements

Request Parameters Description Mandatory Allowed values
Email address type 5 or 6 indicating the first or second email address Y
Party Identifier An internal identifier (CRM ID) of ALIP. Y
Email Text containing an email address Y
User ID Service User ID Y

Response Data Elements

Success/Error Handling

Success Success Scenario Description Message Code Message Description Message Type Additional Comments
#1 Add/Update/DeleteEmail was successful with details being returned in the output 1 Success Informational TXLife/TXLifeResponse/TransResult/ResultCode/@tc =1

Error Error Scenario Description Message Code Message Description Message Type Additional Comments
#1 Add/Update/DeleteEmail call was NOT successful due to technical errors 100 Internal Error Fatal Any system error
#2 Add/Update/DeleteEmail call was NOT successful due to validation errors 100 Validation Error Fatal Any validation error