DRISTI
  • 👋Welcome to DRISTI
    • Why DRISTI?
  • ⚖️About DRISTI
    • Overview
    • Design Principles
    • Value Proposition
    • Architecture Overview
    • System Users
    • Key Modules
      • Async Applications & Submissions
        • Key Features
        • Process & Workflows
        • Specifications
      • Case Management
        • Key Features
        • Process & Workflows
        • Specifications
      • E-Filling, Scrutiny and Admission
        • Key Features
        • Process & Workflows
        • Specifications
        • Sequence Diagrams
      • Evidence
        • Key Features
        • Process & Workflows
        • Specifications
      • Listing & Scheduling
        • Key Features
        • Process & Workflows
        • Specifications
      • Hearings
        • Key Features
        • Process & Workflows
        • Specifications
      • Orders & Tasks
        • Key Features
        • Process & Workflows
        • Specifications
      • Summons, Bails, Warrants
        • Key Features
        • Process & Workflows
        • Specifications
      • User Benefits
      • User Registration
        • Key Features
        • Process & Workflows
        • Specifications
        • Sequence Diagrams
      • Roles per Module
    • API Specifications
    • Security
    • Privacy
  • 🧰DRISTI Platform
    • Architecture
      • Overview
      • Principles
      • High Level Design
        • Technology Stack
        • Access Control & Roles
        • Data & Analytics
        • Non Functional Requirements
          • Performance
          • Security
          • Data Retention
        • Logging Guidelines
      • Low Level Design
        • Advocate
          • Advocate - API Specifications
          • Sequence Diagram
        • Application
          • Application - API Specifications
          • Sequence Diagram
        • Case
          • Case - API Specifications
          • Sequence Diagram
        • Case Management
          • Case Management - API Specifications
          • Sequence Diagram
        • Evidence
          • Evidence - API Specifications
          • Sequence Diagram
        • Hearing
          • Hearing - API Specifications
          • Sequence Diagram
        • Order
          • Order - API Specifications
          • Sequence Diagram
        • Task
          • Task - API Specifications
          • Sequence Diagram
          • Summons
          • Warrant
      • Architectural and Design Decisions
        • Data Visibility
        • Detailed Case Access
        • Case Numbering
          • Filing Number
          • Court Case Number
          • CNR Number
          • Case Stages, Numbers & Dates
    • Interoperability
    • Release Notes
      • Release 1.1.0
      • Release 1.2.0
      • Release 1.3.0
      • Release 1.4.0
      • Release 1.5.0
      • Release 1.6.0
    • Hotfixes
      • Hotfix Release 17.3
      • Hotfix Release 18.1
      • Hotfix Release 18.2
      • Hotfix Release 18.3
      • Hotfix Release 18.4
      • Hotfix Release 19.1
  • 🪝Setup
    • Planning DRISTI Implementation
    • Establish Project & Team
    • Gather Requirements
    • Installation
      • Infrastructure Setup
        • Azure Setup
        • SDC - OpenShift Setup
      • Code Deployment
      • Configuration
        • Functional Configuration
        • Service Configuration
          • Court
            • Court UI
          • Case
            • Case UI
          • Advocate
            • Advocate UI
          • Application
            • Application UI
          • Task
            • Task UI
          • Order
            • Order UI
          • Hearing
            • Hearing UI
          • Evidence
            • Evidence UI
    • Quality Assurance Testing
    • Go Live
    • Operational Support
    • Monitoring
  • 🛣️Roadmap & Updates
    • Roadmap
  • 🌾Resources
    • Source Code
    • Technology Stack
    • Licensing
    • Legal Taxonomy
  • 🌐COMMUNITY
    • Interested in Contributing?
    • Github Discussion
    • Code of Conduct
  • 🪝Setup
    • Coming soon...
    • 🟢ABOUT US
Powered by GitBook
On this page
  • Overview
  • API Details
  • Workflow Details
  • Kafka Topics
  • DB Schema
  1. DRISTI Platform
  2. Architecture
  3. Low Level Design

Advocate

PreviousLow Level DesignNextAdvocate - API Specifications

Last updated 3 months ago

Overview

The advocate and advocate-clerk service allows for the creation, updating and search of advocates and clerks in DRISTI. The APIs are designed to create a single source of truth for advocate-related data, ensuring that each advocate and their clerks are uniquely identified and consistently represented across various systems.

This registry and service plays a pivotal role in establishing a unified and authoritative source of data for advocates and their clerks. By assigning unique identifiers to each advocate and their clerks, the API ensures that every individual is distinctly recognised. With unique identifiers, all interactions involving an advocate, whether in court proceedings, document submissions, or case management, are accurately linked to their profile. This eliminates discrepancies that might arise from duplicate or mismatched records.

The Advocate and Clerk APIs are designed with interoperability in mind, allowing seamless integration with other systems within the judicial ecosystem. This integration capability is crucial for creating a cohesive digital environment where data can flow smoothly between different platforms.

Here’s how other systems can benefit:

  • Access to Up-to-Date Advocate Information: Systems that integrate with the Advocate API can access real-time, accurate data on advocates and their clerks. Whether it's a case management system, an e-filing platform, or a court scheduling tool, these systems can retrieve the latest information without the need for manual updates or separate databases.

  • Streamlined Workflows: By integrating with the Advocate API, other systems can automate various processes involving advocates, such as case assignments, document sharing, and notifications. This reduces administrative overhead and speeds up judicial workflows, benefiting both legal professionals and the courts.

  • Cross-System Data Synchronisation: The API ensures that all connected systems are synchronised, meaning that any changes made in one system (e.g., updating an advocate’s contact details) are automatically propagated to all other integrated systems. This harmonization minimizes the risk of errors and ensures that all stakeholders are working with the most current information.

API Details

  • Registration (/advocate/v1/_create): Registers a new advocate or clerk, requiring details like ID, tenant ID, and bar registration number.

  • Update (/advocate/v1/_update): Updates the advocate's information, requiring similar details as the create operation.

  • Status Search (/advocate/v1/_status/_search): Searches for the status of advocate registrations, optionally filtering by status or application number.

  • Application Search (/advocate/v1/applicationnumber/_search): Searches for an advocate by application number.

  • General Search (/advocate/v1/_search): Allows for a broader search of advocates, optionally filtering by bar registration number and status.

  • Similar actions can be carried out for the clerks through the following methods:

    • /clerk/v1/_create: Register a new advocate clerk

    • /clerk/v1/_update: Update Advocate clerk information

    • /clerk/v1/status/_search: Search for advocate clerks using the status of their registration

    • /clerk/v1/applicationnumber/_search: Search for clerks using the Application Number of their registration

    • /clerk/v1/_search: Search for registered advocate clerk

Workflow Details

Advocate

Business (Module)=user-registration

Business Service (Workflow) Name=user-registration-advocate

Advocate Clerk

Business (Module)=user-registration

Business Service (Workflow) Name=user-registration-advocate-clerk

Kafka Topics

Below are the Kafka topics to which this service publishes data:

Topic
Description
Payload

save-advocate-application

When a new advocate is registered in the system

Advocate create payload. Refer to API spec.

update-advocate-application

When advocate info or workflow status is updated in the system

Advocate update payload. Refer to API spec

save-advocate-clerk

When a new advocate clerk is registered in the system

AdvocateClerk create payload. Refer to API spec

update-advocate-clerk-application

When clerk data or workflow state is changed.

AdvocateClerk update payload. Refer to API spec.

DB Schema

For more functional/process details on the workflows, please refer to . Two separate workflows have been defined for the advocate and advocate clerk.

View the actual .

🧰
Advocate - API Specifications
this section
workflow JSON here