1 General
You can use our web (HTTP request) API to submit new employee information to HRWorks by way of this API. This creates a new employee record in HRWorks.
1.1 Authentication
Your API calls must contain the API key for the purpose of authentication.
Parameter | Description |
|---|---|
| key | Please contact the HRWorks administrator in your organization for the API key. |
You can generate the API key for your organization yourself.
1.2 Endpoint
https://www.hinote.in/hrworks/AttendanceFileUpload.do?key=<customer_api_key>You need to use https in your API call.
Please note that the API key must be appended with the URL as a request parameter.
2 Post Request
Input can be provided as a request parameter named input. The value should be a data file in xls (in MS Excel 97/2000/XP format) or CSV format. The xls template file for this can be downloaded from HRWorks application itself.
The input file contains the following columns:
- Employee Id: Employee Id as specified in HRWorks.
- 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.
- 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.
- 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.
- In Location: If attendance locations are configured, then specify the In Location, else can be left blank.
- Out Location: If attendance locations are configured, then specify the Out Location, else can be left blank.
- Comments: Enter comments for the attendance entry. Can be left blank.
3. Response
If the Attendance Upload request API call is successful, the API shall return a response such as the below.
|
4 Coding Examples
4.1 CURL
1 |
|