This interface provides the ability to find list of Requirements attached to any application. The calling external system needs to provide the application number as an input reference to find the required details. Optionally, the calling external system can also provide a list of Requirement Status as input parameter for fetching only those requirements which match the input list of status. After fetching the required details from ALIP, a response along with success or failure processing indicators will be returned to the calling external system.
In case of a success response, ALIP will return all the requirement details found against the input application number and satisfying the list of input requirement status if provided.
In case of a failure, ALIP will return the error details along with a failure response.
This Interface is independent of any product type in ALIP.
| TR ID# | Technical Requirements |
| TR1 | Standard ACORDv2.39 should be used. |
| TR2 | The interface should accept a GET request which will contain the reference application Number and list of requirement status (optional) as input. |
| TR3 | The interface will send a response back in ACORD TC 1123 XML format. |
| TR4 | It will be an inbound interface and synchronous in nature. |
| TR5 | The interface will use HTTPS protocol. |
| BR ID# | Business Requirements |
| BR1 | This interface should take the reference application Number as an input and return the list of Requirements, attached to the corresponding Application in ALIP, as an output. |
| BR2 | If the calling external system provides a list of requirement status, this interface should return only those requirements which belong to any of the input status provided as query parameter. |
| BR3 | This interface should return both Case Level and Insured Level requirements attached to the respective application in ALIP. |
| BR4 | This interface should return an appropriate error response if there is no match for the incoming application number in ALIP. |
| BR5 | This interface should return an appropriate error response if there is no requirement found for the respective application in ALIP. |
N/A
It is assumed that there are no security constraints or if there are such, will be handled by the external calling system that provides the content.
This interface will use HTTPS protocol.
This interface is a REST based inbound service which is synchronous in nature. It also has an extended support for SOAP/JMS to send the ACORD request.
Following are request data elements. For more details, please refer mapping sheet in Section 3.1.9 Attachments.
| Request Parameters | Description | Mandatory |
| Reference Number | A number which uniquely identifies an Application in ALIP. | Mandatory |
| Requirement Statuses | Comma separated list of requirement status | Optional |
Following are response data elements. For more details, please refer mapping sheet in Section 3.1.9 Attachments.
| Request Parameters | Description | Mandatory |
| Reference Number | A number which uniquely identifies an Application in ALIP. | Mandatory |
| Requirement Code | Requirement Code. This field contains the unique identification code for requirement. | Mandatory |
| Requirement Name | Requirement Name. This field contains the name of the requirement | Mandatory |
| Requirement Details | Requirement Details. This field contains the details that are attached to the requirement | Mandatory |
| Requirement Status | Requirement Status. This field will contain the Requirement Status in ALIP. | Mandatory |
| Requested Date | The date on which the requirement got last updated. | Mandatory |
| Created Date | The date on which the requirement got created. | Mandatory |
| Requirement Level | This field will identify whether it is Case Level or Insured Level. | Mandatory |
| Party Information | The Party’s name and address in case of an Insured Level requirement. | Conditional Mandatory |
| Success | Success Scenario Description | Message Code | Message Description | Message Type | Additional Comments |
| #1 | The Get Requirement Info interface executed successfully. | 1 | Success | Informational |
| Error | Error Scenario Description | Message Code | Message Description | Message Type | Additional Comments |
| #1 | Generic System Failure due to technical errors. | 100 | Internal Error | Fatal | |
| #2 | XSD validation failure for missing input reference application number | 100 | XSD Validation Error | Failure | |
| #3 | No application found for the reference application number mentioned in the input request | 100 | Validation Error | Failure | |
| #4 | No requirement found for the reference number mentioned in the input request. | 100 | Validation Error | Failure | |
| #5 | Provide incorrect value for requirement status in the input request | 100 | Validation Error | Failure |