This API is an outbound interface which has the ability to send an ACORD tc 106 request to the external client system when triggered from ALIP Business process with defined trigger information. On receiving this request, the external client system will send a synchronous response which will contain External Client Policy Number for the application.
| TR ID# | Technical Requirements |
| TR1 | ACORD tc 106 is used to retrive the External Client Policy Number from the external system by employing the following:-BASIC AUTH with token generation serviceREST application/jsonSOAP |
| TR2 | This API will receive an input request containing application data like Application ID, Product Code, and Qualified Type in ALIP Canonical format from ALIP Business Configuration Rules. |
| TR3 | The input data will be transformed as per the Request Data Elements specified section 4.1.4. This transformed ACORD based XML request with Transaction Type ‘106’ will then be sent out to the external client system. |
| TR4 | The interface will then receive a synchronous response back from the external client system with ResultCode tc as ‘1’ (Success) or ‘5’ (Failure) |
| TR5 | The interface will fail in case of the following responses from external system:HTTP_STATUS_4xx:HTTP_STATUS_5xx:In case of HTTP_STATUS_5xx the interface will retry 3 times |
| TR6 | If the product is Non-Qualified, then Qualified Type tag should be empty or not populated by business rules and the API will not send the element in the request. |
| BR ID# | Business Requirements |
| BR1 | This interface will provide the ability for ALIP Business Configuration Rules to trigger an integration call and pass ALIP Application ID, Product Code and Qualified Type to an external client system’s endpoint. |
| BR2 | The policy number received in the synchronous response will be returned to the calling Business Configuration rules after transforming to the required ALIP canonical format. |
| BR3 | No validation will be performed by the ALIP integration for the policy number received. |
Business Configuration will invoke the GetPolicyNumber API end point with the ALIP canonical application XML with the ALIP Application ID, Product Type and Qualified Type.
ALIP server will receive the request and call the GetPolicyNumber API.
The API will prepare an ACORD based XML request with the required Request Data Elements and make an external call to the external client system.
On receiving the request from ALIP, the external client system will send a synchronous response back to ALIP.
The GetPolicyNumber API of ALIP will receive the response and then it will convert the response into ALIP canonical format.
Response transformed in step 5 will be send to calling Business Configuration rules.
The Server will also update the Integration Tracking tables of ALIP database with the appropriate Integration status
N/A
The interface will not do any business validations for data being sent and received.
Interface will only return Policy number.
Interface is not responsible for saving any data into ALIP tables.
Tested this interface via RuleGroup ‘INT-GetPolicyNumber’ for IX
| Sr No | Scenario Description | Message Code | Message Description | Message Type | Additional Comments |
| #1 | The Interface call was successful with HTTP_STATUS_200. | 1 | Success | HTTP STATUS 200 | The ALIP Integration History screen will display one record for this interface with Success status. |
| #2 | The interface call was NOT successful due to bad request sent to external Web Service API. | 400 | Bad Request | HTTP STATUS 400 | Integration History will show a record with Failed status. |
| #3 | The interface call was NOT successful because of data not found at external Web Service API end. | 404 | Not Found | HTTP STATUS 404 | Integration History will show a record with Failed status. |
| #4 | The interface call was NOT successful because invalid method type sent to external Web Service API. | 405 | Method Not Allowed | HTTP STATUS 405 | Integration History will show a record with Failed status. |
| #5 | The interface call was NOT successful because of the Server is not accepting the request. | 406 | Not Acceptable | HTTP STATUS 406 | Integration History will show a record with Failed status. |
| #6 | The interface call was NOT successful because invalid content type sent to external Web Service API. | 415 | Unsupported Content Type | HTTP STATUS 415 | Integration History will show a record with Failed status. |
| #7 | The interface call was NOT successful because of Internal Server Error of the server which is hosting the external Web Service API. | 500 | Internal Server Error | HTTP STATUS 500 | ALIP will make Retry attempts for 3 times and post that, Integration Failure will be logged in ALIP and the Integration History will show Failed status. |