This document provides a detailed overview and functioning of Upload Agent Forms API and how it is used for uploading documents related to client/ application / contract. For a given contract id/ client id/ application id it will upload related forms/documents.
| 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 upload the Documents and its details available within ALIP. |
| BR3 | The Client ID/Application ID/Contract ID needs to be present in ALIP for the data to be returned. |
| BR2 | Interface uploads documents associated with the contract/client/application, irrespective of the status of the contract/ role of client. |
| BR4 | Associated property value tag must be one of these values(10,15,16) |
The external system would post the message containing the forms description and content which will be uploaded on the request queue.
The request is then converted into ACORD format.
ALIP process server will pick up the message, perform the necessary XSD validations, and other basic validations on the completeness of the input request
For the given instance of the request, ALIP the document is uploaded if the corresponding id is present in ALIP and a success ALIP response is sent.
This response 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 |
| DocumentName | Type of Product it is referring to | Y | |
| DocumentFileName | Name of the file to be uploaded with extension | Y | |
| DocumentContent | The content of the document to be uploaded | Y |
| Response Parameters | Description | Mandatory | Allowed values |
| ResultCode | Consists of attribute tc which is 1 for Success and 5 for Failure.Its corresponding text is shown. | Y | Tc values 1 or 5.Text can be “Success” or “Failure” |
| FormInstance | Message displaying whether the form has been uploaded successfully or not. | Y | “Document uploaded successfully.” |
| Success | Success Scenario Description | Message Code | Message Description | Message Type | Additional Comments |
| #1 | Document uploaded successfully 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 Upload Agent Forms call was NOT successful due to technical errors. | 5 | Internal Error | Informational | TXLife/TXLifeResponse/TransResult/ResultCode/@tc =5 |