Versions Compared

Version Old Version 1 New Version Current
Changes made by

T E Gautham

T E Gautham

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Your API calls must contain the API key for the purpose of authentication.

Parameter

Description

keyPlease contact the HRWorks administrator in your organization for the API key.

You can generate the API key for your organization yourself.

...

Input can be provided as a request parameter named inputData or as a request body. Input should comply with the output of the schema API. A typical example is as follows.

{
  "employeeId": "XYZ0001",
  "firstName": "Deepika Sharma",
  "dateOfBirth": "1995-03-01",
  "nationality": "Indian",
  "fatherName": "Anil Sharma",
  "maritalStatus": "Unmarried",
  "salutation": "Ms",
  "bloodGroup": "A Positive",
  "bankBranch": "Axis Bank/Chennai",
  "bankAccountNo": "111111111111",
  "nameInBankAccount": "Deepika A Sharma",
  "dateOfJoining": "2021-04-01",
  "pfJoinDate": "2021-04-01",
  "userId": "XYZ0001",
  "password": "0723$XYZ",
  "tpg": "CPG",
  "gender": "Female",
  "statutoryId": {
    "pan": "DHCPS2159K"
  },
  "designation": "Project Manager",
  "manager": "E0101",
  "employeeType": "PM",
  "status": "Employed",
  "division": "Application Development",
  "workLocation": "Chennai",
  "shift": "Shift 1",
  "contactAddress": [{
    "addressType": "Current Address",
    "addressLine1": "Adyar Main Road",
    "city": "Chennai",
    "state": "Tamilnadu",
    "country": "India",
    "postalCode": "600113",
    "isPrimary": true
  }],
  "contactEmail": [{
    "emailType": "email",
    "emailId": "deepika@xyzco.com",
    "isPrimary": true
  }],
     
  "other.ePS_Contribution": "Yes",
  "payPackage": {
    "fromDate": "2021-04-01",
    "action": "Add Full",
    "compensationDetails": {
      "basic": 30000,
      "hra": 10000,
      "employerPF": "Inherit"
    },
    "deductionDetails": {
      "otherDeduction": 800,
      "employeePF": "Inherit"
    }
  }
}


3. Response


If the Add Employee request API call is successful, the API shall return a response such as the below.

{
    "success": true,
    "statusCode": 200
}


3.1 Response in case of error


In case of error, the API returns the following JSON response:


{
    "success": false,
    "statusCode": 400,
    "errorMsg": "Invalid JSON. Please ensure you are passing a valid JSON string and it is url encoded properly."
}

 
Note:

  1. errorMsg is a string value describing the error. 
  2. Status codes are described in Status Codes section.


4 Coding Examples

4.1 CURL


1
2
3
4
5
6
7
8
9
10
11

#The following command posts new employee data.
  
curl --location --request POST 'https://hinote.in/hrworks/api/v1/addEmployee?key=<customer_api_key>' \
--header 'Content-Type: text/plain' \
--data-raw '{  "employeeId": "XYZ0001",  "firstName": "Deepika Sharma",  "dateOfBirth": "1995-03-01",  "nationality": "Indian",  "fatherName": "Anil Sharma",  "maritalStatus": "Unmarried",  "salutation": "Ms",  "bloodGroup": "A Positive","bankBranch": "Axis Bank/Chennai",  "bankAccountNo": "111111111111",  "nameInBankAccount": "Deepika A Sharma", "dateOfJoining": "2021-04-01",  "pfJoinDate": "2021-04-01",  "userId": "XYZ0001",  "password": "0723$XYZ", "tpg": "CPG",  "gender": "Female",  "statutoryId": {    "pan": "DHCPS2159K"  },  "designation": "Project Manager", "manager": "E0101",  "employeeType": "PM",  "status": "Employed",  "division": "Application Development", "workLocation": "Chennai",  "shift": "Shift 1",  "contactAddress": [{    "addressType": "Current Address",
"addressLine1": "Adyar Main Road", "city": "Chennai",    "state": "Tamilnadu",    "country": "India",
"postalCode": "600113",    "isPrimary": true  }],
"contactEmail": [{    "emailType": "email",    "emailId": "deepika@xyzco.com",    "isPrimary": true  }],
"other.ePS_Contribution": "Yes",  "payPackage": {    "fromDate": "2021-04-01",    "action": "Add Full",
"compensationDetails": {      "basic": 30000,      "hra": 10000,      "employerPF": "Inherit"    },
"deductionDetails": {      "otherDeduction": 800,      "employeePF": "Inherit"    }  }}'