Delete Arrangements API

Request/Response & Json Schema

Overview

This interface in Accenture Life Insurance Platform (ALIP) provides the ability to an Agent or an customer to delete a customer’s Arrangement information. The unique Arrangement System Key should be provided for the deletion of the specific Arrangement.

Technical Requirements

TR ID# Technical Requirements
TR1 ACORDv2.36 shall be used to communicate.
TR2 ACORD Tx 107 “Holding Transaction tc=107” will be used for deleting the Arrangement to support the business use cases
TR3 Interface must always return an error code and desc in the event of a processing failure in addition to HTTP response code.
TR4 For a success the response will be sent for confirming the process.
TR5 A response time of 3 seconds or less is expected.
TR6 Q-switch needs to be always be run while processing any event
TR7 Any changes made by this interface will be associated with the Service User ID (provided in the service request)

Business Requirements

BR ID# Business Requirements
BR1 Client requires the ability to invoke a service within ALIP to delete an Arrangement
BR2 Future and expired events will not be available in the response even if it is processed. Only the current events as of current system date will be returned in response
BR3 Service should return a success or failure message depending on the outcome of processing.

Process Flow

• The external system would fire the REST URL with the JSON message containing the arrangements information to be retrieved/updated/deleted 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 arrangement information, existence of the contract id in ALIP etc.

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

• The arrangement information in case of a “GET” request, or the status information incase of a create/update/delete (POST/DELETE), 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.

Withholding information is available for Owner and Primary roles as part of response based on enabling configurable property in ALIP.

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

None

Assumptions

None

Dependencies

It is assumed that the incoming message from the calling system, will contain the required the RequestType, TransType, TransSubType within the request header provided by the external system to ALIP.

Request Data Elements

Response Data Elements

NA

Error Handling

Error Error Scenario Description Message Code Message Description Message Type Additional Comments
#1 The Arrangements Delete call was successful with details being returned in the output 1 Success Informational TXLife/TXLifeResponse/TransResult/ResultCode/@tc =1
#2 The Arrangements Delete interface could not find any matching contract id record in ALIP. 5 Internal Error Informational TXLife/TXLifeResponse/TransResult/ResultCode/@tc =5