Add Employee API
- T E Gautham
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://hinote.in/hrworks/api/v1/addEmployee?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 inputData or as a request body. Input should comply with the output of the schema API. A typical example is as follows.
|
3. Response
If the Add Employee request API call is successful, the API shall return a response such as the below.
|
3.1 Response in case of error
In case of error, the API returns the following JSON response:
|
Note:
errorMsg is a string value describing the error.
Status codes are described in Status Codes section.
4 Coding Examples
4.1 CURL
1 |
|