Versions Compared

Old Version 2

changes.mady.by.user T E Gautham

Saved on

compared with

New Version Current

changes.mady.by.user T E Gautham

Saved on

Key

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

...

Parameter

Description

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

You can generate the API key for your organization yourself.

...

https://hinote.in/hrworks/api/v1/EmployeeMastertransactions.do
You need to use https in your API call.

...

2.2 URL Format

URL format: https://hinote.in/hrworks/api/v1/EmployeeMaster.do?key=<apiKey>&searchFilter=
{
  "employeeId": "AAAA",
  //Single EmployeeId or multiple employee Ids separated by space or comma. AAAA represents some text input.
  "firstName": "AAAA",
  "lastName": "AAAA",
  "divisionIds": ["AAAA", "AAAA", "..."],
  "designationIds": ["AAAA", "AAAA", "...."],
  "statusIds": ["AAAA", "AAAA", "...."],
  "workLocationIds": ["AAAA", "AAAA", "...."],
  "employeeTypeIds": ["AAAA", "AAAA", "...."],
  "joinDatePeriod": {
                     "fromDate": "YYYY-MM-DD",
                     "toDate": "YYYY-MM-DD",
                     "days": 0000
                    },
  "separationDatePeriod": {
                           "fromDate": "YYYY-MM-DD",
                           "toDate": "YYYY-MM-DD",
                           "days": 0000
                           },
  "changedSince": "yyyy-mm-dd hh:mm:ss"
}
]

2.3 Get Employee Master Info Examples

a. https://hinote.in/hrworks/api/v1/EmployeeMaster.do?key=<apiKey>

Requests all employee data in the database as it exists at the time of the request.

b. https://hinote.in/hrworks/api/v1/EmployeeMaster.do?key=<apiKey>&searchFilter={"divisionIds":["Corporate", "Engineering"]}

Requests all employee data in the divisions with IDs "Corporate" and "Engineering".

c. https://hinote.in/hrworks/api/v1/EmployeeMaster.do?key=<apiKey>&searchFilter={"divisionIds":["Corporate", "Engineering"],"changedSince": "2016-02-01 00:00:00"}

...

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


4 Coding Examples

4.1 CURL

...

1
2
3

#The following command returns employee data in response
  
curl --location --request GET 'https://hinote.in/hrworks/api/v1/EmployeeMaster.do?key=<apiKey>&searchFilter=%7B%22employeeId%22:%22<EmployeeId>%22%7D'