Employee

Employee APIs

APIs available from Employee Information System for employee services to -

• create statewide standardized database of the employee to streamline processes related to personnel management

• increase transparency for higher management for efficient resource planning

• integrate with rainmaker modules for security, authentication and workflow handling

• establish KPIs for employees and generate reports

Get the list of employees defined in the system.

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

POST/egov-hrms/[API endpoint]/employees/_search

Query parameters

Body

*/*

Common request info for getting employee.

apiId*string

unique API ID

ver*string

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

ts*integer (int64)

time in epoch

action*string

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

didstring

Device ID from which the API is called

keystring

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

msgId*string

Unique request message id from the caller

requesterIdstring

UserId of the user calling

authTokenstring

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

userInfoUserInfo (object)

This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.

correlationIdstring

Response

200400

Successful response

Body

*/*

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

Employeearray of Employee (object)

Request

JavaScriptCurlPython

const response = await fetch('/egov-hrms/[API endpoint]/employees/_search?phone=text&isActive=false&offset=0&limit=0&tenantid=text', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "action": "text",
      "apiId": "text",
      "msgId": "text",
      "ts": 0,
      "ver": "text"
    }),
});
const data = await response.json();

Response

200400

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

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

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".

POST/egov-hrms/[API endpoint]/employees/_create

Body

*/*

Details for the new employee.

RequestInfo*RequestInfo (object)

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.

Employee*array of Employee (object)

Response

202400

Employee request accepted for creation.

Body

*/*

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

Employeearray of Employee (object)

Request

JavaScriptCurlPython

const response = await fetch('/egov-hrms/[API endpoint]/employees/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "Employee": [
        {
          "assignments": [
            {
              "department": "text",
              "designation": "text",
              "fromDate": 0,
              "toDate": 0
            }
          ],
          "employeeStatus": "text",
          "employeeType": "text",
          "jurisdictions": [
            {
              "boundary": "text",
              "boundaryType": "text",
              "hierarchy": "text"
            }
          ],
          "tenantId": "text",
          "user": {
            "active": false,
            "gender": "text",
            "locale": "text",
            "mobileNumber": "text",
            "name": "text",
            "tenantId": "text",
            "type": "text",
            "userName": "text"
          }
        }
      ],
      "RequestInfo": {
        "action": "text",
        "apiId": "text",
        "msgId": "text",
        "ts": 0,
        "ver": "text"
      }
    }),
});
const data = await response.json();

Response

202400

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

Update Employee data for a particular employee

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

POST/egov-hrms/[API endpoint]/employees/_update

Body

*/*

Request header for the employee with new of values.

RequestInfo*RequestInfo (object)

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.

Employee*array of Employee (object)

Response

202400

Employee request accepted for update.

Body

*/*

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

Employeearray of Employee (object)

Request

JavaScriptCurlPython

const response = await fetch('/egov-hrms/[API endpoint]/employees/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "Employee": [
        {
          "assignments": [
            {
              "department": "text",
              "designation": "text",
              "fromDate": 0,
              "toDate": 0
            }
          ],
          "employeeStatus": "text",
          "employeeType": "text",
          "jurisdictions": [
            {
              "boundary": "text",
              "boundaryType": "text",
              "hierarchy": "text"
            }
          ],
          "tenantId": "text",
          "user": {
            "active": false,
            "gender": "text",
            "locale": "text",
            "mobileNumber": "text",
            "name": "text",
            "tenantId": "text",
            "type": "text",
            "userName": "text"
          }
        }
      ],
      "RequestInfo": {
        "action": "text",
        "apiId": "text",
        "msgId": "text",
        "ts": 0,
        "ver": "text"
      }
    }),
});
const data = await response.json();

Response

202400

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

Get the list of count of active and inactive employee.

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

POST/egov-hrms/[API endpoint]/employees/_count

Query parameters

Response

200400

Successful response, present the list of count of active and inactive employee for given tenant Id.

Body

*/*

responseInfoResponseHeader (object)

ResponseHeader should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseHeader should always correspond to the same values in respective request's RequestHeader.

EmployeeCountEmployeeCount (object)

Capture the employee count details

Request

JavaScriptCurlPython

const response = await fetch('/egov-hrms/[API endpoint]/employees/_count', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "responseInfo": {
    "ts": 0,
    "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"
  }
}