This interface provides a detailed overview and functioning of ALIP Code List Inquiry API for getting list of drop down values which are dependent of business or product configuration available in ALIP system. The interface accepts ACORD request with TransType/TransSubType 237/23700 and responds with ACORD response. One request TXLife contains one or more TXLifeRequest each containing code list details to be fetched from the ALIP system. ACORD response contains that many TXLifeResponse elements as no of TXLifeRequest in request. Each TXLifeResponse contains list elements for code list passed in TXLifeRequest. The interface checks for request structure using xsd schema. If request does not conform to xsd then error response returned with error code and error description. Error response when xsd check fails will have only one TXLifeResponse element which has details error.
| TR ID# | Technical Requirements |
| TR1 | ACORD version 2.36 shall be used to communicate. |
| TR2 | CodeList Inquiry request “integrationPoint=CodeListInquiry” should be used for executing interface |
| TR3 | All TXLifeRequest elements inside one TXLife, should have same TransRefGUID. |
| TR4 | Request structure is checked against xsd schema. If request does not conform to xsd schema then error is returned. Response will have only one TXLifeResponse element having error details. |
| TR5 | For a successful transaction a return code of 200 is returned. |
| TR6 | The interface can be called using REST/SOAP/JMS calls |
| TR7 | Interface must always return an error code and desc in the event of a processing failure in addition to HTTP response code for SOAP or REST calls |
| BR ID# | Business Requirements |
| BR1 | CodeListCode or KeyCodeType will be used as the input for the interface |
| BR2 | The input CodeListCode or KeyCodeType will be used to fetch code list/s present within the ALIP database |
| BR3 | In case of an successful match for code list of codes will be returned by the interface. |
| BR4 | If code list is not available in ALIP system, then error response is returned. |
| BR5 | If request contains one or more code list which is/are not available in ALIP, then error response is returned even if remaining code list are available in ALIP |
ALIP will receive a new request for CodelistInquiry, on the ALIP Request Queue.
The ALIP process server will pick up the message, and parse each request to find out all code list to be fetched. It formats all code lists into ALIP format request which is passed to base api processor.
The processor fetches data for each code list and collates the replies into a single response.
The response is transformed into multiple TXLifeResponse elements and replied back to the calling system.
None
Code list passed in input should be present within the ALIP system.
N/A
Please refer to spreadsheet below for the Request Data elements
| Success | Success Scenario Description | Message Code | Message Description | Message Type | Additional Comments |
| #1 | The code list inquiry interface call was successful | 1 | Success | Informational | TXLife/TXLifeResponse/TransResult/ResultCode/@tc =1 |
| #2 | The code list inquiry interface call failed with XSD/System error. | 5 | Internal Error | Informational | TXLife/TXLifeResponse/TransResult/ResultCode/@tc =5 |