Get Forms

Request/Response & Json Schema

Overview

The Forms API get the list of Forms form ALIP system.

Technical Requirements

TR ID# Technical Requirements
TR1 ACORDv2.36 shall be used to communicate.
TR2 ACORD Tx 206 “Get Forms tc=310” is being used for getting Forms 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

Business Requirements

BR ID# Business Requirements
BR1 The Forms interface will get the Forms details available within ALIP.

Impact on ALIP system

N/A

Assumptions

The Forms data used should be present within the ALIP system.

Dependencies

The ALIP system must have the required data of Forms within ALIP.

Request Data Elements

Request Parameters Description Mandatory Allowed values

<<< Here Request Dig is pending will dependent on the tool which is provided >>>

Response Data Elements

<<< Here Response Dig is pending will dependent on the tool which is provided >>>

Success/Error Handling

Success Success Scenario Description Message Code Message Description Message Type Additional Comments
#1 The get Forms 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 get Forms call was NOT successful due to a technical error. 5 Internal Error Informational TXLife/TXLifeResponse/TransResult/ResultCode/@tc =5