The Add/UpdateAddress interface associates a new address for the given party and address type, or allows the update/delete of an existing address.The interface takes a unique Customer ID or can take combination of TaxId and ClientTypeID as an input. The effective date of the transaction will default to the current system date.The new address will be added to all contracts after terminating the earlier address for the given party. If no contracts are provided, the new address will be added to all contracts that the client has any role on. On completion of the transaction a confirmation message for success is returned.
| TR ID# | Technical Requirements |
| TR1 | ACORDv2.36 will be used to communicate between ALIP and Client systems |
| TR2 | ACORD Tx 181 “Add/Update/Delete Addresstc=181” Service will provide the ability to associate/disassociate a new address for a given a party |
| TR3 | Any changes made by this interface will be associated with a user id in the request. . |
| TR4 | The effective start date and end dates will be updated for the new address based on the input start and end date. |
| TR5 | Apart from the Client ID, the interface should also have the ability to take a combination of the TaxId and ClientType Id as a input. |
| TR6 | A new RuleGroup will be introduced for the user specific validation. This RuleGroup will be used by the client teams to validate the Input. (For Eg based on the UserLoginName a Rule will do the validation If ContractList exists for a given request). For Default implementation in IX, this RuleGroup will not validate any Request. |
| BR ID# | Business Requirements |
| BR1 | The service will be provided a list of contracts, to which the address change need to be cascaded. If list of contracts is not provided, all the contracts would get this new address i.e. where any party with this address exists in any role for given address type. |
| BR2 | The new address will be added to the contracts after terminating the earlier address for the given party. |
| BR3 | Any changes made by this interface, will be associated with a user called ‘Interface User’ in the ALIP database. |
| BR4 | Interface should also be able to process the combination of TaxId and Client type ID as a input. |
The external system would post the message containing the address 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 completeness of the address information, existence of the client id in ALIP etc.
If the ALIP Client ID is not present in the request, interface will try to fetch the ALIP Client ID from the combination of TaxID and ClientTypeID. (Individual / Company / Trust)
A RuleGroup will be called to validate any client specific validation. For default IX implementation this RuleGroup will not invoke any rule and client teams are responsible for their custom implementations.(For eg AZL-IPA has a custom requirement to check If the contract List has been sent as a part of Request. If the Contract is not present in the request, Interface is expected to give error.)
Post the necessary validations, it would invoke a workflow to terminate the address and create a new address with the provided address information, and apply the same to all associated contracts. The list of contracts would be derived from the database if not provided in the input.
The same process applies for update/delete of addresses as well.
The status of the address change would be posted back to the response queue.
None
N/A
N/A
| Request Parameters | Description | Mandatory | Allowed values |
| Party Identifier | An internal identifier (CRM ID) of ALIP. | Conditional Mandatory | |
| Tax ID and Client Type ID | A combination of Tax Id and Client Type ID unqielyidenties a client. | Conditional Mandatory | |
| Address To Be Updated | Text containing address detail | Y | |
| Address Type | The address type (Physical or Mailing) | Y |
| Success | Success Scenario Description | Message Code | Message Description | Message Type | Additional Comments |
| #1 | The Add/Update/Delete Address call was successful with details being returned in the output | 1 | Success | Informational | |
| #2 | The Add/Update/Delete Address call was successful with combination of TaxID and ClientType Id and details being returned in the output | 1 | Success | Informational |
| Error | Error Scenario Description | Message Code | Message Description | Message Type | Additional Comments |
| #1 | TheAdd/Update/Delete Address call was NOT successful due to technical errors | 100 | Internal Error | Fatal | Any system error |
| #2 | The Add/Update Address call was NOT successful due to validation errors – Any of the following fields is missing - Party id, First Line Address, Jurisdiction Code, Postal Code, Country Code and Address Type Code | 100 | Validation Error | Fatal | Any validation error |
| #3 | The Add/Update/Delete Address call was NOT successful as city field is empty or blank. | 101 | General Error | ||
| #4 | The Add/Update Address call was NOT successful due to missing conditional input. i.e ClientID and combination of TaxID and Client Type ID both are missing | 101 | General Error | ||
| #5 | The Add/Update Address call was NOT successful due to comination of TaxID and ClientType was missing in ALIP | 101 | General Error |