The Task API get the list of task for a agent for the period specified within the start and the end date if no such dates are specified then details received are for that particular year. The task data received depends on the client id of the agent within the ALIP system.
In order to make a get task call to ALIP system the user must have the role of an active agent within the ALIP system
| TR ID# | Technical Requirements |
| TR1 | ACORDv2.36 shall be used to communicate. |
| TR2 | ACORD Tx 206 “Get Tasktc=1217” is being used for getting task details based on the client id of the user having the role as agent. |
| 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 task interface will get the task details for the period specified by the start and end date. |
| BR2 | Interface will get the task details for last one year till the current date in case no dates are specified within the url. |
| BR3 | The client id of the user provided within the logging must have role as Active agent within the ALIP system |
N/A
The client id used should be present within the ALIP system and should be a individual having the role of Agent within ALIP system.
The agent should be active within the ALIP system.
The user for the client id must have role of the type Agent and must be active within the ALIP system.
The ALIP system must have the required data of task within ALIP for the agent.
| Request Parameters | Description | Mandatory | Allowed values |
| Success | Success Scenario Description | Message Code | Message Description | Message Type | Additional Comments |
| #1 | The get task 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 task call was NOT successful due to a technical error. | 5 | Internal Error | Informational | TXLife/TXLifeResponse/TransResult/ResultCode/@tc =5 |