DIGIT Core
PlatformDomainsAcademyDesign SystemFeedback
2.8
2.8
  • ☑️Introducing DIGIT Platform
    • DIGIT - Value Proposition
  • Platform
    • 🔎Overview
      • Principles
      • Architecture
        • Service Architecture
        • Infrastructure Architecture
        • Deployment Architecture
      • Technology
        • API Gateway
        • Open Source Tools
      • Checklists
        • API Checklist
        • Security Checklist
          • Security Guidelines Handbook
          • Security Flow - Exemplar
        • Performance Checklist
        • Deployment Checklist
      • UI Frameworks
        • React UI Framework
    • 🔧Core Services
      • Workflow Service
        • Setting Up Workflows
        • Configuring Workflows For An Entity
        • Workflow Auto Escalation
        • Migration To Workflow 2.0
      • Location Services
      • User Services
      • Access Control Services
      • PDF Generation Service
      • MDMS (Master Data Management Service)
        • Setting up Master Data
          • MDMS Overview
          • MDMS Rewritten
          • Configuring Tenants
          • Configuring Master Data
          • Adding New Master
          • State Level Vs City Level Master
      • Payment Gateway Service
      • User Session Management
      • Indexer Service
        • Indexer Configuration
      • URL Shortening Service
      • XState Core Chatbot
        • Xstate-Chatbot Message Localisation
        • XState-Chatbot Integration Document
      • NLP Engine Service
        • NLP Chatbot
      • SMS Template Approval Process
      • Telemetry Service
      • Document Uploader Service
      • Notification Enhancement Based On Different Channel
      • Report Service
        • Configuring New Reports
          • Impact Of Heavy Reports On Platform
          • Types Of Reports Used In Report Service
      • SMS Notification Service
        • Setting Up SMS Gateway
          • Using The Generic GET & POST SMS Gateway Interface
      • Survey Service
      • Persister Service
        • Persister Configuration
      • Encryption Service
        • Encryption Client Library
        • User Data Security Architecture
        • Guidelines for supporting User Privacy in a module
      • FileStore Service
      • ID Generation Service
      • Localization Service
        • Configuring Localization
          • Setup Base Product Localization
          • Configure SMS and Email
      • Email Notification Service
      • Searcher Service
      • Zuul Service
      • User OTP Service
      • OTP Service
      • Chatbot Service
      • National Dashboard Ingest
        • National Dashboard API Performance Testing Specs and Benchmark
        • National Dashboard: Steps for Index Creation
        • National Dashboard Adaptor Service
          • Deployment of Airflow DAG
          • Trigger Airflow DAG
          • Configure Airflow
          • Insert & Delete Data - Steps
          • Important Links & Credentials
          • Code Structure
          • KT Sessions
          • Pre-requisites For Enabling Adaptor
        • Revenue Maximisation
      • Audit Service
        • Signed Audit Performance Testing Results
      • Service Request
      • Self Contained Service Architecture (HLD)
      • Accelerators
        • Inbox Service
    • ✏️API Specifications
      • User
      • Access Control
      • Employee
      • Location
      • Localisation
      • Encryption
      • Indexer
      • File Store
      • Collection
      • DSS Ingest
      • HRMS
      • National Dashboard Ingest
      • WhatsApp Chatbot
      • Master Data Management
      • ID Generation
      • URL Shortner
      • Workflow Service
      • Workflow v2
      • Document Uploader Service
      • OTP Service
      • Reporting Service
      • PDF Generation Service
      • Payment Gateway Service
    • 🔐Data Protection & Privacy
      • Data Protection & Privacy Definitions
      • Legal Obligations For Privacy - eGov
      • Data Protection & Privacy - Global Best Practices
      • Guidelines
        • Platform Owner Guidelines
        • Implementing Agencies Guidelines
        • Admin Guidelines
        • Program Owner Guidelines
        • Data Security and Data Privacy
      • Data Privacy Policy Templates
        • eGov Data Privacy Policy
        • Implementing Agency Privacy Policy
        • Admin & Program Owner Privacy Policy
        • Supporting Agency Privacy Policy
      • Global Standards For All Roles
    • ▶️Get Started
      • Install DIGIT
      • Access DIGIT
      • Sandbox
      • Training and Certification
        • Training Resources
    • ⚒️Integrations
      • Payment
      • Notification
      • Transaction
      • Verification
      • View
      • Calculation
    • 🛣️Roadmap
    • 🎬Open Events
    • 👩‍💻Source Code
    • 👁️Project Plan
    • 📋Discussion Board
    • 🤝Contribute
  • Guides
    • 📓Installation Guide
      • DIGIT Deployment
      • Quick Setup
        • DIGIT Installation on Azure
        • DIGIT Installation on AWS
      • Production Setup
        • AWS
          • 1. Pre-requisites
          • 2. Understanding EKS
          • 3. Setup AWS Account
          • 4. Provisioning Infra Using Terraform
          • 5. Prepare Deployment Config
          • 6. Deploy DIGIT
          • 7. Bootstrap DIGIT
          • 8. Productionize DIGIT
          • FAQ
        • Azure
          • 1. Azure Pre-requisites
          • 2. Understanding AKS
          • 3. Infra-as-code (Terraform)
        • SDC
          • 1. SDC Pre-requisites
          • 2. Infra-as-code (Kubespray)
          • CI/CD Setup On SDC
        • CI/CD Set Up
          • CI/CD Build Job Pipeline Setup
        • Prepare Helm Release Chart
        • Deployment - Key Concepts
          • Security Practices
          • Readiness & Liveness
          • Resource Requests & Limits
          • Deploying DIGIT Services
          • Deployment Architecture
          • Routing Traffic
          • Backbone Deployment
    • 💽Data Setup Guide
      • User Module
      • Localisation Module
      • Location Module
    • 🚥Design Guide
      • Model Requirements
      • Design Services
      • Design User Interface
      • Checklists
    • ⚒️Developer Guide
      • Pre-requisites Training Resources
      • Backend Developer Guide
        • Section 0: Prep
          • Development Pre-requisites
          • Design Inputs
            • High Level Design
            • Low Level Design
          • Development Environment Setup
        • Section 1: Create Project
          • Generate Project Using API Specs
          • Create Database
          • Configure Application Properties
          • Import Core Models
          • Implement Repository Layer
          • Create Validation & Enrichment Layers
          • Implement Service Layer
          • Build The Web Layer
        • Section 2: Integrate Persister & Kafka
          • Add Kafka Configuration
          • Implement Kafka Producer & Consumer
          • Add Persister Configuration
          • Enable Signed Audit
          • Run Application
        • Section 3: Integrate Microservices
          • Integrate IDGen Service
          • Integrate User Service
          • Add MDMS Configuration
          • Integrate MDMS Service
          • Add Workflow Configuration
          • Integrate Workflow Service
          • Integrate URL Shortener Service
        • Section 4: Integrate Billing & Payment
          • Custom Calculator Service
          • Integrate Calculator Service
          • Payment Back Update
        • Section 5: Other Advanced Integrations
          • Add Indexer Configuration
          • Certificate Generation
        • Section 6: Run Final Application
        • Section 7: Build & Deploy Instructions
        • FAQs
      • Flutter UI Developer Guide
        • Introduction to Flutter
          • Flutter - Key Features
          • Flutter Architecture & Approach
          • Flutter Pre-Requisites
        • Setup Development Environment
          • Flutter Installation & Setup Guide
          • Setup Device Emulators/Simulators
          • Run Application
        • Build User Interfaces
          • Create Form Screen
        • Build Deploy & Publish
          • Build & Deploy Flutter Web Application
          • Generate Android APKs & App Bundles
          • Publishing App Bundle To Play Store
        • State Management With Provider & Bloc
          • Provider State Management
          • BloC State Management
        • Best Practices & Tips
        • Troubleshooting
      • UI Developer Guide
        • DIGIT-UI
        • Android Web View & How To Generate APK
        • DIGIT UI Development Pre-requisites
        • UI Configuration (DevOps)
        • Local Development Setup
        • Run Application
        • Create New Screen In DIGIT-UI
          • Create Screen (FormComposer)
          • Inbox/Search Screen
          • Workflow Component
        • Customisation
          • Integrate External Web Application/UI With DIGIT UI
          • Utility - Pre-Process MDMS Configuration
          • CSS Customisation
        • Citizen Module Setup
          • Sample screenshots
          • Project Structure
          • Install Dependency
          • Import Required Components
          • Write Citizen Module Code
          • Citizen Landing Screen
        • Employee Module Setup
          • Write Employee Module Code
        • Build & Deploy
        • Setup Monitoring Tools
        • FAQs
          • Troubleshoot Using Browser Network Tab
          • Debug Android App Using Chrome Browser
    • 🔄Operations Guide
      • DIGIT - Infra Overview
      • Setup Central Instance Infra
      • Central Monitoring Dashboard Setup
      • Kubernetes
        • RBAC Management
        • DB Dump - Playground
      • Setup Jenkins - Docker way
      • GitOps
        • Git Client installation
        • GitHub organization creation
        • Adding new SSH key to it
        • GitHub repo creation
        • GitHub Team creation
        • Enabling Branch protection:
        • CODEOWNER Reviewers
        • Adding Users to the Git
        • Setting up an OAuth with GitHub
        • Fork (Fork the mdms,config repo with a tenant-specific branch)
      • Working with Kubernetes
        • Installation of Kubectl
      • Containerizing application using Docker
        • Creation of Dockerhub account
      • Infra provisioning using Terraform
        • Installation of Terraform
      • Customization of existing tf templates
      • Cert-Manager
        • Obtaining SSL certificates with the help of cluster-issuer
      • Moving Docker Images
      • Pre and post deployment checklist
      • Multi-tenancy Setup
      • Availability
        • Infrastructure
        • Backbone services
          • Database
          • Kafka
          • Kafka Connect
          • Elastic search
            • ElasticSearch Direct Upgrade
            • Elastic Search Rolling Upgrade
        • Core services
        • DIGIT apps
        • DSS dashboard
      • Observability
        • ES-Curator to clear old logs/indices
        • Monitoring
        • Tracing
        • Jaeger Tracing Setup
        • Logging
        • eGov Monitoring & Alerting Setup
        • eGov Logging Setup
      • Performance
        • What to monitor?
          • Infrastructure
          • Backbone services
          • Core services
        • Identifying bottlenecks
        • Solutions
      • Handling errors
      • Security
      • Reliability and disaster recovery
      • Privacy
      • Skillsets/hiring
      • Incident management processes
      • Kafka Troubleshooting Guide
        • How to clean up Kafka logs
        • How to change or reset consumer offset in Kafka?
      • SRE Rituals
      • FAQs
        • I am unable to login to the citizen or employee portal. The UI shows a spinner.
        • My DSS dashboard is not reflecting accurate numbers? What can I do?
      • Deployment using helm
        • Helm installation:
        • Helm chart creation
        • Helm chart customization
      • How to Dump Elasticsearch Indexes
      • Deploy Nginx-Ingress-Controller
      • Deployment Job Pipeline Setup
      • OAuth2-Proxy Setup
      • Jira Ticket Creation
  • Reference
    • 👉Setup Basics
      • Setup Requirements
        • Tech Enablement Training - Essential Skills and Pre-requisites
        • Tech Enablement Training (eDCR) - Essential Skills and Prerequisites
          • Development Control Rules (Digit-DCR)
          • eDCR Approach Guide
        • DIGIT Rollout Program Governance
        • DevOps Skills Requirements
        • Infra Requirements
        • Team Composition for DIGIT Implementation
        • Infra Best Practices
        • Operational Best Practices
        • Why Kubernetes For DIGIT
      • Supported Clouds
        • Google Cloud
        • Azure
        • AWS
        • VSphere
        • SDC
      • Deployment - Key Concepts
        • Security Practices
        • CI/CD
        • Readiness & Liveness
        • Resource Requests & Limits
      • Understanding ERP Stack
        • ERP Monolithic Architecture
        • ERP Hybrid Architecture
        • ERP Coexistence Architecture
        • APMDP-HYBRID-INFRA ARCHITECTURE
        • eGov SmartCity eGovernance Suite
        • ERP Deployment Process
        • ERP Release Process
        • ERP User Guide
      • Deploying DIGIT Services
        • Deployment Architecture
        • Routing Traffic
        • Backbone Deployment
      • Troubleshooting
        • Distributed Tracing
        • Logging
        • Monitoring & Alerts
    • 📥Reference Reads
      • Analytics
      • DevSecOps
      • Low Code No Code
        • Application Specification
      • Beneficiary Eligibility
      • Government and Open Digital Platforms
      • Microservices and Low Code No Code
      • Registries
      • Platform Orientation - Overview
    • 🔏Data Security
      • Signed Data Audit
      • Encryption Techniques
      • Approaches to handle Encrypted Data
    • ❕Privacy
    • 🕹️DevOps
      • 1. How DNS works
      • 2. Load Balancer
      • 3. SSL/Cert-manager
      • 4.Ingress,WAF
      • 5.VPC
      • 6.Subnets
      • 7.EKS
      • 8.Worker Node Group
      • 9.RDS
      • 10.NAT
      • 11.Internet Gateway
      • 12.Block Storage (EBS Volumes)
      • 13.Object Storage (S3)
      • 14. Telemetry
Powered by GitBook

All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.

On this page

Was this helpful?

  1. Platform
  2. API Specifications

HRMS

PreviousDSS IngestNextNational Dashboard Ingest

Last updated 1 year ago

Was this helpful?

✏️

Get the list of count of active and inactive employee.

post

Get the list of count of active and inactive employee for given tenant Id.

Query parameters
tenantIdanyRequired

Unique id for a tenant.

Responses
200
Successful response, present the list of count of active and inactive employee for given tenant Id.
application/json
400
Invalid input.
application/json
post
POST /rainmaker-hrms/[API endpoint]/employees/_count?tenantId=null HTTP/1.1
Host: 
Accept: */*
{
  "responseInfo": {
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "COMPLETED",
    "signature": "text",
    "error": {
      "code": "text",
      "message": "text",
      "description": "text",
      "params": [
        "text"
      ]
    },
    "information": {},
    "debug": {},
    "additionalInfo": {}
  },
  "EmployeeCount": {
    "activeEmployee": "text",
    "inactiveEmployee": "text",
    "totalEmployee": "text"
  }
}
  • POSTGet the list of employees defined in the system.
  • POSTCreate a new employee in the system along with all the related informations like - assignment, jurisdiction, service, education and probation
  • POSTUpdate Employee data for a particular employee
  • POSTGet the list of count of active and inactive employee.

Create a new employee in the system along with all the related informations like - assignment, jurisdiction, service, education and probation

post

To create a new employee we can use POST and set all the required and non-mandatory parameters. When an employee is created, an user is also created along with it. Type value in object will be "EMPLOYEE".

Body
Responses
202
Employee request accepted for creation.
application/json
400
Invalid Input.
application/json
post
POST /rainmaker-hrms/[API endpoint]/employees/_create HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 3177

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "Employee": [
    {
      "user": {
        "id": 1,
        "userName": "text",
        "password": "password",
        "salutation": "text",
        "name": "text",
        "gender": [
          "MALE"
        ],
        "mobileNumber": "text",
        "emailId": "text",
        "altContactNumber": "text",
        "pan": "text",
        "aadhaarNumber": "text",
        "permanentAddress": "text",
        "permanentCity": "text",
        "permanentPincode": "text",
        "correspondenceCity": "text",
        "correspondencePincode": "text",
        "correspondenceAddress": "text",
        "active": true,
        "dob": "2025-05-15",
        "locale": "text",
        "type": [
          "EMPLOYEE"
        ],
        "signature": "text",
        "accountLocked": true,
        "roles": [
          {
            "id": 1,
            "name": "text",
            "code": "text",
            "description": "text",
            "createdBy": 1,
            "createdDate": "2025-05-15",
            "lastModifiedBy": 1,
            "lastModifiedDate": "2025-05-15",
            "tenantId": "text"
          }
        ],
        "fatherOrHusbandName": "text",
        "bloodGroup": [
          "A+"
        ],
        "identificationMark": "text",
        "photo": "text",
        "createdBy": 1,
        "createdDate": "2025-05-15",
        "lastModifiedBy": 1,
        "lastModifiedDate": "2025-05-15",
        "otpReference": "text",
        "tenantId": "text"
      },
      "id": 1,
      "uuid": "text",
      "code": "text",
      "employeeStatus": "text",
      "employeeType": "text",
      "dateOfAppointment": 1,
      "jurisdictions": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "hierarchy": "text",
          "boundary": "text",
          "boundaryType": "text",
          "auditDetails": {
            "createdBy": "text",
            "createdDate": 1,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1
          }
        }
      ],
      "assignments": [
        {
          "id": "text",
          "position": 1,
          "designation": "text",
          "department": "text",
          "fromDate": 1,
          "toDate": 1,
          "govtOrderNumber": "text",
          "reportingTo": "text",
          "isHOD": true,
          "isCurrentAssignment": true,
          "auditDetails": {
            "createdBy": "text",
            "createdDate": 1,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1
          }
        }
      ],
      "serviceHistory": [
        {
          "id": "text",
          "serviceStatus": "text",
          "serviceFrom": 1,
          "serviceTo": 1,
          "location": "text",
          "orderNo": "text",
          "isCurrentPosition": true,
          "auditDetails": {
            "createdBy": "text",
            "createdDate": 1,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1
          }
        }
      ],
      "isActive": true,
      "education": [
        {
          "id": "text",
          "qualification": "text",
          "stream": "text",
          "yearOfPassing": 1,
          "university": "text",
          "remarks": "text",
          "auditDetails": {
            "createdBy": "text",
            "createdDate": 1,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1
          }
        }
      ],
      "tests": [
        {
          "id": "text",
          "test": "text",
          "yearOfPassing": 1,
          "remarks": "text",
          "auditDetails": {
            "createdBy": "text",
            "createdDate": 1,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1
          }
        }
      ],
      "tenantId": "text",
      "deactivationDetails": [
        {
          "id": "text",
          "employeeId": "text",
          "reasonForDeactivation": "text",
          "effectiveFrom": 1,
          "orderNo": "text",
          "typeOfDeactivation": [
            "SUSPENSION"
          ],
          "auditDetails": {
            "createdBy": "text",
            "createdDate": 1,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1
          }
        }
      ],
      "reactivationDetails": [
        {
          "id": "text",
          "employeeId": "text",
          "reasonForReactivation": "text",
          "effectiveFrom": 1,
          "orderNo": "text",
          "typeOfReactivation": [
            "ORDER FROM COMISSIONER"
          ],
          "auditDetails": {
            "createdBy": "text",
            "createdDate": 1,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1
          }
        }
      ],
      "documents": [
        {
          "id": 1,
          "employeeId": 1,
          "documentId": "text",
          "documentName": "text",
          "referenceType": [
            "HEADER"
          ],
          "referenceId": "text",
          "auditDetails": {
            "createdBy": "text",
            "createdDate": 1,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1
          }
        }
      ],
      "auditDetails": {
        "createdBy": "text",
        "createdDate": 1,
        "lastModifiedBy": "text",
        "lastModifiedDate": 1
      }
    }
  ]
}
{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Employee": [
    {
      "user": {
        "id": 1,
        "userName": "text",
        "password": "password",
        "salutation": "text",
        "name": "text",
        "gender": [
          "MALE"
        ],
        "mobileNumber": "text",
        "emailId": "text",
        "altContactNumber": "text",
        "pan": "text",
        "aadhaarNumber": "text",
        "permanentAddress": "text",
        "permanentCity": "text",
        "permanentPincode": "text",
        "correspondenceCity": "text",
        "correspondencePincode": "text",
        "correspondenceAddress": "text",
        "active": true,
        "dob": "2025-05-15",
        "pwdExpiryDate": "2025-05-15",
        "locale": "text",
        "type": [
          "EMPLOYEE"
        ],
        "signature": "text",
        "accountLocked": true,
        "roles": [
          {
            "id": 1,
            "name": "text",
            "code": "text",
            "description": "text",
            "createdBy": 1,
            "createdDate": "2025-05-15",
            "lastModifiedBy": 1,
            "lastModifiedDate": "2025-05-15",
            "tenantId": "text"
          }
        ],
        "fatherOrHusbandName": "text",
        "bloodGroup": [
          "A+"
        ],
        "identificationMark": "text",
        "photo": "text",
        "createdBy": 1,
        "createdDate": "2025-05-15",
        "lastModifiedBy": 1,
        "lastModifiedDate": "2025-05-15",
        "otpReference": "text",
        "tenantId": "text"
      },
      "id": 1,
      "uuid": "text",
      "code": "text",
      "employeeStatus": "text",
      "employeeType": "text",
      "dateOfAppointment": 1,
      "jurisdictions": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "hierarchy": "text",
          "boundary": "text",
          "boundaryType": "text",
          "auditDetails": {
            "createdBy": "text",
            "createdDate": 1,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1
          }
        }
      ],
      "assignments": [
        {
          "id": "text",
          "position": 1,
          "designation": "text",
          "department": "text",
          "fromDate": 1,
          "toDate": 1,
          "govtOrderNumber": "text",
          "reportingTo": "text",
          "isHOD": true,
          "isCurrentAssignment": true,
          "auditDetails": {
            "createdBy": "text",
            "createdDate": 1,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1
          }
        }
      ],
      "serviceHistory": [
        {
          "id": "text",
          "serviceStatus": "text",
          "serviceFrom": 1,
          "serviceTo": 1,
          "location": "text",
          "orderNo": "text",
          "isCurrentPosition": true,
          "auditDetails": {
            "createdBy": "text",
            "createdDate": 1,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1
          }
        }
      ],
      "isActive": true,
      "education": [
        {
          "id": "text",
          "qualification": "text",
          "stream": "text",
          "yearOfPassing": 1,
          "university": "text",
          "remarks": "text",
          "auditDetails": {
            "createdBy": "text",
            "createdDate": 1,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1
          }
        }
      ],
      "tests": [
        {
          "id": "text",
          "test": "text",
          "yearOfPassing": 1,
          "remarks": "text",
          "auditDetails": {
            "createdBy": "text",
            "createdDate": 1,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1
          }
        }
      ],
      "tenantId": "text",
      "deactivationDetails": [
        {
          "id": "text",
          "employeeId": "text",
          "reasonForDeactivation": "text",
          "effectiveFrom": 1,
          "orderNo": "text",
          "typeOfDeactivation": [
            "SUSPENSION"
          ],
          "auditDetails": {
            "createdBy": "text",
            "createdDate": 1,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1
          }
        }
      ],
      "reactivationDetails": [
        {
          "id": "text",
          "employeeId": "text",
          "reasonForReactivation": "text",
          "effectiveFrom": 1,
          "orderNo": "text",
          "typeOfReactivation": [
            "ORDER FROM COMISSIONER"
          ],
          "auditDetails": {
            "createdBy": "text",
            "createdDate": 1,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1
          }
        }
      ],
      "documents": [
        {
          "id": 1,
          "employeeId": 1,
          "documentId": "text",
          "documentName": "text",
          "referenceType": [
            "HEADER"
          ],
          "referenceId": "text",
          "auditDetails": {
            "createdBy": "text",
            "createdDate": 1,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1
          }
        }
      ],
      "auditDetails": {
        "createdBy": "text",
        "createdDate": 1,
        "lastModifiedBy": "text",
        "lastModifiedDate": 1
      }
    }
  ]
}

Update Employee data for a particular employee

post

To update an existing employee's employee details and all other details like assignment, jurisdiction, qualification service details and porbation. This API will also be used for deactivating an employee

Body
Responses
202
Employee request accepted for update.
application/json
400
Invalid input.
application/json
post
POST /rainmaker-hrms/[API endpoint]/employees/_update HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 3177

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "Employee": [
    {
      "user": {
        "id": 1,
        "userName": "text",
        "password": "password",
        "salutation": "text",
        "name": "text",
        "gender": [
          "MALE"
        ],
        "mobileNumber": "text",
        "emailId": "text",
        "altContactNumber": "text",
        "pan": "text",
        "aadhaarNumber": "text",
        "permanentAddress": "text",
        "permanentCity": "text",
        "permanentPincode": "text",
        "correspondenceCity": "text",
        "correspondencePincode": "text",
        "correspondenceAddress": "text",
        "active": true,
        "dob": "2025-05-15",
        "locale": "text",
        "type": [
          "EMPLOYEE"
        ],
        "signature": "text",
        "accountLocked": true,
        "roles": [
          {
            "id": 1,
            "name": "text",
            "code": "text",
            "description": "text",
            "createdBy": 1,
            "createdDate": "2025-05-15",
            "lastModifiedBy": 1,
            "lastModifiedDate": "2025-05-15",
            "tenantId": "text"
          }
        ],
        "fatherOrHusbandName": "text",
        "bloodGroup": [
          "A+"
        ],
        "identificationMark": "text",
        "photo": "text",
        "createdBy": 1,
        "createdDate": "2025-05-15",
        "lastModifiedBy": 1,
        "lastModifiedDate": "2025-05-15",
        "otpReference": "text",
        "tenantId": "text"
      },
      "id": 1,
      "uuid": "text",
      "code": "text",
      "employeeStatus": "text",
      "employeeType": "text",
      "dateOfAppointment": 1,
      "jurisdictions": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "hierarchy": "text",
          "boundary": "text",
          "boundaryType": "text",
          "auditDetails": {
            "createdBy": "text",
            "createdDate": 1,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1
          }
        }
      ],
      "assignments": [
        {
          "id": "text",
          "position": 1,
          "designation": "text",
          "department": "text",
          "fromDate": 1,
          "toDate": 1,
          "govtOrderNumber": "text",
          "reportingTo": "text",
          "isHOD": true,
          "isCurrentAssignment": true,
          "auditDetails": {
            "createdBy": "text",
            "createdDate": 1,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1
          }
        }
      ],
      "serviceHistory": [
        {
          "id": "text",
          "serviceStatus": "text",
          "serviceFrom": 1,
          "serviceTo": 1,
          "location": "text",
          "orderNo": "text",
          "isCurrentPosition": true,
          "auditDetails": {
            "createdBy": "text",
            "createdDate": 1,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1
          }
        }
      ],
      "isActive": true,
      "education": [
        {
          "id": "text",
          "qualification": "text",
          "stream": "text",
          "yearOfPassing": 1,
          "university": "text",
          "remarks": "text",
          "auditDetails": {
            "createdBy": "text",
            "createdDate": 1,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1
          }
        }
      ],
      "tests": [
        {
          "id": "text",
          "test": "text",
          "yearOfPassing": 1,
          "remarks": "text",
          "auditDetails": {
            "createdBy": "text",
            "createdDate": 1,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1
          }
        }
      ],
      "tenantId": "text",
      "deactivationDetails": [
        {
          "id": "text",
          "employeeId": "text",
          "reasonForDeactivation": "text",
          "effectiveFrom": 1,
          "orderNo": "text",
          "typeOfDeactivation": [
            "SUSPENSION"
          ],
          "auditDetails": {
            "createdBy": "text",
            "createdDate": 1,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1
          }
        }
      ],
      "reactivationDetails": [
        {
          "id": "text",
          "employeeId": "text",
          "reasonForReactivation": "text",
          "effectiveFrom": 1,
          "orderNo": "text",
          "typeOfReactivation": [
            "ORDER FROM COMISSIONER"
          ],
          "auditDetails": {
            "createdBy": "text",
            "createdDate": 1,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1
          }
        }
      ],
      "documents": [
        {
          "id": 1,
          "employeeId": 1,
          "documentId": "text",
          "documentName": "text",
          "referenceType": [
            "HEADER"
          ],
          "referenceId": "text",
          "auditDetails": {
            "createdBy": "text",
            "createdDate": 1,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1
          }
        }
      ],
      "auditDetails": {
        "createdBy": "text",
        "createdDate": 1,
        "lastModifiedBy": "text",
        "lastModifiedDate": 1
      }
    }
  ]
}
{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Employee": [
    {
      "user": {
        "id": 1,
        "userName": "text",
        "password": "password",
        "salutation": "text",
        "name": "text",
        "gender": [
          "MALE"
        ],
        "mobileNumber": "text",
        "emailId": "text",
        "altContactNumber": "text",
        "pan": "text",
        "aadhaarNumber": "text",
        "permanentAddress": "text",
        "permanentCity": "text",
        "permanentPincode": "text",
        "correspondenceCity": "text",
        "correspondencePincode": "text",
        "correspondenceAddress": "text",
        "active": true,
        "dob": "2025-05-15",
        "pwdExpiryDate": "2025-05-15",
        "locale": "text",
        "type": [
          "EMPLOYEE"
        ],
        "signature": "text",
        "accountLocked": true,
        "roles": [
          {
            "id": 1,
            "name": "text",
            "code": "text",
            "description": "text",
            "createdBy": 1,
            "createdDate": "2025-05-15",
            "lastModifiedBy": 1,
            "lastModifiedDate": "2025-05-15",
            "tenantId": "text"
          }
        ],
        "fatherOrHusbandName": "text",
        "bloodGroup": [
          "A+"
        ],
        "identificationMark": "text",
        "photo": "text",
        "createdBy": 1,
        "createdDate": "2025-05-15",
        "lastModifiedBy": 1,
        "lastModifiedDate": "2025-05-15",
        "otpReference": "text",
        "tenantId": "text"
      },
      "id": 1,
      "uuid": "text",
      "code": "text",
      "employeeStatus": "text",
      "employeeType": "text",
      "dateOfAppointment": 1,
      "jurisdictions": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "hierarchy": "text",
          "boundary": "text",
          "boundaryType": "text",
          "auditDetails": {
            "createdBy": "text",
            "createdDate": 1,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1
          }
        }
      ],
      "assignments": [
        {
          "id": "text",
          "position": 1,
          "designation": "text",
          "department": "text",
          "fromDate": 1,
          "toDate": 1,
          "govtOrderNumber": "text",
          "reportingTo": "text",
          "isHOD": true,
          "isCurrentAssignment": true,
          "auditDetails": {
            "createdBy": "text",
            "createdDate": 1,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1
          }
        }
      ],
      "serviceHistory": [
        {
          "id": "text",
          "serviceStatus": "text",
          "serviceFrom": 1,
          "serviceTo": 1,
          "location": "text",
          "orderNo": "text",
          "isCurrentPosition": true,
          "auditDetails": {
            "createdBy": "text",
            "createdDate": 1,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1
          }
        }
      ],
      "isActive": true,
      "education": [
        {
          "id": "text",
          "qualification": "text",
          "stream": "text",
          "yearOfPassing": 1,
          "university": "text",
          "remarks": "text",
          "auditDetails": {
            "createdBy": "text",
            "createdDate": 1,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1
          }
        }
      ],
      "tests": [
        {
          "id": "text",
          "test": "text",
          "yearOfPassing": 1,
          "remarks": "text",
          "auditDetails": {
            "createdBy": "text",
            "createdDate": 1,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1
          }
        }
      ],
      "tenantId": "text",
      "deactivationDetails": [
        {
          "id": "text",
          "employeeId": "text",
          "reasonForDeactivation": "text",
          "effectiveFrom": 1,
          "orderNo": "text",
          "typeOfDeactivation": [
            "SUSPENSION"
          ],
          "auditDetails": {
            "createdBy": "text",
            "createdDate": 1,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1
          }
        }
      ],
      "reactivationDetails": [
        {
          "id": "text",
          "employeeId": "text",
          "reasonForReactivation": "text",
          "effectiveFrom": 1,
          "orderNo": "text",
          "typeOfReactivation": [
            "ORDER FROM COMISSIONER"
          ],
          "auditDetails": {
            "createdBy": "text",
            "createdDate": 1,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1
          }
        }
      ],
      "documents": [
        {
          "id": 1,
          "employeeId": 1,
          "documentId": "text",
          "documentName": "text",
          "referenceType": [
            "HEADER"
          ],
          "referenceId": "text",
          "auditDetails": {
            "createdBy": "text",
            "createdDate": 1,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1
          }
        }
      ],
      "auditDetails": {
        "createdBy": "text",
        "createdDate": 1,
        "lastModifiedBy": "text",
        "lastModifiedDate": 1
      }
    }
  ]
}

Get the list of employees defined in the system.

post

Get the employee list based on the input parameters. Response will give the minimum set of information related to the employee.

Query parameters
codesstring[]Optional

List of employee codes

namesstring[]Optional

List of employee names

departmentsstring[]Optional

List of Department codes for the employee assignment.

designationsstring[]Optional

List of Designation codes for the employee assignment.

asOnDatenumberOptional

Epoch Date of assignment

idsinteger[] · max: 100Optional

List of Unique Id of employee

employeestatusesstring[]Optional

List of Unique codes of employee status

employeetypesstring[]Optional

List of Unique codes of employee type

uuidsstring[]Optional

List of Unique uuid of employee

positionsinteger[]Optional

List of Unique Positions

rolesstring[]Optional

List of Roles of employee

phonestringRequired

Phone Number

isActivebooleanRequired

True will return active employees, False otherwise

offsetintegerRequired

Offset of the search result

limitintegerRequired

No of records to be returned from the offset

tenantidstringRequired

Tenant id

Body

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.

apiIdstring · max: 128Required

unique API ID

verstring · max: 32Required

API version - for HTTP based request this will be same as used in path

tsinteger · int64Required

time in epoch

actionstring · max: 32Required

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

didstring · max: 1024Optional

Device ID from which the API is called

keystring · max: 256Optional

API key (API key provided to the caller in case of server to server communication)

msgIdstring · max: 256Required

Unique request message id from the caller

requesterIdstring · max: 256Optional

UserId of the user calling

authTokenstringOptional

//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token

correlationIdstringRead-onlyOptional
Responses
200
Successful response
application/json
400
Invalid input.
application/json
post
POST /rainmaker-hrms/[API endpoint]/employees/_search?phone=text&isActive=true&offset=1&limit=1&tenantid=text HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 133

{
  "apiId": "text",
  "ver": "text",
  "ts": 1,
  "action": "text",
  "did": "text",
  "key": "text",
  "msgId": "text",
  "requesterId": "text",
  "authToken": "text"
}
{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Employee": [
    {
      "user": {
        "id": 1,
        "userName": "text",
        "password": "password",
        "salutation": "text",
        "name": "text",
        "gender": [
          "MALE"
        ],
        "mobileNumber": "text",
        "emailId": "text",
        "altContactNumber": "text",
        "pan": "text",
        "aadhaarNumber": "text",
        "permanentAddress": "text",
        "permanentCity": "text",
        "permanentPincode": "text",
        "correspondenceCity": "text",
        "correspondencePincode": "text",
        "correspondenceAddress": "text",
        "active": true,
        "dob": "2025-05-15",
        "pwdExpiryDate": "2025-05-15",
        "locale": "text",
        "type": [
          "EMPLOYEE"
        ],
        "signature": "text",
        "accountLocked": true,
        "roles": [
          {
            "id": 1,
            "name": "text",
            "code": "text",
            "description": "text",
            "createdBy": 1,
            "createdDate": "2025-05-15",
            "lastModifiedBy": 1,
            "lastModifiedDate": "2025-05-15",
            "tenantId": "text"
          }
        ],
        "fatherOrHusbandName": "text",
        "bloodGroup": [
          "A+"
        ],
        "identificationMark": "text",
        "photo": "text",
        "createdBy": 1,
        "createdDate": "2025-05-15",
        "lastModifiedBy": 1,
        "lastModifiedDate": "2025-05-15",
        "otpReference": "text",
        "tenantId": "text"
      },
      "id": 1,
      "uuid": "text",
      "code": "text",
      "employeeStatus": "text",
      "employeeType": "text",
      "dateOfAppointment": 1,
      "jurisdictions": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "hierarchy": "text",
          "boundary": "text",
          "boundaryType": "text",
          "auditDetails": {
            "createdBy": "text",
            "createdDate": 1,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1
          }
        }
      ],
      "assignments": [
        {
          "id": "text",
          "position": 1,
          "designation": "text",
          "department": "text",
          "fromDate": 1,
          "toDate": 1,
          "govtOrderNumber": "text",
          "reportingTo": "text",
          "isHOD": true,
          "isCurrentAssignment": true,
          "auditDetails": {
            "createdBy": "text",
            "createdDate": 1,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1
          }
        }
      ],
      "serviceHistory": [
        {
          "id": "text",
          "serviceStatus": "text",
          "serviceFrom": 1,
          "serviceTo": 1,
          "location": "text",
          "orderNo": "text",
          "isCurrentPosition": true,
          "auditDetails": {
            "createdBy": "text",
            "createdDate": 1,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1
          }
        }
      ],
      "isActive": true,
      "education": [
        {
          "id": "text",
          "qualification": "text",
          "stream": "text",
          "yearOfPassing": 1,
          "university": "text",
          "remarks": "text",
          "auditDetails": {
            "createdBy": "text",
            "createdDate": 1,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1
          }
        }
      ],
      "tests": [
        {
          "id": "text",
          "test": "text",
          "yearOfPassing": 1,
          "remarks": "text",
          "auditDetails": {
            "createdBy": "text",
            "createdDate": 1,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1
          }
        }
      ],
      "tenantId": "text",
      "deactivationDetails": [
        {
          "id": "text",
          "employeeId": "text",
          "reasonForDeactivation": "text",
          "effectiveFrom": 1,
          "orderNo": "text",
          "typeOfDeactivation": [
            "SUSPENSION"
          ],
          "auditDetails": {
            "createdBy": "text",
            "createdDate": 1,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1
          }
        }
      ],
      "reactivationDetails": [
        {
          "id": "text",
          "employeeId": "text",
          "reasonForReactivation": "text",
          "effectiveFrom": 1,
          "orderNo": "text",
          "typeOfReactivation": [
            "ORDER FROM COMISSIONER"
          ],
          "auditDetails": {
            "createdBy": "text",
            "createdDate": 1,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1
          }
        }
      ],
      "documents": [
        {
          "id": 1,
          "employeeId": 1,
          "documentId": "text",
          "documentName": "text",
          "referenceType": [
            "HEADER"
          ],
          "referenceId": "text",
          "auditDetails": {
            "createdBy": "text",
            "createdDate": 1,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1
          }
        }
      ],
      "auditDetails": {
        "createdBy": "text",
        "createdDate": 1,
        "lastModifiedBy": "text",
        "lastModifiedDate": 1
      }
    }
  ]
}
Swagger Editor
Swagger API Contract Link
Logo