NB Post Submit Status Update

Request/Response & Json Schema

Overview

This interface provides an ability to external users, to change the status of a submitted application in ALIP. Once the status is changed, ALIP will respond to the calling external system with a success or failure response.

This Interface is applicable for all products in ALIP.

Technical Requirements

TR ID# Technical Requirements
TR1 ACORDv2.36 shall be used to communicate with the client system.
TR2 Client system sends ACORD message for application status update to ALIP (TransType tc= “505” and TransSubType tc=”50500”)
TR3 ALIP will receive the message and changes the status of the application in ALIP.
TR4 Any failure or error would be saved as an Integration Failure in ALIP, and sent back to the client system.
TR5 In case of no errors, a success message will be sent back to Client’s system to indicate the status change of the application.
TR6 Events will be published for the update of the application status.

Business Requirements

BR ID# Business Requirements
BR1 ALIP receives an application status update request for a submitted application.
BR2 ALIP will receive the request and change the Status of the corresponding application to the given status. Once the status is changed, ALIP will respond to the client system with a success or failure response.
BR3 Any changes made by this interface, will be associated with a user called ‘Interface User’ in the ALIP database.

Process Flow

Process Flow Description

The external system will send an application status update request to ALIP in ACORD format.

ALIP will receive the message, further transform the message to ALIP format, and invoke the necessary APIs and workflows to change the status of the application.

ALIP will generate the corresponding response, transform it to ACORD format and send it back to the calling system.

Events will be published for application status changes that occur in the ALIP system

Impact on ALIP system

None

Assumptions

N/A

Dependencies

N/A

Request Data Elements

Request Parameters Description Mandatory Allowed values
CaseName A tag which uniquely identifies an Application number within ALIP. Y String

Response Data Elements

Please refer to spreadsheet below for the Response Data elements

NB Post Submit Status Update

Success/Error Handling

Success Success Scenario Description Message Code Message Description Message Type Additional Comments
#1 The NB Status Change request was successful with details being returned in the output. 1 Success Informational

Error Error Scenario Description Message Description Message Type Additional Comments
#1 The NB Status Change request was successful with details being returned in the output. Success Informational
#2 The NB Status Change call was NOT successful due to technical errors. Internal Error Fatal General ErrorSystem Error
#3 The NB Status Change request was not successful, where Source System Transaction Number is given in the ACORD request and no such application present for given input in ALIP. Failure Warning General ErrorNo Application Found
#4 The NB Status Change request was not successful, where Source System Transaction Number is missing in ACORD request, or any other mandatory element is missing from the input XML. Failure Warning General Error Validation Error[Validation Error] will correspond to the actual validation error being returned from the validator.
#5 The NB Status Change request was not successful, where ‘CaseName’ is given in the ACORD request but application is present within ALIP with status as ‘Disconnected Submit’ for given CaseName. Failure Warning General ErrorStatus of the Application can’t be changed as it is in Disconnected Submit
#6 The NB Status Change request was not successful, where ‘CaseName’ is given in the ACORD request but Policy for given application is present within ALIP is in “Active” Status. Failure Warning General Error Status of the Application can’t be changed as its corresponding policy is in Active status
#7 The NB Status Change request was not successful, where ‘CaseName’ is given in the ACORD.Condition: Application status is “Unsubmitted” Failure Warning General Error Status of the Application can’t be changed as it is not submitted