Add Update Delete Telephone Interface

Request/Response & Json Schema

Overview

The Add/Update/Delete TelephoneNumber interface receives the party id and list of phone numbers in the input request and will add/updates/deletes the phone numbers accordingly. If for a phone type, corresponding values are blank, it will update the phone numbers 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 Tx 182 “Add/Update/Delete TelephoneNumbertc=182” Service will provide the ability to add/update/delete the telephone numbers for a given party.
TR3 More than 1 set of telephone numbers can be provided as part of array. Each set will contain a phone type and the phone number..

Business Requirements

BR ID# Business Requirements
BR1 The interface allows for adding/updating/deleting of home phone, work phone, cell phone numbers for a given party 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 phone 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 phone number and the existence of the client id in ALIP etc.

Post the necessary validations, it would invoke a workflow to update the telephone number for the client id with the provided information.

The same process applies for update/delete of phone information as well.

The status of the phone number update would be posted back to the response queue.

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
Telephone Type BP or HP or MP Y
Party Identifier An internal identifier (CRM ID) of ALIP. Y
Telephone Number Telephone details of the party 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/Delete Telephone Number 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/Delete Telephone Number call was NOT successful due to technical errors 100 Internal Error Fatal Any system error
#2 The Add/Update/Delete Telephone Number call was NOT successful due to validation error – Phone type provided is not valid 100 Validation Error Fatal Validation error for phone type
#3 The Add/Update/Delete Telephone Number call was NOT successful due to validation error – Phone number provided is not 10 digit 100 Validation Error Fatal Validation error for length of phone number
#4 Add/Update/Delete Telephone Number interface could not find any matching record in ALIP. 100 No rows founds Warning If party id is missing, a warning will be returned.