Hearing - API Specifications

create hearing requests.

post
Body

This object holds information about the hearing request

Responses
201

success

*/*
post
/hearing/v1/create
POST /hearing/v1/create HTTP/1.1
Host: 
Content-Type: */*
Accept: */*
Content-Length: 2091

{
  "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-11-08",
      "lastModifiedDate": "2025-11-08",
      "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"
  }
}

update hearing requests.

post
Body

This object holds information about the hearing request

Responses
200

ResponseInfo with hearing(s) updated successfully

*/*
post
/hearing/v1/update
POST /hearing/v1/update HTTP/1.1
Host: 
Content-Type: */*
Accept: */*
Content-Length: 2091

{
  "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-11-08",
      "lastModifiedDate": "2025-11-08",
      "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"
  }
}

Get hearing requests

post

Gets the list of hearing requests for a particular ULB based on search criteria.

Body
Responses
200

ResponseInfo with hearing(s) search successfully

*/*
post
/hearing/v1/search
POST /hearing/v1/search HTTP/1.1
Host: 
Content-Type: */*
Accept: */*
Content-Length: 1295

{
  "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-11-08",
      "lastModifiedDate": "2025-11-08",
      "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": 10,
    "offSet": 0,
    "sortBy": "text",
    "order": {}
  }
}
{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "TotalCount": 1,
  "HearingList": [
    null
  ]
}

Hearing exits or not

post
Body
Responses
201

ResponseInfo with Hearing(s) updated successfully

*/*
post
/hearing/v1/exists
POST /hearing/v1/exists HTTP/1.1
Host: 
Content-Type: */*
Accept: */*
Content-Length: 1140

{
  "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-11-08",
      "lastModifiedDate": "2025-11-08",
      "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
    }
  ]
}

update hearing transcript requests.

post
Body

This object holds information about the hearing request

Responses
200

ResponseInfo with hearing(s) updated successfully

*/*
post
/hearing/v1/updateTranscript
POST /hearing/v1/updateTranscript HTTP/1.1
Host: 
Content-Type: */*
Accept: */*
Content-Length: 2091

{
  "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-11-08",
      "lastModifiedDate": "2025-11-08",
      "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"
  }
}

update hearing start and end time.

post
Body
Responses
200

ResponseInfo with hearing(s) time updated successfully

*/*
post
/hearing/v1/update/time
POST /hearing/v1/update/time HTTP/1.1
Host: 
Content-Type: */*
Accept: */*
Content-Length: 1039

{
  "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-11-08",
      "lastModifiedDate": "2025-11-08",
      "dob": 1,
      "pwdExpiryDate": 1
    }
  },
  "hearings": [
    null
  ]
}
{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "hearings": [
    null
  ]
}

PreviousHearingNextSequence Diagram

Last updated