HRMS

Swagger Editor

Swagger API Contract Link

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/rainmaker-hrms/[API endpoint]/employees/_search

Query parameters

Body

application/json

Common request info for getting employee.

any

Response

200400

Successful response

Body

*/*

Employeearray of Employee (object)

Request

JavaScriptCurlPython

const response = await fetch('/rainmaker-hrms/[API endpoint]/employees/_search?phone=text&isActive=false&offset=0&limit=0&tenantid=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Response

200

{
  "Employee": [
    {
      "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/rainmaker-hrms/[API endpoint]/employees/_create

Body

application/json

Details for the new employee.

Employee*array of any

Response

202400

Employee request accepted for creation.

Body

*/*

Employeearray of Employee (object)

Request

JavaScriptCurlPython

const response = await fetch('/rainmaker-hrms/[API endpoint]/employees/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "Employee": []
    }),
});
const data = await response.json();

Response

202

{
  "Employee": [
    {
      "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/rainmaker-hrms/[API endpoint]/employees/_update

Body

application/json

Request header for the employee with new of values.

Employee*array of Employee (object)

Response

202400

Employee request accepted for update.

Body

*/*

Employeearray of Employee (object)

Request

JavaScriptCurlPython

const response = await fetch('/rainmaker-hrms/[API endpoint]/employees/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "Employee": [
        {
          "jurisdictions": [
            {
              "hierarchy": "text",
              "boundary": "text",
              "boundaryType": "text"
            }
          ],
          "assignments": [
            {
              "fromDate": 0,
              "toDate": 0,
              "department": "text",
              "designation": "text"
            }
          ],
          "employeeStatus": "text",
          "employeeType": "text",
          "tenantId": "text"
        }
      ]
    }),
});
const data = await response.json();

Response

202

{
  "Employee": [
    {
      "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/rainmaker-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('/rainmaker-hrms/[API endpoint]/employees/_count?tenantId=text', {
    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"
      ]
    }
  },
  "EmployeeCount": {
    "activeEmployee": "text",
    "inactiveEmployee": "text",
    "totalEmployee": "text"
  }
}