1 General

The JSON Schema API presents the input template for adding new employee master data to and editing the master data of existing employees in HRWorks. Each customer database in HRWorks has a unique set of masters with regard to employee data. Hence, it is imperative that the JSON schema API is conformed to while sending employee data to HRWorks from a third-party system.

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/employeeJsonSchema?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. Response

If the JSON Schema API call is successful, the API shall return an input template for the addEmployee and editEmployee API. A typical example of the response is as follows.

2.1 Response in case of error

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

{
  "success": false,
  "statusCode": 500,
  "errorMsg": "An error has occurred. Please contact Hinote Customer Support by sending an email to support@hinote.in."
}

Note:

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

3 Coding Examples

3.1 CURL

1
2
3

#The following command returns employee JSON schema in response.

curl --location --request GET 'https://hinote.in/hrworks/api/v1/employeeJsonSchema?key=<customer_api_key>'