Hearing - API Specifications
Last updated
Last updated
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.
a case can have multiple hearings. this represents one of the many hearings related to the case
curl -L \
--request POST \
--url '/hearing/v1/create' \
--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
}
},
"hearing": {
"tenantId": "text",
"hearingId": "text",
"filingNumber": [
"text"
],
"cnrNumbers": [
"text"
],
"applicationNumbers": [
"text"
],
"hearingType": "admission, trail, judgment, evidence, plea",
"status": "scheduled, in progress, in transcription, closed, adjourned",
"adjournmentReason": "text",
"startTime": 1,
"endTime": 1,
"presidedBy": {
"benchID": "text",
"judgeID": [
"123e4567-e89b-12d3-a456-426614174000"
],
"courtID": "text"
},
"attendees": [
{
"name": "text",
"individualId": "text",
"type": "complainant, respondent, lawyer, witness",
"associatedWith": "text",
"wasPresent": true,
"isOnline": true
}
],
"transcript": [
"text"
],
"vcLink": "text",
"isActive": true,
"documents": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
],
"additionalDetails": "text",
"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": {}
}
]
},
"notes": "text"
}
}'
{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"hearing": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"tenantId": "text",
"hearingId": "text",
"filingNumber": [
"text"
],
"cnrNumbers": [
"text"
],
"applicationNumbers": [
"text"
],
"hearingType": "admission, trail, judgment, evidence, plea",
"status": "scheduled, in progress, in transcription, closed, adjourned",
"adjournmentReason": "text",
"startTime": 1,
"endTime": 1,
"presidedBy": {
"benchID": "text",
"judgeID": [
"123e4567-e89b-12d3-a456-426614174000"
],
"courtID": "text"
},
"attendees": [
{
"name": "text",
"individualId": "text",
"type": "complainant, respondent, lawyer, witness",
"associatedWith": "text",
"wasPresent": true,
"isOnline": true
}
],
"transcript": [
"text"
],
"vcLink": "text",
"isActive": true,
"documents": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
],
"additionalDetails": "text",
"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": {}
}
]
},
"notes": "text"
}
}
success
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.
a case can have multiple hearings. this represents one of the many hearings related to the case
curl -L \
--request POST \
--url '/hearing/v1/update' \
--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
}
},
"hearing": {
"tenantId": "text",
"hearingId": "text",
"filingNumber": [
"text"
],
"cnrNumbers": [
"text"
],
"applicationNumbers": [
"text"
],
"hearingType": "admission, trail, judgment, evidence, plea",
"status": "scheduled, in progress, in transcription, closed, adjourned",
"adjournmentReason": "text",
"startTime": 1,
"endTime": 1,
"presidedBy": {
"benchID": "text",
"judgeID": [
"123e4567-e89b-12d3-a456-426614174000"
],
"courtID": "text"
},
"attendees": [
{
"name": "text",
"individualId": "text",
"type": "complainant, respondent, lawyer, witness",
"associatedWith": "text",
"wasPresent": true,
"isOnline": true
}
],
"transcript": [
"text"
],
"vcLink": "text",
"isActive": true,
"documents": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
],
"additionalDetails": "text",
"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": {}
}
]
},
"notes": "text"
}
}'
{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"hearing": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"tenantId": "text",
"hearingId": "text",
"filingNumber": [
"text"
],
"cnrNumbers": [
"text"
],
"applicationNumbers": [
"text"
],
"hearingType": "admission, trail, judgment, evidence, plea",
"status": "scheduled, in progress, in transcription, closed, adjourned",
"adjournmentReason": "text",
"startTime": 1,
"endTime": 1,
"presidedBy": {
"benchID": "text",
"judgeID": [
"123e4567-e89b-12d3-a456-426614174000"
],
"courtID": "text"
},
"attendees": [
{
"name": "text",
"individualId": "text",
"type": "complainant, respondent, lawyer, witness",
"associatedWith": "text",
"wasPresent": true,
"isOnline": true
}
],
"transcript": [
"text"
],
"vcLink": "text",
"isActive": true,
"documents": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
],
"additionalDetails": "text",
"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": {}
}
]
},
"notes": "text"
}
}
ResponseInfo with hearing(s) updated successfully
Gets the list of hearing requests for a particular ULB based on search criteria.
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.
can send in any one of the values. If multiple parameters are passed, then it will be a logical AND search
Pagination details
curl -L \
--request POST \
--url '/hearing/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": {
"filingNumber": "text",
"cnrNumber": "text",
"applicationNumber": "text",
"hearingType": "text",
"hearingId": "text",
"tenantId": "text",
"attendeeIndividualId": "text",
"courtId": "text",
"fromDate": 1,
"toDate": 1
},
"pagination": {
"limit": 1,
"offSet": 1,
"sortBy": "text",
"order": {
"0": "a",
"1": "s",
"2": "c"
}
}
}'
{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"TotalCount": 1,
"HearingList": [
null
]
}
ResponseInfo with hearing(s) search successfully
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.
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
curl -L \
--request POST \
--url '/hearing/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
}
},
"hearingList": [
{
"hearingId": "text",
"filingNumber": "text",
"cnrNumber": "text",
"applicationNumber": "text",
"exists": true
}
]
}'
{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"hearingList": [
{
"hearingId": "text",
"filingNumber": "text",
"cnrNumber": "text",
"applicationNumber": "text",
"exists": true
}
]
}
ResponseInfo with Hearing(s) updated successfully
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.
a case can have multiple hearings. this represents one of the many hearings related to the case
curl -L \
--request POST \
--url '/hearing/v1/updateTranscript' \
--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
}
},
"hearing": {
"tenantId": "text",
"hearingId": "text",
"filingNumber": [
"text"
],
"cnrNumbers": [
"text"
],
"applicationNumbers": [
"text"
],
"hearingType": "admission, trail, judgment, evidence, plea",
"status": "scheduled, in progress, in transcription, closed, adjourned",
"adjournmentReason": "text",
"startTime": 1,
"endTime": 1,
"presidedBy": {
"benchID": "text",
"judgeID": [
"123e4567-e89b-12d3-a456-426614174000"
],
"courtID": "text"
},
"attendees": [
{
"name": "text",
"individualId": "text",
"type": "complainant, respondent, lawyer, witness",
"associatedWith": "text",
"wasPresent": true,
"isOnline": true
}
],
"transcript": [
"text"
],
"vcLink": "text",
"isActive": true,
"documents": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
],
"additionalDetails": "text",
"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": {}
}
]
},
"notes": "text"
}
}'
{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"hearing": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"tenantId": "text",
"hearingId": "text",
"filingNumber": [
"text"
],
"cnrNumbers": [
"text"
],
"applicationNumbers": [
"text"
],
"hearingType": "admission, trail, judgment, evidence, plea",
"status": "scheduled, in progress, in transcription, closed, adjourned",
"adjournmentReason": "text",
"startTime": 1,
"endTime": 1,
"presidedBy": {
"benchID": "text",
"judgeID": [
"123e4567-e89b-12d3-a456-426614174000"
],
"courtID": "text"
},
"attendees": [
{
"name": "text",
"individualId": "text",
"type": "complainant, respondent, lawyer, witness",
"associatedWith": "text",
"wasPresent": true,
"isOnline": true
}
],
"transcript": [
"text"
],
"vcLink": "text",
"isActive": true,
"documents": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
],
"additionalDetails": "text",
"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": {}
}
]
},
"notes": "text"
}
}
ResponseInfo with hearing(s) updated successfully
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.
a case can have multiple hearings. this represents one of the many hearings related to the case
curl -L \
--request POST \
--url '/hearing/v1/update/time' \
--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
}
},
"hearings": [
null
]
}'
{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"hearings": [
null
]
}
ResponseInfo with hearing(s) time updated successfully