Versions Compared

Key

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

...

If the API call is successful, HRWorks the API shall return a JSON formatted string response with the following parameter values.such as the below.

{
    "statusCode": 200,
    "msg": Bad Request - Invalid Date Format
}

3.1 Output Parameters

Parameter

Description

statusCode

Refers to the relevant http status code. Any status code other than "200" refers to an error while processing the request.

msg

Refers to a text value describing the response. For errors, it can describe any error which may have occurred.

The possible values for "statusCode" are presented here.The  response shall be in the format {"statusCode": <code>, "msg": <msg>}. For example, {"statusCode": 400, "msg": “Bad Request - Invalid Date Format”}