Versions Compared

Version Old Version 7 New Version 8
Changes made by

T E Gautham

T E Gautham

Saved on

Key

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

...

  1. Employee Id: Employee Id as specified in HRWorks.
  2. Date: Date for which attendance is being uploaded. Should be Excel date value in case of xls file. For CSV format, the date value should be in the yyyy-mm-dd format.
  3. In Time: Date and Time of the employee entry time. Should be Excel date time value. For CSV format, the "TimeStamp" format in Data Types should be used.
  4. Out Time: Date and Time of the employee exit time. Should be Excel date time value. For CSV format, the "TimeStamp" format in Data Types should be used.
  5. In Location: Should If attendance locations are configured, then specify the In Location, else can be left as blank. Created for future use.
  6. Out Location: Should If attendance locations are configured, then specify the Out Location, else can be left as blank. Created for future use.
  7. Comments: Any relevant Enter comments for the attendance entry. Can be left blank.

3. Response


If the Add Employee Attendance Upload 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

...

{    "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 attendance 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"    }  }}'

CURL utility can be used to upload attendance data into HRWorks application. The following command can be used for the upload:

...

F "key=<hrworks_user_id>" -F "input=@<local reference to the attendance data file>" https://www.hinote.in/hrworks/AttendanceFileUpload.do





curl -F "key=<hrworks_user_id>" -F "input=@<local reference to the attendance data file>" https://www.hinote.in/hrworks/AttendanceFileUpload.do

...