Versions Compared

Key

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

...

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.

...


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:

  1. errorMsg is a string value describing the error. 

  2. 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>'