This interface provides the ability to search an application in ALIP for:
A given Owner Tax Id, Start date and End Date.
A given Portal User Id, Start date and End Date
A given External Agent Id, Start date
ALIP returns all the applications found, as a response, back to the client system.
URL for view applications for an agent for Owner Tax Id and Portal User Id
agents/{id}/dashboard/applications/{startDate}
URL for External Agent Id
agents/1.1/{id}/dashboard/applications/{startDate}
| TR ID# | Technical Requirements |
| TR1 | ACORDv2.36 shall be used to communicate with the client system |
| TR2 | Client system makes a call to ALIP with either an Owner Tax ID or a Portal User Id or Agent External ID. In both the cases of Tax ID/Portal User ID, there will always be a Date Range I.e. Start Date and End Date. (TransType=”302” and TransSubType=”30200”) |
| TR3 | If the Owner Tax ID exists in the input, ALIP would not look for the Portal User ID but instead perform the search based on the Owner Tax ID, Start and End date |
| TR4 | If the Owner Tax ID does not exist, ALIP would use the Portal User ID to perform the search using Portal user ID field inside Integration History database tables. |
| TR5 | For fetching applications for an agent, client id will be used and search will be performed. |
| TR6 | The API also supports to fetch Application Details for max 10 tags in response which will be displayed in Policy/OlifeExtension/NameValueDataElements/ DataElementName and Policy/OlifeExtension/NameValueDataElements/ ValueThe list of tags expected is configurable by each client. |
| TR6 | ACORD Tx 302 is used to retrive the details from ALIP employing the following:-REST application/xml &application/jsonSOAP |
| BR ID# | Business Requirements |
| BR1 | Client system sends a request message to ALIP with either the owner tax id or the user id used to create/modify applications. LIP is expected to return all the matching applications found as a response to the client’s system. |
| BR2 | Any changes made by this interface, will be associated with a user called ‘Interface User’ in the ALIP database. |
The external system sends the application search request to ALIP in ACORD format.
ALIP will receive the request, transform the message to ALIP format, identify the appropriate search criteria to be applied, and invoke the necessary APIs to first retrieve application ids that match the criteria and then the corresponding application details for each application id, from the ALIP database.
ALIP will transform the retrieved application information to ACORD format and send it back to the calling system.
None
The StartDate which is sent in the REST parameter will not check the length and will truncate the first 8 digits to prepare the StartDate
N/A
| Request Parameters | Description | Mandatory | Allowed values | Comment |
| TaxID | A tag which uniquely identifies a Client within ALIP. | Y | String | Conditional Mandatory |
| UserLoginName | User Login tag. | Y | String | Conditional Mandatory |
| Agent Client Id | Agent client ID | Y | String | Conditional Mandatory |
| Agent External Id | Agent external ID | Y | String | Conditional Mandatory |
Only one of the above two should be provided at a time.
Instead of defining static tag Ids for the tags, we are defining a single property with a list of tag Ids. This list will be passed as-is to Base API. Base will return the data in the Name value format. We are defining it in a similar key-value pair in the OLifEExtension as well.
Policy OLifeExtensionNameValueDataElements
Currently, We have added ‘SearchApplicationNVData’ key into process-server property file where all the Xpaths are listed. Which will retrieve ID and We will populate data accordingly.
| Success | Success Scenario Description | Message Code | Message Description | Message Type | Additional Comments |
| #1 | The NB Searchrequest was successful withdetails beingreturned in theoutput | 1 | Success | Informational |
| Error | Error Scenario Description | Message Description | Message Type | Additional Comments |
| #1 | The NB Searchrequest was successful withdetails beingreturned in theoutput | Success | Informational | |
| #2 | The NB Searchcall wasNOT successfuldue to technicalerrors. | Internal Error | Fatal | |
| #3 | The NB Search request was not successful, where Owner tax id, start date and end date is given in ACORD request and no such application present for given Owner tax id in ALIP. | Failure | Warning | |
| #4 | The NB Search request was not successful, where Owner tax id, start date and end date is given in ACORD request and no such application present for given start date and end date in ALIP. | Failure | Warning | |
| #5 | The NB Search request was not successful, where Owner tax id, start date and end date is given in ACORD request and no such application present in pre-issue status in ALIP | Failure | Warning | |
| #6 | The NB Search request was not successful, where Portal User id, start date and end date is given in ACORD request and no such application is present for given portal user id in ALIP | Failure | Warning | |
| #7 | The NB Search request was not successful, where Portal User id, start date and end date is given in ACORD request and no such application is present for given start date and end date in ALIP | Failure | Warning | |
| #8 | The NB Search request was not successful, where Portal User id, start date and end date is given in ACORD request and no such application is present in pre-issue status in ALIP. | Failure | Warning | |
| #9 | The NB Search request was not successful, where Portal User Id and Owner tax id both are missing. | Failure | Warning | |
| #10 | The NB Search request is successful, where agent client id is present | Sucess | ||
| #11 | The NB Search request is not successful, where agent client id is not valid. | Failure | "ResultInfoCode”: { "@tc”: "100", "$”: "General Error" }, "ResultInfoDesc”: "Agent is not valid" | |
| #12 | The NBSearch is successful where valid agent client Id is passed but agent has no applications associated. | Failure | No application is found | |
| #13 | The NBSearch is not successful as the agent client id passed in request is not active | Failure | “Agent is not currently active.” | |
| #14 | The NBSearch is not successful as the agent client id passed is not non- numeric or blank | Failure | “’ ‘is not a valid value for integer” | |
| #15 | The NB Search request is successful, where agent External ID is present | Sucess | ||
| #16 | The NB Search request is not successful, where agent External ID is not valid. | Failure | "ResultInfoCode”: { "@tc”: "100", "$”: "General Error" }, "ResultInfoDesc”: "Agent is not valid" | |
| #17 | The NBSearch is successful where valid agent External ID is passed but agent has no applications associated. | Failure | No application is found | |
| #18 | The NBSearch is not successful as the agent External ID passed in request is not active | Failure | “Agent is not currently active.” | |
| #19 | The NBSearch is not successful as the agent External ID passed is blank | Failure | “’ ‘is not a valid value” |