For a given contract id/ client id/ application id it will list all the related forms/documents, the List Contract Documents API get 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 interface will get the Forms details available within ALIP. |
| BR2 | Interface lists all the 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 would post the message containing the information required for listing the documents on the request queue in ACORD format.
This message is converted into ALIP Format and sent to ALIP System.
ALIP process server will pick up the message, perform the necessary XSD validations, and other basic validations such as completeness of the input request,existence of the instance in ALIP.
It then lists documents with document id and document name available for the given instance in response.
The response obtained in ALIP format is then converted in ACORD format.
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 | Client ID/Application ID/Contract IDexisting in ALIP | Y | |
| Property Value | Whether it is a client,application or a contract. | Y | 10,15,16 |
| Response Parameters | Description | Mandatory | Allowed values |
| ResultCode | It consists of tc attribute which can have value 1 or 5 .Text is also displayed. | Y | Tc values can be 1 or 5 .Text displayed should be “Success” or “Failure” |
| AttachmentKey | A particular unique indentifier | Y | |
| Description | Product name of the application | Y | |
| AttachmentSource | Name of the document listed according to the criteria | Y |
<<< Here Response Dig is pending will dependent on the tool which is provided >>>
| Success | Success Scenario Description | Message Code | Message Description | Message Type | Additional Comments |
| #1 | The list 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 |
| #1 | The list Contract Documents call was NOT successful due to a technical error or data does not exist. | 5 | Internal Error | Informational | TXLife/TXLifeResponse/TransResult/ResultCode/@tc =5 |