This interface provides the ability to provide Detailed Requirement Data along with Vendor/ALIP XML Results for the received Requirement Header ID . The calling external system needs to provide the Requirement Identifier as an input reference to find the required details. Optionally, the calling external system can also provide a flag of Vendor indicator as input parameter for fetching either Vendor result or ALIP results associated with the requirement. 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 the fetched requirement details along with the vendor XML attached for the input requirement Header ID.
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 ALIP Requirement Header ID as input. |
| TR3 | The interface will send a response back in ACORD TC 123 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 should take the ALIP Requirement Header ID as an input and return the details of the Requirement, as an output. |
| BR2 | This interface should also return the Vendor / ALIP results attached to the requirement (If applicable). |
| BR3 | The interface will return either Vendor Results or ALIP results based on Vendor Indicator flag.0 :- ALIP Results1 :- Vendor ResultsThis flag is optional. If this flag is not sent as part of input then the API will default to Vendor Results as response. |
| BR4 | This interface should return either Case Level or Insured Level requirement attached to the respective Requirement Header ID in ALIP. |
| BR5 | This interface should return an appropriate error response if there is no requirement found for the incoming Requirement Header ID in ALIP. |
| BR6 | The vendor result XML will be sent as received. If it contains PII (Personal Insured Information) this will be present ‘as is’ in the attachment. There will be no embedded image sent. |
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.
The API will return either Vendor Results or ALIP results , not Both.
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.
This interface will only translate Requirement Status mentioned in Section 3.2.9 Attachments - Data Mapping sheet. Client teams having requirement status other than supported need to map them separately as an extension of this interface.
Following are request data elements. For more details, please refer mapping sheet in Section 3.1.9 Attachments.
| Request Parameters | Description | Mandatory |
| Requirement Header ID | A number which uniquely belongs to a Requirement Header in ALIP. | Mandatory |
Following are response data elements. For more details, please refer mapping sheet in Section 3.1.9 Attachments.
| Request Parameters | Description | Mandatory |
| Requirement ID | This field contains the unique identification code for requirement. | Mandatory |
| Requirement Name | This field contains the name of the requirement. | Mandatory |
| 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 |
| Vendor | Vendor that fulfilled the Requirement | Optional |
| Image ID | Image ID associated with the Requirement | Optional |
| Vendor Result XML | Result XML received from the Vendor catering the requirement. | Optional |
| Party Information | The Party’s name and address in case of an Insured Level requirement. | Conditional Mandatory |
| No | Success Scenario Description | Message Code | Message Description | Message Type | Additional Comments |
| #1 | The Get Requirement Detail interface executed successfully. | 1 | Success | Informational |
| No | 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 incorrect trans type tc code. | 100 | XSD Validation Error | Failure | |
| #3 | No requirement found for the input Requirement Header ID mentioned in the input request. | 100 | Validation Error | Failure | |
| #4 | Empty Requirement Header ID passed in the input request | 100 | Validation | Failure |