Employee

Employee Registry

Swagger Editor

Swagger API Contract Link

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

/employees/_create

Body

RequestInfoobjectrequired

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.

Employeeobject[]required

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/rainmaker-hrms/[API endpoint]/employees/_create' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"Employee":[{"user":{"userName":"text","name":"text","mobileNumber":"text","active":true,"locale":"text","tenantId":"text","roles":[{"name":"text","tenantId":"text"}],"gender":["MALE"],"type":["EMPLOYEE"]},"employeeStatus":"text","employeeType":"text","tenantId":"text","auditDetails":{},"jurisdictions":[{"hierarchy":"text","boundary":"text","boundaryType":"text","auditDetails":{}}],"assignments":[{"designation":"text","department":"text","fromDate":1,"toDate":1,"auditDetails":{}}],"serviceHistory":[{"serviceStatus":"text","serviceFrom":1,"serviceTo":1,"orderNo":"text","auditDetails":{}}],"education":[{"qualification":"text","stream":"text","yearOfPassing":1,"auditDetails":{}}],"tests":[{"test":"text","yearOfPassing":1,"auditDetails":{}}],"deactivationDetails":[{"auditDetails":{}}],"reactivationDetails":[{"auditDetails":{}}],"documents":[{"employeeId":1,"auditDetails":{}}]}]}'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Employee": [
    {
      "user": {
        "userName": "text",
        "name": "text",
        "mobileNumber": "text",
        "active": true,
        "locale": "text",
        "tenantId": "text",
        "roles": [
          {
            "name": "text",
            "tenantId": "text"
          }
        ],
        "gender": [
          "MALE"
        ],
        "type": [
          "EMPLOYEE"
        ]
      },
      "id": 1,
      "uuid": "text",
      "code": "text",
      "employeeStatus": "text",
      "employeeType": "text",
      "dateOfAppointment": 1,
      "isActive": true,
      "tenantId": "text",
      "auditDetails": {},
      "jurisdictions": [
        {
          "hierarchy": "text",
          "boundary": "text",
          "boundaryType": "text",
          "auditDetails": {}
        }
      ],
      "assignments": [
        {
          "designation": "text",
          "department": "text",
          "fromDate": 1,
          "toDate": 1,
          "auditDetails": {}
        }
      ],
      "serviceHistory": [
        {
          "serviceStatus": "text",
          "serviceFrom": 1,
          "serviceTo": 1,
          "orderNo": "text",
          "auditDetails": {}
        }
      ],
      "education": [
        {
          "qualification": "text",
          "stream": "text",
          "yearOfPassing": 1,
          "auditDetails": {}
        }
      ],
      "tests": [
        {
          "test": "text",
          "yearOfPassing": 1,
          "auditDetails": {}
        }
      ],
      "deactivationDetails": [
        {
          "auditDetails": {}
        }
      ],
      "reactivationDetails": [
        {
          "auditDetails": {}
        }
      ],
      "documents": [
        {
          "employeeId": 1,
          "auditDetails": {}
        }
      ]
    }
  ]
}

Employee request accepted for creation.

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

/employees/_update

Body

RequestInfoobjectrequired

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.

Employeeobject[]required

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/rainmaker-hrms/[API endpoint]/employees/_update' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"Employee":[{"user":{"userName":"text","name":"text","mobileNumber":"text","active":true,"locale":"text","tenantId":"text","roles":[{"name":"text","tenantId":"text"}],"gender":["MALE"],"type":["EMPLOYEE"]},"employeeStatus":"text","employeeType":"text","tenantId":"text","auditDetails":{},"jurisdictions":[{"hierarchy":"text","boundary":"text","boundaryType":"text","auditDetails":{}}],"assignments":[{"designation":"text","department":"text","fromDate":1,"toDate":1,"auditDetails":{}}],"serviceHistory":[{"serviceStatus":"text","serviceFrom":1,"serviceTo":1,"orderNo":"text","auditDetails":{}}],"education":[{"qualification":"text","stream":"text","yearOfPassing":1,"auditDetails":{}}],"tests":[{"test":"text","yearOfPassing":1,"auditDetails":{}}],"deactivationDetails":[{"auditDetails":{}}],"reactivationDetails":[{"auditDetails":{}}],"documents":[{"employeeId":1,"auditDetails":{}}]}]}'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Employee": [
    {
      "user": {
        "userName": "text",
        "name": "text",
        "mobileNumber": "text",
        "active": true,
        "locale": "text",
        "tenantId": "text",
        "roles": [
          {
            "name": "text",
            "tenantId": "text"
          }
        ],
        "gender": [
          "MALE"
        ],
        "type": [
          "EMPLOYEE"
        ]
      },
      "id": 1,
      "uuid": "text",
      "code": "text",
      "employeeStatus": "text",
      "employeeType": "text",
      "dateOfAppointment": 1,
      "isActive": true,
      "tenantId": "text",
      "auditDetails": {},
      "jurisdictions": [
        {
          "hierarchy": "text",
          "boundary": "text",
          "boundaryType": "text",
          "auditDetails": {}
        }
      ],
      "assignments": [
        {
          "designation": "text",
          "department": "text",
          "fromDate": 1,
          "toDate": 1,
          "auditDetails": {}
        }
      ],
      "serviceHistory": [
        {
          "serviceStatus": "text",
          "serviceFrom": 1,
          "serviceTo": 1,
          "orderNo": "text",
          "auditDetails": {}
        }
      ],
      "education": [
        {
          "qualification": "text",
          "stream": "text",
          "yearOfPassing": 1,
          "auditDetails": {}
        }
      ],
      "tests": [
        {
          "test": "text",
          "yearOfPassing": 1,
          "auditDetails": {}
        }
      ],
      "deactivationDetails": [
        {
          "auditDetails": {}
        }
      ],
      "reactivationDetails": [
        {
          "auditDetails": {}
        }
      ],
      "documents": [
        {
          "employeeId": 1,
          "auditDetails": {}
        }
      ]
    }
  ]
}

Employee request accepted for update.

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

/employees/_count

Query parameters

tenantIdstring · varcharrequired

Unique id for a tenant.

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/rainmaker-hrms/[API endpoint]/employees/_count?tenantId=text'

200

400

200

{
  "responseInfo": {
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "signature": "text",
    "error": {
      "code": "text",
      "message": "text",
      "description": "text",
      "params": [
        "text"
      ]
    },
    "information": {},
    "debug": {},
    "additionalInfo": {},
    "status": "COMPLETED"
  },
  "EmployeeCount": {
    "activeEmployee": "text",
    "inactiveEmployee": "text",
    "totalEmployee": "text"
  }
}

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

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

/employees/_search

Query parameters

codesstring[]

List of employee codes

namesstring[]

List of employee names

departmentsstring[]

List of Department codes for the employee assignment.

designationsstring[]

List of Designation codes for the employee assignment.

asOnDatenumber

Epoch Date of assignment

idsinteger[]

List of Unique Id of employee

employeestatusesstring[]

List of Unique codes of employee status

employeetypesstring[]

List of Unique codes of employee type

uuidsstring[]

List of Unique uuid of employee

positionsinteger[]

List of Unique Positions

rolesstring[]

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

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: 1024

Device ID from which the API is called

keystring · max: 256

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: 256

UserId of the user calling

authTokenstring

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

userInfoobject

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

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/rainmaker-hrms/[API endpoint]/employees/_search?phone=text&isActive=true&offset=1&limit=1&tenantid=text' \
  --header 'Content-Type: application/json' \
  --data '{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}}'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Employee": [
    {
      "user": {
        "userName": "text",
        "name": "text",
        "mobileNumber": "text",
        "active": true,
        "locale": "text",
        "tenantId": "text",
        "roles": [
          {
            "name": "text",
            "tenantId": "text"
          }
        ],
        "gender": [
          "MALE"
        ],
        "type": [
          "EMPLOYEE"
        ]
      },
      "id": 1,
      "uuid": "text",
      "code": "text",
      "employeeStatus": "text",
      "employeeType": "text",
      "dateOfAppointment": 1,
      "isActive": true,
      "tenantId": "text",
      "auditDetails": {},
      "jurisdictions": [
        {
          "hierarchy": "text",
          "boundary": "text",
          "boundaryType": "text",
          "auditDetails": {}
        }
      ],
      "assignments": [
        {
          "designation": "text",
          "department": "text",
          "fromDate": 1,
          "toDate": 1,
          "auditDetails": {}
        }
      ],
      "serviceHistory": [
        {
          "serviceStatus": "text",
          "serviceFrom": 1,
          "serviceTo": 1,
          "orderNo": "text",
          "auditDetails": {}
        }
      ],
      "education": [
        {
          "qualification": "text",
          "stream": "text",
          "yearOfPassing": 1,
          "auditDetails": {}
        }
      ],
      "tests": [
        {
          "test": "text",
          "yearOfPassing": 1,
          "auditDetails": {}
        }
      ],
      "deactivationDetails": [
        {
          "auditDetails": {}
        }
      ],
      "reactivationDetails": [
        {
          "auditDetails": {}
        }
      ],
      "documents": [
        {
          "employeeId": 1,
          "auditDetails": {}
        }
      ]
    }
  ]
}

Successful response