The Get Contract Documents API gets the list of documents of ALIP system.
| TR ID# | Technical Requirements |
| TR1 | ACORDv2.36 shall be used to communicate. |
| TR2 | ACORD Tx 206 “List Contract Documents tc=310” is being used for getting document details based on the search criteria |
| TR3 | Interface must always return an error code and desc in the event of a processing failure in addition to HTTP response code. |
| TR4 | For a success, the request will be successfully processed |
| BR ID# | Business Requirements |
| BR1 | The Document System interface will get the Documents and its details available within ALIP. |
| BR2 | Interface gets the details of documents associated with the contract/client/application, irrespective of the status of the contract/ role of client. |
| BR3 | The Client ID/Application ID/Contract ID needs to be present in ALIP for the data to be returned. |
| BR4 | Associated property value tag must be one of these values(10,15,16) |
The external system takes request containing document id as an input in ACORD format.
The request is then converted from ACORD format to ALIP format.
The request is then validated for the completeness of the required information such as existence of Document ID in ALIP database.
Using the Document Id, document content is extracted from ALIP system and sent in ALIP Response.
The response is then converted into ACORD format as the Interface output.
N/A
The documents used should be present within the ALIP system.
The ALIP system must have the required documents within ALIP.
| Request Parameters | Description | Mandatory | Allowed values |
| Property Name | It takes Contract Number as an input | Y |
| Response Parameters | Description | Mandatory | Allowed values |
| ResultCode | It has attribute tc which has value 1 or 5 and Text is displayed as output | Y | Tc value can be 1 or 5.Text can be Displayed as “Successs” or “Failure” |
| Success | Success Scenario Description | Message Code | Message Description | Message Type | Additional Comments |
| #1 | The get Contract Documents call was successful with details being returned in the output | 1 | Success | Informational | TXLife/TXLifeResponse/TransResult/ResultCode/@tc =1 |
| Error | Error Scenario Description | Message Code | Message Description | Message Type | Additional Comments |
| #2 | The get Contract Documents was NOT successful due to a technical error or data does not exist. | 5 | Internal Error | Informational | TXLife/TXLifeResponse/TransResult/ResultCode/@tc =5 |