Task - API Specifications

create a new Task

post

Body

orderIdstring · uuid · min: 36 · max: 36optional

ID of the order, this task is associated with

RequestInfoobjectoptional

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

taskobjectoptional

A task is created as part of an Order. It will always be linked to an order

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/task/v1/create' \
  --header 'Content-Type: */*' \
  --data '{
    "orderId": "123e4567-e89b-12d3-a456-426614174000",
    "RequestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text",
      "userInfo": {
        "tenantId": "text",
        "id": 1,
        "uuid": "text",
        "userName": "text",
        "mobileNumber": "text",
        "emailId": "text",
        "roles": [
          {
            "tenantId": "text",
            "id": "text",
            "name": "text",
            "description": "text"
          }
        ],
        "salutation": "text",
        "name": "text",
        "gender": "text",
        "alternateMobileNumber": "text",
        "altContactNumber": "text",
        "pan": "text",
        "aadhaarNumber": "text",
        "permanentAddress": "text",
        "permanentCity": "text",
        "permanentPincode": "text",
        "correspondenceCity": "text",
        "correspondencePincode": "text",
        "correspondenceAddress": "text",
        "active": true,
        "locale": "text",
        "type": "text",
        "accountLocked": true,
        "accountLockedDate": 1,
        "fatherOrHusbandName": "text",
        "relationship": "text",
        "signature": "text",
        "bloodGroup": "text",
        "photo": "text",
        "identificationMark": "text",
        "createdBy": 1,
        "password": "text",
        "otpReference": "text",
        "lastModifiedBy": 1,
        "createdDate": "2025-03-25",
        "lastModifiedDate": "2025-03-25",
        "dob": 1,
        "pwdExpiryDate": 1
      }
    },
    "task": {
      "tenantId": "text",
      "orderId": "123e4567-e89b-12d3-a456-426614174000",
      "taskNumber": "text",
      "filingNumber": "text",
      "cnrNumber": "text",
      "createdDate": 1,
      "dateCloseBy": 1,
      "dateClosed": 1,
      "taskDescription": "text",
      "taskType": "document.submission, summons, bail.cash, bail.surety, warrant, notice",
      "taskDetails": {},
      "amount": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "amount": "text",
        "type": "fees, fine, refund",
        "paymentRefNumber": "text",
        "additionalDetails": {},
        "status": "text"
      },
      "status": "text",
      "assignedTo": {
        "individualId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text"
      },
      "isActive": true,
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ],
      "additionalDetails": {},
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "workflow": {
        "action": "text",
        "comment": "text",
        "assignees": [
          "text"
        ],
        "status": "text",
        "documents": [
          {
            "id": "text",
            "documentType": "text",
            "fileStore": "text",
            "documentUid": "text",
            "additionalDetails": {}
          }
        ]
      },
      "referenceId": "text",
      "state": "text",
      "duedate": 1
    }
  }'

*/*

201

400

201

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "task": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "tenantId": "text",
    "orderId": "123e4567-e89b-12d3-a456-426614174000",
    "taskNumber": "text",
    "filingNumber": "text",
    "cnrNumber": "text",
    "createdDate": 1,
    "dateCloseBy": 1,
    "dateClosed": 1,
    "taskDescription": "text",
    "taskType": "document.submission, summons, bail.cash, bail.surety, warrant, notice",
    "taskDetails": {},
    "amount": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "amount": "text",
      "type": "fees, fine, refund",
      "paymentRefNumber": "text",
      "additionalDetails": {},
      "status": "text"
    },
    "status": "text",
    "assignedTo": {
      "individualId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    },
    "isActive": true,
    "documents": [
      {
        "id": "text",
        "documentType": "text",
        "fileStore": "text",
        "documentUid": "text",
        "additionalDetails": {}
      }
    ],
    "additionalDetails": {},
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    },
    "workflow": {
      "action": "text",
      "comment": "text",
      "assignees": [
        "text"
      ],
      "status": "text",
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ]
    },
    "referenceId": "text",
    "state": "text",
    "duedate": 1
  }
}

ResponseInfo with task created successfully

update a Task

post

Body

orderIdstring · uuid · min: 36 · max: 36optional

ID of the order, this task is associated with

RequestInfoobjectoptional

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

taskobjectoptional

A task is created as part of an Order. It will always be linked to an order

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/task/v1/update' \
  --header 'Content-Type: */*' \
  --data '{
    "orderId": "123e4567-e89b-12d3-a456-426614174000",
    "RequestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text",
      "userInfo": {
        "tenantId": "text",
        "id": 1,
        "uuid": "text",
        "userName": "text",
        "mobileNumber": "text",
        "emailId": "text",
        "roles": [
          {
            "tenantId": "text",
            "id": "text",
            "name": "text",
            "description": "text"
          }
        ],
        "salutation": "text",
        "name": "text",
        "gender": "text",
        "alternateMobileNumber": "text",
        "altContactNumber": "text",
        "pan": "text",
        "aadhaarNumber": "text",
        "permanentAddress": "text",
        "permanentCity": "text",
        "permanentPincode": "text",
        "correspondenceCity": "text",
        "correspondencePincode": "text",
        "correspondenceAddress": "text",
        "active": true,
        "locale": "text",
        "type": "text",
        "accountLocked": true,
        "accountLockedDate": 1,
        "fatherOrHusbandName": "text",
        "relationship": "text",
        "signature": "text",
        "bloodGroup": "text",
        "photo": "text",
        "identificationMark": "text",
        "createdBy": 1,
        "password": "text",
        "otpReference": "text",
        "lastModifiedBy": 1,
        "createdDate": "2025-03-25",
        "lastModifiedDate": "2025-03-25",
        "dob": 1,
        "pwdExpiryDate": 1
      }
    },
    "task": {
      "tenantId": "text",
      "orderId": "123e4567-e89b-12d3-a456-426614174000",
      "taskNumber": "text",
      "filingNumber": "text",
      "cnrNumber": "text",
      "createdDate": 1,
      "dateCloseBy": 1,
      "dateClosed": 1,
      "taskDescription": "text",
      "taskType": "document.submission, summons, bail.cash, bail.surety, warrant, notice",
      "taskDetails": {},
      "amount": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "amount": "text",
        "type": "fees, fine, refund",
        "paymentRefNumber": "text",
        "additionalDetails": {},
        "status": "text"
      },
      "status": "text",
      "assignedTo": {
        "individualId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text"
      },
      "isActive": true,
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ],
      "additionalDetails": {},
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "workflow": {
        "action": "text",
        "comment": "text",
        "assignees": [
          "text"
        ],
        "status": "text",
        "documents": [
          {
            "id": "text",
            "documentType": "text",
            "fileStore": "text",
            "documentUid": "text",
            "additionalDetails": {}
          }
        ]
      },
      "referenceId": "text",
      "state": "text",
      "duedate": 1
    }
  }'

*/*

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "task": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "tenantId": "text",
    "orderId": "123e4567-e89b-12d3-a456-426614174000",
    "taskNumber": "text",
    "filingNumber": "text",
    "cnrNumber": "text",
    "createdDate": 1,
    "dateCloseBy": 1,
    "dateClosed": 1,
    "taskDescription": "text",
    "taskType": "document.submission, summons, bail.cash, bail.surety, warrant, notice",
    "taskDetails": {},
    "amount": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "amount": "text",
      "type": "fees, fine, refund",
      "paymentRefNumber": "text",
      "additionalDetails": {},
      "status": "text"
    },
    "status": "text",
    "assignedTo": {
      "individualId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    },
    "isActive": true,
    "documents": [
      {
        "id": "text",
        "documentType": "text",
        "fileStore": "text",
        "documentUid": "text",
        "additionalDetails": {}
      }
    ],
    "additionalDetails": {},
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    },
    "workflow": {
      "action": "text",
      "comment": "text",
      "assignees": [
        "text"
      ],
      "status": "text",
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ]
    },
    "referenceId": "text",
    "state": "text",
    "duedate": 1
  }
}

ResponseInfo with summons updated successfully

search for task(s)

post

search task(s) based on different parameters

Body

RequestInfoobjectoptional

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

criteriaobjectoptional

can send in any one of the values. If multiple parameters are passed, then it will be a logical AND search, referece and state should pass together

paginationobjectoptional

Pagination details

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/task/v1/search' \
  --header 'Content-Type: */*' \
  --data '{
    "RequestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text",
      "userInfo": {
        "tenantId": "text",
        "id": 1,
        "uuid": "text",
        "userName": "text",
        "mobileNumber": "text",
        "emailId": "text",
        "roles": [
          {
            "tenantId": "text",
            "id": "text",
            "name": "text",
            "description": "text"
          }
        ],
        "salutation": "text",
        "name": "text",
        "gender": "text",
        "alternateMobileNumber": "text",
        "altContactNumber": "text",
        "pan": "text",
        "aadhaarNumber": "text",
        "permanentAddress": "text",
        "permanentCity": "text",
        "permanentPincode": "text",
        "correspondenceCity": "text",
        "correspondencePincode": "text",
        "correspondenceAddress": "text",
        "active": true,
        "locale": "text",
        "type": "text",
        "accountLocked": true,
        "accountLockedDate": 1,
        "fatherOrHusbandName": "text",
        "relationship": "text",
        "signature": "text",
        "bloodGroup": "text",
        "photo": "text",
        "identificationMark": "text",
        "createdBy": 1,
        "password": "text",
        "otpReference": "text",
        "lastModifiedBy": 1,
        "createdDate": "2025-03-25",
        "lastModifiedDate": "2025-03-25",
        "dob": 1,
        "pwdExpiryDate": 1
      }
    },
    "criteria": {
      "cnrNumber": "text",
      "orderId": "123e4567-e89b-12d3-a456-426614174000",
      "tenantId": "text",
      "id": "text",
      "taskNumber": "text",
      "status": "text",
      "name": "text",
      "state": "text",
      "referenceId": "text"
    },
    "pagination": {
      "limit": 1,
      "offSet": 1,
      "sortBy": "text",
      "order": {
        "0": "a",
        "1": "s",
        "2": "c"
      }
    }
  }'

*/*

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "TotalCount": 1,
  "list": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "tenantId": "text",
      "orderId": "123e4567-e89b-12d3-a456-426614174000",
      "taskNumber": "text",
      "filingNumber": "text",
      "cnrNumber": "text",
      "createdDate": 1,
      "dateCloseBy": 1,
      "dateClosed": 1,
      "taskDescription": "text",
      "taskType": "document.submission, summons, bail.cash, bail.surety, warrant, notice",
      "taskDetails": {},
      "amount": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "amount": "text",
        "type": "fees, fine, refund",
        "paymentRefNumber": "text",
        "additionalDetails": {},
        "status": "text"
      },
      "status": "text",
      "assignedTo": {
        "individualId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text"
      },
      "isActive": true,
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ],
      "additionalDetails": {},
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "workflow": {
        "action": "text",
        "comment": "text",
        "assignees": [
          "text"
        ],
        "status": "text",
        "documents": [
          {
            "id": "text",
            "documentType": "text",
            "fileStore": "text",
            "documentUid": "text",
            "additionalDetails": {}
          }
        ]
      },
      "referenceId": "text",
      "state": "text",
      "duedate": 1
    }
  ],
  "pagination": {
    "limit": 1,
    "offSet": 1,
    "totalCount": 1,
    "sortBy": "text",
    "order": {
      "0": "a",
      "1": "s",
      "2": "c"
    }
  }
}

ResponseInfo with list of task(s)

task exits or not

post

Body

RequestInfoobjectoptional

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

taskListobject[]optional

can send in any one of the values and Exists value will be populated with true or false. If multiple paramters are passed, then it will be a logical AND search, referenceid and state should pass together

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/task/v1/exists' \
  --header 'Content-Type: */*' \
  --data '{
    "RequestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text",
      "userInfo": {
        "tenantId": "text",
        "id": 1,
        "uuid": "text",
        "userName": "text",
        "mobileNumber": "text",
        "emailId": "text",
        "roles": [
          {
            "tenantId": "text",
            "id": "text",
            "name": "text",
            "description": "text"
          }
        ],
        "salutation": "text",
        "name": "text",
        "gender": "text",
        "alternateMobileNumber": "text",
        "altContactNumber": "text",
        "pan": "text",
        "aadhaarNumber": "text",
        "permanentAddress": "text",
        "permanentCity": "text",
        "permanentPincode": "text",
        "correspondenceCity": "text",
        "correspondencePincode": "text",
        "correspondenceAddress": "text",
        "active": true,
        "locale": "text",
        "type": "text",
        "accountLocked": true,
        "accountLockedDate": 1,
        "fatherOrHusbandName": "text",
        "relationship": "text",
        "signature": "text",
        "bloodGroup": "text",
        "photo": "text",
        "identificationMark": "text",
        "createdBy": 1,
        "password": "text",
        "otpReference": "text",
        "lastModifiedBy": 1,
        "createdDate": "2025-03-25",
        "lastModifiedDate": "2025-03-25",
        "dob": 1,
        "pwdExpiryDate": 1
      }
    },
    "taskList": [
      {
        "taskId": "123e4567-e89b-12d3-a456-426614174000",
        "filingNumber": "text",
        "cnrNumber": "text",
        "referenceId": "text",
        "state": "text",
        "exists": true
      }
    ]
  }'

*/*

201

400

201

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "taskList": [
    {
      "taskId": "123e4567-e89b-12d3-a456-426614174000",
      "filingNumber": "text",
      "cnrNumber": "text",
      "referenceId": "text",
      "state": "text",
      "exists": true
    }
  ]
}

ResponseInfo with task(s) updated successfully