Update Address Indicators Interface

Request/Response & Json Schema

Overview

UpdateAddressIndicatorsinterface provides the ability to save/update any data, coming from the external client system, which are identified as Client Address Level Named Value data pertaining to a client’s address, into ALIP database.

Technical Requirements

TR ID# Technical Requirements
TR1 ACORDv2.36 will be used to communicate between ALIP and Client systems
TR2 ACORD Tx181 “UpdateAddressIndicatorstc=181” Service will provide the ability to update the Undeliverable Address Indicator/Bad Address Indicator in ALIP based on a party id/address id.

Business Requirements

BR ID# Business Requirements
BR1 ALIP allows the update of Address level named value Indicators.
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 address indicator 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 address id in ALIP etc.

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

The status of the address indicator information 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
Party Identifier An internal identifier (CRM ID) of ALIP. Y
Bad Address Indicator The indicator for Undeliverable Address set to false or true Y
User ID Service User ID Y
Address To Be Updated Set of address fields Y

Response Data Elements

Success/Error Handling

Success Success Scenario Description Message Code Message Description Message Type Additional Comments
#1 The UpdateAddressIndicators call was successful with details being returned in the output 1 Success Informational

Error Error Scenario Description Message Code Message Description Message Type Additional Comments
#1 The UpdateAddressIndicators call was NOT successful due to technical errors 100 Internal Error fatal Any system error
#2 The UpdateAddressIndicators interface could not find any matching record in ALIP. 100 No rows founds Warning