API Parameters
As can be seen from the API Spec, a Task has some generalized fields like date of creation, expected closure date, who is the task assigned to and what is the nature of the task, along with to which order is this task associated. For ease of search, the task also stores the case filing number or the CNR number (which ever is available).
There are some specific types of tasks like Summon, Bail and Warrant. Each of these tasks have some additional fields that are required and these are stored in the taskDetails field. Each of these also have their own specific schema that is used for validating the data. Details about each of them can be found in following sections.
Each task will be related to one and only one specific action. If the order is to upload multiple documents, each document upload will become a task request. If the order is to upload a document, but expected from multiple people, then each document upload by each person will become one task. If a summon is issued by using multiple delivery channels, it will be one task per delivery channel. Effectively
1 task = 1 summon = 1 delivery channel + 1 address = 1 channel fees + 1 court fees
/task/v1/create
Create a new task
- tenantId (Tenant ID)
String
- taskType (Type of task)
String
- caseId (Case ID associated with the task)
String
- status (Status of the task)
String
- taskNumber (Task number)
String
- createdDate (Date when the task was created)
Integer (Epoch)
/task/v1/update
Update an existing task
- tenantId (Tenant ID)
String
- taskType (Updated task type)
String
- caseId (Case ID associated with the task)
String
- status (Updated status of the task)
String
- taskNumber (Updated task number)
String
- updatedDate (Date when the task was updated)
Integer (Epoch)
/task/v1/search
Search for tasks based on criteria
- tenantId (Required, tenant ID for filtering)
String
- taskId (Optional, filter by task ID)
String
- caseId (Optional, filter by case ID)
String
- taskType (Optional, filter by task type)
String
- status (Optional, filter by task status)
String
- taskNumber (Optional, filter by task number)
String
- createdDate (Optional, filter by creation date)
Integer (Epoch)
/task/v1/exists
Check if a task exists
- taskId (Required, task ID to check)
String
Last updated